feat: updated uen validator (ref stdnum) and tests cases

[hui-jie-lim]

Problem

Closes [#5919]

Solution

1. Implemented UEN validator based on stdnum
2. Added test for uen-validator, and new script for standalone sharedutils (npm run test:sharedutils), along with corresponding config files

Breaking Changes

• Yes - this PR contains breaking changes
  • Details ...
• No - this PR is backwards compatible

Features:

• uen-validation

Tests

Test comprises 2 happy and 1 unhappy test cases. Happy test cases are based on UEN codes that are known to be valid issued by ACRA and Other entities. Unhappy test case checks if uen-validator captures the checksum accurately for all types if UEN. (5XXX, 2XXX, ROC, ROB, T and S entities.) See shared/utils/tests/uen-validation.spec.ts

May run as a check
npm run test:backend shared

Deploy Notes

[hui-jie-lim]

Hi @KenLSM ,

Please have a look at this PR for #5919, thank you. There seem to be a lot of new additions to package-lock.json. I think it might have been the additions generated by my local builds. If its alright, perhaps you can help to review the code first? I'll fix the package-lock file subsequently. Thanks!

Hui

[KenLSM]

Hey @hui-jie-lim, firstly thanks for following through with the commitment you have. We appreciate your help here.

I've ran through the first round combing of the changes. I've also triggered the CIs for this branch. But it seems like there are a couple of linting issues lying around that our CI is not capturing as well. Meanwhile, you might want to double check on your linting config.

[hui-jie-lim]

Cool! Let me work on these changes. Will get back. Thanks for the review btw. I am still quite new to software development so its very helpful to have another person view my code!

[KenLSM]

Could you also help me to apply this git patch that I've written to fix the issue of CI not checking for linting issues on shared/?

Here's the command to on applying git patches.

P.S. As I was reviewing, the code, I'm spotting some prettier issues

[hui-jie-lim]

Hey @KenLSM , the code should be cleaned up already - reformatted with prettier and also removed some of the unnecessary changes. Should be all good to go. Please have a look, thanks!

[hui-jie-lim]

Hey @KenLSM , i saw that the previous PR failed npm ci because the packages were not in sync. I had a look at the code and notice that it was because i still had jest in shared/package.json. Now that I removed it, could you re-trigger the test again please? Thank you

[KenLSM]

Don't worry about the issue from Chromatic / chromatic-deployment (pull_request)

[hui-jie-lim]

hey @KenLSM , was wondering if there's any update on this, and if there's any follow up required on my end.

[KenLSM]

Hey @hui-jie-lim apologies for the late response last week. There seems to have some tests failures on (1) linting (due to the linting that we've added for shared/ in this PR), and also (2) test cases where it now fails due to the strengthened UEN.

(2a)
Frontend Tests
Extract of some of the errors

 const success = screen.getByText('You have submitted: S01LP1234Z')

Previously, S01LP1234Z would have passed, but with the strengthened validator, this now fails. Updating the provided UEN in the test cases to something that's valid would suffice.

(2b)
Playwright Tests
I believe the e2e testing is also failing due to the strengthened UEN. A similar approach of updating to a valid UEN should suffice.
Here's probably where you should update the UEN for e2e testing

  {
    title: 'Some UEN here please',
    fieldType: BasicField.Uen,
    val: 'T09LL0001B', // <-- this
  },

[hui-jie-lim]

Hey @KenLSM , I have updated the UEN for the tests and ran the linting scripts. Just a quick question. I notice that I am failing the playwright test for email submissions due to timeouts on my local machine(m1 mba). It shows time out on github too. Is this expected behaviour?

[KenLSM]

Yes. Expected albeit not the best way to announce test failures. The timeouts are due to the way the tests were conducted.

The test waits until a certain element appears before concluding the tests. This also means that if there is a validation error that prevents the element from showing, the playwright tests would wait until the it timed out and fail.

[KenLSM]

Hey @hui-jie-lim the feature changes looks good, and all of the tests have passed. 🎉

However, before we can merge, we'll still have to remove the changes on package.json (except for the two scripts that we've added) and package-lock.json.

[hui-jie-lim]

Done! I have removed the changes on package-lock.json and package.json

[KenLSM]

Merged! Thanks for your contribution @hui-jie-lim 🎉 🎉

[hui-jie-lim]

Awesome! Feels great to be able to contribute :)
Thanks for your help on this @KenLSM

[LinHuiqing]

Note: just put the issue number directly without the square brackets to trigger automations! Will close the issue manually this time 👍
Thanks for your contribution @hui-jie-lim!

[LinHuiqing]

Manual tests:

• Create a email mode form with a UEN field
• Submit the form with a local company UEN
• Submit the form with a business UEN
• Submit the form with a UEN from the others list
• 3 emails should the received for the 3 successful form submissions above
• Key in a UEN with the wrong checksum. The field should throw a warning.
• Perform a submission through an API call with an invalid UEN. This should fail.