#1761 - Handling full time BCSL lifetime and federal maximums #1886

ann-aot · 2023-04-13T00:54:10Z

Added LIfetime maximum logic to e-cert generation during calculateEffectiveValue calculation.
When the maximum is hit, the BCLM restriction is added to the student.
Total BCSL disbursement amount from legacy is processed from sfasApplication table with sin, birthdate, and last name. ( IF the student has a temporary SIN in SFAS and a permanent SIN in SIMS, we expect to miss the details from SFAS.)
Moved certain restriction-related methods to shared services like createRestrictionToSave, getRestrictionByCode.

andrewsignori-aot · 2023-04-17T23:36:28Z

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts

+        application.programYear.maxLifetimeBCLoanAmount;
+      const auditUser = await this.systemUsersService.systemUser();
+
+      const totalLifeTimeAmount =


Please take a look at the getOverawardBalance. The idea for the e-Cert is that we can execute the methods in bulk and process the result in memory. Is the current way, unless I am missing something, for every single e-cert record there will be other 2 queries executed to get the sum from SIMS + SFAS.

As we discussed, keeping it as it is. As we will be changing the implementation in the future ticket

andrewsignori-aot · 2023-04-18T16:25:45Z

sources/packages/backend/apps/workers/src/controllers/disbursement/disbursement.controller.ts

@@ -8,7 +8,7 @@ import {
 } from "zeebe-node";
 // TODO: In the upcoming tasks, either DisbursementScheduleService will be renamed at shared library
 // or MSFAA related methods will move to shared library.
-import { DisbursementScheduleService as DisbursementScheduleSharedService } from "@sims/services";
+import { DisbursementScheduleSharedService } from "@sims/services";


Thanks for doing the refactor 👍

andrewsignori-aot · 2023-04-18T18:16:40Z

sources/packages/backend/libs/services/src/restriction/model/restriction.model.ts

