#2741 - Ministry Filter Search Programs and Offerings [Location and Program Status Search] #3819

sh16011993 · 2024-10-23T00:27:15Z

As a part of the PR, the following were completed:

Added Location Search and Program Status Search for the institution programs in the UI. Each of the searches act as an && operation.
Added sorting for the Location Name and the Program Status columns.
Updated the api to include the location and the program status in the pagination for the search and updated the sql query fetching the result.

Screenshots:

Location Search and Program Status Search added:

Location Search with Program Search Empty and Program Statuses: Pending and Inactive selected:

Both Location and Program Search with Program Statuses: Pending and Approved selected

Location Search along with the Program Status: Pending selected:

Inactive Programs selected:

Nothing selected from the Program Status filter:

Descending Sort by Program Status:

Natural Sorting (without ASC / DESC selected) on page load:

Ascending Sort by Program Status:

… Search]

guru-aot · 2024-10-23T16:20:03Z

sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts

+      );
+      queryParams.push(`%${paginationOptions.locationNameSearch}%`);
+    }
+    if (paginationOptions.status) {


guru-aot · 2024-10-23T16:41:59Z

sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts

@@ -331,6 +331,33 @@ export class EducationProgramService extends RecordDataModelService<EducationPro
      });
      queryParams.push(`%${paginationOptions.searchCriteria}%`);
    }
