Skip to content
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

Support for discriminator tag lookup in referenced schemas #2262

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 33 additions & 5 deletions lib/vocabularies/discriminator/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type {CodeKeywordDefinition, AnySchemaObject, KeywordErrorDefinition} from "../../types"
import type {AnySchemaObject, CodeKeywordDefinition, KeywordErrorDefinition} from "../../types"
import type {KeywordCxt} from "../../compile/validate"
import {_, getProperty, Name} from "../../compile/codegen"
import {DiscrError, DiscrErrorObj} from "../discriminator/types"
import {DiscrError, DiscrErrorObj} from "./types"
import {resolveRef, SchemaEnv} from "../../compile"
import {schemaHasRulesButRef} from "../../compile/util"

Expand Down Expand Up @@ -69,18 +69,46 @@
sch = resolveRef.call(it.self, it.schemaEnv.root, it.baseId, sch?.$ref)
if (sch instanceof SchemaEnv) sch = sch.schema
}
const propSch = sch?.properties?.[tagName]
if (typeof propSch != "object") {
let propSch = sch?.properties?.[tagName]
let hasSubSchRequired = false
if (!propSch && sch?.allOf) {
const {hasRequired, propertyObject} = mapDiscriminatorFromAllOf(propSch, sch)

Check warning on line 75 in lib/vocabularies/discriminator/index.ts

View workflow job for this annotation

GitHub Actions / build (14.x)

'hasRequired' is already declared in the upper scope on line 112 column 16

Check warning on line 75 in lib/vocabularies/discriminator/index.ts

View workflow job for this annotation

GitHub Actions / build (16.x)

'hasRequired' is already declared in the upper scope on line 112 column 16

Check warning on line 75 in lib/vocabularies/discriminator/index.ts

View workflow job for this annotation

GitHub Actions / build (18.x)

'hasRequired' is already declared in the upper scope on line 112 column 16

Check warning on line 75 in lib/vocabularies/discriminator/index.ts

View workflow job for this annotation

GitHub Actions / build (19.x)

'hasRequired' is already declared in the upper scope on line 112 column 16

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re: the GitHubActions warnings, maybe we can rename this key or avoid the destructuring and just use a constant for the returned object and reference each key in the following lines?

E.g.

const discriminator = mapDiscriminatorFromAllOf(propSch, sch)
hasSubSchRequired = discriminator.hasRequired
propSch = discriminator.propertyObject

hasSubSchRequired = hasRequired
propSch = propertyObject
}
if (!propSch || typeof propSch != "object") {
throw new Error(
`discriminator: oneOf subschemas (or referenced schemas) must have "properties/${tagName}"`
)
}
tagRequired = tagRequired && (topRequired || hasRequired(sch))
tagRequired = tagRequired && (topRequired || hasRequired(sch) || hasSubSchRequired)
addMappings(propSch, i)
}
if (!tagRequired) throw new Error(`discriminator: "${tagName}" must be required`)
return oneOfMapping

function mapDiscriminatorFromAllOf(
propSch: any,
sch: any
): {hasRequired: boolean; propertyObject: any} {
let subSchObj: any = null
for (const subSch of sch.allOf) {
if (subSch?.properties) {
propSch = subSch.properties[tagName]
subSchObj = subSch
} else if (subSch?.$ref) {
subSchObj = resolveRef.call(it.self, it.schemaEnv.root, it.baseId, subSch.$ref)
if (subSchObj instanceof SchemaEnv) subSchObj = subSchObj.schema
propSch = subSchObj?.properties?.[tagName]
}
if (propSch) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it possible to move the check out of for? The reason is that currently the first match is applied and it is better to return the last match. Therefore the last override has priority

//found discriminator mapping in one of the allOf objects, stop searching
return {hasRequired: hasRequired(subSchObj), propertyObject: propSch}
}
}
return {hasRequired: false, propertyObject: null}
}

function hasRequired({required}: AnySchemaObject): boolean {
return Array.isArray(required) && required.includes(tagName)
}
Expand Down
78 changes: 78 additions & 0 deletions spec/discriminator.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,84 @@ describe("discriminator keyword", function () {
})
})

describe("validation with referenced schemas and allOf", () => {
const definitions = {
baseObject: {
properties: {
base: {type: "string"},
},
required: ["base"],
},
schema1: {
properties: {
foo: {const: "x"},
a: {type: "string"},
},
required: ["foo", "a"],
},
schema2: {
properties: {
foo: {enum: ["y", "w"]},
b: {type: "string"},
},
required: ["foo", "b"],
},
schema1Object: {
allOf: [
{
$ref: "#/definitions/baseObject",
},
{
$ref: "#/definitions/schema1",
},
],
},
}
const mainSchema = {
type: "object",
discriminator: {propertyName: "foo"},
oneOf: [
{
//referenced allOf
$ref: "#/definitions/schema1Object",
},
{
//inline allOf
allOf: [
{
$ref: "#/definitions/baseObject",
},
{
$ref: "#/definitions/schema2",
},
],
},
{
//plain object
properties: {
base: {type: "string"},
foo: {const: "z"},
c: {type: "string"},
},
required: ["base", "foo", "c"],
},
],
}

const schema = [{definitions: definitions, ...mainSchema}]

it("should validate data", () => {
assertValid(schema, {foo: "x", a: "a", base: "base"})
assertValid(schema, {foo: "y", b: "b", base: "base"})
assertValid(schema, {foo: "z", c: "c", base: "base"})
assertInvalid(schema, {})
assertInvalid(schema, {foo: 1})
assertInvalid(schema, {foo: "bar"})
assertInvalid(schema, {foo: "x", b: "b"})
assertInvalid(schema, {foo: "y", a: "a"})
})
})

describe("validation with deeply referenced schemas", () => {
const schema = [
{
Expand Down