fix: fixes #3692 - simple discriminator now bypasses isValid() calls in getMatchingOption and getClosestMatchingOption for improved performance #3845
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
…() calls in getMatchingOption and getClosestMatchingOption.ts for improved performance
michal-kurz
commented
Aug 29, 2023
Comment on lines
+301
to
+303
| Compares the value of `discriminatorField` within `formData` against the value of `discriminatorField` within schema for each `option`. Returns index of first `option` whose discriminator matches formData. Returns `undefined` if there is no match. | ||
|
|
||
| This function does not work with discriminators of `"type": "object"` and `"type": "array"` |
There was a problem hiding this comment.
I quite struggled trying to make this description as understandable and straght-forwards as possible.
michal-kurz
commented
Aug 29, 2023
michal-kurz
commented
Aug 29, 2023
Comment on lines
+39
to
+58
| test('const discriminator', () => { | ||
| expect( | ||
| getOptionMatchingSimpleDiscriminator( | ||
| { foo: 'foo' }, | ||
| [{}, { type: 'object', properties: { foo: { const: 'foo' } } }], | ||
| 'foo' | ||
| ) | ||
| ).toEqual(1); | ||
| }); | ||
|
|
||
| test('enum discriminator', () => { | ||
| expect( | ||
| getOptionMatchingSimpleDiscriminator( | ||
| { foo: 'foo' }, | ||
| [{}, { type: 'object', properties: { foo: { enum: ['bar', 'foo'] } } }], | ||
| 'foo' | ||
| ) | ||
| ).toEqual(1); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
Perhaps there are some other relevant cases that I'm missing
There was a problem hiding this comment.
You just need to figure out the test coverage
michal-kurz
changed the title
michal-kurz
changed the title
4 tasks
| import { PROPERTIES_KEY } from './constants'; | ||
| import { RJSFSchema, StrictRJSFSchema } from './types'; | ||
|
|
||
| export default function getOptionMatchingSimpleDiscriminator<T = any, S extends StrictRJSFSchema = RJSFSchema>( |
There was a problem hiding this comment.
Please add the same documentation you put into the docs above here.
|
@michal-kurz It looks like your changes causes line |
heath-freenome
approved these changes
Oct 5, 2023
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.
Reasons for making this change
fixes #3692
Checklist
npm run test:updateto update snapshots, if needed.