Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#4281 - SDPR API - Student search result - Student details #4376

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

dheepak-aot
Copy link
Collaborator

@dheepak-aot dheepak-aot commented Feb 21, 2025

PR Scope

  1. Student external search result - Student details from SIMS and SFAS
  2. Update E2E Test token helper
  3. E2E tests for external controller

Student search result - Student details

  • Updated the existing external API to return Student details(Application details is hardcoded and will be implemented in upcoming PR) from SIMS and SFAS.
  • Created StudentInformationService to get all student related information details based on both SIMS and SFAS.

E2E Test Helpers

  • Updated the E2E test helpers with an option to provide client id and client secret to obtain the token.
  • Created a helper method to get external token.
  • Created a new Repository secret that will be used by E2E tests for external controller.

E2E Tests

  • Created E2E tests for the external controller.

image

Upcoming PR

  • Return FT application details in student search result.
  • E2E tests for application data.

@dheepak-aot dheepak-aot self-assigned this Feb 21, 2025
@dheepak-aot dheepak-aot added the SIMS-Api SIMS-Api label Feb 21, 2025
Copy link

Backend Unit Tests Coverage Report

Totals Coverage
Statements: 22.08% ( 3928 / 17791 )
Methods: 9.93% ( 226 / 2276 )
Lines: 25.44% ( 3394 / 13340 )
Branches: 14.16% ( 308 / 2175 )

Copy link

E2E Workflow Workers Coverage Report

Totals Coverage
Statements: 65.59% ( 589 / 898 )
Methods: 59.63% ( 65 / 109 )
Lines: 68.72% ( 468 / 681 )
Branches: 51.85% ( 56 / 108 )

Copy link

E2E Queue Consumers Coverage Report

Totals Coverage
Statements: 85.28% ( 1425 / 1671 )
Methods: 83.33% ( 160 / 192 )
Lines: 87.7% ( 1177 / 1342 )
Branches: 64.23% ( 88 / 137 )

Copy link

E2E SIMS API Coverage Report

Totals Coverage
Statements: 70.3% ( 6356 / 9041 )
Methods: 67.71% ( 782 / 1155 )
Lines: 73.94% ( 4955 / 6701 )
Branches: 52.24% ( 619 / 1185 )

@dheepak-aot dheepak-aot marked this pull request as ready for review February 24, 2025 04:03
@@ -0,0 +1,99 @@
import { AddressAPIOutDTO } from "../../models/common.dto";
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please import it from the index.

import { AddressAPIOutDTO } from "../..";

Comment on lines +63 to +67
// If the student is found in SIMS, return the student details.
// Otherwise, return the legacy student details.
const studentDetails = student
? this.transformStudentDetails(student)
: this.transformLegacyStudentDetails(sfasIndividual);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a temporary solution or is it already the final approach to return student data?
I was assuming that the entire dataset of student + application data (a single query) would be executed (in parallel), targeting SIMS data and SFAS data. From the complete result of these two queries a "merge" would happen.
Is the idea that sfasIndividualPromise and studentPromise will be expanded?

* @param student student.
* @returns student details.
*/
private transformStudentDetails(student: Student): StudentDetails {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For my understanding, will these transform methods be moved into some service to keep the controller "clean" in some upcoming PR?

Copy link
Collaborator

@andrewsignori-aot andrewsignori-aot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work and thanks for enabling the secret auth for E2Es. Please take a look at the comments, mostly questions for clarification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants