fix #894: oas3-valid-(content-)schema-example has problem with nullable #914
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,6 @@ import * as AJV from 'ajv'; | |
| import { ValidateFunction } from 'ajv'; | ||
| import * as jsonSpecv4 from 'ajv/lib/refs/json-schema-draft-04.json'; | ||
| import * as jsonSpecv6 from 'ajv/lib/refs/json-schema-draft-06.json'; | ||
| import { IOutputError } from 'better-ajv-errors'; | ||
| import { escapeRegExp } from 'lodash'; | ||
| import { IFunction, IFunctionResult, IRule, JSONSchema, RuleFunction } from '../types'; | ||
|
|
@@ -13,6 +12,8 @@ const betterAjvErrors = require('better-ajv-errors/lib/modern'); | |
|
|
||
| export interface ISchemaOptions { | ||
| schema: object; | ||
| // The oasVersion, either 2 or 3 for OpenAPI Spec versions, or undefined / 0 for JSON Schema | ||
| oasVersion?: number; | ||
| } | ||
|
|
||
| export type SchemaRule = IRule<RuleFunction.SCHEMA, ISchemaOptions>; | ||
|
|
@@ -33,26 +34,40 @@ const logger = { | |
| error: console.error, | ||
| }; | ||
|
|
||
| const ajvInstances = {}; | ||
P0lip marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| function getAjv(oasVersion: number = 0): AJV.Ajv { | ||
m-mohr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (typeof ajvInstances[oasVersion] !== 'undefined') { | ||
| return ajvInstances[oasVersion]; | ||
| } | ||
|
|
||
| const ajvOpts: object = { | ||
m-mohr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| meta: true, // Add default meta schemas (draft 7 at the moment) | ||
| schemaId: 'auto', | ||
| jsonPointers: true, | ||
| unknownFormats: 'ignore', | ||
| nullable: oasVersion >= 2, // Support nullable for OAS | ||
m-mohr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| logger, | ||
| }; | ||
| const ajv = new AJV(ajvOpts); | ||
| // We need v4 for OpenAPI and it doesn't hurt to have v6 as well. | ||
| ajv.addMetaSchema(jsonSpecv4); | ||
| ajv.addMetaSchema(jsonSpecv6); | ||
|
|
||
| // @ts-ignore | ||
| ajv._opts.defaultMeta = jsonSpecv4.id; | ||
| // @ts-ignore | ||
| ajv._refs['http://json-schema.org/schema'] = 'http://json-schema.org/draft-04/schema'; | ||
|
|
||
| ajv.addFormat('int32', { type: 'number', validate: oasFormatValidator.int32 }); | ||
| ajv.addFormat('int64', { type: 'number', validate: oasFormatValidator.int64 }); | ||
| ajv.addFormat('float', { type: 'number', validate: oasFormatValidator.float }); | ||
| ajv.addFormat('double', { type: 'number', validate: oasFormatValidator.double }); | ||
| ajv.addFormat('byte', { type: 'string', validate: oasFormatValidator.byte }); | ||
|
|
||
| ajvInstances[oasVersion] = ajv; | ||
| return ajv; | ||
| } | ||
|
|
||
| function getSchemaId(schemaObj: JSONSchema): void | string { | ||
| if ('$id' in schemaObj) { | ||
|
|
@@ -65,7 +80,8 @@ function getSchemaId(schemaObj: JSONSchema): void | string { | |
| } | ||
|
|
||
| const validators = new (class extends WeakMap<JSONSchema, ValidateFunction> { | ||
| public get(schemaObj: JSONSchema, oasVersion: number = 0) { | ||
m-mohr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const ajv = getAjv(oasVersion); | ||
|
There was a problem hiding this comment. @P0lip how cheap is it to recreate a new instance in that layer? There was a problem hiding this comment. Only three instances are created, one for each "schema version" (i.e. oas2, oas3 and json schema). So overhead should be minimal and better than creating one ajv instance per example validation. |
||
| const schemaId = getSchemaId(schemaObj); | ||
| let validator = schemaId !== void 0 ? ajv.getSchema(schemaId) : void 0; | ||
| if (validator !== void 0) { | ||
|
|
@@ -128,7 +144,7 @@ export const schema: IFunction<ISchemaOptions> = (targetVal, opts, paths) => { | |
|
|
||
| try { | ||
| // we used the compiled validation now, hence this lookup here (see the logic above for more info) | ||
| const validator = validators.get(schemaObj, opts.oasVersion); | ||
| if (!validator(targetVal) && validator.errors) { | ||
| try { | ||
| results.push( | ||
|
|
||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's go with null instead of 0.
Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I chose 0 so that it can be used in the ajvInstances object as key (and because I was confused with how to enforce null as default value in TS).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@P0lip I couldn't get your suggestions working and I'm not familiar with how Optional works, so I tried a bit and the solution committed now works without 0. Please check whether that's okay for you.
Now I need to get #915 fixed so that my CI doesn't fail all the time. ;-)