#3815 - Identification of changed information during edit #4221

andrewsignori-aot · 2025-01-09T20:45:22Z

New method `compareApplicationData`

Created a new helper method with the sole intention of executing the comparison between two application dynamic data JSONB data.
- The method will detect changes as below
  - Added/removed/updated properties
  - Added/removed array items
- Used JSON.stringify a simple solution to perform a deep equality between two objects. During the tests, the comparison of two part-time applications took less than a millisecond to execute.
- Method created at lib level to allow its usage in future comparison in application data by other apps than API.

Form.io considerations

The Form.io event render was used instead of load because the lists are not fully created right after the loading stage which means that not all the children will be present to have the highlight style applied.
Form.io component tree for lists contains only the "first child" and the regular document.getElementById was used to ensure that a child component in a list would receive the highlight style.

Other changes

Adjusted the Ministry controller to execute the application data comparison in the application read-only versions that is the data being displayed to the users where the changes should be detected.
Note: The compareApplicationData would also be able to detect changes in the non-read-only application dynamic data.

Sample API result

[
    {
        "key": "dependants",
        "changeType": "itemsRemoved",
        "changes": [
            {
                "index": 0,
                "changeType": "updated",
                "changes": [
                    {
                        "key": "fullName",
                        "changeType": "updated"
                    },
                    {
                        "key": "dateOfBirth",
                        "changeType": "updated"
                    }
                ]
            }
        ]
    },
    {
        "key": "citizenship",
        "changeType": "updated"
    },
    {
        "key": "courseDetails",
        "changeType": "updated",
        "changes": [
            {
                "index": 1,
                "changeType": "updated",
                "changes": [
                    {
                        "key": "courseCode",
                        "changeType": "updated"
                    },
                    {
                        "key": "courseStartDate",
                        "changeType": "updated"
                    }
                ]
            }
        ]
    },
    {
        "key": "studentNumber",
        "changeType": "updated"
    },
    {
        "key": "studentHomeAddress",
        "changeType": "updated"
    },
    {
        "key": "applicationPDPPDStatus",
        "changeType": "updated"
    },
    {
        "key": "hasSignificantDegreeOfIncome",
        "changeType": "updated"
    },
    {
        "key": "partTimeAwardTypesToBeConsidered",
        "changeType": "updated"
    },
    {
        "key": "reasonsignificantdecreaseInIncome",
        "changeType": "updated"
    },
    {
        "key": "decreaseInIncomeSupportingDocuments",
        "changeType": "itemsRemoved"
    },
    {
        "key": "currentYearIncomeApplicationException",
        "changeType": "updated"
    },
    {
        "key": "selectedLocationName",
        "changeType": "updated"
    },
    {
        "key": "selectedOfferingName",
        "changeType": "updated"
    }
]

Sample UI Changes

Non-PR-related changes

Added a new option for VS Code debug Unit tests - Current test file following the same idea from other available.
Extracted the jest configurations from packages.json and moved to a file to allow the reference using the --config while executing the npm commands, following the same idea from the E2E tests.

andrewsignori-aot · 2025-01-10T00:59:46Z

sources/packages/backend/jest-unit-tests.json

No changes in these configurations, they were extracted from the packages.json as they were.

dheepak-aot · 2025-01-10T22:32:54Z

.vscode/launch.json

+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Unit tests - Current test file",


sources/packages/backend/apps/api/src/services/application/application.service.ts

guru-aot · 2025-01-10T23:46:03Z

...s/packages/backend/apps/api/src/route-controllers/application/application.aest.controller.ts

+        );
+      // If there is a previous application, generate its read-only data.
+      const previousReadOnlyDataPromise =
+        previousApplicationVersion &&


...ackages/backend/apps/api/src/route-controllers/application/application.controller.service.ts

guru-aot · 2025-01-10T23:55:09Z

...ackages/backend/apps/api/src/route-controllers/application/application.controller.service.ts