@@ -28,4 +28,10 @@ export enum RestrictionCode {
   * this restriction is applied case the SIN expiry date is before the offering end date.
   */
  SINF = "SINF",
+  /**
+   * BCSL Lifetime Maximum is the student's cumulative full-time BCSL awards received over
+   * a lifetime. Thus restriction is added to a student when they reach BC lifetime maximum


Was the intention to use "Thus" here or is it supposed to be "This"?

andrewsignori-aot · 2023-04-18T20:17:39Z

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts

@@ -192,14 +200,30 @@ export class ECertGenerationService {
        END`,
        "stopFullTimeBCFunding",
      )
+      .addSelect(


Is it not the case of, instead of having 2 subqueries, we start to bring all active restrictions and do the verifications on the in-memory list, which in this case will be "all active restrictions that can impact disbursement"?
I am assuming also the possibles StopFullTimeDisbursement and StopPartTimeDisbursement will be already excluded by the where condition at line 244, since these records will not even be selected.

get the whole list and assign the latest restriction to the bc grants and loans when needed. I can give it a try

#1886 (comment) but I have added

andrewsignori-aot · 2023-04-18T20:29:23Z

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts

+        const newEffectiveAmount =
+          disbursementValue.effectiveAmount - amountSubtracted;
+        /**
+         * Create {@link RestrictionCode.BCLM} restriction when lifetime maximum is reached/exceeded.


I like the Create {@link RestrictionCode.BCLM} and I would support its usage in the methods comments.
At this level, I believe that it leaves the code less readable, also because you need the comment to be placed with /***/.

andrewsignori-aot · 2023-04-18T20:42:57Z

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts

+            application.id,
+          );
+
+        if (bclmRestriction) {


Edge case but a possible scenario.
Depending on certain circumstances we may be processing at the same time 2 disbursements for the same students, for instance, assuming that we have two applications as below.

Application A: Jan, 1st - April, 30th
Application B: May, 1st - July, 31st.
Wonder that Application A can be reassessed near the offering end date on April, 30th and it may be having the e-Cert generated on May, 1st, which will lead both to be part of the same e-Cert file.

The e-Cert SQL query will get both records where no BCSL restriction will be in place, but then the first one will be adding the BCSL restriction and the second one must be aware of it to stop the BC funding.

When we have 2 records for the same student, we may need to have a way to refresh the restrictions in a way that the second disbursement will not have the BC fundings disbursed.

mm, That is a good edge case, are we managing the similar scenario overwards.? ya we need to find a way

@dheepak-aot @guru-aot @andrepestana-aot @sh16011993 I and @andrewsignori-aot were discussing this and for the PR I am planning to add a directory that will be updated when a student gets a restriction for the first time, and as this directory as the reference the next disbursement of the same student will execute restriction logic. feel free to add your points

As discussed we will handle this in a separate ticket

Lets handle it in a separate ticket, can we add a TODO here?

andrewsignori-aot · 2023-04-18T20:48:03Z

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts

+          .filter((disbursementValue) => {
+            if (
+              disbursementValue.valueType === DisbursementValueType.BCGrant &&
+              disbursementValue.restrictionAmountSubtracted !== null


Why do we need additional checks here? The idea of this method was to be concerned only about doing the SUM of the BC Grants if there is a value to be ignored it probably must be set to zero before this calculation happen.

Here Iam trying to avoid the happy path disbursements, which doesn't have a restrictionAmountSubtracted, so, these disbursements will not make up to the lifetime maximum calculations. are you saying to make the default for all restrictionAmountSubtracted as zero in the db level?

removed the logic got total bc grant

andrewsignori-aot · 2023-04-18T20:52:23Z

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts

@@ -332,8 +439,35 @@ export class ECertGenerationService {
        .reduce((previousValue, currentValue) => {
          return previousValue + currentValue.effectiveAmount;
        }, 0);
+      // Calculate total BC grants subtracted due to restriction.


Is it not supposed to be taken care of during the effective value calculation?

I added it here because the total bc grant itself is created at this stage, after the effective calculation

#1886 (comment)

andrewsignori-aot · 2023-04-18T21:27:17Z

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts

@@ -419,7 +553,7 @@ export class ECertGenerationService {
   * @param disbursementValue award to be checked.
   * @returns true if the funding should not be disbursed, otherwise, false.
   */
-  private shouldStopFunding(
+  private shouldStopFullTimeBCFunding(


I got the point about changing this method's name but it actually needs to be adapted to support both part-time/full-time. Maybe keeping the name, adjusting the comments, and adding a todo would be better.
We need a separate ticket or maybe review the e-Cert query to have part-time also considered.

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts

sources/packages/backend/libs/services/src/sfas/sfas-application.service.ts

sources/packages/backend/libs/services/src/restriction/restriction-shared.service.ts

...ages/backend/libs/services/src/disbursement-schedule/disbursement-schedule-shared.service.ts

dheepak-aot · 2023-04-18T23:12:20Z

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts

    for (const disbursement of disbursements) {
      for (const disbursementValue of disbursement.disbursementValues) {
-        if (this.shouldStopFunding(disbursement, disbursementValue)) {
+        if (this.shouldStopFullTimeBCFunding(disbursement, disbursementValue)) {


I saw this point in the story and confused why this was added as I was assuming stop disbursement means the whole e-cert generation process does not happen for disbursements if student has stop disbursement restriction.

@dheepak-aot that is not part of the PR, The first 2 order is already implemented in our system, this PR is implementing the 3rd order and some changes in the 2nd order. That point for just to make sure we follow the order

As discussed, can slightly add context to first point in the story like it is already happening in ecert disbursements selection criteria.

Updated the story, as discussed

dheepak-aot · 2023-04-18T23:17:05Z

Great to see the BCSL life time maximum coming up @ann-aot . Add some comments.

guru-aot

LGTM, nice work @ann-aot

andrewsignori-aot · 2023-04-20T16:31:28Z

sources/packages/backend/libs/services/src/sfas/sfas-application.service.ts

+   * @param studentId student id.
+   * @returns total BCSL amount that the student received from the legacy(sfas) system.
+   */
+  async totalLegacyBCSLAmount(studentId: number): Promise<number> {


As part of the upcoming ticket, we can also discuss the possibility of stopping doing the calculation every time and maybe have the SUM for the students consolidated in some other table on SIMS.

sources/packages/backend/libs/sims-db/src/entities/student.model.ts

sonarqubecloud · 2023-04-20T20:11:50Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

No Coverage information
0.0% Duplication

github-actions · 2023-04-20T20:12:19Z

Backend Unit Tests Coverage Report

Totals
Statements:	17.93% ( 1968 / 10975 )
Methods:	8.08% ( 115 / 1424 )
Lines:	20.65% ( 1724 / 8350 )
Branches:	10.74% ( 129 / 1201 )

github-actions · 2023-04-20T20:13:35Z

E2E Queue Consumers Coverage Report

Totals
Statements:	65.01% ( 353 / 543 )
Methods:	53.62% ( 37 / 69 )
Lines:	67.24% ( 312 / 464 )
Branches:	40% ( 4 / 10 )

github-actions · 2023-04-20T20:13:54Z

E2E Workflow Workers Coverage Report

Totals
Statements:	32.41% ( 176 / 543 )
Methods:	21.25% ( 17 / 80 )
Lines:	39.25% ( 157 / 400 )
Branches:	3.17% ( 2 / 63 )

github-actions · 2023-04-20T20:18:35Z

E2E SIMS API Coverage Report

Totals
Statements:	38.94% ( 2634 / 6765 )
Methods:	30.91% ( 272 / 880 )
Lines:	44.4% ( 2240 / 5045 )
Branches:	14.52% ( 122 / 840 )

dheepak-aot

Thanks for doing the changes and creating new ticket for the new way of processing disbursements. LGTM. 👍

andrewsignori-aot

Thanks for doing the changes, looks good 👍

andrepestana-aot

LGTM.

ann-aot added 3 commits April 11, 2023 16:45

inital commit

4bd5101

refactor

cb2fca1

initial commit

b4a1403

ann-aot self-assigned this Apr 13, 2023

ann-aot added 3 commits April 13, 2023 19:10

comments

98c9e20

Merge branch 'main' into feature/sims-#1761/part-1

34fa7ec

grants calculation after restrcition

81905f3

ann-aot added User Story Task SIMS-Api SIMS-Api Queue Consumers labels Apr 14, 2023

ann-aot added 3 commits April 14, 2023 20:44

refactor

c13a004

refactor

c662b3d

refactor

3f9164f

ann-aot requested review from andrewsignori-aot, andrepestana-aot, sh16011993, dheepak-aot, guru-aot and JasonCTang April 17, 2023 21:59

ann-aot marked this pull request as ready for review April 17, 2023 22:00

andrewsignori-aot reviewed Apr 17, 2023

View reviewed changes

andrewsignori-aot reviewed Apr 18, 2023

View reviewed changes

dheepak-aot reviewed Apr 18, 2023

View reviewed changes

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts Show resolved Hide resolved

dheepak-aot reviewed Apr 18, 2023

View reviewed changes

sources/packages/backend/libs/services/src/sfas/sfas-application.service.ts Outdated Show resolved Hide resolved

dheepak-aot reviewed Apr 18, 2023

View reviewed changes

sources/packages/backend/libs/services/src/sfas/sfas-application.service.ts Outdated Show resolved Hide resolved

dheepak-aot reviewed Apr 18, 2023

View reviewed changes

sources/packages/backend/libs/services/src/restriction/restriction-shared.service.ts Show resolved Hide resolved

dheepak-aot reviewed Apr 18, 2023

View reviewed changes

...ages/backend/libs/services/src/disbursement-schedule/disbursement-schedule-shared.service.ts Outdated Show resolved Hide resolved

dheepak-aot reviewed Apr 18, 2023

View reviewed changes

ann-aot removed User Story Task labels Apr 18, 2023

feedback

b91d3e9

guru-aot approved these changes Apr 20, 2023

View reviewed changes

ann-aot mentioned this pull request Apr 20, 2023

Analysis to Change E-cert Implementation for Individual Student Processing #1894

Closed

andrewsignori-aot reviewed Apr 20, 2023

View reviewed changes

sources/packages/backend/libs/sims-db/src/entities/student.model.ts Outdated Show resolved Hide resolved

ann-aot added 2 commits April 20, 2023 16:04

test and refactors

40e7a4c

Merge branch 'main' into feature/sims-#1761/part-1

755757e

dheepak-aot approved these changes Apr 20, 2023

View reviewed changes

andrewsignori-aot approved these changes Apr 20, 2023

View reviewed changes

andrepestana-aot approved these changes Apr 20, 2023

View reviewed changes

ann-aot merged commit d8c1e3d into main Apr 20, 2023

ann-aot temporarily deployed to DEV April 20, 2023 21:11 — with GitHub Actions Inactive

ann-aot temporarily deployed to DEV April 20, 2023 21:20 — with GitHub Actions Inactive

ann-aot deleted the feature/sims-#1761/part-1 branch April 20, 2023 21:33

andrewsignori-aot mentioned this pull request Nov 15, 2023

e-Cert Implementation for Individual Student Processing #2510

Closed

14 tasks

#1761 - Handling full time BCSL lifetime and federal maximums #1886

#1761 - Handling full time BCSL lifetime and federal maximums #1886

Conversation

ann-aot commented Apr 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ann-aot Apr 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ann-aot Apr 18, 2023 • edited Loading

Choose a reason for hiding this comment

ann-aot Apr 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ann-aot Apr 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ann-aot Apr 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dheepak-aot Apr 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ann-aot Apr 20, 2023 • edited Loading

Choose a reason for hiding this comment

dheepak-aot commented Apr 18, 2023

guru-aot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Apr 20, 2023

github-actions bot commented Apr 20, 2023

Backend Unit Tests Coverage Report

github-actions bot commented Apr 20, 2023

E2E Queue Consumers Coverage Report

github-actions bot commented Apr 20, 2023

E2E Workflow Workers Coverage Report

github-actions bot commented Apr 20, 2023

E2E SIMS API Coverage Report

dheepak-aot left a comment

Choose a reason for hiding this comment

andrewsignori-aot left a comment

Choose a reason for hiding this comment

andrepestana-aot left a comment

Choose a reason for hiding this comment

ann-aot commented Apr 13, 2023 •

edited

Loading

ann-aot Apr 18, 2023 •

edited

Loading

ann-aot Apr 18, 2023 •

edited

Loading

ann-aot Apr 18, 2023 •

edited

Loading

ann-aot Apr 18, 2023 •

edited

Loading

ann-aot Apr 18, 2023 •

edited

Loading

dheepak-aot Apr 18, 2023 •

edited

Loading

ann-aot Apr 20, 2023 •

edited

Loading