Skip to content

Commit

Permalink
#4015 - FT program year total contribution limits (#4154)
Browse files Browse the repository at this point in the history 
- AssessmentGateway workflow has been changed to save the following data
in the workflow data
> - calculatedDataExemptScholarshipsBursaries
> - calculatedDataSpouseContributionWeeks
> - calculatedDataTotalFederalFSC
> - calculatedDataTotalProvincialFSC


![image](https://github.com/user-attachments/assets/a58ee079-0016-4d17-9a66-c07fa46f6dd6)

- Refactored the method
[getProgramYearPreviousAwardsTotals](https://github.com/bcgov/SIMS/blob/main/sources/packages/backend/libs/services/src/students-assessments/assessment-sequential-processing.service.ts#L148)
to reduce the call to the database in fetching the sequenced application
and assessment.
- Created a private method as requested in the ticket and additionally
created another method getFTProgramYearContributionTotals to process the
contribution total logic.
- E2E test case was updated to show the created variables and new E2E
created to test the sum logic in the query.
> - programYearTotalScholarshipsBursaries
> - programYearTotalSpouseContributionWeeks
> - programYearTotalFederalFSC
> - programYearTotalProvincialFSC

Note: PR separation is not done, as the workflow change was very minor
and it can be accommodated in a single PR.

---------

Co-authored-by: guru-aot <[email protected]>
  • Loading branch information
@guru-aot
guru-aot and guru-aot authored Dec 23, 2024
1 parent 054aa9e commit ca835ac
Show file tree
Hide file tree
Showing 7 changed files with 377 additions and 88 deletions.
157 changes: 141 additions & 16 deletions ...assessment/_tests_/e2e/assessment.controller-verifyAssessmentCalculationOrder.e2e-spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import {
DisbursementValueType,
OfferingIntensity,
StudentAssessmentStatus,
WorkflowData,
} from "@sims/sims-db";
import { addDays, getISODateOnlyString } from "@sims/utilities";
import { createFakeVerifyAssessmentCalculationOrderPayload } from "./verify-assessment-calculation-order-factory";
Expand Down Expand Up @@ -283,7 +284,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
});
});

