#5594 - Analysis: new unified data path for appeals and forms + non punitive (DB migrations)

sims.code-workspace

@@ -2,32 +2,32 @@
   "folders": [
     {
       "name": "Web UI",
-      "path": "./sources/packages/web"
+      "path": "./sources/packages/web",
     },
     {
       "name": "Backend",
-      "path": "./sources/packages/backend"
+      "path": "./sources/packages/backend",
     },
     {
       "name": "Forms",
-      "path": "./sources/packages/forms"
+      "path": "./sources/packages/forms",
     },
     {
       "name": "DevOps",
-      "path": "./devops"
+      "path": "./devops",
     },
     {
       "name": "Load Tests",
-      "path": "./sources/packages/load-test"
+      "path": "./sources/packages/load-test",
     },
     {
       "name": "Sources",
-      "path": "./sources"
+      "path": "./sources",
     },
     {
       "name": "All",
-      "path": "."
-    }
+      "path": ".",
+    },
   ],
   "extensions": {
     "recommendations": [
@@ -40,8 +40,8 @@
       "adpyke.vscode-sql-formatter",
       "redhat.vscode-yaml",
       "mongodb.mongodb-vscode",
-      "sonarsource.sonarlint-vscode"
-    ]
+      "sonarsource.sonarlint-vscode",
+    ],
   },
   "tasks": {
     "version": "2.0.0",
@@ -51,91 +51,91 @@
         "type": "shell",
         "command": "make deploy-camunda-definitions",
         "options": {
-          "cwd": "${workspaceFolder:Sources}"
+          "cwd": "${workspaceFolder:Sources}",
         },
-        "problemMatcher": []
+        "problemMatcher": [],
       },
       {
         "label": "Deploy Form Definitions",
         "type": "shell",
         "command": "make deploy-form-definitions",
         "options": {
-          "cwd": "${workspaceFolder:Sources}"
+          "cwd": "${workspaceFolder:Sources}",
         },
-        "problemMatcher": []
+        "problemMatcher": [],
       },
       {
         "label": "Database - Run Migrations",
         "type": "shell",
         "command": "npm run migration:run",
         "options": {
-          "cwd": "${workspaceFolder:Backend}"
+          "cwd": "${workspaceFolder:Backend}",
         },
-        "problemMatcher": []
+        "problemMatcher": [],
       },
       {
         "label": "Database - Clean E2E Test DB",
         "type": "shell",
         "command": "npm run db:seed:test:clean",
         "options": {
-          "cwd": "${workspaceFolder:Backend}"
+          "cwd": "${workspaceFolder:Backend}",
         },
-        "problemMatcher": []
+        "problemMatcher": [],
       },
       {
         "label": "Database - Reset for API E2E Tests",
         "type": "shell",
         "command": "npm run db:seed:test:clean && npm run test:e2e:api:seed",
         "options": {
-          "cwd": "${workspaceFolder:Backend}"
+          "cwd": "${workspaceFolder:Backend}",
         },
-        "problemMatcher": []
+        "problemMatcher": [],
       },
       {
         "label": "Database - Reset for Queue-consumers E2E Tests",
         "type": "shell",
         "command": "npm run db:seed:test:clean && npm run test:e2e:queue-consumers:seed",
         "options": {
-          "cwd": "${workspaceFolder:Backend}"
+          "cwd": "${workspaceFolder:Backend}",
         },
-        "problemMatcher": []
+        "problemMatcher": [],
       },
       {
         "label": "View Outdated Web Packages",
         "type": "shell",
         "command": "npm outdated",
         "options": {
-          "cwd": "${workspaceFolder:Web UI}"
+          "cwd": "${workspaceFolder:Web UI}",
         },
-        "problemMatcher": []
+        "problemMatcher": [],
       },
       {
         "label": "View Outdated Backend Packages",
         "type": "shell",
         "command": "npm outdated",
         "options": {
-          "cwd": "${workspaceFolder:Backend}"
+          "cwd": "${workspaceFolder:Backend}",
         },
-        "problemMatcher": []
+        "problemMatcher": [],
       },
       {
         "label": "View Outdated Forms Packages",
         "type": "shell",
         "command": "npm outdated",
         "options": {
-          "cwd": "${workspaceFolder:Forms}"
+          "cwd": "${workspaceFolder:Forms}",
         },
-        "problemMatcher": []
-      }
-    ]
+        "problemMatcher": [],
+      },
+    ],
   },
   "settings": {
     "eslint.workingDirectories": [{ "mode": "auto" }],
     "search.exclude": {
       "**/bin": true,
       "**/obj": true,
       "**/dist": true,
-      "**/node_modules": true
+      "**/node_modules": true,
     },
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true,
@@ -145,8 +145,8 @@
       "editor.codeActionsOnSave": {
         "source.addMissingImports": "explicit",
         "source.fixAll.eslint": "explicit",
-        "source.removeUnusedImports": "always"
-      }
+        "source.removeUnusedImports": "always",
+      },
     },
     "typescript.preferences.importModuleSpecifier": "non-relative",
     "cSpell.words": [
@@ -200,6 +200,7 @@
       "MSFAA",
       "MULT",
       "NOAAPI",
+      "nonpunitivewithdrawalform",
       "NSLSC",
       "Overaward",
       "overawards",
@@ -238,14 +239,14 @@
       "unparse",
       "VALD",
       "WTHD",
-      "Zeebe"
+      "Zeebe",
     ],
     "[json]": {
-      "editor.defaultFormatter": "vscode.json-language-features"
+      "editor.defaultFormatter": "vscode.json-language-features",
     },
     "[sql]": {
-      "editor.defaultFormatter": "adpyke.vscode-sql-formatter"
+      "editor.defaultFormatter": "adpyke.vscode-sql-formatter",
     },