+    if (paginationOptions.programNameSearch) {


Please correct me if i am wrong, the paginationOptions, if searched with only one criteria, paginationOptions.searchCriteria is used else the paginationOptions.programNameSearch and paginationOptions.locationNameSearch is pushed. If that is the case, either paginationOptions.searchCriteria should be pushed or the paginationOptions.programNameSearch and paginationOptions.locationNameSearch.

searchCriteria should not be used for programs.
@sh16011993 what if we change the service models as below to ensure the searchCriteria will not be present.

export interface BasePaginationOptions { sortField?: string; sortOrder?: FieldSortOrder; page: number; pageLimit: number; } /** * Pagination option. */ export interface PaginationOptions extends BasePaginationOptions { searchCriteria?: string; } export interface ProgramPaginationOptions extends BasePaginationOptions { programNameSearch?: string; locationNameSearch?: string; status?: string; }

guru-aot

Looks good, please have a look on the comment

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

andrewsignori-aot · 2024-10-23T18:09:42Z

sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts

+    }
+    if (paginationOptions.status) {
+      paginatedProgramQuery.andWhere(
+        "programs.programStatus Ilike :programStatusSearchCriteria",


programStatus does not require Ilike.

andrewsignori-aot · 2024-10-23T18:10:40Z

sources/packages/backend/apps/api/src/utilities/datatable-config.ts

@@ -11,6 +11,12 @@ export interface PaginationOptions {
  pageLimit: number;
 }

+export interface ProgramPaginationOptions extends PaginationOptions {


Please see suggested changes here: https://github.com/bcgov/SIMS/pull/3819/files#r1813295340

andrewsignori-aot · 2024-10-23T18:23:52Z

sources/packages/web/src/helpers/helpers/uri.ts

+  if (
+    paginationOptions.searchCriteria &&
+    typeof paginationOptions.searchCriteria === "object"
+  ) {
+    const searchCriteria = paginationOptions.searchCriteria;
+    for (const searchCriterion in searchCriteria) {
+      parameters.push(`${searchCriterion}=${searchCriteria[searchCriterion]}`);
+    }
+  }


Suggestion:

if (!paginationOptions.searchCriteria) { return parameters.join("&"); } // Search criteria. if (typeof paginationOptions.searchCriteria === "string") { // Single search criteria. parameters.push( `${PaginationParams.SearchCriteria}=${paginationOptions.searchCriteria}`, ); return parameters.join("&"); } // Multiple search criteria. const searchCriteria = paginationOptions.searchCriteria; for (const searchCriterion in paginationOptions.searchCriteria) { parameters.push(`${searchCriterion}=${searchCriteria[searchCriterion]}`); } return parameters.join("&");

andrewsignori-aot · 2024-10-23T18:25:00Z

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

@@ -123,7 +123,7 @@ export enum PaginationParams {
 * todo: remove sortOrder: DataTableSortOrder when all primevue datatables are removed.
 */
 export interface PaginationOptions {
-  searchCriteria?: string;
+  searchCriteria?: string | Record<string, string>;


Can you please add a comment to this parameter.

sources/packages/web/src/views/aest/institution/Programs.vue

andrewsignori-aot

Great work. Please take a look at the comments.

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

andrewsignori-aot · 2024-10-30T20:16:01Z

sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts

+    // query parameter assigned to paginatedProgramQuery like
+    // paginationOptions.searchCriteria or institutionId
+    // queryParams should follow the order/index.
+    const queryParams: any[] = [...offeringTypes, institutionId];


Even being from the old code, it can be changed to unknown without a need for further modifications.

andrewsignori-aot · 2024-10-30T20:18:02Z

sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts

+    institutionId: number,
+  ): {
+    programQuery: SelectQueryBuilder<EducationProgram>;
+    queryParams: any[];


Same from https://github.com/bcgov/SIMS/pull/3819/files#r1823332164

andrewsignori-aot · 2024-10-30T20:20:48Z

sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts

+    if (
+      !paginationOptions.statusSearch &&
+      !paginationOptions.inactiveProgramSearch
+    ) {
+      return {
+        results: [],
+        count: 0,
+      };
+    }


I am not following up on why "nothing" should be returned for this case. Can you please elaborate?

As we talked let's move this to the beginning of the method.
It seems okay to stay if it respects the business requirements.
My advise would be to UI and DTO enforce that one of these should be present.

andrewsignori-aot · 2024-10-30T21:39:58Z

sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts

+  private async preparePaginatedProgramQuery(
+    paginatedProgramQuery: SelectQueryBuilder<EducationProgram>,
+    paginationOptions: PaginationOptions,
+    queryParams: any[],


Please change to unknown.

andrewsignori-aot · 2024-10-30T22:06:44Z

sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts

+    // sort
+    if (
+      paginationOptions.sortField === "programStatus" &&
+      paginationOptions.sortOrder === "DESC"
+    ) {
+      paginatedProgramQuery.orderBy(
+        `CASE          
+          WHEN programs.programStatus = '${ProgramStatus.Pending}' and programs.isActive = true THEN ${SortPriority.Priority1}
+          WHEN programs.isActive = false THEN ${SortPriority.Priority2}
+          WHEN programs.programStatus = '${ProgramStatus.Declined}' and programs.isActive = true THEN ${SortPriority.Priority3}
+          WHEN programs.programStatus = '${ProgramStatus.Approved}' and programs.isActive = true THEN ${SortPriority.Priority4}
+          ELSE ${SortPriority.Priority5}
+        END`,
+      );
+    } else if (
+      paginationOptions.sortField === "programStatus" &&
+      paginationOptions.sortOrder === "ASC"
+    ) {
+      paginatedProgramQuery.orderBy(
+        `CASE          
+          WHEN programs.programStatus = '${ProgramStatus.Approved}' and programs.isActive = true THEN ${SortPriority.Priority1}
+          WHEN programs.programStatus = '${ProgramStatus.Declined}' and programs.isActive = true THEN ${SortPriority.Priority2}
+          WHEN programs.isActive = false THEN ${SortPriority.Priority3}
+          WHEN programs.programStatus = '${ProgramStatus.Pending}' and programs.isActive = true THEN ${SortPriority.Priority4}
+          ELSE ${SortPriority.Priority5}
+        END`,
+      );


Since the requirement is to have this ordered alphabetically, can the first part be simplified as below?

// Sort if (paginationOptions.sortField === "programStatus") { paginatedProgramQuery.orderBy( `CASE WHEN programs.isActive = false THEN '${INACTIVE_PROGRAM_STATUS}' ELSE programs.programStatus :: text end`, paginationOptions.sortOrder, ); } else if (paginationOptions.sortField && paginationOptions.sortOrder) { paginatedProgramQuery.orderBy( sortProgramsColumnMap(paginationOptions.sortField), paginationOptions.sortOrder, ); }

andrewsignori-aot · 2024-10-30T22:11:22Z

sources/packages/web/src/views/aest/institution/Programs.vue

 } from "@/types";
 import { AESTRoutesConst } from "@/constants/routes/RouteConstants";
 import StatusChipProgram from "@/components/generic/StatusChipProgram.vue";
 import { EducationProgramService } from "@/services/EducationProgramService";

+const INACTIVE_PROGRAM = "Inactive";


This can be added to a common location and shared with the program status chip.

andrewsignori-aot · 2024-10-30T22:31:00Z

sources/packages/web/src/views/aest/institution/Programs.vue

+        const statusSearchList = JSON.parse(
+          JSON.stringify(searchProgramStatus.value),
+        );
+        const searchInactiveProgram = statusSearchList.indexOf("Inactive") > -1;
+        if (searchInactiveProgram) {
+          statusSearchList.splice(statusSearchList.indexOf("Inactive"), 1);
+        }
+        let searchCriteria: Record<string, string | string[] | boolean>;
+        if (statusSearchList.length) {
+          searchCriteria = {
+            programNameSearch: searchProgramName.value,
+            locationNameSearch: searchLocationName.value,
+            statusSearch: statusSearchList,
+            inactiveProgramSearch: searchInactiveProgram,
+          };
+        } else {
+          searchCriteria = {
+            programNameSearch: searchProgramName.value,
+            locationNameSearch: searchLocationName.value,
+            inactiveProgramSearch: searchInactiveProgram,
+          };
+        }


Can it be refactored as below? The idea is to execute more array checks than string manipulations.

const statusSearchList = searchProgramStatus.value.filter( (searchItem) => searchItem !== INACTIVE_PROGRAM, ); const searchInactiveProgram = searchProgramStatus.value.some( (searchItem) => searchItem === INACTIVE_PROGRAM, ); let searchCriteria: Record<string, string | string[] | boolean> = { programNameSearch: searchProgramName.value, locationNameSearch: searchLocationName.value, statusSearch: statusSearchList, inactiveProgramSearch: searchInactiveProgram, }; if (statusSearchList.length) { searchCriteria.statusSearch = statusSearchList.toString(); // Check if we need JSON.stringify. }

No conversion needed here as filter returns a string array.

andrewsignori-aot

Great work doing the changes and refactors. Please take a look a the comments.

andrewsignori-aot · 2024-10-31T18:59:18Z

sources/packages/web/src/constants/program-constants.ts

@@ -0,0 +1 @@
+export const INACTIVE_PROGRAM = "Inactive";


Please use the same name from the API: INACTIVE_PROGRAM_STATUS.

andrewsignori-aot · 2024-10-31T19:11:10Z

sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts

+    // sort
+    if (paginationOptions.sortField === "programStatus") {
+      paginatedProgramQuery.orderBy(
+        `CASE WHEN programs.isActive = false THEN '${INACTIVE_PROGRAM_STATUS}' ELSE programs.programStatus :: text end`,


Please change it to "END".

andrewsignori-aot

Thanks for making the changes and for all the effort. The search seems a great addition. Looks good 👍

sonarqubecloud · 2024-10-31T21:10:26Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

github-actions · 2024-10-31T21:11:05Z

Backend Unit Tests Coverage Report

Totals
Statements:	22.3% ( 3695 / 16568 )
Methods:	10.31% ( 212 / 2057 )
Lines:	25.63% ( 3205 / 12507 )
Branches:	13.87% ( 278 / 2004 )

github-actions · 2024-10-31T21:13:42Z

E2E Queue Consumers Coverage Report

Totals
Statements:	85.88% ( 1216 / 1416 )
Methods:	87.86% ( 123 / 140 )
Lines:	86.8% ( 1032 / 1189 )
Branches:	70.11% ( 61 / 87 )

github-actions · 2024-10-31T21:16:28Z

E2E SIMS API Coverage Report

Totals
Statements:	65.65% ( 5574 / 8490 )
Methods:	63.07% ( 683 / 1083 )
Lines:	69.83% ( 4404 / 6307 )
Branches:	44.27% ( 487 / 1100 )

github-actions · 2024-10-31T21:19:06Z

E2E Workflow Workers Coverage Report

Totals
Statements:	65.43% ( 583 / 891 )
Methods:	59.26% ( 64 / 108 )
Lines:	68.54% ( 464 / 677 )
Branches:	51.89% ( 55 / 106 )

#2741 - Ministry Filter Search Programs and Offerings [Added Location…

4e8cf05

… Search]

sh16011993 self-assigned this Oct 23, 2024

sh16011993 added Ministry Ministry Features SIMS-Api SIMS-Api labels Oct 23, 2024

guru-aot self-requested a review October 23, 2024 16:18

guru-aot reviewed Oct 23, 2024

View reviewed changes

andrewsignori-aot reviewed Oct 23, 2024

View reviewed changes

sources/packages/backend/apps/api/src/route-controllers/models/pagination.dto.ts Outdated Show resolved Hide resolved

andrewsignori-aot reviewed Oct 23, 2024

View reviewed changes

sources/packages/backend/apps/api/src/route-controllers/models/pagination.dto.ts Outdated Show resolved Hide resolved

andrewsignori-aot reviewed Oct 23, 2024

View reviewed changes

sources/packages/web/src/views/aest/institution/Programs.vue Show resolved Hide resolved

andrewsignori-aot reviewed Oct 23, 2024

View reviewed changes

sh16011993 marked this pull request as draft October 23, 2024 23:11

Code Update

0143f5c

sh16011993 marked this pull request as ready for review October 29, 2024 00:57

sh16011993 marked this pull request as draft October 29, 2024 00:58

Code Update

1389aa9

sh16011993 marked this pull request as ready for review October 29, 2024 16:29

sh16011993 changed the title ~~#2741 - Ministry Filter Search Programs and Offerings [Location Search]~~ #2741 - Ministry Filter Search Programs and Offerings [Location and Program Status Search] Oct 29, 2024

sh16011993 added 2 commits October 29, 2024 12:58

Code Update

3abc707

Code Update

0e0ddc7

andrewsignori-aot reviewed Oct 29, 2024

View reviewed changes

sources/packages/backend/apps/api/src/route-controllers/models/pagination.dto.ts Show resolved Hide resolved

sh16011993 added 3 commits October 29, 2024 14:34

Code Update

6ec28be

Code Update

dbde62e

Added comments

8343df2

andrewsignori-aot reviewed Oct 29, 2024

View reviewed changes

sources/packages/backend/apps/api/src/route-controllers/models/pagination.dto.ts Show resolved Hide resolved

Code Update

9eff44a

andrewsignori-aot reviewed Oct 30, 2024

View reviewed changes

Code Update: Review Comments

8376f74

andrewsignori-aot reviewed Oct 31, 2024

View reviewed changes

andrewsignori-aot approved these changes Oct 31, 2024

View reviewed changes

Code Update

80c2469

sh16011993 added this pull request to the merge queue Oct 31, 2024

Merged via the queue into main with commit 69840a9 Oct 31, 2024
20 checks passed

sh16011993 deleted the 2741_ministry_filter_search_programs_and_offerings_add_location_search branch October 31, 2024 21:23

sh16011993 temporarily deployed to DEV October 31, 2024 21:30 — with GitHub Actions Inactive

sh16011993 temporarily deployed to DEV October 31, 2024 21:32 — with GitHub Actions Inactive

sh16011993 temporarily deployed to DEV October 31, 2024 21:34 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#2741 - Ministry Filter Search Programs and Offerings [Location and Program Status Search] #3819

#2741 - Ministry Filter Search Programs and Offerings [Location and Program Status Search] #3819

sh16011993 commented Oct 23, 2024 •

edited

Loading

guru-aot Oct 23, 2024

guru-aot Oct 23, 2024

andrewsignori-aot Oct 23, 2024

guru-aot left a comment

andrewsignori-aot Oct 23, 2024

andrewsignori-aot Oct 23, 2024 •

edited

Loading

andrewsignori-aot Oct 23, 2024

andrewsignori-aot Oct 23, 2024

andrewsignori-aot left a comment

andrewsignori-aot Oct 30, 2024

andrewsignori-aot Oct 30, 2024

andrewsignori-aot Oct 30, 2024

andrewsignori-aot Oct 30, 2024

andrewsignori-aot Oct 30, 2024

andrewsignori-aot Oct 30, 2024

andrewsignori-aot Oct 30, 2024

andrewsignori-aot Oct 30, 2024

sh16011993 Oct 31, 2024

andrewsignori-aot left a comment

andrewsignori-aot Oct 31, 2024

andrewsignori-aot Oct 31, 2024

andrewsignori-aot left a comment

sonarqubecloud bot commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

github-actions bot commented Oct 31, 2024

#2741 - Ministry Filter Search Programs and Offerings [Location and Program Status Search] #3819

#2741 - Ministry Filter Search Programs and Offerings [Location and Program Status Search] #3819

Conversation

sh16011993 commented Oct 23, 2024 • edited Loading

As a part of the PR, the following were completed:

Screenshots:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guru-aot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrewsignori-aot Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrewsignori-aot left a 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

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

Choose a reason for hiding this comment

andrewsignori-aot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrewsignori-aot left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Oct 31, 2024

Quality Gate passed

github-actions bot commented Oct 31, 2024

Backend Unit Tests Coverage Report

github-actions bot commented Oct 31, 2024

E2E Queue Consumers Coverage Report

github-actions bot commented Oct 31, 2024

E2E SIMS API Coverage Report

github-actions bot commented Oct 31, 2024

E2E Workflow Workers Coverage Report

sh16011993 commented Oct 23, 2024 •

edited

Loading

andrewsignori-aot Oct 23, 2024 •

edited

Loading