#4584 - Pending Offerings queue #5561

weskubo-cgi · 2025-12-24T00:13:48Z

Overview

For Ministry users, add a new Offerings screen (available through the sidebar) in order to easily see Pending Offerings and navigate to them for approval.

Pending

Determine if we should use separate Study Start/End Dates like the recent update to Offerings.

API

Added new endpoint and associated artifacts to retrieve pending offerings.

Web

Added new screen to view pending offerings.
Added sidebar navigation.
Added supporting dto/service/API code.

Screenshots

E2E Tests

EducationProgramOfferingAESTController(e2e)-getPendingOfferings - Added e2e tests to cover sort, search, inactive/expired programs.

Copilot

Pull request overview

This PR implements a new "Pending Offerings" queue feature for AEST (ministry) users, allowing them to view and manage education program offerings that require ministry review. The implementation includes a complete full-stack feature with frontend UI, backend API, comprehensive e2e testing, and proper pagination/sorting/search capabilities.

Key Changes:

Added a new AEST view for pending offerings with search, sort, and pagination capabilities
Implemented backend API endpoint to retrieve offerings with "Creation Pending" status for active programs
Added comprehensive e2e tests covering default/custom sorting, search functionality, and inactive program filtering

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
ViewPendingOfferings.vue	New Vue component providing the UI for viewing pending offerings with search, sort, and pagination
DataTableContract.ts	Added PendingOfferingsHeaders configuration for the data table columns
AppRoutes.ts	Added PendingOfferings route definition
EducationProgramOffering.dto.ts (web)	Added EducationProgramOfferingPendingAPIOutDTO interface for frontend
EducationProgramOfferingApi.ts	Added getPendingOfferings API client method
EducationProgramOfferingService.ts	Added getPendingOfferings service method wrapping the API call
AESTRoutes.ts	Configured route for ViewPendingOfferings component
RouteConstants.ts	Added PENDING_OFFERINGS route constant
AESTHomeSideBar.vue	Added "Offerings" menu item linking to pending offerings view
education-program-offering.ts (test-utils)	Enhanced factory to support name and submittedDate in initial values
datatable-database-mapping-utils.ts	Added sort column mappings for submittedDate, offeringIntensity, and offeringType
education-program-offering.service.ts (backend)	Implemented getPendingOfferings business logic with query building, filtering, sorting, and pagination
pagination.dto.ts	Extended OfferingsPaginationOptionsAPIInDTO to support additional sort fields
education-program-offering.dto.ts (backend)	Added EducationProgramOfferingPendingAPIOutDTO interface
education-program-offering.controller.service.ts	Added getPendingOfferings method and removed duplicate service injection
education-program-offering.aest.controller.ts	Added GET /pending endpoint with proper decorators and documentation
education-program-offering.aest.controller.getPendingOfferings.e2e-spec.ts	Comprehensive e2e tests covering sorting, search, and filtering scenarios

...ckend/apps/api/src/services/education-program-offering/education-program-offering.service.ts

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

sources/packages/web/src/services/http/EducationProgramOfferingApi.ts

tiago-graf · 2025-12-30T21:48:21Z

...ering/_tests_/e2e/education-program-offering.aest.controller.getPendingOfferings.e2e-spec.ts

+      .auth(token, BEARER_AUTH_TYPE)
+      .expect(HttpStatus.OK);
+
+    expect(response.body.count).toBeGreaterThanOrEqual(2);


I'll let @dheepak-aot confirm this but we follow a standard for the expect block, you can find some examples in my PR

these goes for all other tests

I went with this approach to avoid blocks of duplicated code in the toEqual assertion. I have simplified the tests that don't return results. I'll look the team's guidance on whether to refactor the other tests.

Yes same for me, i just got asked to change it to their standard a few times now!

tiago-graf · 2025-12-30T21:49:14Z

...ering/_tests_/e2e/education-program-offering.aest.controller.getPendingOfferings.e2e-spec.ts

+    // Ministry token.
+    const token = await getAESTToken(AESTGroups.BusinessAdministrators);
+    // Include a search criteria that matches both offerings to avoid test data collisions.
+    const endpoint = `/aest/education-program-offering/pending?page=0&pageLimit=10&searchCriteria=Psychology`;


you can set a base endpoint to avoid duplicating the url many times

tiago-graf · 2025-12-30T21:55:13Z

...ering/_tests_/e2e/education-program-offering.aest.controller.getPendingOfferings.e2e-spec.ts

+    // Ministry token.
+    const token = await getAESTToken(AESTGroups.BusinessAdministrators);
+
+    const endpoint = `/aest/education-program-offering/pending?page=0&pageLimit=10&sortField=submittedDate&sortOrder=DESC`;


nit -> Id move the values to a variable and add them to the url using string interpolation, it makes it a bit easier to see what the request is sending

Agreed. I've done this for sortField/sortOrder/searchCriteria.

