Feature/cb2 10593 - update parseAdrDetails function by meys-bjss · Pull Request #78 · dvsa/cvs-tsk-update-store

meys-bjss · 2024-02-01T16:25:01Z

Description

Updating the update-store's parseAdrDetails functionality so that it parses the ADR Details attribute in a given tech record if the adrDetails attribute exists.

Related issue:
CB2-10593
CB2-10592

Useful links:
https://dvsa.atlassian.net/wiki/spaces/HVT/pages/382011842/ADR+Section
https://dvsa.atlassian.net/wiki/spaces/HVT/pages/494174610/SPIKE+Validate+existing+update-store+functionality+for+ADR

Before submitting (or marking as "ready for review")

Does the pull request title follow the conventional commit specification?
Have you performed a self-review of the code
Have you have added tests that prove the fix or feature is effective and working
Did you make sure to update any documentation relating to this change?

… adding in-line comments

…nit test added

Nat-McCabe-BJSS

Great work, very nice job at writing your own Typescript too, add it to your AMP 👀

Nat-McCabe-BJSS · 2024-02-06T11:18:55Z

tests/resources/Dockerfile

@@ -1,5 +1,5 @@
 # Match Aurora MySQL version as closely as possible
-FROM mysql:5.7.12
+FROM mysql:8.2.0


Are we OK to change this? I was just wondering if it's best to leave it as is and you just change the version locally

simontindallbjss · 2024-02-08T10:16:34Z

src/models/adr-details.ts

-  weight?: string;
-  compatibilityGroupJ?: boolean;
+  weight?: number;
+  newCertificateRequested?: boolean;


This is not required as it is a front end field for UX

Weight is listed as a number in ADR section, so I would presume that is required, it's how I've done it in Pydantic. CompatibilityGroupJ should still be listed though no? NewCertificateRequested is also in the ADR section documentation that should also be needed

@simontindallbjss, newCertificateRequested is removed from the final upsert function for now, so it wouldn't end up in NOP. we can always add it whenever needed. Note that all the attributes are defined as 'optional', so fine if they don't exist in the payload.

simontindallbjss · 2024-02-08T10:43:36Z

src/models/adr-details.ts

  documents?: string[];
-  permittedDangerousGoods?: string[];
-  additionalExaminerNotes?: string;
+  permittedDangerousGoods?: permittedDangerousGoodsEnum[];


ADR documentation states that this shouldn't be an enum in the backend due to the historic data containing erroneous values

As previously discussed with @reisedawson-bjss, at this stage, we are going to keep them as Enums. After the first round of remediation (hopefully in pre-prod), if this creates a massive issue, we can always turn them into
general "string" type.

simontindallbjss · 2024-02-08T10:44:42Z

src/models/adr-details.ts

  applicantDetails?: ApplicantDetails;
-  memosApply?: string[];
+  dangerousGoods?: boolean;
+  memosApply?: memosApplyEnum[];


ADR documentation states that this shouldn't be an enum in the backend due to the historic data containing erroneous values

Same as permittedDangerousGoodsEnum case

CompatibilityGroupJ query and enum typings need fixing

Nat-McCabe-BJSS · 2024-02-08T11:00:38Z

src/models/adr-details.ts

+// define AdrDetails' sub-attributes data types
 export interface VehicleDetails {
-  type?: string;
+  type?: VehicleDetailsTypeEnum;


Should be a string in the backend

Same as permittedDangerousGoodsEnum case

Nat-McCabe-BJSS · 2024-02-08T11:01:14Z

src/models/adr-details.ts

 export interface AdditionalNotes {
-  number?: string[];
-  guidanceNotes?: string[];
+  number?: additionalNotesNumberEnum[];


Should be array of strings in backend

simontindallbjss · 2024-02-08T11:37:46Z

src/models/adr-details.ts

+// define AdrDetails' sub-attributes data types
 export interface VehicleDetails {
-  type?: string;
+  type?: VehicleDetailsTypeEnum;


ADR documentation states that this shouldn't be an enum in the backend due to the historic data containing erroneous values

Same as permittedDangerousGoodsEnum case

simontindallbjss · 2024-02-08T11:38:21Z

src/models/adr-details.ts

 export interface AdditionalNotes {
-  number?: string[];
-  guidanceNotes?: string[];
+  number?: additionalNotesNumberEnum[];


ADR documentation states that this shouldn't be an enum in the backend due to the historic data containing erroneous values

Same as permittedDangerousGoodsEnum case

simontindallbjss · 2024-02-08T11:47:05Z

src/models/adr-details.ts

+  additionalExaminerNotes?: AdditionalExaminerNotes;
  applicantDetails?: ApplicantDetails;
-  memosApply?: string[];
+  dangerousGoods?: boolean;


This is not required as it is a front end field for UX

Same as newCertificateRequested case

Meys Torkaman added 5 commits January 26, 2024 13:56

rectifying data type mismatches, add un-defined Enums and attributes,…

5c0c30e

… adding in-line comments

add AdrCertificateDetails interface and parsing function

96b894e

adding guidanceNotes Enum

722ebfd

adding m145 attribute as per documentation change

f373b0a

feat: adr details added, test resource for technoical record added, u…

e8eb827

…nit test added

meys-bjss requested review from DanielFry-bjss, Nat-McCabe-BJSS, reisedawson and simontindallbjss February 1, 2024 16:25

meys-bjss changed the title ~~Feature/cb2 10593~~ Feature/cb2 10593 - update parseAdrDetails function Feb 1, 2024

meys-bjss requested review from me-matt and shivangidas February 1, 2024 16:29

Meys Torkaman added 5 commits February 2, 2024 10:07

style: rearrange enums

a5488b4

fix: replace ! with ? for optional attributes

e456415

fix: memosApplyEnum value updated

c9025ce

fix: 2 new attributes added to adrDetails, as per documentation

43ed027

fix: enum updated

3b20a99

shivangidas previously approved these changes Feb 5, 2024

View reviewed changes

Nat-McCabe-BJSS previously approved these changes Feb 7, 2024

View reviewed changes

docker image version for mysql updated to match NOP on PROD

7ac372f

meys-bjss dismissed stale reviews from Nat-McCabe-BJSS and shivangidas via 7ac372f February 7, 2024 10:25

tsconfig types back to normal

ca71d09

shivangidas approved these changes Feb 7, 2024

View reviewed changes

Nat-McCabe-BJSS previously approved these changes Feb 7, 2024

View reviewed changes

simontindallbjss reviewed Feb 8, 2024

View reviewed changes

Nat-McCabe-BJSS reviewed Feb 8, 2024

View reviewed changes

simontindallbjss reviewed Feb 8, 2024

View reviewed changes

Conversation

meys-bjss commented Feb 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Before submitting (or marking as "ready for review")

Uh oh!

Nat-McCabe-BJSS left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

simontindallbjss Feb 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Nat-McCabe-BJSS Feb 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

meys-bjss Feb 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

meys-bjss commented Feb 1, 2024 •

edited

Loading

simontindallbjss Feb 8, 2024 •

edited

Loading

Nat-McCabe-BJSS Feb 8, 2024 •

edited

Loading

meys-bjss Feb 8, 2024 •

edited

Loading