#4877 - Reverse scholastic standing API #5045

dheepak-aot · 2025-08-11T19:37:30Z

Reverse scholastic standing API

Keycloak role

Created a new keycloak role student-reverse-scholastic-standing and added the role to the group aest-business-administrators in DEV

API

Created new API to reverse a scholastic standing change.
This API will handle the reversal process based on the scholastic standing change type. For e.g. when the change type is Unsuccessful completion, only the reversal date, reversal_by and reversal_note is added without any re-assessment or updating the archiving status. But otherwise additionally re-assessment and updating archive status to false is also done.

Service

Created a new service ScholasticStandingReversalService to handle all the operations for reversal.
Added the property versions to offering similar to applications to get it's current version.

E2E Tests

E2E Tests added for the reverse scholastic standing API to cover all major scenarios. Few more tests for different errors will be added in the upcoming PR.

E2E tests added for UC summary API for students to ensure UC weeks from a reversed scholastic standing is ignored.

andrewsignori-aot · 2025-08-13T19:51:11Z

...ute-controllers/student-scholastic-standings/student-scholastic-standings.aest.controller.ts

+          default:
+            throw error;


Minor, the default is not required.

andrewsignori-aot · 2025-08-13T19:53:37Z

...d/apps/api/src/services/student-scholastic-standings/scholastic-standing-reversal.service.ts

