#2001 - Changes to handle PD PPD Part 1 #2115

dheepak-aot · 2023-07-14T20:26:13Z

System changes to handle PD PPD

Created DB migration to add new type permanent_disability_status and add column pd_status to student table. Updated the entity model and created enum PDStatus.
Updated SIMS API, and Vue with PDStatus enum. (By doing this, the PD status field is handled on both student profile and student application)

Student Profile:

Student Application:

The existing pd_verified column is kept as is to avoid workflow changes as per the story.
Student profile form definition updated to check for value Not requested instead of Not Requested to display the Apply for PD Status button
When "apply to PD status" is not allowed due to SIN validation is not complete or already applied for PD status, code changes are made to display the appropriate error message to the toast.

To be done in upcoming PR

Read the PD response from ATBC and update the pd status. Remove/Refactor the existing code.
Remove refactor existing code
E2E Tests

andrewsignori-aot · 2023-07-14T22:35:19Z

sources/packages/backend/apps/db-migrations/src/sql/Student/Add-col-pd-status.sql

+ALTER TABLE
+    sims.students
+ADD
+    COLUMN IF NOT EXISTS pd_status sims.permanent_disability_status;


I hope that it will not open a can of worms about naming possibilities 😉
I believe that the acronyms for PD/PPD mean

PPD: Persistent or Prolonged Disability

PD: Permanent Disability
With the above in mind I believe that instead of permanent_disability_status it should be only disability_status.

As per discussion with the dev team, we decided to use disability status instead of permanent disability status and try to change the existing code as much as possible.

andrewsignori-aot · 2023-07-14T22:37:17Z

sources/packages/backend/apps/api/src/constants/error-code.constants.ts

@@ -122,3 +122,8 @@ export const DUPLICATE_SABC_CODE = "DUPLICATE_SABC_CODE";
 * Institution location not valid.
 */
 export const INSTITUTION_LOCATION_NOT_VALID = "INSTITUTION_LOCATION_NOT_VALID";
