#1786 - Enable Search Student for Institutions - part 1 (#1857)

* initial commit

* removed unused import

* changed SearchStudents from ministry to use the same component

* reverted conf to display queries on logs

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

* review issues

Author: andrepestana-aot

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

@@ -42,6 +42,8 @@ import {
   EducationProgramOfferingInstitutionsController,
   EducationProgramOfferingControllerService,
   ConfirmationOfEnrollmentControllerService,
+  StudentInstitutionsController,
+  StudentControllerService,
 } from "./route-controllers";
 import { AuthModule } from "./auth/auth.module";
 import {
@@ -73,6 +75,7 @@ import { UserControllerService } from "./route-controllers/user/user.controller.
     ProgramInfoRequestInstitutionsController,
     EducationProgramOfferingInstitutionsController,
     UserInstitutionsController,
+    StudentInstitutionsController,
   ],
   providers: [
     WorkflowClientService,
@@ -117,6 +120,7 @@ import { UserControllerService } from "./route-controllers/user/user.controller.
     ConfirmationOfEnrollmentService,
     DisbursementOverawardService,
     NoteSharedService,
+    StudentControllerService,
   ],
 })
 export class AppInstitutionsModule {}

sources/packages/backend/apps/api/src/route-controllers/index.ts

@@ -56,3 +56,4 @@ export * from "./confirmation-of-enrollment/confirmation-of-enrollment.aest.cont
 export * from "./overaward/overaward.controller.service";
 export * from "./overaward/overaward.aest.controller";
 export * from "./overaward/overaward.students.controller";
+export * from "./student/student.institutions.controller";

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

@@ -3,7 +3,10 @@ import { InstitutionService, InstitutionTypeService } from "../../services";
 import { AddressInfo } from "@sims/sims-db";
 import { InstitutionDetailAPIOutDTO } from "./models/institution.dto";
 import { OptionItemAPIOutDTO } from "../models/common.dto";
-import { INSTITUTION_TYPE_BC_PRIVATE } from "@sims/sims-db/constant";
+import {
+  INSTITUTION_TYPE_BC_PRIVATE,
+  INSTITUTION_TYPE_BC_PUBLIC,
+} from "@sims/sims-db/constant";
 
 /**
  * Service/Provider for Institutions controller to wrap the common methods.
@@ -31,6 +34,8 @@ export class InstitutionControllerService {
     }
     const isBCPrivate =
       INSTITUTION_TYPE_BC_PRIVATE === institutionDetail.institutionType.id;
+    const isBCPublic =
+      INSTITUTION_TYPE_BC_PUBLIC === institutionDetail.institutionType.id;
 
     // {} as AddressInfo is added to prevent old data to break.
     const mailingAddress =
@@ -62,7 +67,8 @@ export class InstitutionControllerService {
         postalCode: mailingAddress.postalCode,
         selectedCountry: mailingAddress.selectedCountry,
       },
-      isBCPrivate: isBCPrivate,
+      isBCPrivate,
+      isBCPublic,
       hasBusinessGuid: !!institutionDetail.businessGuid,
     };
   }

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

@@ -131,7 +131,8 @@ export class InstitutionProfileAPIOutDTO extends InstitutionContactAPIOutDTO {
 export class InstitutionDetailAPIOutDTO extends InstitutionProfileAPIOutDTO {
   legalOperatingName: string;
   institutionTypeName?: string;
-  isBCPrivate?: boolean;
+  isBCPrivate: boolean;
+  isBCPublic: boolean;
   /**
    * Indicates if the institution has a BCeID business guid
    * associated with, if not it is a basic BCeID institution.

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

@@ -91,29 +91,29 @@ export class UpdateStudentAPIInDTO
 }
 
 /**
- * Student AEST search parameters.
+ * Student search parameters.
  */
