feat: add double schema bucket for validator and serializer (#3402)#6757
Open
BALOGUN-DAVID wants to merge 1 commit into
Open
feat: add double schema bucket for validator and serializer (#3402)#6757BALOGUN-DAVID wants to merge 1 commit into
BALOGUN-DAVID wants to merge 1 commit into
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
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.
resolves #3402
This PR implements the "Double Schema Bucket" feature discussed in #3402 to resolve compatibility issues when passing schemas containing newer JSON Schema drafts (e.g., 2020-12) to both
ajv(which supports it) andfast-json-stringify(which throws errors as it only supports up to draft 07).Changes:
lib/schema-controller.js: Split the core schema container into discretevalidatorBucketandserializerBucketinstances.fastify.js: Added anoptionsparameter toaddSchema(schema, options)supporting{ validator?: boolean, serializer?: boolean }config object.types/instance.d.ts: Updated TypeScript definitions for the new options argument and exposed getters.test/schema-double-bucket.test.js: Added unit tests to ensure scopes do not leak when adding schemas targeted at specific compilers.Note: The feature is completely backward compatible. Calling
addSchema(schema)without options continues to add the schema to both buckets as it always has.Checklist
npm run test && npm run benchmark --if-presentand the Code of conduct