+      const dataChangeDTO: ApplicationDataChangeAPIOutDTO = {
+        key: dataChange.key,
+        index: dataChange.index,
+        changeType: dataChange.changeType,


Suggestion:

add changes to the const dataChangeDTO:

changes: dataChange.changes.length ? [] : undefined

and do the below changes,

I am not able to see the benefit. Would it be to improve the code readability or something else?
Unless there is a stronger reason I am keeping the current way.

...ackages/backend/apps/api/src/route-controllers/application/application.controller.service.ts

dheepak-aot · 2025-01-13T18:58:39Z

sources/packages/web/src/views/aest/StudentApplicationView.vue

@@ -16,6 +16,7 @@
      {{ emptyStringFiller(applicationDetail.applicationNumber) }}
    </h2>
    <StudentApplication
+      @render="formRender"


sources/packages/web/src/views/aest/StudentApplicationView.vue

dheepak-aot · 2025-01-13T19:15:25Z

sources/packages/web/src/views/aest/StudentApplicationView.vue

+      if (
+        component.type === FromIOComponentTypes.Hidden ||
+        component._visible === false


sources/packages/web/src/views/aest/StudentApplicationView.vue

sources/packages/web/src/composables/useFormioUtils.ts

dheepak-aot · 2025-01-13T20:46:04Z

sources/packages/web/src/assets/css/formio-shared.scss

+
+.changed-value::before {
+  @extend .changed-value-content-base;
+  content: "\00a0\00a0Updated";


What is this \00a0\00a0 ?

Just to add some white space.

Can you try like this ?

content: " Updated"; white-space: pre;

It looks better, I did the change 😉

dheepak-aot · 2025-01-13T20:50:43Z

Great work @andrewsignori-aot and thanks for the walkthrough. I see that almost all the comments are addressed. Only one question and clarification there now.

dheepak-aot

Thanks for doing the changes. 👍Great work.

sonarqubecloud · 2025-01-13T22:36:23Z

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 · 2025-01-13T22:37:17Z

Backend Unit Tests Coverage Report

Totals
Statements:	22.49% ( 3850 / 17122 )
Methods:	10.37% ( 224 / 2161 )
Lines:	25.88% ( 3322 / 12837 )
Branches:	14.31% ( 304 / 2124 )

github-actions · 2025-01-13T22:37:39Z

E2E Workflow Workers Coverage Report

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

github-actions · 2025-01-13T22:39:59Z

E2E Queue Consumers Coverage Report

Totals
Statements:	86.14% ( 1249 / 1450 )
Methods:	82.42% ( 136 / 165 )
Lines:	88.51% ( 1032 / 1166 )
Branches:	68.07% ( 81 / 119 )

github-actions · 2025-01-13T22:43:09Z

E2E SIMS API Coverage Report

Totals
Statements:	67.77% ( 5992 / 8842 )
Methods:	65.54% ( 738 / 1126 )
Lines:	71.62% ( 4695 / 6555 )
Branches:	48.15% ( 559 / 1161 )

guru-aot

LGTM, nice and great work @andrewsignori-aot

andrewsignori-aot added 7 commits January 7, 2025 17:51

Detecting changes and testing UI

3ad2b33

Changes detection working close to expected

ece7202

Adjusting read-only

45d09ac

Adjusted comparison for read-only

d969f2e

Code refactor for PR preparation

ddc7a3d

Enabled debug for unit tests

5012f57

Added unit tests and DTO conversion

20f09e9

andrewsignori-aot added the Ministry Ministry Features label Jan 9, 2025

andrewsignori-aot self-assigned this Jan 9, 2025

andrewsignori-aot changed the title ~~#3815 - Detect application changes~~ #3815 - Identification of changed information during edit Jan 9, 2025

andrewsignori-aot added Web portal SIMS-Api SIMS-Api labels Jan 9, 2025

andrewsignori-aot added 5 commits January 9, 2025 14:18

E2E tests

d7ec513

Sonarcloud issues

168f042

Reused method from another open PR

5c39f11

Allow changes array to be null

ea1c3e8

Removed empty arrays from API result

1648afd

andrewsignori-aot commented Jan 10, 2025

View reviewed changes

andrewsignori-aot added 4 commits January 10, 2025 08:33

Minor unit test renaming

094f568

Fix E2E test result

69a87f3

Pre-review adjustments

19be56b

Fix highlight logic

4356d2d

andrewsignori-aot marked this pull request as ready for review January 10, 2025 19:40

dheepak-aot self-requested a review January 10, 2025 21:29

dheepak-aot reviewed Jan 10, 2025

View reviewed changes

.vscode/launch.json

{

"type": "node",

"request": "launch",

"name": "Unit tests - Current test file",

Copy link

Collaborator

dheepak-aot Jan 10, 2025

Choose a reason for hiding this comment

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

👍

guru-aot self-requested a review January 10, 2025 22:50

guru-aot reviewed Jan 10, 2025

View reviewed changes

sources/packages/backend/apps/api/src/services/application/application.service.ts Show resolved Hide resolved

guru-aot reviewed Jan 10, 2025

View reviewed changes

...ackages/backend/apps/api/src/route-controllers/application/application.controller.service.ts Outdated Show resolved Hide resolved

dheepak-aot reviewed Jan 13, 2025

View reviewed changes

sources/packages/web/src/views/aest/StudentApplicationView.vue Outdated Show resolved Hide resolved

dheepak-aot reviewed Jan 13, 2025

View reviewed changes

sources/packages/web/src/views/aest/StudentApplicationView.vue Outdated Show resolved Hide resolved

andrewsignori-aot added 3 commits January 13, 2025 11:29

Unit test for itemsAppended and PR comment fix

69dad6b

E2E fix

524fe44

PR review fixes

a88feb5

dheepak-aot reviewed Jan 13, 2025

View reviewed changes

sources/packages/web/src/composables/useFormioUtils.ts Show resolved Hide resolved

dheepak-aot reviewed Jan 13, 2025

View reviewed changes

PR review comment

4039fb6

dheepak-aot approved these changes Jan 13, 2025

View reviewed changes

CSS improvement as Dheepak's suggestion

a9f371a

guru-aot approved these changes Jan 13, 2025

View reviewed changes

andrewsignori-aot added this pull request to the merge queue Jan 13, 2025

Merged via the queue into main with commit c07806b Jan 13, 2025
21 checks passed

andrewsignori-aot temporarily deployed to DEV January 13, 2025 23:18 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV January 13, 2025 23:20 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV January 13, 2025 23:22 — with GitHub Actions Inactive

andrewsignori-aot deleted the feature/#3815-detect-application-changes branch January 14, 2025 01:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#3815 - Identification of changed information during edit #4221

#3815 - Identification of changed information during edit #4221

andrewsignori-aot commented Jan 9, 2025 •

edited

Loading

andrewsignori-aot Jan 10, 2025

dheepak-aot Jan 10, 2025

guru-aot Jan 10, 2025

guru-aot Jan 10, 2025

andrewsignori-aot Jan 13, 2025

dheepak-aot Jan 13, 2025

dheepak-aot Jan 13, 2025

dheepak-aot Jan 13, 2025

andrewsignori-aot Jan 13, 2025

dheepak-aot Jan 13, 2025 •

edited

Loading

andrewsignori-aot Jan 13, 2025

dheepak-aot commented Jan 13, 2025

dheepak-aot left a comment

sonarqubecloud bot commented Jan 13, 2025

github-actions bot commented Jan 13, 2025

github-actions bot commented Jan 13, 2025

github-actions bot commented Jan 13, 2025

github-actions bot commented Jan 13, 2025

guru-aot left a comment

#3815 - Identification of changed information during edit #4221

#3815 - Identification of changed information during edit #4221

Conversation

andrewsignori-aot commented Jan 9, 2025 • edited Loading

New method compareApplicationData

Form.io considerations

Other changes

Sample API result

Sample UI Changes

Non-PR-related changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dheepak-aot Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dheepak-aot commented Jan 13, 2025

dheepak-aot left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jan 13, 2025

Quality Gate passed

github-actions bot commented Jan 13, 2025

Backend Unit Tests Coverage Report

github-actions bot commented Jan 13, 2025

E2E Workflow Workers Coverage Report

github-actions bot commented Jan 13, 2025

E2E Queue Consumers Coverage Report

github-actions bot commented Jan 13, 2025

E2E SIMS API Coverage Report

guru-aot left a comment

Choose a reason for hiding this comment

andrewsignori-aot commented Jan 9, 2025 •

edited

Loading

New method `compareApplicationData`

dheepak-aot Jan 13, 2025 •

edited

Loading