-export class AESTStudentSearchAPIInDTO {
+export class StudentSearchAPIInDTO {
   @ValidateIf(
-    (input: AESTStudentSearchAPIInDTO) =>
+    (input: StudentSearchAPIInDTO) =>
       !input.lastName && !input.appNumber && !input.sin,
   )
   @IsNotEmpty()
   firstName: string;
   @ValidateIf(
-    (input: AESTStudentSearchAPIInDTO) =>
+    (input: StudentSearchAPIInDTO) =>
       !input.firstName && !input.appNumber && !input.sin,
   )
   @IsNotEmpty()
   lastName: string;
   @ValidateIf(
-    (input: AESTStudentSearchAPIInDTO) =>
+    (input: StudentSearchAPIInDTO) =>
       !input.firstName && !input.lastName && !input.sin,
   )
   @IsNotEmpty()
   appNumber: string;
   @ValidateIf(
-    (input: AESTStudentSearchAPIInDTO) =>
+    (input: StudentSearchAPIInDTO) =>
       !input.firstName && !input.lastName && !input.appNumber,
   )
   @IsNotEmpty()

sources/packages/backend/apps/api/src/route-controllers/student/student.aest.controller.ts

@@ -2,7 +2,6 @@ import {
   Body,
   Controller,
   Get,
-  Injectable,
   NotFoundException,
   Param,
   ParseIntPipe,
@@ -40,7 +39,7 @@ import {
   AESTFileUploadToStudentAPIInDTO,
   AESTStudentFileAPIOutDTO,
   AESTStudentProfileAPIOutDTO,
-  AESTStudentSearchAPIInDTO,
+  StudentSearchAPIInDTO,
   ApplicationSummaryAPIOutDTO,
   CreateSINValidationAPIInDTO,
   SearchStudentAPIOutDTO,
@@ -57,10 +56,10 @@ import {
   MINISTRY_FILE_UPLOAD_GROUP_NAME,
   uploadLimits,
 } from "../../utilities";
-import { CustomNamedError, getISODateOnlyString } from "@sims/utilities";
+import { CustomNamedError } from "@sims/utilities";
 import { IUserToken } from "../../auth/userToken.interface";
 import { StudentControllerService } from "..";
-import { FileOriginType, Student } from "@sims/sims-db";
+import { FileOriginType } from "@sims/sims-db";
 import { FileCreateAPIOutDTO } from "../models/common.dto";
 import {
   ApplicationPaginationOptionsAPIInDTO,
@@ -81,7 +80,6 @@ import { EntityManager } from "typeorm";
 @Groups(UserGroups.AESTUser)
 @Controller("student")
 @ApiTags(`${ClientTypeBaseRoute.AEST}-student`)
-@Injectable()
 export class StudentAESTController extends BaseController {
   constructor(
     private readonly fileService: StudentFileService,
@@ -228,17 +226,12 @@ export class StudentAESTController extends BaseController {
    */
   @Post("search")
   async searchStudents(
-    @Body() searchCriteria: AESTStudentSearchAPIInDTO,
+    @Body() searchCriteria: StudentSearchAPIInDTO,
   ): Promise<SearchStudentAPIOutDTO[]> {
-    const searchStudentApplications =
-      await this.studentService.searchStudentApplication(searchCriteria);
-    return searchStudentApplications.map((eachStudent: Student) => ({
-      id: eachStudent.id,
-      firstName: eachStudent.user.firstName,
-      lastName: eachStudent.user.lastName,
-      birthDate: getISODateOnlyString(eachStudent.birthDate),
-      sin: eachStudent.sinValidation.sin,
-    }));
+    const students = await this.studentService.searchStudent(searchCriteria);
+    return this.studentControllerService.transformStudentsToSearchStudentDetails(
+      students,
+    );
   }
 
   /**

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

@@ -13,9 +13,10 @@ import {
 } from "../models/pagination.dto";
 import { determinePDStatus, getUserFullName } from "../../utilities";
 import { getISODateOnlyString } from "@sims/utilities";
-import { AddressInfo, Application } from "@sims/sims-db";
+import { AddressInfo, Application, Student } from "@sims/sims-db";
 import {
   ApplicationSummaryAPIOutDTO,
+  SearchStudentAPIOutDTO,
   StudentProfileAPIOutDTO,
 } from "./models/student.dto";
 import { transformAddressDetailsForAddressBlockForm } from "../utils/address-utils";
@@ -179,4 +180,21 @@ export class StudentControllerService {
       status: application.applicationStatus,
     };
   };
+
+  /**
+   * Transforms a list of students into a list of student search details.
+   * @param students list of students.
+   * @returns a list of student search details.
+   */
+  transformStudentsToSearchStudentDetails(
+    students: Student[],
+  ): SearchStudentAPIOutDTO[] {
+    return students.map((eachStudent: Student) => ({
+      id: eachStudent.id,
+      firstName: eachStudent.user.firstName,
+      lastName: eachStudent.user.lastName,
+      birthDate: getISODateOnlyString(eachStudent.birthDate),
+      sin: eachStudent.sinValidation.sin,
+    }));
+  }
 }

sources/packages/backend/apps/api/src/route-controllers/student/student.institutions.controller.ts

@@ -0,0 +1,48 @@
+import { Body, Controller, Post } from "@nestjs/common";
+import { ApiTags } from "@nestjs/swagger";
+import { StudentService } from "../../services";
+import { ClientTypeBaseRoute } from "../../types";
+import { AuthorizedParties } from "../../auth/authorized-parties.enum";
+import { AllowAuthorizedParty, UserToken } from "../../auth/decorators";
+import BaseController from "../BaseController";
+import {
+  StudentSearchAPIInDTO,
+  SearchStudentAPIOutDTO,
+} from "./models/student.dto";
+import { IInstitutionUserToken } from "../../auth";
+import { StudentControllerService } from "./student.controller.service";
+
+/**
+ * Student controller for institutions.
+ */
+@AllowAuthorizedParty(AuthorizedParties.institution)
+@Controller("student")
+@ApiTags(`${ClientTypeBaseRoute.Institution}-student`)
+export class StudentInstitutionsController extends BaseController {
+  constructor(
+    private readonly studentService: StudentService,
+    private readonly studentControllerService: StudentControllerService,
+  ) {
+    super();
+  }
+
+  /**
+   * Search students based on the search criteria.
+   * TODO add decorator to restrict to BC Public institutions.
+   * @param searchCriteria criteria to be used in the search.
+   * @returns searched student details.
+   */
+  @Post("search")
+  async searchStudents(
+    @UserToken() userToken: IInstitutionUserToken,
+    @Body() searchCriteria: StudentSearchAPIInDTO,
+  ): Promise<SearchStudentAPIOutDTO[]> {
+    const students = await this.studentService.searchStudent(
+      searchCriteria,
+      userToken.authorizations.institutionId,
+    );
+    return this.studentControllerService.transformStudentsToSearchStudentDetails(
+      students,
+    );
+  }
+}

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

@@ -13,7 +13,7 @@ import {
   DisbursementOveraward,
   DisbursementOverawardOriginType,
 } from "@sims/sims-db";
-import { DataSource, EntityManager } from "typeorm";
+import { Brackets, DataSource, EntityManager } from "typeorm";
 import { StudentUserToken } from "../../auth/userToken.interface";
 import { LoggerService, InjectLogger } from "@sims/utilities/logger";
 import { removeWhiteSpaces, transformAddressDetails } from "../../utilities";
@@ -438,17 +438,21 @@ export class StudentService extends RecordDataModelService<Student> {
   }
 
   /**
-   * Search students based on the search criteria.
+   * Search students based on the search criteria and institution id if provided.
    * @param searchCriteria options to search by firstName,
    * lastName, appNumber or sin.
-   * @returns list of students.
+   * @param institutionId id of the institution that the student applied to.
+   * @returns list of student details.
    */
-  async searchStudentApplication(searchCriteria: {
-    firstName?: string;
-    lastName?: string;
-    appNumber?: string;
-    sin?: string;
-  }): Promise<Student[]> {
+  async searchStudent(
+    searchCriteria: {
+      firstName?: string;
+      lastName?: string;
+      appNumber?: string;
+      sin?: string;
+    },
+    institutionId?: number,
+  ): Promise<Student[]> {
     const searchQuery = this.repo
       .createQueryBuilder("student")
       .select([
@@ -457,16 +461,48 @@ export class StudentService extends RecordDataModelService<Student> {
         "user.firstName",
         "user.lastName",
         "sinValidation.sin",
-      ])
-      .leftJoin(
+      ]);
+    if (institutionId) {
+      searchQuery
+        .innerJoin(
+          Application,
+          "application",
+          "application.student.id = student.id",
+        )
+        .leftJoin("application.location", "pirLocation")
+        .leftJoin("pirLocation.institution", "pirInstitution")
+        .leftJoin("application.currentAssessment", "studentAssessment")
+        .leftJoin("studentAssessment.offering", "offering")
+        .leftJoin("offering.institutionLocation", "offeringLocation")
+        .leftJoin("offeringLocation.institution", "offeringInstitution");
+    } else {
+      searchQuery.leftJoin(
         Application,
         "application",
         "application.student.id = student.id",
-      )
+      );
+    }
+    searchQuery
       .innerJoin("student.user", "user")
       .innerJoin("student.sinValidation", "sinValidation")
       .where("user.isActive = true");
-
+    if (institutionId) {
+      searchQuery.andWhere(
+        new Brackets((qb) => {
+          qb.where("offeringInstitution.id = :institutionId", {
+            institutionId,
+          }).orWhere("pirInstitution.id = :institutionId", { institutionId });
+        }),
+      );
+    }
+    if (institutionId || searchCriteria.appNumber) {
+      searchQuery.andWhere(
+        "application.applicationStatus != :overwrittenStatus",
+        {
+          overwrittenStatus: ApplicationStatus.Overwritten,
+        },
+      );
+    }
     if (searchCriteria.sin) {
       searchQuery.andWhere("sinValidation.sin = :sin", {
         sin: removeWhiteSpaces(searchCriteria.sin),
@@ -483,13 +519,9 @@ export class StudentService extends RecordDataModelService<Student> {
       });
     }
     if (searchCriteria.appNumber) {
-      searchQuery
-        .andWhere("application.applicationNumber Ilike :appNumber")
-        .andWhere("application.applicationStatus != :overwrittenStatus")
-        .setParameters({
-          appNumber: `%${searchCriteria.appNumber}%`,
-          overwrittenStatus: ApplicationStatus.Overwritten,
-        });
+      searchQuery.andWhere("application.applicationNumber Ilike :appNumber", {
+        appNumber: `%${searchCriteria.appNumber}%`,
+      });
     }
     return searchQuery.getMany();
   }

sources/packages/backend/libs/sims-db/src/constant.ts

@@ -58,4 +58,5 @@ export const TableNames = {
   QueueConfigurations: "queue_configurations",
 };
 
+export const INSTITUTION_TYPE_BC_PUBLIC = 1;
 export const INSTITUTION_TYPE_BC_PRIVATE = 2;