it("Should sum the grants from past applications with different offering intensities and awards from SFAS and SFAS part time applications data when the applications are for the same student and program year.", async () => {
it("Should sum the grants from past applications with different offering intensities and awards from SFAS and SFAS part-time applications data when the applications are for the same student and program year.", async () => {
// Arrange

// Create the student and program year to be shared across the applications.
Expand Down Expand Up @@ -395,13 +396,13 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
);
const firstAssessmentDate =
currentApplication.currentAssessment.assessmentDate;
// The start date for the first SFAS and SFAS part time application record is set to the date before the first assessment date of the current application.
// The start date for the first SFAS and SFAS part-time application record is set to the date before the first assessment date of the current application.
const firstLegacyApplicationStartDate = faker.date.between(
programYear.startDate,
addDays(-1, firstAssessmentDate),
);
const firstLegacyApplicationEndDate = addDays(30, firstAssessmentDate);
// The start date for the second SFAS and SFAS part time application record is set to the date after the end date of the first SFAS application.
// The start date for the second SFAS and SFAS part-time application record is set to the date after the end date of the first SFAS application.
const secondLegacyApplicationStartDate = faker.date.between(
firstLegacyApplicationEndDate,
addDays(10, firstLegacyApplicationEndDate),
Expand Down Expand Up @@ -466,7 +467,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
firstFakeSFASApplication,
secondFakeSFASApplication,
]);
// First SFAS part time application with the start date before the first assessment date of the current application.
// First SFAS part-time application with the start date before the first assessment date of the current application.
const firstFakeSFASPartTimeApplication = createFakeSFASPartTimeApplication(
{ individual: sfasIndividual },
{
Expand All @@ -481,7 +482,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
},
},
);
// Second SFAS part time application with the start date after the end date of the first SFAS part time application.
// Second SFAS part-time application with the start date after the end date of the first SFAS part-time application.
const secondFakeSFASPartTimeApplication = createFakeSFASPartTimeApplication(
{ individual: sfasIndividual },
{
Expand Down Expand Up @@ -510,7 +511,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
expect(FakeWorkerJobResult.getResultType(result)).toBe(
MockedZeebeJobResult.Complete,
);
// The calculation will only take SFAS and SFAS part time application data where the start date is the date before the first assessment date of the current application.
// The calculation will only take SFAS and SFAS part-time application data where the start date is the date before the first assessment date of the current application.
expect(FakeWorkerJobResult.getOutputVariables(result)).toStrictEqual({
isReadyForCalculation: true,
latestCSLPBalance: 0,
Expand Down Expand Up @@ -666,7 +667,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
},
);

it("Should sum the awards from SFAS and SFAS part time applications data when there is no past SIMS application for the same student and program year.", async () => {
it("Should sum the awards from SFAS and SFAS part-time applications data when there is no past SIMS application for the same student and program year.", async () => {
// Arrange

// Create the student to be shared across the applications.
Expand All @@ -690,13 +691,13 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
);
const firstAssessmentDate =
currentApplication.currentAssessment.assessmentDate;
// The start date for the first SFAS and SFAS part time application record is set to the date before the first assessment date of the current application.
// The start date for the first SFAS and SFAS part-time application record is set to the date before the first assessment date of the current application.
const firstLegacyApplicationStartDate = faker.date.between(
programYear.startDate,
addDays(-1, firstAssessmentDate),
);
const firstLegacyApplicationEndDate = addDays(30, firstAssessmentDate);
// The start date for the second SFAS and SFAS part time application record is set to the date after the end date of the first SFAS application.
// The start date for the second SFAS and SFAS part-time application record is set to the date after the end date of the first SFAS application.
const secondLegacyApplicationStartDate = faker.date.between(
firstLegacyApplicationEndDate,
addDays(10, firstLegacyApplicationEndDate),
Expand Down Expand Up @@ -762,7 +763,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
firstFakeSFASApplication,
secondFakeSFASApplication,
]);
// First SFAS part time application with the start date before the first assessment date of the current application.
// First SFAS part-time application with the start date before the first assessment date of the current application.
const firstFakeSFASPartTimeApplication = createFakeSFASPartTimeApplication(
{ individual: sfasIndividual },
{
Expand All @@ -777,7 +778,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
},
},
);
// Second SFAS part time application with the start date after the end date of the first SFAS part time application.
// Second SFAS part-time application with the start date after the end date of the first SFAS part-time application.
const secondFakeSFASPartTimeApplication = createFakeSFASPartTimeApplication(
{ individual: sfasIndividual },
{
Expand Down Expand Up @@ -806,7 +807,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
expect(FakeWorkerJobResult.getResultType(result)).toBe(
MockedZeebeJobResult.Complete,
);
// The calculation will only take SFAS and SFAS part time application data where the start date is the date before the first assessment date of the current application.
// The calculation will only take SFAS and SFAS part-time application data where the start date is the date before the first assessment date of the current application.
expect(FakeWorkerJobResult.getOutputVariables(result)).toStrictEqual({
isReadyForCalculation: true,
latestCSLPBalance: 0,
Expand All @@ -824,7 +825,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
});
});

it("Should not return any program year total awards or grants from awards from SFAS and SFAS part time applications when there are no SIMS applications in the past and SFAS and SFAS part time applications for the same student and program year.", async () => {
it("Should not return any program year total awards or grants from awards from SFAS and SFAS part-time applications when there are no SIMS applications in the past and SFAS and SFAS part-time applications for the same student and program year.", async () => {
// Arrange

// Create the student to be shared across the applications.
Expand Down Expand Up @@ -854,7 +855,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
expect(FakeWorkerJobResult.getResultType(result)).toBe(
MockedZeebeJobResult.Complete,
);
// The result will not have data from SFAS or SFAS part time application data.
// The result will not have data from SFAS or SFAS part-time application data.
expect(FakeWorkerJobResult.getOutputVariables(result)).toStrictEqual({
isReadyForCalculation: true,
latestCSLPBalance: 0,
Expand Down Expand Up @@ -918,7 +919,7 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
expect(FakeWorkerJobResult.getResultType(result)).toBe(
MockedZeebeJobResult.Complete,
);
// The result will not have data from SFAS or SFAS part time application data.
// The result will not have data from SFAS or SFAS part-time application data.
expect(FakeWorkerJobResult.getOutputVariables(result)).toStrictEqual({
isReadyForCalculation: true,
latestCSLPBalance: 1000,
Expand Down Expand Up @@ -969,9 +970,133 @@ describe("AssessmentController(e2e)-verifyAssessmentCalculationOrder", () => {
expect(FakeWorkerJobResult.getResultType(result)).toBe(
MockedZeebeJobResult.Complete,
);
// The result will not have data from SFAS or SFAS part time application data.
// The result will not have data from SFAS or SFAS part-time application data.
expect(FakeWorkerJobResult.getOutputVariables(result)).toStrictEqual({
isReadyForCalculation: true,
// Student contribution total.
programYearTotalFederalFSC: 0,
programYearTotalProvincialFSC: 0,
programYearTotalScholarshipsBursaries: 0,
programYearTotalSpouseContributionWeeks: 0,
});
});

it("Should sum the contributions from past applications with full-time offering intensities when the applications are for the same student and program year and the student submits a full-time application.", async () => {
// Arrange

// Create the student and program year to be shared across the applications.
const student = await saveFakeStudent(db.dataSource);
// Get the program year for the start date.
const programYear = await db.programYear.findOne({ where: { id: 2 } });

// Past full-time application with federal and provincial loans and grants.
// Loans will be ignored.
await saveFakeApplicationDisbursements(
db.dataSource,
{
student,
firstDisbursementValues: [
createFakeDisbursementValue(
DisbursementValueType.CanadaLoan,
"CSLF",
1,
),
],
},
{
offeringIntensity: OfferingIntensity.fullTime,
applicationStatus: ApplicationStatus.Completed,
currentAssessmentInitialValues: {
studentAssessmentStatus: StudentAssessmentStatus.Completed,
assessmentDate: addDays(10, programYear.startDate),
workflowData: {
calculatedData: {
studentSpouseContributionWeeks: 1000,
exemptScholarshipsBursaries: 2000,
totalFederalFSC: 3000,
totalProvincialFSC: 4000,
},
} as WorkflowData,
},
},
);
// Past full-time application with federal and provincial loans and grants.
// Loans will be ignored.
await saveFakeApplicationDisbursements(
db.dataSource,
{
student,
firstDisbursementValues: [
createFakeDisbursementValue(
DisbursementValueType.CanadaLoan,
"CSLF",
8,
),
],
},
{
offeringIntensity: OfferingIntensity.fullTime,
applicationStatus: ApplicationStatus.Completed,
currentAssessmentInitialValues: {
studentAssessmentStatus: StudentAssessmentStatus.Completed,
assessmentDate: addDays(20, programYear.startDate),
workflowData: {
calculatedData: {
studentSpouseContributionWeeks: 1000,
exemptScholarshipsBursaries: 2000,
totalFederalFSC: 3000,
totalProvincialFSC: 4000,
},
} as WorkflowData,
},
},
);
// Current application having the first assessment already processed.
const currentApplication = await saveFakeApplicationDisbursements(
db.dataSource,
{ student },
{
offeringIntensity: OfferingIntensity.fullTime,
applicationStatus: ApplicationStatus.InProgress,
currentAssessmentInitialValues: {
studentAssessmentStatus: StudentAssessmentStatus.Completed,
assessmentDate: addDays(30, programYear.startDate),
},
},
);
const secondAssessment = createFakeStudentAssessment(
{
auditUser: currentApplication.student.user,
application: currentApplication,
offering: currentApplication.currentAssessment.offering,
},
{
initialValue: {
studentAssessmentStatus: StudentAssessmentStatus.InProgress,
},
},
);
currentApplication.currentAssessment = secondAssessment;
await db.application.save(currentApplication);

// Act
const result = await assessmentController.verifyAssessmentCalculationOrder(
createFakeVerifyAssessmentCalculationOrderPayload(
currentApplication.currentAssessment.id,
),
);
// Assert
expect(FakeWorkerJobResult.getResultType(result)).toBe(
MockedZeebeJobResult.Complete,
);
// The calculation will only take full-time and part-time application data where the start date is the date before the first assessment date of the current application.
expect(FakeWorkerJobResult.getOutputVariables(result)).toStrictEqual({
isReadyForCalculation: true,
// Student contribution total.
programYearTotalFederalFSC: 6000,
programYearTotalProvincialFSC: 8000,
programYearTotalScholarshipsBursaries: 4000,
programYearTotalSpouseContributionWeeks: 2000,
});
});
});
40 changes: 27 additions & 13 deletions sources/packages/backend/apps/workers/src/controllers/assessment/assessment.controller.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import { CustomNamedError } from "@sims/utilities";
import { MaxJobsToActivate } from "../../types";
import {
AssessmentSequentialProcessingService,
AwardTotal,
ProgramYearTotal,
SystemUsersService,
WorkflowClientService,
} from "@sims/services";
Expand Down Expand Up @@ -420,15 +420,18 @@ export class AssessmentController {
this.studentAssessmentService.saveAssessmentCalculationStartDate(
assessmentId,
);
const getProgramYearTotalAwards =
this.assessmentSequentialProcessingService.getProgramYearPreviousAwardsTotals(
const programYearTotals =
await this.assessmentSequentialProcessingService.getProgramYearTotals(
assessmentId,
{ alternativeReferenceDate: new Date() },
{
alternativeReferenceDate: new Date(),
},
);
// Updates the calculation start date and get the program year totals in parallel.
const [, programYearTotalAwards] = await Promise.all([
// Updates the calculation start date and get the program year totals and for
// full-time the contribution program year totals in parallel.
const [programYearAwardsContributionTotals] = await Promise.all([
programYearTotals,
saveAssessmentCalculationStartDate,
getProgramYearTotalAwards,
]);
if (
assessment.offering.offeringIntensity === OfferingIntensity.partTime
Expand All @@ -442,7 +445,10 @@ export class AssessmentController {
jobLogger.log(
`The assessment calculation order has been verified and the assessment id ${assessmentId} is ready to be processed.`,
);
this.createOutputForProgramYearTotals(programYearTotalAwards, result);
this.createOutputForProgramYearTotals(
programYearAwardsContributionTotals,
result,
);
result.isReadyForCalculation = true;
return job.complete(result);
}
Expand All @@ -458,30 +464,38 @@ export class AssessmentController {
}

/**
* Create a new dynamic output variable for each award and offering intensity.
* Create a new dynamic output variable for each award and offering intensity for both part-time and full-time.
* Create a new dynamic output variable for each contribution for full-time.
* Each variable is prefixed with 'programYearTotal' and then concatenated
* with the offering intensity as 'FullTime'/'PartTime' and the award code.
* @example
* programYearTotalFullTimeBCAG: 1250
* programYearTotalPartTimeBCAG: 3450
* @param programYearTotalAwards awards to be added to the output.
* @param ProgramYearTotal awards and contributions to be added to the output.
* @param output output to receive the dynamic property.
*/
private createOutputForProgramYearTotals(
programYearTotalAwards: AwardTotal[],
programYearTotal: ProgramYearTotal,
output: VerifyAssessmentCalculationOrderJobOutDTO,
): void {
const PROGRAM_YEAR_TOTAL = "programYearTotal";
// Create the dynamic variables to be outputted.
programYearTotalAwards.forEach((award) => {
programYearTotal.awardTotals.forEach((award) => {
const intensity =
award.offeringIntensity === OfferingIntensity.fullTime
? "FullTime"
: "PartTime";
const outputName = `programYearTotal${intensity}${award.valueCode}`;
const outputName = `${PROGRAM_YEAR_TOTAL}${intensity}${award.valueCode}`;
output[outputName] = output[outputName]
? output[outputName] + award.total
: award.total;
});
programYearTotal.contributionTotals?.forEach((contributionTotal) => {
const outputName = `${PROGRAM_YEAR_TOTAL}${contributionTotal.contribution}`;
output[outputName] = output[outputName]
? output[outputName] + contributionTotal.total
: contributionTotal.total;
});
}

/**
Expand Down
17 changes: 17 additions & 0 deletions ...libs/services/src/students-assessments/assessment-sequential-processing.service.models.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,20 @@ export interface AwardTotal {
valueCode: string;
total: number;
}

/**
* Program year totals with award code (e.g. CSPT, CSGD, CSGP, SBSD, BCAG) and its totals
* and for full-time program year contribution (e.g. ScholarshipsBursaries, SpouseContributionWeeks, FederalFSC, ProvincialFSC) and its totals.
*/
export interface ProgramYearTotal {
awardTotals: AwardTotal[];
contributionTotals?: ProgramYearContributionTotal[];
}

/**
* Full-time program year contribution and its totals.
*/
export interface ProgramYearContributionTotal {
contribution: string;
total: number;
}
Loading

0 comments on commit ca835ac

Please sign in to comment.