#2183 - Queued Assessments - Assessment Gateway Changes #2245
Conversation
This file contains 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
andrewsignori-aot
requested review from
ann-aot,
andrepestana-aot,
dheepak-aot,
sh16011993,
guru-aot and
JasonCTang
Comment on lines
75
to
93
| if (!assessment.assessmentWorkflowId) { | ||
| // Assessment is available to be associated with the workflow instance id. | ||
| await assessmentRepo.update(assessmentId, { assessmentWorkflowId }); | ||
| const now = new Date(); | ||
| await assessmentRepo.update(assessmentId, { | ||
| assessmentWorkflowId, | ||
| studentAssessmentStatus: StudentAssessmentStatus.InProgress, | ||
| studentAssessmentStatusUpdatedOn: now, | ||
| modifier: auditUser, | ||
| updatedAt: now, | ||
| }); | ||
| return; | ||
| } | ||
| if (assessment.assessmentWorkflowId !== assessmentWorkflowId) { | ||
| throw new CustomNamedError( | ||
| `The assessment is already associated with another workflow instance. Current associated instance id ${assessment.assessmentWorkflowId}.`, | ||
| ASSESSMENT_INVALID_OPERATION_IN_THE_CURRENT_STATE, | ||
| ASSESSMENT_ALREADY_ASSOCIATED_WITH_DIFFERENT_WORKFLOW, | ||
| ); | ||
| } | ||
| // The workflow was already associated with the workflow, no need to update it again. |
There was a problem hiding this comment.
I was wondering if this part could refactored to put all the validations before the association like in:
There was a problem hiding this comment.
I guess so, I will take a look 😉
There was a problem hiding this comment.
Method refactored, please take a look 😉
| * in the format "Message (ERROR_CODE).". | ||
| * @returns user friendly error message. | ||
| */ | ||
| getSummaryMessage() { |
dheepak-aot
reviewed
Sep 1, 2023
| // Check if the assessment is in one of the initial statuses. Any status different than "Submitted" and "Queued" should | ||
| // cancel the workflow because there is no point executing it. | ||
| // A workflow in these statuses can be associated and updated to "In progress" nicely. The expectation is that it would | ||
| // be primarily "Queued" but there is no harm in allowing "Submitted" also. |
There was a problem hiding this comment.
Considering submitted here is to keep the option of starting the assessments manually for any troubleshooting purpose if required right?
There was a problem hiding this comment.
Yes, you are right. The concern here was more about not allowing the association to other statuses.
dheepak-aot
reviewed
Sep 1, 2023
| * in the format "Message (ERROR_CODE).". | ||
| * @returns user friendly error message. | ||
| */ | ||
| getSummaryMessage() { |
There was a problem hiding this comment.
return type to signature?
There was a problem hiding this comment.
Added the return type.
|
Nice work @andrewsignori-aot . Minor comment and a clarification. |
ann-aot
reviewed
Sep 1, 2023
| job.variables.assessmentId, | ||
| job.processInstanceKey, | ||
| ); | ||
| jobLogger.log("Associated the assessment id."); | ||
| logger.log("Associated the assessment id."); |
There was a problem hiding this comment.
do we need to update the log content too?
There was a problem hiding this comment.
I changed as below to add more context too.
ann-aot
reviewed
Sep 1, 2023
| @@ -102,7 +102,7 @@ export class DisbursementController { | |||
| await this.disbursementScheduleService.associateMSFAANumber( | |||
| job.variables.assessmentId, | |||
| ); | |||
| jobLogger.error("Associated the MSFAA number to the disbursements."); | |||
| jobLogger.log("Associated the MSFAA number to the disbursements."); | |||
ann-aot
reviewed
Sep 1, 2023
| throw new CustomNamedError( | ||
| `The assessment is already associated with another workflow instance. Current associated instance id ${assessment.assessmentWorkflowId}.`, | ||
| ASSESSMENT_INVALID_OPERATION_IN_THE_CURRENT_STATE, | ||
| `The assessment is already associated to the workflow.`, |
ann-aot
reviewed
Sep 1, 2023
| workflowData, | ||
| studentAssessmentStatus: StudentAssessmentStatus.Completed, | ||
| studentAssessmentStatusUpdatedOn: now, | ||
| modifier: auditUser, |
ann-aot
approved these changes
Sep 1, 2023
There was a problem hiding this comment.
LGTM 👍 Good work @andrewsignori-aot . approving the PR as the added comments are very minor
guru-aot
approved these changes
Sep 1, 2023
andrepestana-aot
approved these changes
Sep 1, 2023
|
Kudos, SonarCloud Quality Gate passed!
|
Backend Unit Tests Coverage Report
|
E2E Workflow Workers Coverage Report
|
E2E Queue Consumers Coverage Report
|
E2E SIMS API Coverage Report
|
andrewsignori-aot
deleted the
feature/#2183-queued-assessments-assessment-gateway-changes
branch
andrewsignori-aot
temporarily deployed
to
DEV
GitHub Actions
Inactive
andrewsignori-aot
temporarily deployed
to
DEV
GitHub Actions
Inactive
andrewsignori-aot
temporarily deployed
to
DEV
GitHub Actions
Inactive
andrewsignori-aot
temporarily deployed
to
DEV
GitHub Actions
Inactive
andrewsignori-aot
temporarily deployed
to
DEV
GitHub Actions
Inactive
andrewsignori-aot
temporarily deployed
to
DEV
GitHub Actions
Inactive
andrewsignori-aot
temporarily deployed
to
DEV
GitHub Actions
Inactive
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.
associateWorkflowIdtoassociateWorkflowInstanceto include the part of the process to update the status to "In progress".associateWorkflowInstancefrom being executed with an unexpected status (see comments in code).wrap up task.CustomNamedError.