+
+/**
+ * Request for permanent disability not allowed.


The requests are no longer specifically for permanent disability.

andrewsignori-aot · 2023-07-14T22:49:34Z

sources/packages/backend/apps/api/src/route-controllers/atbc/atbc.students.controller.ts

    ) {
      throw new UnprocessableEntityException(
-        "Either the client does not have a validated SIN or the request was already sent to ATBC.",
+        new ApiProcessError(


andrewsignori-aot · 2023-07-14T22:50:28Z

sources/packages/backend/apps/api/src/route-controllers/atbc/atbc.students.controller.ts

    ) {
      throw new UnprocessableEntityException(
-        "Either the client does not have a validated SIN or the request was already sent to ATBC.",
+        new ApiProcessError(
+          "Either SIN validation is not complete or requested for PD already.",


I believe that we can have it adjusted to PD/PPD for now.

andrewsignori-aot · 2023-07-14T22:53:21Z

sources/packages/backend/libs/sims-db/src/entities/student-pd-status.type.ts

@@ -0,0 +1,10 @@
+/**
+ * Permanent disability status of student.


Everything is SIMS used to be named using PD as permanent disability which is no longer true with the inclusion of PPD.
I would say that we need to reinforce it for the new things and try to adjust the current ones as possible.
As a suggestion, I would remove the "Permanent" from the comment and name the below enum as DisabilityStatus.

andrewsignori-aot · 2023-07-14T22:54:59Z

sources/packages/web/src/views/student/StudentProfileEdit.vue

        snackBar.error(
-          "An error happened during the apply PD process. Please try after sometime.",
+          "Unexpected error while applying for PD. Please try after sometime.",


Can we change PD to PD/PPD?

sources/packages/backend/apps/api/src/route-controllers/atbc/atbc.students.controller.ts

ann-aot · 2023-07-17T18:34:41Z

...ication-offering-change-request.institutions.controller.getCompletedApplications.e2e-spec.ts

@@ -306,7 +306,7 @@ describe("ApplicationOfferingChangeRequestInstitutionsController(e2e)-getComplet

    const searchKeyword = "TestStudent";
    const endpoint = `/institutions/location/${collegeFLocation.id}/application-offering-change-request/completed?page=0&pageLimit=10&searchCriteria=${searchKeyword}`;
-    console.log(endpoint);


sh16011993 · 2023-07-17T18:35:13Z

...te-controllers/student/_tests_/e2e/student.students.controller.getStudentProfile.e2e-spec.ts

@@ -62,7 +62,7 @@ describe("StudentInstitutionsController(e2e)-getStudentProfile", () => {
          },
          phone: student.contactInfo.phone,
        },
-        pdStatus: determinePDStatus(student),
+        pdStatus: student.pdStatus,


ann-aot · 2023-07-17T18:39:10Z

sources/packages/backend/apps/api/src/route-controllers/atbc/atbc.students.controller.ts

-    // studentPDVerified is true if PD confirmed by ATBC or is true from sfas_individual table.
-    // studentPDVerified is false if PD denied by ATBC.
+    // To apply for a PD, SIN validation must be completed for the student and
+    // not applied for PD already.


@dheepak-aot , can you confirm this? In our grooming, I remember saying that the student can apply for PD multiple times, especially for the PPD

Thanks for bring this up.
I had a quick chat with @JasonCTang on the same and got to know that, as per the current understanding, student requests disability status only once in our application. In case they want to apply again because of something happened to them later after losing their status, they update ATBC directly and ATBC will be updating the student disability status which we read on daily basis through their response API.
I will update this information to the ticket.

Let me know if it is still not clear. We can talk.

Thanks @dheepak-aot for the details. Ya, adding it to the ticket will make it easier for future development. Keeping it open for other devs

sources/packages/backend/apps/api/src/route-controllers/atbc/atbc.students.controller.ts

sources/packages/backend/apps/api/src/services/student/student.service.ts

...ges/backend/apps/db-migrations/src/migrations/1689350242512-AddStudentDisabilityStatusCol.ts

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

sources/packages/backend/libs/test-utils/src/factories/student.ts

sources/packages/web/src/services/StudentService.ts

sources/packages/web/src/types/contracts/StudentContract.ts

ann-aot

Added some comments

guru-aot · 2023-07-17T20:58:26Z

sources/packages/backend/apps/db-migrations/src/sql/Student/Add-col-disability-status.sql

+        AND pd_date_sent IS NOT NULL THEN 'Requested'
+        WHEN pd_verified = true THEN 'PD'
+        WHEN pd_verified = false THEN 'Declined'
+        ELSE 'Not requested' :: sims.disability_status


I get this update is written for the existing data in Test, but is there a chance that any PDs can be PPDs? are we considering any update in the existing data update from ATBC?

There is no PPD in our system so far so we cannot do anything in the query about it.

If a student is PPD, ATBC response will be read and updated in our system.

guru-aot · 2023-07-17T21:15:46Z

sources/packages/backend/libs/integrations/src/services/student/student.service.ts

+    auditUser: User,
+  ): Promise<UpdateResult> {
+    const now = new Date();
+    return this.repo.update(


sh16011993

LGTM @dheepak-aot 👍

ann-aot · 2023-07-17T23:41:37Z

sources/packages/web/src/services/http/dto/Student.dto.ts

@@ -15,6 +15,8 @@ export class CreateStudentAPIInDTO extends AddressDetailsFormAPIDTO {
  sinNumber: string;
  @Expose()
  gender: string;
+  @Expose()
+  sinConsent: boolean;


ann-aot

Nice work @dheepak-aot. thanks for doing the changes, wava fix as well as the label changes 👍

github-actions · 2023-07-18T00:20:08Z

Backend Unit Tests Coverage Report

Totals
Statements:	17.86% ( 2129 / 11922 )
Methods:	8.3% ( 126 / 1518 )
Lines:	20.64% ( 1865 / 9034 )
Branches:	10.07% ( 138 / 1370 )

sonarqubecloud · 2023-07-18T00:20:19Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

github-actions · 2023-07-18T00:21:01Z

E2E Workflow Workers Coverage Report

Totals
Statements:	49.81% ( 267 / 536 )
Methods:	41.56% ( 32 / 77 )
Lines:	55.33% ( 218 / 394 )
Branches:	26.15% ( 17 / 65 )

github-actions · 2023-07-18T00:21:26Z

E2E Queue Consumers Coverage Report

Totals
Statements:	71% ( 399 / 562 )
Methods:	61.97% ( 44 / 71 )
Lines:	72.97% ( 351 / 481 )
Branches:	40% ( 4 / 10 )

github-actions · 2023-07-18T00:27:03Z

E2E SIMS API Coverage Report

Totals
Statements:	49.76% ( 3536 / 7106 )
Methods:	45.06% ( 415 / 921 )
Lines:	54.97% ( 2914 / 5301 )
Branches:	23.42% ( 207 / 884 )

guru-aot

LGTM, Nice work @dheepak-aot

dheepak-aot added 2 commits July 14, 2023 13:11

Enable system to have PD and PPD

eb9ff85

PD status enhancement

aab3384

dheepak-aot self-assigned this Jul 14, 2023

dheepak-aot added SIMS-Api SIMS-Api Web Portal Form.io Form IO definitions changed. DB DB migration involved labels Jul 14, 2023

dheepak-aot added 2 commits July 14, 2023 14:40

Enable system to have PD and PPD

4ac4553

Request for PD updates

fa0f438

dheepak-aot requested review from ann-aot, guru-aot, sh16011993, andrewsignori-aot and JasonCTang July 14, 2023 22:24

form defintion

769ef00

andrewsignori-aot reviewed Jul 14, 2023

View reviewed changes

sh16011993 reviewed Jul 17, 2023

View reviewed changes

sources/packages/backend/apps/api/src/route-controllers/atbc/atbc.students.controller.ts Outdated Show resolved Hide resolved

renaming to disability status

4639583