#5190 - Appeals and forms analysis work - Student Notes by andrewsignori-aot · Pull Request #5862 · bcgov/SIMS

andrewsignori-aot · 2026-03-06T21:04:45Z

PR Goal

"Student appeal" and "Student form" note categories are displayed under a new "Forms" category for the Ministry and Institutions.
For listing the notes, Institutions have the same access as the Ministry; no authorization should be applied.
- The institutions should be able to see notes that belong to other applications, appeals, and forms, even if not their own (student filter applied only).
Ministry manual creation of a note should allow the creation of the individual categories "Student appeal" and "Student form". Once added, they will be displayed under the shared "Forms" category.
Only users with the specific roles should be able to see the options for manually creating notes for "Student appeal" and "Student form", which means the list of available options will remove note categories that the user does not have access to.
No need to toggle this area since there will be no meaningful production impact in having it available ahead of the remaining feature.

UI displaying "Student appeal" and "Student form"

Ministry

Institution

UI Fixes

For a long note entry, the date was breaking into multiple lines, and the "Show more" feature was no longer working, as shown below.

The "fixed" version would be as shown below. Please note that the "Show more" was already there, just not working properly.

The user name is now retrieved from the API, as the other endpoints, resolving the issue for mononyn names.

Technical Changes

Note-related API endpoints are now supporting multiple categories as a filter. This allows the user to see a category named Forms and filter by Student appeal and Student forms notes.
- Create a small structure to allow this, and any other similar UI-to-API-note-category-map to be created.
- NoteService methods on Web are still accepting one StudentNoteType or InstitutionNoteType. Please note that the Web deals with the institution vs students' notes using different enums, which are subsets of the backend notes.
enum NoteType was added to the Web.
NoteAPIOutDTO is now in sync between Web and API.

E2E Tests

New E2E test added to retrieve two categories:
- Should get two student notes from two different categories when the two categories are provided as a filter.
Note-related get E2E tests refactored to bring the patterns closer to the most updated ones.
New E2E tests to test the proper authorization for the categories.
- Should create a note for category Student appeal when the user has authorization for this note type.
- Should create a note for category Student form when the user has authorization for this note type.
- Should throw forbidden error when trying to create a Student appeal but the user does not have authorization for this note type.
- Should throw forbidden error when trying to create a Student form but the user does not have authorization for this note type.

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.

You can also share your feedback on Copilot code review. Take the survey.

tiago-graf · 2026-03-09T22:21:29Z

