#1834 - Service task identifier for subprocesses #1842
Conversation
andrewsignori-aot
added
E2E/Unit tests
Camunda Worflow
andrewsignori-aot
changed the title
andrewsignori-aot
requested review from
dheepak-aot,
guru-aot,
ann-aot,
andrepestana-aot,
JasonCTang and
sh16011993
|
The e2e test cases for assessment gatewat for program year 2021-2022 is removed. Is that because those years are no longer used and its just a duplication? |
...workflow/test/2021-2022/assessment-gateway/assessment-gateway.originalAssessment.e2e-spec.ts
Outdated
Show resolved
Hide resolved
...workflow/test/2023-2024/assessment-gateway/assessment-gateway.originalAssessment.e2e-spec.ts
Show resolved
Hide resolved
| WorkflowSubprocesses.PartnerIncomeVerification, | ||
| WorkflowSubprocesses.RetrieveSupportingInfoParent1, | ||
| WorkflowSubprocesses.Parent1IncomeVerification, | ||
| WorkflowSubprocesses.RetrieveSupportingInfoParent2, | ||
| WorkflowSubprocesses.Parent2IncomeVerification, | ||
| ); |
sources/packages/backend/workflow/test/test-utils/constants/system-configurations-constants.ts
Show resolved
Hide resolved
...orkflow/test/test-utils/mock/assessment-gateway/create-supporting-users-parents-task-mock.ts
Outdated
Show resolved
Hide resolved
| * @returns mock for the 'Load consolidated data' completed subprocess. | ||
| */ | ||
| export function createLoadAssessmentConsolidatedDataMock(options: { | ||
| assessmentConsolidatedData: AssessmentConsolidatedData; |
| const assessmentConsolidatedData: AssessmentConsolidatedData = { | ||
| assessmentTriggerType: AssessmentTriggerType.OriginalAssessment, | ||
| ...createFakeConsolidatedFulltimeData(PROGRAM_YEAR), | ||
| ...createParentsData({ numberOfParents: 2 }), |
There was a problem hiding this comment.
I know this way works, but the supporting user parent data must be returned by the following worker and not the load-assessment-consolidated data right?
There was a problem hiding this comment.
I believe that there is confusion here. The service task above has specific mocked data to return its data.
The assumption that parent data is returned by the workflow in the picture is not correct.
All the data (I mean, all the data) to process an assessment (and reassessments) is returned in the consolidated data.
Keep in mind that the reassessment does not go down this path and if this was the workflow responsible for loading the parent's data the reassessment would never have supporting users' data.
Please let me know If it is clear or if I am missing something.
There was a problem hiding this comment.
Great work @andrewsignori-aot 👍 . Added some minor comments. I believe I got the idea, let me know if you planning to do a walkthrough, I would also like to join, to cover up in case I miss something.
|
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
|
| serviceTasks.forEach((serviceTask) => { | ||
| expect(workflowResultVariables[serviceTask]).toBeUndefined; | ||
| expectedTasks.forEach((expectedTask) => { | ||
| expect(workflowResultVariables[expectedTask]).toBeUndefined(); |
| * @param assessmentConsolidatedData assessment consolidated data. | ||
| * @returns mock for the 'Load consolidated data' completed subprocess. | ||
| */ | ||
| export function createLoadAssessmentConsolidatedDataMock(options: { |
There was a problem hiding this comment.
is options not optional ?. May be assessmentConsolidatedData not one of the options?
|
Great work and thanks for the walkthrough. In github actions I saw these logs which I haven't seen before.
Still have doubts on about #1842 (comment) and we can talk to get my understanding better. |
| */ | ||
| export function createCheckSupportingUserResponseTaskMock(options: { | ||
| totalIncome: number; | ||
| subprocesses?: WorkflowSubprocesses; |
There was a problem hiding this comment.
My be we could name it subprocess as we not take an array.
| * Camunda variable name like service_task_id. | ||
| */ | ||
| function getNormalizedServiceTaskId(serviceTaskId: string) { | ||
| return serviceTaskId.replace( |
There was a problem hiding this comment.
I got the idea of camunda variables not allowed with -. Why cant we change the service task id to have underscore _instead of - as convention so that we can avoid this replace, and also when we create any task in modeler the default task id which is generated is with _ and not -.
There was a problem hiding this comment.
I would assume that if we will be changing the way that we are using the IDs we would be changing everywhere, not limited to only tasks, and also renaming the subprocesses calls.
We can do it but I do not believe that it would be the scope of this PR.
|
|
||
| /** | ||
| * Creates the mock for the 'Load consolidated data' completed subprocess. | ||
| * @param assessmentConsolidatedData assessment consolidated data. |
| */ | ||
| export function createMockedWorkerResult( | ||
| serviceTaskId: WorkflowServiceTasks, | ||
| options: { |
There was a problem hiding this comment.
Shouldn't options be optional?
There was a problem hiding this comment.
For this options is not optional because ideally one of the three parameters should be provided.
| if (options?.subprocesses?.length) { | ||
| fullServiceTaskId = [...options.subprocesses, fullServiceTaskId].join( | ||
| MOCKS_SEPARATOR, | ||
| ); | ||
| } | ||
| const mockedWorkerResult: Record<string, unknown> = {}; | ||
| if (options.jobCompleteMock) { |
There was a problem hiding this comment.
Either options is optional and we do the check with "?" or we don't need to check for null.
There was a problem hiding this comment.
Is this a comment for line 164?
For line 164 options will not be null but options.jobCompleteMock can be null.
The comment would make sense for line 158 where we can have it as if (options.subprocesses?.length). Make sense?
| totalIncome: options.totalIncome, | ||
| }, | ||
| subprocesses: [options?.subprocesses], |
There was a problem hiding this comment.
There was a problem hiding this comment.
Great work @andrewsignori-aot . Thanks for doing the changes and working on organizing the structure 👍
andrewsignori-aot
deleted the
feature/#1834-service-task-identifier-sub-process
branch
Test cases enabled
To provide complete support for mocking the workers, and allowing the workflow to be tested including the subprocesses, some scenarios from parents were used. As part of this PR the below scenarios were enabled:
Single Mocked Worker
Created a single mocked worker method to return the job completed object and also publish messages needed to unblock the workflow.
While creating the mocked result for a worker, it is possible to specify the object to be returned to Camunda and also configure 1 to n messages that must be published to unblock the workflow. As shown below, the
cra-integration-income-verificationneeds to be completed using 3 mocked objects created using 2 helpers.Create income requestmust have some data returned;Create income requestis completed, the workflow must receive a message, also mocked and shown on the below message.incomeVerificationCompleted as trueto proceed.Validation/Asserts
Examples of variables available on the workflow to perform the validations related to the flow path
expectToPassThroughServiceTasksandexpectNotToPassThroughServiceTasks.{ "program-info-not-required-task": "program-info-not-required-task", "associate-workflow-instance-task": "associate-workflow-instance-task", "update-noa-status-to-required-task": "update-noa-status-to-required-task", "verify-application-exceptions-task": "verify-application-exceptions-task", "parent1IncomeVerificationSubprocess": "parent1IncomeVerificationSubprocess", "parent2IncomeVerificationSubprocess": "parent2IncomeVerificationSubprocess", "studentIncomeVerificationSubprocess": "studentIncomeVerificationSubprocess", "retrieveSupportingInfoParent1Subprocess": "retrieveSupportingInfoParent1Subprocess", "retrieveSupportingInfoParent2Subprocess": "retrieveSupportingInfoParent2Subprocess", }The value that indicates if the service task or subprocess was changed from
trueto thestringabove makes it easier to identify which validation failed, as shown below.Camunda bpmn configurations for subprocess identification
Sample mocked start event data
Scenario:
{ "bpmnProcessId": "assessment-gateway", "variables": { "assessmentId": 2000, "load_assessment_data_task_result": { "data_removed_to_make_it_short": "Original assessment", }, "verify_application_exceptions_task_result": { "applicationExceptionStatus": "Approved" }, "create_supporting_users_for_parents_task_result": { "createdSupportingUsersIds": [ 2000, 2001 ] }, "create_supporting_users_for_parents_task_messageResult": [ { "name": "supporting-user-info-received", "correlationKey": "2000", "variables": {}, "timeToLive": { "type": "SECONDS", "value": 5, "valueType": "TYPED_DURATION", "unit": "s" } }, { "name": "supporting-user-info-received", "correlationKey": "2001", "variables": {}, "timeToLive": { "type": "SECONDS", "value": 5, "valueType": "TYPED_DURATION", "unit": "s" } } ], "retrieveSupportingInfoParent1Subprocess_check_supporting_user_response_task_result": { "totalIncome": 1 }, "retrieveSupportingInfoParent2Subprocess_check_supporting_user_response_task_result": { "totalIncome": 1 }, "studentIncomeVerificationSubprocess_create_income_request_task_result": { "incomeVerificationCompleted": true, "incomeVerificationId": 2000 }, "studentIncomeVerificationSubprocess_create_income_request_task_messageResult": [ { "name": "income-verified", "correlationKey": "2000", "variables": {}, "timeToLive": { "type": "SECONDS", "value": 5, "valueType": "TYPED_DURATION", "unit": "s" } } ], "parent1IncomeVerificationSubprocess_create_income_request_task_result": { "incomeVerificationCompleted": true, "incomeVerificationId": 2001 }, "parent1IncomeVerificationSubprocess_create_income_request_task_messageResult": [ { "name": "income-verified", "correlationKey": "2001", "variables": {}, "timeToLive": { "type": "SECONDS", "value": 5, "valueType": "TYPED_DURATION", "unit": "s" } } ], "parent2IncomeVerificationSubprocess_create_income_request_task_result": { "incomeVerificationCompleted": true, "incomeVerificationId": 2002 }, "parent2IncomeVerificationSubprocess_create_income_request_task_messageResult": [ { "name": "income-verified", "correlationKey": "2002", "variables": {}, "timeToLive": { "type": "SECONDS", "value": 5, "valueType": "TYPED_DURATION", "unit": "s" } } ], "studentIncomeVerificationSubprocess_check_income_request_task_result": { "incomeVerificationCompleted": true }, "parent1IncomeVerificationSubprocess_check_income_request_task_result": { "incomeVerificationCompleted": true }, "parent2IncomeVerificationSubprocess_check_income_request_task_result": { "incomeVerificationCompleted": true } }, "requestTimeout": 90000 }Variable names were adapted trying to follow Camunda recommendations for variables names: https://docs.camunda.io/docs/components/concepts/variables/#variable-names