#5099 - Bypass Program Suspension Restriction: UI#5859
Merged
sh16011993 merged 22 commits intomainfrom Mar 12, 2026
Merged
Conversation
- Added Chip Status based on Client Type for the Restriction Bypasses
- EOL formatting changed from CRLF to LF
- Fixed the failing e2e tests
- Fixed failing e2e tests
- Fixed the failing e2e tests
sh16011993
added
Ministry
Contributor
There was a problem hiding this comment.
Pull request overview
Extends the “application restriction bypass” feature so AEST users can bypass both student and institution restrictions, and updates the web UI to display/select restriction type (Student vs Institution) when creating/viewing bypasses.
Changes:
- Updated API/service contracts and logic to support bypassing institution restrictions in addition to student restrictions.
- Enhanced UI modal and supporting components to display restriction type and submit the new payload shape.
- Updated/added e2e tests for the new “available restrictions to bypass” and “bypass restriction” scenarios.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| sources/packages/web/src/views/aest/institution/Restrictions.vue | Switched from RestrictionEntityType to RestrictedParty when passing restriction party type. |
| sources/packages/web/src/types/vuetify.ts | Modified shared SelectItemType to include restriction party type. |
| sources/packages/web/src/types/contracts/RestrictionContract.ts | Renamed enum RestrictionEntityType to RestrictedParty and fixed comment punctuation. |
| sources/packages/web/src/services/http/dto/ApplicationRestrictionBypass.dto.ts | Updated web DTOs to support both student/institution restrictions and new field names. |
| sources/packages/web/src/services/http/ApplicationRestrictionBypassApi.ts | Renamed API method and updated return type for available restrictions. |
| sources/packages/web/src/services/ApplicationRestrictionBypassService.ts | Renamed service method and updated types to align with API changes. |
| sources/packages/web/src/components/generic/StatusChipClientType.vue | New chip component to label restriction party type. |
| sources/packages/web/src/components/common/students/StudentRestrictions.vue | Updated imports/returned bindings for RestrictedParty. |
| sources/packages/web/src/components/aest/students/bypassedRestrictions/BypassRestrictionModal.vue | Updated modal to select restriction + show party type chip; updated payload fields. |
| sources/packages/backend/libs/sims-db/src/entities/institution-restriction.model.ts | Added relation from institution restriction to application restriction bypasses. |
| sources/packages/backend/apps/api/src/services/application-restriction-bypass/application-restriction-bypass.service.ts | Added institution restriction support in option listing and bypass creation validations/persistence. |
| sources/packages/backend/apps/api/src/services/application-restriction-bypass/application-restriction-bypass.models.ts | Updated internal models to be restriction-party aware. |
| sources/packages/backend/apps/api/src/route-controllers/application-restriction-bypass/models/application-restriction-bypass.dto.ts | Updated API DTOs for new payload/response shapes including restriction party type. |
| sources/packages/backend/apps/api/src/route-controllers/application-restriction-bypass/application-restriction-bypass.aest.controller.ts | Updated endpoints/response mapping and error handling for institution restrictions. |
| sources/packages/backend/apps/api/src/route-controllers/application-restriction-bypass/tests/e2e/application-restriction-bypass.aest.controller.getAvailableRestricitionsToBypass.e2e-spec.ts | Expanded e2e coverage for listing available restrictions, including institution restrictions. |
| sources/packages/backend/apps/api/src/route-controllers/application-restriction-bypass/tests/e2e/application-restriction-bypass.aest.controller.getApplicationRestrictionBypass.e2e-spec.ts | Updated assertions for new response shape (restrictionId, restrictionType). |
| sources/packages/backend/apps/api/src/route-controllers/application-restriction-bypass/tests/e2e/application-restriction-bypass.aest.controller.bypassRestriction.e2e-spec.ts | Added institution restriction bypass creation and error scenarios. |
| sources/packages/backend/apps/api/src/constants/error-code.constants.ts | Added new error codes for institution restriction bypass scenarios. |
Comments suppressed due to low confidence (1)
sources/packages/backend/apps/api/src/route-controllers/application-restriction-bypass/tests/e2e/application-restriction-bypass.aest.controller.getAvailableRestricitionsToBypass.e2e-spec.ts:30
- Test file name contains a typo (
getAvailableRestricitionsToBypass) and does not match the project’s e2e naming convention ([feature].[client-type].controller.[method].e2e-spec.ts) or the controller method namegetAvailableRestrictionsToBypass. Please rename the file to keep conventions consistent and make tests easier to locate.
describe("ApplicationRestrictionBypassAESTController(e2e)-getAvailableRestrictionsToBypass.", () => {
let app: INestApplication;
let db: E2EDataSources;
sources/packages/web/src/components/common/students/StudentRestrictions.vue
Show resolved
Hide resolved
...controllers/application-restriction-bypass/application-restriction-bypass.aest.controller.ts
Show resolved
Hide resolved
Comment on lines
+325
to
+349
| if (institutionApplication) { | ||
| const bypassedInstitutionRestrictionIds = new Set( | ||
| institutionApplication.currentAssessment.offering.institutionLocation.institution.restrictions | ||
| .flatMap( | ||
| (institutionRestriction) => | ||
| institutionRestriction.applicationRestrictionBypasses, | ||
| ) | ||
| .filter((bypass) => bypass.isActive) | ||
| .map((bypass) => bypass.institutionRestriction.id), | ||
| ); | ||
|
|
||
| return studentRestrictionsThatAreNotBypassed | ||
| .filter((studentRestriction) => | ||
| allowedRestrictionActions.some((actionType) => | ||
| studentRestriction.restriction.actionType.includes(actionType), | ||
| ), | ||
| ) | ||
| .map((studentRestriction) => ({ | ||
| studentRestrictionId: studentRestriction.id, | ||
| restrictionCode: studentRestriction.restriction.restrictionCode, | ||
| studentRestrictionCreatedAt: studentRestriction.createdAt, | ||
| })) | ||
| .sort((a, b) => a.restrictionCode.localeCompare(b.restrictionCode)); | ||
| const institutionRestrictionsThatAreNotBypassed = | ||
| institutionApplication.currentAssessment.offering.institutionLocation.institution.restrictions.filter( | ||
| (institutionRestriction) => | ||
| !bypassedInstitutionRestrictionIds.has(institutionRestriction.id), | ||
| ); | ||
| mappedInstitutionRestrictionsNotBypassed = | ||
| institutionRestrictionsThatAreNotBypassed.map( | ||
| (institutionRestriction) => ({ | ||
| restrictionId: institutionRestriction.id, | ||
| restrictionCode: institutionRestriction.restriction.restrictionCode, | ||
| restrictionCreatedAt: institutionRestriction.createdAt, | ||
| restrictionType: RestrictedParty.Institution, | ||
| }), | ||
| ); |
There was a problem hiding this comment.
Institution restrictions are currently returned as bypass options without filtering by the allowed restriction action types for the application’s offering intensity (unlike student restrictions, which are filtered). If institution restrictions can include non-disbursement-blocking action types, this will expose/allow bypasses that should not be available. Consider applying the same allowedRestrictionActions filter using institutionRestriction.restriction.actionType (the query already selects actionType).
...es/packages/web/src/components/aest/students/bypassedRestrictions/BypassRestrictionModal.vue
Outdated
Show resolved
Hide resolved
- Addressed the copilot review comments
dheepak-aot
reviewed
Mar 9, 2026
sources/packages/backend/apps/api/src/constants/error-code.constants.ts
Outdated
Show resolved
Hide resolved
dheepak-aot
reviewed
Mar 9, 2026
sources/packages/backend/apps/api/src/constants/error-code.constants.ts
Outdated
Show resolved
Hide resolved
dheepak-aot
reviewed
Mar 9, 2026
Comment on lines
+135
to
+139
| const remitRestriction = await db.restriction.findOne({ | ||
| where: { | ||
| restrictionCode: RestrictionCode.REMIT, | ||
| }, | ||
| }); |
Collaborator
There was a problem hiding this comment.
Remit restriction must technically not be valid to create a bypass as it does not block disbursement.
I believe there is an existing GAP in API not validating the restriction actions while creating bypass.
dheepak-aot
reviewed
Mar 9, 2026
...ass/_tests_/e2e/application-restriction-bypass.aest.controller.bypassRestriction.e2e-spec.ts
Outdated
Show resolved
Hide resolved
dheepak-aot
reviewed
Mar 9, 2026
...ass/_tests_/e2e/application-restriction-bypass.aest.controller.bypassRestriction.e2e-spec.ts
Outdated
Show resolved
Hide resolved
dheepak-aot
reviewed
Mar 9, 2026
...ass/_tests_/e2e/application-restriction-bypass.aest.controller.bypassRestriction.e2e-spec.ts
Outdated
Show resolved
Hide resolved
dheepak-aot
reviewed
Mar 9, 2026
...ass/_tests_/e2e/application-restriction-bypass.aest.controller.bypassRestriction.e2e-spec.ts
Outdated
Show resolved
Hide resolved
dheepak-aot
reviewed
Mar 9, 2026
...ass/_tests_/e2e/application-restriction-bypass.aest.controller.bypassRestriction.e2e-spec.ts
Outdated
Show resolved
Hide resolved
dheepak-aot
reviewed
Mar 11, 2026
sources/packages/web/src/types/contracts/RestrictionBypassContracts.ts
Outdated
Show resolved
Hide resolved
Collaborator
|
Thanks for making the changes. Added few more comments. |
- Review Comments
- Review Comments
dheepak-aot
reviewed
Mar 12, 2026
| * @returns allowed restriction actions. | ||
| */ | ||
| private getAllowedRestrictionActions( | ||
| offeringIntensity: string, |
Collaborator
There was a problem hiding this comment.
Please use the type OfferingIntensity
dheepak-aot
reviewed
Mar 12, 2026
| RestrictionActionType.StopPartTimeDisbursement, | ||
| ]; | ||
| default: | ||
| return []; |
Collaborator
There was a problem hiding this comment.
Please throw error on default. throw new Error("Invalid offering intensity.")
dheepak-aot
reviewed
Mar 12, 2026
| }) | ||
| bypassRemovedDate?: Date; | ||
|
|
||
| getBypassRestriction(): StudentRestriction | InstitutionRestriction { |
Collaborator
There was a problem hiding this comment.
Please add comments to the method. Same for other method as well.
dheepak-aot
reviewed
Mar 12, 2026
Comment on lines
+165
to
+169
| if (this.studentRestriction && this.institutionRestriction) { | ||
| throw new Error( | ||
| "Cannot have both student restriction and institution restriction associated with a restriction bypass.", | ||
| ); | ||
| } |
Collaborator
There was a problem hiding this comment.
This condition is not necessary as both restrictions cannot co-exist in DB together.
dheepak-aot
approved these changes
Mar 12, 2026
Collaborator
dheepak-aot
left a comment
dheepak-aot
left a comment
There was a problem hiding this comment.
Thanks for making the changes and addressing the validation missing for action types on bypass create. Looks good. Added few last comments to wrap up.
- Review Comments
Backend Unit Tests Coverage Report
|
|
E2E Workflow Workers Coverage Report
|
E2E Queue Consumers Coverage Report
|
E2E SIMS API Coverage Report
|
weskubo-cgi
approved these changes
Mar 12, 2026
| @@ -0,0 +1,16 @@ | |||
| <template> | |||
Collaborator
There was a problem hiding this comment.
I think this a good use for ChipTag.vue. You won't need either RestrictedPartyChip.vue or ChipWithTag. We should confirm the color for the font and also look at whether the chips can be consistently right aligned in the v-select. If they can't be nicely right aligned then we can leave them as is.
| import { computed } from "vue"; | ||
|
|
||
| const props = defineProps<{ | ||
| clientType: RestrictedParty.Student | RestrictedParty.Institution; |
Collaborator
There was a problem hiding this comment.
FYI clientType is still being used but as suggested I think we can just use ChipTag.vue in which case this won't matter.
sh16011993
deleted the
feature/#5099-bypass-program-suspension-restriction-ui
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As a part of this PR, the following was completed:
History of Bypassed Restrictions:
Bypass Restriction Modal Dialog:
Bypassed Institution Restriction View:
Added / Updated the following e2e tests:
ApplicationRestrictionBypassAESTController(e2e)-getAvailableRestrictionsToBypass.
√ Should list all the active restrictions and not the ones already bypassed for a part-time application when there are some restrictions bypassed and some others not.
ApplicationRestrictionBypassAESTController(e2e)-bypassRestriction
√ Should be able to create a bypass when there is not an active bypass for the same institution restriction.
√ Should throw an HTTP error while creating a bypass when there is an active bypass for the same active institution restriction.
√ Should throw an HTTP error while creating a bypass when institution restriction is not active.
ApplicationRestrictionBypassAESTController(e2e)-getApplicationRestrictionBypass.
√ Should get an institution application restriction bypass for a submitted part-time application when there is an application restriction bypass with the required id.