+ * @param note note to be transformed.
+ * @returns an object item for the notes returned by the API.
+ */
+export function noteToApiReturn(note: Note) {


not your code but can we call it transformNoteToApiReturn?

tiago-graf · 2026-03-09T22:40:03Z

+      return ApiClient.NoteApi.getStudentNotes(studentId);
+    }
+    const convertedNotes = STUDENT_NOTE_TO_NOTES_TYPE_MAP.get(noteType) ?? [
+      noteType as unknown as NoteType,


Clever but confusing conversion, it seems there's no other way to "extend" enums but you could have a export type directly mapping to the enum ->

export type InstitutionNoteType =
| NoteType.General
| NoteType.Restriction
| NoteType.System
| NoteType.Program
| NoteType.Designation;

not sure of the side effects of this tho!

Yeah, I wasn't too happy about it. I tried different approaches, but I tried to avoid losing the iterable part over the InstitutionNoteType that is used in one part of the UI.
I can give a second thought 😉

Didn`t find any great alternative. I ended up just renaming it a bit and changing the cast as below.

studentNote as string as NoteType

tiago-graf

It looks great just a small comment

dheepak-aot · 2026-03-10T17:46:20Z

+ */
+export class NoteAPIQueryStringAPIInDTO {
+  @IsOptional()
+  @ArrayMaxSize(Object.keys(NoteType).length)


dheepak-aot · 2026-03-10T18:04:58Z

  @Roles(Role.StudentCreateNote)
  @ApiNotFoundResponse({ description: "Student not found." })
+  @ApiForbiddenResponse({
+    description:


Asking the question if not raised already, for the scope of adding institution notes, there must be consideration of NoteTypes permissible and not permissible to be added.

I am not sure if I am following. What would be the case to have institution notes permissions considerations in the context of this feature?

I meant while adding the note for an institution, shouldn't the note types be only w.r.t institutions. ?We have that in UI, but API is not validated.

Currently, the DTO is shared between the institution and students. We need to create a specific DTO for each client, do the same on the Web, and create an E2E for each. I do not see it as part of this PR.

dheepak-aot

Nice work. Thanks for making the changes. Looks good 👍

…als-and-forms-notes

sonarqubecloud · 2026-03-10T20:50:44Z

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 · 2026-03-10T20:51:32Z

Backend Unit Tests Coverage Report

Totals
Statements:	20.26% ( 4565 / 22529 )
Methods:	9.56% ( 262 / 2741 )
Lines:	24.58% ( 3917 / 15933 )
Branches:	10.01% ( 386 / 3855 )

github-actions · 2026-03-10T20:51:52Z

E2E Workflow Workers Coverage Report

Totals
Statements:	75.23% ( 1066 / 1417 )
Methods:	78.38% ( 116 / 148 )
Lines:	78.68% ( 775 / 985 )
Branches:	61.62% ( 175 / 284 )

github-actions · 2026-03-10T20:54:45Z

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 · 2026-03-10T20:56:33Z

E2E SIMS API Coverage Report

Totals
Statements:	75.72% ( 9529 / 12584 )
Methods:	73.92% ( 1100 / 1488 )
Lines:	80.33% ( 6912 / 8605 )
Branches:	60.9% ( 1517 / 2491 )

Added student appeals and forms category for student notes

8cc95db

andrewsignori-aot self-assigned this Mar 6, 2026

andrewsignori-aot added Ministry Ministry Features SIMS-Api SIMS-Api Web portal labels Mar 6, 2026

andrewsignori-aot added 2 commits March 7, 2026 11:25

Pre review changes.

45fe3e2

E2E tests

9a05b37

andrewsignori-aot requested a review from Copilot March 7, 2026 20:19

Copilot started reviewing on behalf of andrewsignori-aot March 7, 2026 20:20 View session

This comment was marked as outdated.

Sign in to view

Minor changes for Show more...

091d6ac

andrewsignori-aot mentioned this pull request Mar 7, 2026

Appeals and forms analysis work continued part 2 #5190

Closed

18 tasks

andrewsignori-aot added 2 commits March 7, 2026 14:27

Adapted notes creation

0fd936a

API validation

3c6dbd0

andrewsignori-aot requested a review from Copilot March 7, 2026 22:58

Copilot started reviewing on behalf of andrewsignori-aot March 7, 2026 22:59 View session

Copilot AI reviewed Mar 7, 2026

View reviewed changes

Comment thread sources/packages/web/src/components/common/notes/CreateNoteModal.vue Outdated

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

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

andrewsignori-aot added 2 commits March 7, 2026 15:10

Copilot fixes

be562a5

Comment

14fa30f

andrewsignori-aot marked this pull request as ready for review March 9, 2026 16:53

tiago-graf reviewed Mar 9, 2026

View reviewed changes

tiago-graf approved these changes Mar 9, 2026

View reviewed changes

andrewsignori-aot added 2 commits March 9, 2026 15:40

Renaming noteToApiReturn

de993aa

Minor cast change

1d64b19

dheepak-aot self-requested a review March 10, 2026 16:04

dheepak-aot reviewed Mar 10, 2026

View reviewed changes

Comment thread sources/packages/backend/apps/api/src/route-controllers/note/models/note.dto.ts

dheepak-aot reviewed Mar 10, 2026

View reviewed changes

Comment thread sources/packages/backend/apps/api/src/route-controllers/note/note.aest.controller.ts Outdated

dheepak-aot reviewed Mar 10, 2026

View reviewed changes

Comment thread sources/packages/web/src/components/common/notes/CreateNoteModal.vue

PR comments

beb6e61

dheepak-aot approved these changes Mar 10, 2026

View reviewed changes

andrewsignori-aot added 2 commits March 10, 2026 13:06

Merge branch 'main' into feature/#5190-new-unified-data-path-for-appe…

a5df40d

…als-and-forms-notes

Minor E2E fix

3a4900d

andrewsignori-aot added this pull request to the merge queue Mar 10, 2026

Merged via the queue into main with commit eb655ab Mar 10, 2026
22 checks passed

andrewsignori-aot deleted the feature/#5190-new-unified-data-path-for-appeals-and-forms-notes branch March 10, 2026 21:02

andrewsignori-aot temporarily deployed to DEV March 10, 2026 21:07 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV March 10, 2026 21:11 — with GitHub Actions Inactive

Conversation

andrewsignori-aot commented Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Goal

UI displaying "Student appeal" and "Student form"

Ministry

Institution

UI Fixes

Technical Changes

E2E Tests

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tiago-graf Mar 9, 2026 • 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 Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Mar 9, 2026 • 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!

andrewsignori-aot Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

tiago-graf left a comment

Choose a reason for hiding this comment

Uh oh!

dheepak-aot Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dheepak-aot Mar 10, 2026 • 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!

andrewsignori-aot Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

dheepak-aot Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dheepak-aot left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Mar 10, 2026

Quality Gate passed

Uh oh!

github-actions Bot commented Mar 10, 2026

Backend Unit Tests Coverage Report

Uh oh!

github-actions Bot commented Mar 10, 2026

E2E Workflow Workers Coverage Report

Uh oh!

github-actions Bot commented Mar 10, 2026

E2E Queue Consumers Coverage Report

Uh oh!

github-actions Bot commented Mar 10, 2026

E2E SIMS API Coverage Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

andrewsignori-aot commented Mar 6, 2026 •

edited

Loading

tiago-graf Mar 9, 2026 •

edited

Loading

andrewsignori-aot Mar 9, 2026 •

edited

Loading

dheepak-aot Mar 10, 2026 •

edited

Loading