+  SCHOLASTIC_STANDING_REVERSAL_NOT_UPDATED,
+} from "../../constants";
+import { DataSource, IsNull, Repository } from "typeorm";
+/**


Please add a blank line.

andrewsignori-aot · 2025-08-13T20:07:27Z

...d/apps/api/src/services/student-scholastic-standings/scholastic-standing-reversal.service.ts

+          { id: scholasticStandingId, reversalDate: IsNull() },
+          { reversalDate: now, reversalBy: auditUser, reversalNote: note },
+        );
+      if (updateResult.affected !== 1) {


Minor, just a suggestion, I found the check as if (!updateResult.affected) better to read 😉
We have both ways in the solution, no need for change.

andrewsignori-aot

Great work with the different scenarions, looks good 👍

Copilot

Pull Request Overview

This PR implements a reverse scholastic standing API that allows authorized users to reverse student scholastic standing changes. The implementation handles different reversal scenarios based on the type of scholastic standing change, including creating re-assessments and updating application archive status when necessary.

Key Changes:

Added new Keycloak role student-reverse-scholastic-standing for authorization
Created new service ScholasticStandingReversalService to handle reversal logic
Implemented API endpoint to reverse scholastic standings with appropriate error handling
Added comprehensive E2E tests covering various reversal scenarios

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
sources/packages/web/src/types/contracts/aest/roles.ts	Added new role constant for scholastic standing reversal
sources/packages/backend/libs/test-utils/src/factories/student-scholastic-standing.ts	Enhanced factory to support reversal date initialization
sources/packages/backend/libs/test-utils/src/factories/education-program-offering.ts	Added offering versioning support for testing
sources/packages/backend/libs/sims-db/src/entities/education-program-offering.model.ts	Added versions relationship to track offering changes
sources/packages/backend/apps/api/src/services/student-scholastic-standings/scholastic-standing-reversal.service.ts	Core service implementing reversal business logic
sources/packages/backend/apps/api/src/route-controllers/student-scholastic-standings/student-scholastic-standings.aest.controller.ts	API endpoint for reversing scholastic standings
sources/packages/backend/apps/api/src/route-controllers/student-scholastic-standings/models/student-scholastic-standings.dto.ts	Request DTO for reversal payload
sources/packages/backend/apps/api/src/constants/error-code.constants.ts	Added error constants for reversal operations
sources/packages/backend/apps/api/src/auth/roles.enum.ts	Added role enum for backend authorization
sources/packages/backend/apps/api/src/app.aest.module.ts	Registered new service in DI container

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.}

Copilot · 2025-08-13T20:48:47Z

...d/apps/api/src/services/student-scholastic-standings/scholastic-standing-reversal.service.ts

+      if (isReAssessmentAndArchiveUpdateRequired) {
+        // Current version of the offering that was associated with the application before the scholastic standing was reported.
+        const [offeringBeforeScholasticStanding] =
+          scholasticStanding.referenceOffering.parentOffering.versions;


Using array destructuring to get the first element assumes the array has at least one element, but there's no validation that versions array is not empty. This could cause runtime errors if no versions exist.

Suggested change

scholasticStanding.referenceOffering.parentOffering.versions;

const versions = scholasticStanding.referenceOffering.parentOffering.versions;

if (!Array.isArray(versions) || versions.length === 0) {

throw new CustomNamedError(

"No offering versions found for the parent offering when attempting to reverse scholastic standing.",

SCHOLASTIC_STANDING_REVERSAL_NOT_ALLOWED,

);

}

const [offeringBeforeScholasticStanding] = versions;

Copilot · 2025-08-13T20:48:48Z

...2e/student-scholastic-standings.students.controller.getScholasticStandingSummary.e2e-spec.ts

+
+  it(
+    "Should get scholastic standing summary for a student excluding the details from reversed scholastic standing(s)" +
+      " when a student has one ore more reversed scholastic standings.",


There is a spelling error: 'ore' should be 'or'.

Suggested change

" when a student has one ore more reversed scholastic standings.",

" when a student has one or more reversed scholastic standings.",

@dheepak-aot please review spelling check

sonarqubecloud · 2025-08-13T23:36:01Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

github-actions · 2025-08-13T23:36:33Z

Backend Unit Tests Coverage Report

Totals
Statements:	21.45% ( 4114 / 19181 )
Methods:	9.55% ( 234 / 2449 )
Lines:	24.82% ( 3561 / 14350 )
Branches:	13.39% ( 319 / 2382 )

github-actions · 2025-08-13T23:36:49Z

E2E Workflow Workers Coverage Report

Totals
Statements:	74.3% ( 896 / 1206 )
Methods:	77.14% ( 108 / 140 )
Lines:	77.16% ( 696 / 902 )
Branches:	56.1% ( 92 / 164 )

bidyashish

LGTM

github-actions · 2025-08-13T23:39:36Z

E2E Queue Consumers Coverage Report

Totals
Statements:	86.43% ( 1548 / 1791 )
Methods:	84.62% ( 176 / 208 )
Lines:	88.75% ( 1278 / 1440 )
Branches:	65.73% ( 94 / 143 )

github-actions · 2025-08-13T23:40:23Z

E2E SIMS API Coverage Report

Totals
Statements:	73.84% ( 7344 / 9946 )
Methods:	71.62% ( 901 / 1258 )
Lines:	77.3% ( 5687 / 7357 )
Branches:	56.8% ( 756 / 1331 )

dheepak-aot added 3 commits August 8, 2025 18:17

E2E test for UC counter

4d934cb

Create boilerplate endpoint for reversal

1e19af8

Reverse scholasticc standing E2E test

795fd05

dheepak-aot self-assigned this Aug 11, 2025

dheepak-aot added SIMS-Api SIMS-Api E2E/Unit tests labels Aug 11, 2025

dheepak-aot added 8 commits August 11, 2025 14:44

Updated the import

d95a29a

Added E2E test for reversal with re-assessment

f6f9a21

Scholastic standing reversal service

d2b774c

Reversal service

b7ebe29

scholastic standing reversal

256412b

E2E Test with offering version

76afeef

E2E Test with offering version

0ca1a72

Add E2E test for student appeal

e7242ea

dheepak-aot marked this pull request as ready for review August 13, 2025 19:35

andrewsignori-aot reviewed Aug 13, 2025

View reviewed changes

andrewsignori-aot approved these changes Aug 13, 2025

View reviewed changes

Added API tags and adjust E2E test description

49200d4

bidyashish requested a review from Copilot August 13, 2025 20:48

Copilot AI reviewed Aug 13, 2025

View reviewed changes

review comments

33b6bdb

bidyashish approved these changes Aug 13, 2025

View reviewed changes

dheepak-aot added this pull request to the merge queue Aug 13, 2025

Merged via the queue into main with commit eb285ce Aug 13, 2025
22 checks passed

dheepak-aot deleted the feature/#4877-reverse-scholastic-standing-api branch August 13, 2025 23:47

dheepak-aot temporarily deployed to DEV August 13, 2025 23:55 — with GitHub Actions Inactive

dheepak-aot temporarily deployed to DEV August 13, 2025 23:56 — with GitHub Actions Inactive

dheepak-aot temporarily deployed to DEV August 13, 2025 23:58 — with GitHub Actions Inactive

-          scholasticStanding.referenceOffering.parentOffering.versions;
+        const versions = scholasticStanding.referenceOffering.parentOffering.versions;
+        if (!Array.isArray(versions) || versions.length === 0) {
+          throw new CustomNamedError(
+            "No offering versions found for the parent offering when attempting to reverse scholastic standing.",
+            SCHOLASTIC_STANDING_REVERSAL_NOT_ALLOWED,
+          );
+        }
+        const [offeringBeforeScholasticStanding] = versions;

	" when a student has one ore more reversed scholastic standings.",
	" when a student has one or more reversed scholastic standings.",

#4877 - Reverse scholastic standing API #5045

#4877 - Reverse scholastic standing API #5045

Uh oh!

Conversation

dheepak-aot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reverse scholastic standing API

Keycloak role

API

Service

E2E Tests

Uh oh!

andrewsignori-aot Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes:

Reviewed Changes

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

bidyashish Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Aug 13, 2025

Quality Gate passed

Uh oh!

github-actions bot commented Aug 13, 2025

Backend Unit Tests Coverage Report

Uh oh!

github-actions bot commented Aug 13, 2025

E2E Workflow Workers Coverage Report

Uh oh!

bidyashish left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 13, 2025

E2E Queue Consumers Coverage Report

Uh oh!

github-actions bot commented Aug 13, 2025

E2E SIMS API Coverage Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dheepak-aot commented Aug 11, 2025 •

edited

Loading