RW-15004 [risk=low] validate js repacement #9291
Merged
Conversation
This file contains hidden or 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
- initial introduction of zod schema validation library. - created zod-validators util module which a handful of components have been converted to make use of. - converted components now have a componentx-valdation sister file which has the valdation logic moved into it. - zod is a very nice library with excellent Typescript type safety and flow. But it requires a passthru pattern for safer usage in form validation scenarious. See refineObject helper in zod-valdators.ts. - zod 3.x also lacks "pretty" field name functionality which we made use of in validate.js. So these are replaced with more explicit error message mechanics. - also did some unit test cleanup, mainly adding mocks for dependencies that were adding warning noise to test output.
- first wave of components swapped to use zod validation in place of validate.js. - zod validators are using refinedObject and refineFields helpers to avoid early-abort validation scenarios with the normal zod usage patterns. See zod-validators.ts - also fixed act() related warnings and masked async race conditions causing unit test flakiness in data-page.spec, data-access-requirements.spec, and egress-events-table.spec
…elper when used by demographics servey v2 component that passes null for some of the optional string fields.
evrii
reviewed
Jul 2, 2025
| newName: z | ||
| .string() | ||
| .trim() | ||
| .min(1, "New name can't be blank") |
| {Object.keys(errors).map((key) => ( | ||
| <li key={errors[key][0]}> | ||
| {errors[key]} (Question {questionsIndex[key]}) | ||
| {key}: {errors[key]} (Question {questionsIndex[key]}) |
There was a problem hiding this comment.
It seems like this might have been added for debugging. Is it ok to remove this?
| (fields, ctx) => { | ||
| const noop = undefined; | ||
| const needYearOfBirthMsg = | ||
| 'You must either fill in your year of birth or check the corresponding "Prefer not to answer" checkbox '; |
There was a problem hiding this comment.
fixed with requiredNumber zod helper
| refineFields(fields, ctx, { | ||
| ethnicCategories: nonEmptyArray( | ||
| z.string(), | ||
| "Ethnic categories can't be blank" |
| ), | ||
| genderIdentities: nonEmptyArray( | ||
| z.string(), | ||
| "Gender identities can't be blank" |
| ? requiredStringWithMaxLength(100, 'Other Specific Population') | ||
| : noop, | ||
| diseaseOfFocus: data.diseaseFocusedResearch | ||
| ? requiredStringWithMaxLength(80, 'Disease of Focus') |
| data.disseminateResearchFindingList?.includes( | ||
| DisseminateResearchEnum.OTHER | ||
| ) | ||
| ? requiredStringWithMaxLength( |
There was a problem hiding this comment.
When I have a large value in this field and it is checked, I get the error. If I uncheck the other dissemination box, the contents stay the same, I don't get the error, and I can submit.
I am in the process of seeing if submitting a workspace in this situation will break anything.
There was a problem hiding this comment.
The workspace creation errored out.
There was a problem hiding this comment.
defering this issue for now since it's existing logic outside of validation logic
| 'Other methods of disseminating research findings' | ||
| ) | ||
| : noop, | ||
| aianResearchType: askAboutAIAN |
| ? z.nativeEnum(AIANResearchType, { required_error: "can't be blank" }) | ||
| : noop, | ||
| aianResearchDetails: askAboutAIAN | ||
| ? requiredStringWithMaxLength(1000) |
ui/src/app/utils/zod-validators.ts
Outdated
| const isHttp = url.protocol === 'http:' || url.protocol === 'https:'; | ||
| const isLocalHost = | ||
| url.hostname === 'localhost' || url.hostname === '127.0.0.1'; | ||
| console.log( |
There was a problem hiding this comment.
I think that this might have been left from debugging.
- fixed null issue with requiredNumber validator, minor cleanup.
evrii
approved these changes
Jul 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PR checklist
[risk=no|low|moderate|severe]in the PR title as outlined in CONTRIBUTING.md.