fix(input_schema): show all valid editors in error when invalid editor is used on array property #596
+92
−4
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
…rray property When an invalid editor value (e.g., "fileUpload" instead of "fileupload") was used on an array field, the error message only showed a single editor from the first oneOf branch instead of all valid options. Now the error lists all valid array editors when the value is completely outside the allowed set. Co-Authored-By: Claude Opus 4.6 <[email protected]>
Verifies that invalid editor values on nested (sub-schema) array properties show all valid editors, not just a subset from a oneOf branch. Co-Authored-By: Claude Opus 4.6 <[email protected]>
mfori
added
adhoc
github-actions
bot
added
the
tested
There was a problem hiding this comment.
Pull request overview
Improves human-readable AJV validation errors for input_schema by ensuring invalid editor values on array fields report the complete set of valid editors (instead of a misleading subset from a oneOf/anyOf branch), and updates/adds regression tests for this behavior.
Changes:
- Add logic to select a more relevant AJV error and enhance enum errors from
oneOf/anyOfbranches to show top-level allowed values when the provided value is outside the allowed set. - Update existing array-editor validation tests to expect the full allowed editor list.
- Add new tests covering invalid editor values on array properties (including nested/sub-schema arrays).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
packages/input_schema/src/input_schema.ts |
Adds selectBestError and enhances enum error reporting to prefer full allowed editor lists when appropriate. |
test/input_schema.test.ts |
Updates expected error messages and adds coverage for invalid array editor values (top-level and nested). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+159
to
+181
| function selectBestError(errors: ErrorObject[]): ErrorObject { | ||
| const branchPattern = /\/(oneOf|anyOf)\/\d+\//; | ||
| const nonBranchErrors = errors.filter( | ||
| (e) => !branchPattern.test(e.schemaPath) && e.keyword !== 'oneOf' && e.keyword !== 'anyOf', | ||
| ); | ||
| return nonBranchErrors[0] ?? errors[0]; | ||
| } | ||
|
|
||
| /** | ||
| * Validates a given object against the schema and throws a human-readable error. | ||
| */ | ||
| const validateAgainstSchemaOrThrow = (validator: Ajv, obj: Record<string, unknown>, inputSchema: Schema, rootName: string) => { | ||
| if (validator.validate(inputSchema, obj)) return; | ||
|
|
||
| const errorMessage = parseAjvError(validator.errors![0], rootName)?.message; | ||
| let bestError = selectBestError(validator.errors!); | ||
|
|
||
| /* | ||
| When the best AJV error comes from a oneOf/anyOf branch (showing only a subset of valid values), | ||
| and the schema has a broader top-level enum for the same property, and the input value is not in | ||
| that enum at all, the error is enhanced to show all valid values instead of just the branch subset. | ||
| */ | ||
| const branchPattern = /\/(oneOf|anyOf)\/\d+\//; | ||
| if (bestError.keyword === 'enum' && branchPattern.test(bestError.schemaPath)) { |
There was a problem hiding this comment.
branchPattern is declared both in selectBestError and again in validateAgainstSchemaOrThrow. Consider extracting it to a single module-level constant (or reusing the one from selectBestError) to avoid future divergence if the pattern needs to change.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
When an invalid editor value (e.g., "fileUpload" instead of "fileupload") was used on an array field, the error message only showed a single editor from the first oneOf branch instead of all valid options. Now the error lists all valid array editors when the value is completely outside the allowed set.
Reported here: https://apify.slack.com/archives/C0L33UM7Z/p1770826695378579