-    "sql-formatter.uppercase": true
-  }
+    "sql-formatter.uppercase": true,
+  },
 }

sources/packages/backend/apps/api/src/app.aest.module.ts

@@ -42,6 +42,7 @@ import {
   StudentAppealAssessmentService,
   StudentAppealCreateAssessmentAction,
   StudentAppealUpdateModifiedIndependentAction,
+  FormSubmissionService,
 } from "./services";
 import {
   SupportingUserAESTController,
@@ -91,6 +92,7 @@ import {
   ApplicationChangeRequestAESTController,
   DynamicFormAESTController,
   DisbursementScheduleAESTController,
+  FormSubmissionAESTController,
 } from "./route-controllers";
 import { AuthModule } from "./auth/auth.module";
 import {
@@ -147,6 +149,7 @@ import { ECertIntegrationModule } from "@sims/integrations/esdc-integration";
     ApplicationChangeRequestAESTController,
     DynamicFormAESTController,
     DisbursementScheduleAESTController,
+    FormSubmissionAESTController,
   ],
   providers: [
     ApplicationExceptionControllerService,
@@ -226,6 +229,7 @@ import { ECertIntegrationModule } from "@sims/integrations/esdc-integration";
     StudentAppealActionsProcessor,
     StudentAppealCreateAssessmentAction,
     StudentAppealUpdateModifiedIndependentAction,
+    FormSubmissionService,
   ],
 })
 export class AppAESTModule {}

sources/packages/backend/apps/api/src/app.institutions.module.ts

@@ -35,6 +35,7 @@ import {
   SupportingUserService,
   ApplicationRestrictionBypassService,
   InstitutionRestrictionService,
+  FormSubmissionService,
 } from "./services";
 import {
   ApplicationControllerService,
@@ -196,6 +197,7 @@ import { ECertIntegrationModule } from "@sims/integrations/esdc-integration";
     SupportingUserService,
     DisbursementScheduleSharedService,
     InstitutionRestrictionService,
+    FormSubmissionService,
   ],
 })
 export class AppInstitutionsModule {}

sources/packages/backend/apps/api/src/app.students.module.ts

