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.

Sign up for GitHub

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

Jump to bottom

feat: add validationErrors to schema mismatch errors #641

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: add validationErrors to schema mismatch errors #641

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04d0b3c
feat: add validationErrors to schema mismatch errors
MoLow Aug 20, 2023
35f3539
CR
MoLow Aug 27, 2023
437f67e
Update index.js
MoLow Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -866,6 +866,7 @@ function buildValue (context, location, input) {

if ((type === undefined || type === 'object') && (schema.anyOf || schema.oneOf)) {
context.validatorSchemasIds.add(location.getSchemaId())
code = 'const errors = []\n'
MoLow marked this conversation as resolved.
Show resolved Hide resolved

if (schema.type === 'object') {
context.wrapObjects = false
Expand All @@ -885,8 +886,9 @@ function buildValue (context, location, input) {
const schemaRef = optionLocation.getSchemaRef()
const nestedResult = buildValue(context, optionLocation, input)
code += `
${index === 0 ? 'if' : 'else if'}(validator.validate("${schemaRef}", ${input}))
${index === 0 ? 'if' : 'else if'}(validator.validate("${schemaRef}", ${input}, errors)) {
${nestedResult}
}
`
}

Expand All @@ -896,7 +898,9 @@ function buildValue (context, location, input) {
}

code += `
else throw new TypeError(\`The value of '${schemaRef}' does not match schema definition.\`)
else throw Object.assign(new TypeError(\`The value of '${schemaRef}' does not match schema definition.\`), {
validationErrors: errors
})
Comment on lines +901 to +903
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not use cause and avoid the Object.assign?

Suggested change
else throw Object.assign(new TypeError(\`The value of '${schemaRef}' does not match schema definition.\`), {
validationErrors: errors
})
else throw new TypeError(\`The value of '${schemaRef}' does not match schema definition.\`, {
cause: errors
})

`
if (schema.type === 'object') {
code += `
Expand Down
6 changes: 4 additions & 2 deletions lib/validator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,10 @@ class Validator {
}
}

validate (schemaRef, data) {
return this.ajv.validate(schemaRef, data)
validate (schemaRef, data, errors) {
const valid = this.ajv.validate(schemaRef, data)
if (this.ajv.errors && Array.isArray(errors)) errors.push(...this.ajv.errors)
Eomm marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

could this be faster?

Suggested change
if (this.ajv.errors && Array.isArray(errors)) errors.push(...this.ajv.errors)
Array.isArray(errors) && Arrry.prototype.push.apply(errors, this.ajv.errors)

return valid
}

// Ajv does not support js date format. In order to properly validate objects containing a date,
Expand Down
14 changes: 12 additions & 2 deletions test/any.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,12 @@ test('should throw a TypeError with the path to the key of the invalid value /1'

const stringify = build(schema)

t.throws(() => stringify({ kind: 'Baz', value: 1 }), new TypeError('The value of \'#\' does not match schema definition.'))
t.throws(() => stringify({ kind: 'Baz', value: 1 }), Object.assign(new TypeError('The value of \'#\' does not match schema definition.'), {
validationErrors: [
{ message: 'must be equal to one of the allowed values', schemaPath: '#/properties/kind/enum', instancePath: '/kind' },
{ message: 'must be equal to one of the allowed values', schemaPath: '#/properties/kind/enum', instancePath: '/kind' }
]
}))
MoLow marked this conversation as resolved.
Show resolved Hide resolved
})

test('should throw a TypeError with the path to the key of the invalid value /2', (t) => {
Expand Down Expand Up @@ -227,5 +232,10 @@ test('should throw a TypeError with the path to the key of the invalid value /2'

const stringify = build(schema)

t.throws(() => stringify({ data: { kind: 'Baz', value: 1 } }), new TypeError('The value of \'#/properties/data\' does not match schema definition.'))
t.throws(() => stringify({ data: { kind: 'Baz', value: 1 } }), Object.assign(new TypeError('The value of \'#/properties/data\' does not match schema definition.'), {
validationErrors: [
{ message: 'must be equal to one of the allowed values', schemaPath: '#/properties/kind/enum', instancePath: '/kind' },
{ message: 'must be equal to one of the allowed values', schemaPath: '#/properties/kind/enum', instancePath: '/kind' }
]
}))
})