Fix incorrect paths type on ConstraintFailure #275
Merged
Conversation
This file contains 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
henryfauna
approved these changes
Jul 17, 2024
ptpaterson
approved these changes
Jul 17, 2024
| expect(e.constraint_failures).toEqual([ | ||
| { | ||
| message: expect.any(String), | ||
| paths: expect.arrayContaining([expect.any(Array)]), |
There was a problem hiding this comment.
I couldn't figure out a simple way to assert the array contains String | Number. I guess we could extend expect but doesn't seem worth it. This is much improved already.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Ticket(s): FE-5552
Problem
The type
ConstraintFailure["paths"]was set to beArray<number | string>. However, the wire response forpathsis actually an array of arrays. Anyone trying to interact withpathsusing the declared types would have a runtime error. The existing integration tests only checkpathsis defined.Solution
Fix the the types to match the current response, and update the integration tests to actually test the array of array data structure. The
expectstatements were updated to use more "complex" matchers to reduce the number of assertions while visually documenting the data structures.Result
The types now match the expected wire result and the integration tests validate that structure more concretely.
Out of scope
N/A.
Testing
Updated the existing constraint failure query tests.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.