@@ -29,6 +29,7 @@ import {
   AnnouncementService,
   ApplicationRestrictionBypassService,
   InstitutionRestrictionService,
+  FormSubmissionService,
 } from "./services";
 import {
   ApplicationStudentsController,
@@ -79,6 +80,7 @@ import {
 import { ATBCIntegrationModule } from "@sims/integrations/atbc-integration";
 import { ECertIntegrationModule } from "@sims/integrations/esdc-integration";
 import { ObjectStorageModule } from "@sims/integrations/object-storage";
+import { FormSubmissionStudentsController } from "apps/api/src/route-controllers/form-submission/form-submission.students.controller";
 
 @Module({
   imports: [
@@ -104,6 +106,7 @@ import { ObjectStorageModule } from "@sims/integrations/object-storage";
     ScholasticStandingStudentsController,
     AnnouncementStudentsController,
     SupportingUserStudentsController,
+    FormSubmissionStudentsController,
   ],
   providers: [
     AnnouncementService,
@@ -158,6 +161,7 @@ import { ObjectStorageModule } from "@sims/integrations/object-storage";
     SupportingUserControllerService,
     DisbursementScheduleSharedService,
     InstitutionRestrictionService,
+    FormSubmissionService,
   ],
 })
 export class AppStudentsModule {}

sources/packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

@@ -23,6 +23,7 @@ import {
   MASKED_MSFAA_NUMBER,
   ApplicationOfferingChangeRequestService,
   MASKED_MONEY_AMOUNT,
+  FormSubmissionService,
 } from "../../services";
 import {
   AssessmentNOAAPIOutDTO,
@@ -72,6 +73,7 @@ export class AssessmentControllerService {
     private readonly educationProgramOfferingService: EducationProgramOfferingService,
     private readonly applicationExceptionService: ApplicationExceptionService,
     private readonly applicationOfferingChangeRequestService: ApplicationOfferingChangeRequestService,
+    private readonly formSubmissionService: FormSubmissionService,
   ) {}
 
   /**
@@ -573,10 +575,18 @@ export class AssessmentControllerService {
         }));
       return requestAssessmentSummary.concat(applicationExceptionArray);
     }
-    const appeals = await this.getPendingAndDeniedAppeals(
-      applicationId,
-      options?.studentId,
-    );
+    // Get application appeals requests.
+    const nonCompletedAppeals =
+      await this.formSubmissionService.getNonCompletedAppealsSubmissions(
+        applicationId,
+      );
+    const appealsRequests = nonCompletedAppeals.map((appeal) => ({
+      id: appeal.id,
+      submittedDate: appeal.submittedDate,
+      status: appeal.submissionStatus,
+      requestType: RequestAssessmentTypeAPIOutDTO.StudentAppeal,
+    }));
+
     const applicationOfferingChangeRequests =
       await this.getApplicationOfferingChangeRequestsByStatus(
         applicationId,
@@ -588,8 +598,9 @@ export class AssessmentControllerService {
         ],
         { studentId: options?.studentId },
       );
+
     return requestAssessmentSummary
-      .concat(appeals)
+      .concat(appealsRequests)
       .concat(applicationOfferingChangeRequests)
       .sort(this.sortAssessmentHistory);
   }

sources/packages/backend/apps/api/src/route-controllers/assessment/models/assessment.dto.ts

@@ -5,6 +5,7 @@ import {
   Assessment,
   AssessmentStatus,
   AssessmentTriggerType,
+  FormSubmissionStatus,
   NOTE_DESCRIPTION_MAX_LENGTH,
   OfferingIntensity,
   OfferingStatus,
@@ -49,7 +50,8 @@ type RequestAssessmentSummaryStatus =
   | StudentAppealStatus
   | ApplicationExceptionStatus
   | OfferingStatus
-  | ApplicationOfferingChangeRequestStatus;
+  | ApplicationOfferingChangeRequestStatus
+  | FormSubmissionStatus;
 
 export class RequestAssessmentSummaryAPIOutDTO {
   id: number;