#1910 - Student profile returns SIN #2354

andrepestana-aot · 2023-09-26T17:52:35Z

Added a new DTO to contain sensitive data and changed the logic to make the student api to not bring the SIN data.
Removed the SIN property from the student profile retrieved by the student.

Student view

Institution view

Ministry view

sources/packages/backend/apps/api/src/route-controllers/student/student.aest.controller.ts

andrewsignori-aot · 2023-09-26T21:04:57Z

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

@@ -181,10 +181,13 @@ export class StudentProfileAPIOutDTO {
  contact: ContactInformationAPIOutDTO;
  validSin: boolean;
  disabilityStatus: DisabilityStatus;
+}
+
+export class SensitiveDataStudentProfileAPIOutDTO extends StudentProfileAPIOutDTO {


We probably have web dtos counterparts for these DTOs. Do they require any change also?

I don't think we should change the web. In the web we are using the same DTO for all cases:

and in runtime JS doesn't complain about it:

Institution

Student

I see ministry student profile has SIN to it. But we can use a seperate service in Vue with different DTO for ministry and student.

then shouldn't we make sin as optional in web?

I believe that the below one can reflect both possible DTOs received from the API.

SIMS/sources/packages/web/src/services/http/StudentApi.ts

Lines 46 to 52 in 43ca26b

async getStudentProfile(

studentId?: number,

): Promise<StudentProfileAPIOutDTO> {

return this.getCall<StudentProfileAPIOutDTO>(

this.addClientRoot(`student/${studentId ?? ""}`),

);

}

The service is already returning a StudentProfile that can have optional properties like SIN, as @ann-aot mentioned.

SIMS/sources/packages/web/src/services/StudentService.ts

Lines 52 to 62 in 43ca26b

async getStudentProfile(studentId?: number): Promise<StudentProfile> {

const { dateOnlyLongString } = useFormatters();

const studentProfile = await ApiClient.Students.getStudentProfile(

studentId,

);

const studentInfoAll: StudentProfile = {

...studentProfile,

birthDateFormatted: dateOnlyLongString(studentProfile.dateOfBirth),

};

return studentInfoAll;

}

The StudentProfile would be something like below.

export interface StudentProfile extends StudentProfileAPIOutDTO { birthDateFormatted: string; sin?: string; hasRestriction?: boolean; }

Does it make sense?

sources/packages/backend/apps/api/src/route-controllers/student/student.controller.service.ts

guru-aot

LGTM, nice work @andrepestana-aot

sources/packages/backend/apps/api/src/route-controllers/student/student.controller.service.ts

sh16011993 · 2023-09-26T23:59:46Z

sources/packages/backend/apps/api/src/route-controllers/student/student.aest.controller.ts

@@ -242,13 +242,18 @@ export class StudentAESTController extends BaseController {
    @Param("studentId", ParseIntPipe) studentId: number,
  ): Promise<AESTStudentProfileAPIOutDTO> {
    const [student, studentRestrictions] = await Promise.all([
-      this.studentControllerService.getStudentProfile(studentId),
+      this.studentControllerService.getStudentProfile(studentId, {
+        withSensitiveData: true,


sh16011993

Nice work. 👍

sonarqubecloud · 2023-09-27T19:25:07Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

github-actions · 2023-09-27T19:26:36Z

Backend Unit Tests Coverage Report

Totals
Statements:	17.44% ( 2205 / 12643 )
Methods:	8.1% ( 129 / 1593 )
Lines:	20.18% ( 1932 / 9573 )
Branches:	9.75% ( 144 / 1477 )

github-actions · 2023-09-27T19:27:29Z

E2E Queue Consumers Coverage Report

Totals
Statements:	74.93% ( 514 / 686 )
Methods:	67.47% ( 56 / 83 )
Lines:	76.96% ( 451 / 586 )
Branches:	41.18% ( 7 / 17 )

github-actions · 2023-09-27T19:27:32Z

E2E Workflow Workers Coverage Report

Totals
Statements:	46.73% ( 300 / 642 )
Methods:	40% ( 32 / 80 )
Lines:	51.02% ( 251 / 492 )
Branches:	24.29% ( 17 / 70 )

github-actions · 2023-09-27T19:34:26Z

E2E SIMS API Coverage Report

Totals
Statements:	54.9% ( 4025 / 7331 )
Methods:	51.89% ( 493 / 950 )
Lines:	59.74% ( 3269 / 5472 )
Branches:	28.93% ( 263 / 909 )

sources/packages/web/src/components/common/students/StudentProfile.vue

andrewsignori-aot

Thanks for making the changes and for the discussions. Looks good 👍

ann-aot

Thanks @andrepestana-aot for doing the changes and for the info 👍

dheepak-aot

Thanks for doing the changes 👍

initial commit

94ec083

andrepestana-aot self-assigned this Sep 26, 2023

andrepestana-aot added Student Student Features SIMS-Api SIMS-Api labels Sep 26, 2023

andrepestana-aot marked this pull request as ready for review September 26, 2023 20:27

andrepestana-aot requested review from dheepak-aot, sh16011993, andrewsignori-aot, guru-aot, ann-aot and JasonCTang September 26, 2023 20:27

andrewsignori-aot reviewed Sep 26, 2023

View reviewed changes

sources/packages/backend/apps/api/src/route-controllers/student/student.aest.controller.ts Outdated Show resolved Hide resolved

andrewsignori-aot reviewed Sep 26, 2023

View reviewed changes

andrepestana-aot added 2 commits September 26, 2023 14:44

added comment for options

678cea2

overloaded method

d4b9a88

andrewsignori-aot reviewed Sep 26, 2023

View reviewed changes

sources/packages/backend/apps/api/src/route-controllers/student/student.controller.service.ts Outdated Show resolved Hide resolved

andrepestana-aot added 2 commits September 26, 2023 15:29

removed unused import

10949e5

change option property type

602406a

guru-aot approved these changes Sep 26, 2023

View reviewed changes

ann-aot reviewed Sep 26, 2023

View reviewed changes

sources/packages/backend/apps/api/src/route-controllers/student/student.controller.service.ts Show resolved Hide resolved

sh16011993 reviewed Sep 26, 2023

View reviewed changes

sh16011993 approved these changes Sep 27, 2023

View reviewed changes

andrepestana-aot added 2 commits September 27, 2023 09:42

created a dto for institution

5e38ac3

changed web to reflect the API DTOs

5ac172f

ann-aot reviewed Sep 27, 2023

View reviewed changes

sources/packages/web/src/components/common/students/StudentProfile.vue Show resolved Hide resolved

andrewsignori-aot approved these changes Sep 27, 2023

View reviewed changes

ann-aot approved these changes Sep 27, 2023

View reviewed changes

dheepak-aot approved these changes Sep 27, 2023

View reviewed changes

andrepestana-aot merged commit 6d79135 into main Sep 27, 2023

andrepestana-aot deleted the 1910_api_student_profile_returns_sin branch September 27, 2023 21:19

andrepestana-aot temporarily deployed to DEV September 27, 2023 21:33 — with GitHub Actions Inactive

andrepestana-aot temporarily deployed to DEV September 27, 2023 21:35 — with GitHub Actions Inactive

andrepestana-aot temporarily deployed to DEV September 27, 2023 21:37 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#1910 - Student profile returns SIN #2354

#1910 - Student profile returns SIN #2354

andrepestana-aot commented Sep 26, 2023 •

edited

Loading

andrewsignori-aot Sep 26, 2023

andrepestana-aot Sep 26, 2023

dheepak-aot Sep 26, 2023 •

edited

Loading

ann-aot Sep 26, 2023 •

edited

Loading

andrewsignori-aot Sep 26, 2023 •

edited

Loading

guru-aot left a comment

sh16011993 Sep 26, 2023

sh16011993 left a comment

sonarqubecloud bot commented Sep 27, 2023

github-actions bot commented Sep 27, 2023

github-actions bot commented Sep 27, 2023

github-actions bot commented Sep 27, 2023

github-actions bot commented Sep 27, 2023

andrewsignori-aot left a comment

ann-aot left a comment

dheepak-aot left a comment •

edited

Loading

	async getStudentProfile(
	studentId?: number,
	): Promise<StudentProfileAPIOutDTO> {
	return this.getCall<StudentProfileAPIOutDTO>(
	this.addClientRoot(`student/${studentId ?? ""}`),
	);
	}

	async getStudentProfile(studentId?: number): Promise<StudentProfile> {
	const { dateOnlyLongString } = useFormatters();
	const studentProfile = await ApiClient.Students.getStudentProfile(
	studentId,
	);
	const studentInfoAll: StudentProfile = {
	...studentProfile,
	birthDateFormatted: dateOnlyLongString(studentProfile.dateOfBirth),
	};
	return studentInfoAll;
	}

#1910 - Student profile returns SIN #2354

#1910 - Student profile returns SIN #2354

Conversation

andrepestana-aot commented Sep 26, 2023 • edited Loading

Student view

Institution view

Ministry view

andrewsignori-aot Sep 26, 2023

Choose a reason for hiding this comment

andrepestana-aot Sep 26, 2023

Choose a reason for hiding this comment

dheepak-aot Sep 26, 2023 • edited Loading

Choose a reason for hiding this comment

ann-aot Sep 26, 2023 • edited Loading

Choose a reason for hiding this comment

andrewsignori-aot Sep 26, 2023 • edited Loading

Choose a reason for hiding this comment

guru-aot left a comment

Choose a reason for hiding this comment

sh16011993 Sep 26, 2023

Choose a reason for hiding this comment

sh16011993 left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Sep 27, 2023

github-actions bot commented Sep 27, 2023

Backend Unit Tests Coverage Report

github-actions bot commented Sep 27, 2023

E2E Queue Consumers Coverage Report

github-actions bot commented Sep 27, 2023

E2E Workflow Workers Coverage Report

github-actions bot commented Sep 27, 2023

E2E SIMS API Coverage Report

andrewsignori-aot left a comment

Choose a reason for hiding this comment

ann-aot left a comment

Choose a reason for hiding this comment

dheepak-aot left a comment • edited Loading

Choose a reason for hiding this comment

andrepestana-aot commented Sep 26, 2023 •

edited

Loading

dheepak-aot Sep 26, 2023 •

edited

Loading

ann-aot Sep 26, 2023 •

edited

Loading

andrewsignori-aot Sep 26, 2023 •

edited

Loading

dheepak-aot left a comment •

edited

Loading