-
Notifications
You must be signed in to change notification settings - Fork 13
feat(ajv): validate JSON Schema inputs #172
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mcollina
merged 3 commits into
platformatic:main
from
rozzilla:feat/ajv/validate-JSON-Schema-inputs
Jul 31, 2026
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import type { Options } from 'ajv' | ||
| import { Ajv2020 } from 'ajv/dist/2020.js' | ||
| import type { ErrorObject } from 'ajv/dist/2020.js' | ||
| import stringify from 'safe-stable-stringify' | ||
|
|
||
| function formatJsonSchemaErrors (errors: ErrorObject[]): string { | ||
| return errors | ||
| .map(error => `${error.instancePath || '/'} ${error.message ?? 'is invalid'}`) | ||
| .join('; ') | ||
| } | ||
|
|
||
| export type JsonSchemaValidator = ReturnType<typeof createJsonSchemaValidator> | ||
|
|
||
| /** | ||
| * Create a per-plugin-instance AJV validator with a compiled-schema cache, | ||
| * so registering the plugin twice never shares compilation state. | ||
| */ | ||
| export function createJsonSchemaValidator (customOptions: Options = {}) { | ||
| // Deliberately non-mutating: tool arguments must reach handlers exactly as the | ||
| // client sent them, so no coercion, no defaults injection, no property removal. | ||
| // `strict: false` tolerates MCP-style schemas carrying extra annotation keywords; | ||
| // `validateFormats: false` keeps `format` annotation-only, which is also JSON | ||
| // Schema 2020-12's own default behavior. | ||
| const ajv = new Ajv2020({ | ||
| coerceTypes: 'array', | ||
| useDefaults: true, | ||
| removeAdditional: true, | ||
| addUsedSchema: false, | ||
| allErrors: false, | ||
| strict: false, | ||
| validateFormats: false, | ||
| ...customOptions | ||
| }) | ||
|
rozzilla marked this conversation as resolved.
|
||
|
|
||
| // Compiled validator cache, mirroring the TypeBox cache in validator.ts | ||
| const compiledValidators = new Map<string, ReturnType<typeof ajv.compile>>() | ||
|
|
||
| /** | ||
| * Compile a plain JSON Schema with AJV, with caching. Throws when the schema | ||
| * cannot be compiled, so callers can fail fast at tool registration time. | ||
| */ | ||
| function compileAndCache (schema: object) { | ||
| const key = stringify(schema) | ||
| let validator = compiledValidators.get(key) | ||
| if (!validator) { | ||
| validator = ajv.compile(schema) | ||
| compiledValidators.set(key, validator) | ||
| } | ||
| return validator | ||
| } | ||
|
|
||
| /** | ||
| * Validate data against a plain JSON Schema. Returns a formatted error message | ||
| * when the data is invalid, or `null` when it passes. | ||
| */ | ||
| function validate (schema: object, data: unknown): string | null { | ||
| const validator = compileAndCache(schema) | ||
| if (validator(data)) { | ||
| return null | ||
| } | ||
| return formatJsonSchemaErrors(validator.errors ?? []) | ||
| } | ||
|
|
||
| return { compileAndCache, validate } | ||
| } | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.