tiago-graf · 2025-12-30T21:59:24Z

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

 export class OfferingsPaginationOptionsAPIInDTO extends PaginationOptionsAPIInDTO {
  @IsOptional()
-  @IsIn(["name"])
+  @IsIn(["name", "submittedDate", "offeringIntensity", "offeringType"])


incoming conflict here since i'm also making changes to this in my PR

I'm going to create a separate DTO. I shouldn't have re-used this.

tiago-graf · 2025-12-30T22:00:58Z

sources/packages/backend/libs/test-utils/src/factories/education-program-offering.ts

    relations?.institutionLocation?.institution ?? relations.institution;
  const offering = new EducationProgramOffering();
-  offering.name = faker.lorem.word();
+  offering.name = options?.initialValues?.name ?? faker.lorem.word();


coud have used this in my tests!!

tiago-graf · 2025-12-30T22:20:53Z

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

+      loading.value = false;
+    };
+
+    onMounted(async () => {


i dont think you need a wrapper: onMounted(getofferings); should work

I think it's required to wait for the async call to load and seems to be used more often than not in the code.

tiago-graf

Looks great, just a few small comments, it would be nice to have the "study dates" column split into the start/end for consistency, i've done the changes in the offerings view (it also looks really cramped in the table)

sonarqubecloud · 2025-12-31T18:49:54Z

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 SonarQube Cloud

github-actions · 2025-12-31T18:50:27Z

Backend Unit Tests Coverage Report

Totals
Statements:	20.33% ( 4323 / 21268 )
Methods:	9.66% ( 252 / 2608 )
Lines:	24.47% ( 3705 / 15139 )
Branches:	10.39% ( 366 / 3521 )

github-actions · 2025-12-31T18:50:48Z

E2E Workflow Workers Coverage Report

Totals
Statements:	75.41% ( 1055 / 1399 )
Methods:	79.31% ( 115 / 145 )
Lines:	78.79% ( 769 / 976 )
Branches:	61.51% ( 171 / 278 )

github-actions · 2025-12-31T18:53:39Z

E2E Queue Consumers Coverage Report

Totals
Statements:	85.68% ( 1616 / 1886 )
Methods:	85% ( 187 / 220 )
Lines:	88.64% ( 1287 / 1452 )
Branches:	66.36% ( 142 / 214 )

github-actions · 2025-12-31T18:54:27Z

E2E SIMS API Coverage Report

Totals
Statements:	75.29% ( 8545 / 11349 )
Methods:	75.24% ( 1024 / 1361 )
Lines:	79.41% ( 6214 / 7825 )
Branches:	60.43% ( 1307 / 2163 )

weskubo-cgi added 3 commits December 22, 2025 13:54

Initial implementation.

10c9b4a

Small updates.

61b2aab

Added custom DTO. Started on e2e tests.

7f17216

weskubo-cgi marked this pull request as draft December 24, 2025 00:13

Updated e2e tests.

dc4ccda

weskubo-cgi requested a review from Copilot December 29, 2025 19:44

Copilot started reviewing on behalf of weskubo-cgi December 29, 2025 19:44 View session

Copilot AI reviewed Dec 29, 2025

View reviewed changes

weskubo-cgi changed the title ~~Feature/#4584 pending offerings queue~~ #4584 - Pending Offerings queue Dec 29, 2025

weskubo-cgi self-assigned this Dec 29, 2025

weskubo-cgi added Ministry Ministry Features SIMS-Api SIMS-Api E2E/Unit tests Web portal labels Dec 29, 2025

weskubo-cgi added 4 commits December 29, 2025 12:12

CoPilot PR feedback.

fae5c7f

Updated E2E tests. Code cleanup.

4abdd33

Updated comments for consistency.

2bd75b0

Updated headers case to be consistent with Offerings screen.

aebfbb3

weskubo-cgi marked this pull request as ready for review December 30, 2025 00:55

tiago-graf reviewed Dec 30, 2025

View reviewed changes

tiago-graf approved these changes Dec 30, 2025

View reviewed changes

Added missing columns and used standard formatter for Intensity.

821cd84

weskubo-cgi marked this pull request as draft December 31, 2025 00:43

weskubo-cgi added 2 commits December 30, 2025 17:43

Created custom PaginationDTO and sort method for pending offerings.

e5fe6ec

PR feedback.

8263721

weskubo-cgi added 3 commits December 31, 2025 00:55

Standardized formatter with Offerings screen.

81c4658

Implemented custom sort and added additional e2e tests.

ded98cc

Removed unused columnMap.

c8ff015

weskubo-cgi marked this pull request as ready for review December 31, 2025 18:49

#4584 - Pending Offerings queue #5561

Are you sure you want to change the base?

#4584 - Pending Offerings queue #5561

Uh oh!

Conversation

weskubo-cgi commented Dec 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Pending

API

Web

Screenshots

E2E Tests

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weskubo-cgi Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weskubo-cgi Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tiago-graf left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Dec 31, 2025

Quality Gate passed

Uh oh!

github-actions bot commented Dec 31, 2025

Backend Unit Tests Coverage Report

Uh oh!

github-actions bot commented Dec 31, 2025

E2E Workflow Workers Coverage Report

Uh oh!

github-actions bot commented Dec 31, 2025

E2E Queue Consumers Coverage Report

Uh oh!

github-actions bot commented Dec 31, 2025

E2E SIMS API Coverage Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

weskubo-cgi commented Dec 24, 2025 •

edited

Loading

weskubo-cgi Dec 31, 2025 •

edited

Loading

weskubo-cgi Dec 31, 2025 •

edited

Loading

tiago-graf left a comment •

edited

Loading