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

fix: #3260 by properly mapping missing required fields #3309

Merged
merged 1 commit into from Dec 22, 2022
Merged

fix: #3260 by properly mapping missing required fields #3309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Expand Up @@ -37,6 +37,7 @@ should change the heading of the (upcoming) version to include a major version b

## @rjsf/validator-ajv8
- Updated the validator to use the `ErrorSchemaBuilder` in the `toErrorSchema()` function to simplify the implementation
- Updated the validator to properly map missing required field errors in the `ErrorSchema`, fixing [#3260](https://github.com/rjsf-team/react-jsonschema-form/issues/3260)

## Dev / docs / playground
- Fixed the documentation for `ArrayFieldItemTemplate` as part of the fix for [#3253](https://github.com/rjsf-team/react-jsonschema-form/issues/3253)
Expand Down
4 changes: 3 additions & 1 deletion packages/core/test/Form_test.js
View file
Open in desktop
Expand Up @@ -2220,7 +2220,9 @@ describeRepeated("Form common", (createFormComponent) => {
field1: {
__errors: ["must be number"],
},
__errors: ["must have required property 'field2'"],
field2: {
__errors: ["must have required property 'field2'"],
},
},
},
"root_field1"
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/validate_test.js
View file
Open in desktop
Expand Up @@ -618,7 +618,7 @@ describe("Validation", () => {
message: "must have required property 'foo'",
name: "required",
params: { missingProperty: "foo" },
property: "",
property: "foo",
schemaPath: "#/required",
stack: "must have required property 'foo'",
},
Expand Down Expand Up @@ -943,7 +943,7 @@ describe("Validation", () => {
message: "must have required property 'foo'",
name: "required",
params: { missingProperty: "foo" },
property: "",
property: "foo",
schemaPath: "#/required",
stack: "must have required property 'foo'",
},
Expand Down
65 changes: 65 additions & 0 deletions packages/validator-ajv6/test/validator.test.ts
View file
Open in desktop
Expand Up @@ -224,6 +224,71 @@ describe("AJV6Validator", () => {
]);
});
});
describe("Validating required fields", () => {
let errors: RJSFValidationError[];
let errorSchema: ErrorSchema;
describe("formData is not provided at top level", () => {
beforeAll(() => {
const schema: RJSFSchema = {
type: "object",
required: ["pass1", "pass2"],
properties: {
pass1: { type: "string" },
pass2: { type: "string" },
},
};

const formData = { pass1: "a" };
const result = validator.validateFormData(formData, schema);
errors = result.errors;
errorSchema = result.errorSchema;
});
it("should return an error list", () => {
expect(errors).toHaveLength(1);
expect(errors[0].stack).toEqual(".pass2 is a required property");
});
it("should return an errorSchema", () => {
expect(errorSchema.pass2!.__errors).toHaveLength(1);
expect(errorSchema.pass2!.__errors![0]).toEqual(
"is a required property"
);
});
});
describe("formData is not provided for nested child", () => {
beforeAll(() => {
const schema: RJSFSchema = {
type: "object",
properties: {
nested: {
type: "object",
required: ["pass1", "pass2"],
properties: {
pass1: { type: "string" },
pass2: { type: "string" },
},
},
},
};

const formData = { nested: { pass1: "a" } };
const result = validator.validateFormData(formData, schema);
errors = result.errors;
errorSchema = result.errorSchema;
});
it("should return an error list", () => {
expect(errors).toHaveLength(1);
expect(errors[0].stack).toEqual(
".nested.pass2 is a required property"
);
});
it("should return an errorSchema", () => {
expect(errorSchema.nested!.pass2!.__errors).toHaveLength(1);
expect(errorSchema.nested!.pass2!.__errors![0]).toEqual(
"is a required property"
);
});
});
});
describe("No custom validate function, single additionalProperties value", () => {
let errors: RJSFValidationError[];
let errorSchema: ErrorSchema;
Expand Down
11 changes: 9 additions & 2 deletions packages/validator-ajv8/src/validator.ts
View file
Open in desktop
Expand Up @@ -203,15 +203,22 @@ export default class AJV8Validator<
): RJSFValidationError[] {
return errors.map((e: ErrorObject) => {
const { instancePath, keyword, message, params, schemaPath } = e;
const property = instancePath.replace(/\//g, ".");
let property = instancePath.replace(/\//g, ".");
let stack = `${property} ${message}`.trim();
if ("missingProperty" in params) {
property = property
? `${property}.${params.missingProperty}`
: params.missingProperty;
stack = message!;
}

// put data in expected format
return {
name: keyword,
property,
message,
params, // specific to ajv
stack: `${property} ${message}`.trim(),
stack,
schemaPath,
};
});
Expand Down
201 changes: 201 additions & 0 deletions packages/validator-ajv8/test/validator.test.ts
View file
Open in desktop
Expand Up @@ -254,6 +254,73 @@ describe("AJV8Validator", () => {
]);
});
});
describe("Validating required fields", () => {
let errors: RJSFValidationError[];
let errorSchema: ErrorSchema;
describe("formData is not provided at top level", () => {
beforeAll(() => {
const schema: RJSFSchema = {
type: "object",
required: ["pass1", "pass2"],
properties: {
pass1: { type: "string" },
pass2: { type: "string" },
},
};

const formData = { pass1: "a" };
const result = validator.validateFormData(formData, schema);
errors = result.errors;
errorSchema = result.errorSchema;
});
it("should return an error list", () => {
expect(errors).toHaveLength(1);
expect(errors[0].stack).toEqual(
"must have required property 'pass2'"
);
});
it("should return an errorSchema", () => {
expect(errorSchema.pass2!.__errors).toHaveLength(1);
expect(errorSchema.pass2!.__errors![0]).toEqual(
"must have required property 'pass2'"
);
});
});
describe("formData is not provided for nested child", () => {
beforeAll(() => {
const schema: RJSFSchema = {
type: "object",
properties: {
nested: {
type: "object",
required: ["pass1", "pass2"],
properties: {
pass1: { type: "string" },
pass2: { type: "string" },
},
},
},
};

const formData = { nested: { pass1: "a" } };
const result = validator.validateFormData(formData, schema);
errors = result.errors;
errorSchema = result.errorSchema;
});
it("should return an error list", () => {
expect(errors).toHaveLength(1);
expect(errors[0].stack).toEqual(
"must have required property 'pass2'"
);
});
it("should return an errorSchema", () => {
expect(errorSchema.nested!.pass2!.__errors).toHaveLength(1);
expect(errorSchema.nested!.pass2!.__errors![0]).toEqual(
"must have required property 'pass2'"
);
});
});
});
describe("No custom validate function, single additionalProperties value", () => {
let errors: RJSFValidationError[];
let errorSchema: ErrorSchema;
Expand Down Expand Up @@ -695,6 +762,73 @@ describe("AJV8Validator", () => {
]);
});
});
describe("Validating required fields", () => {
let errors: RJSFValidationError[];
let errorSchema: ErrorSchema;
describe("formData is not provided at top level", () => {
beforeAll(() => {
const schema: RJSFSchema = {
type: "object",
required: ["pass1", "pass2"],
properties: {
pass1: { type: "string" },
pass2: { type: "string" },
},
};

const formData = { pass1: "a" };
const result = validator.validateFormData(formData, schema);
errors = result.errors;
errorSchema = result.errorSchema;
});
it("should return an error list", () => {
expect(errors).toHaveLength(1);
expect(errors[0].stack).toEqual(
"must have required property 'pass2'"
);
});
it("should return an errorSchema", () => {
expect(errorSchema.pass2!.__errors).toHaveLength(1);
expect(errorSchema.pass2!.__errors![0]).toEqual(
"must have required property 'pass2'"
);
});
});
describe("formData is not provided for nested child", () => {
beforeAll(() => {
const schema: RJSFSchema = {
type: "object",
properties: {
nested: {
type: "object",
required: ["pass1", "pass2"],
properties: {
pass1: { type: "string" },
pass2: { type: "string" },
},
},
},
};

const formData = { nested: { pass1: "a" } };
const result = validator.validateFormData(formData, schema);
errors = result.errors;
errorSchema = result.errorSchema;
});
it("should return an error list", () => {
expect(errors).toHaveLength(1);
expect(errors[0].stack).toEqual(
"must have required property 'pass2'"
);
});
it("should return an errorSchema", () => {
expect(errorSchema.nested!.pass2!.__errors).toHaveLength(1);
expect(errorSchema.nested!.pass2!.__errors![0]).toEqual(
"must have required property 'pass2'"
);
});
});
});
describe("No custom validate function, single additionalProperties value", () => {
let errors: RJSFValidationError[];
let errorSchema: ErrorSchema;
Expand Down Expand Up @@ -1137,6 +1271,73 @@ describe("AJV8Validator", () => {
]);
});
});
describe("Validating required fields", () => {
let errors: RJSFValidationError[];
let errorSchema: ErrorSchema;
describe("formData is not provided at top level", () => {
beforeAll(() => {
const schema: RJSFSchema = {
type: "object",
required: ["pass1", "pass2"],
properties: {
pass1: { type: "string" },
pass2: { type: "string" },
},
};

const formData = { pass1: "a" };
const result = validator.validateFormData(formData, schema);
errors = result.errors;
errorSchema = result.errorSchema;
});
it("should return an error list", () => {
expect(errors).toHaveLength(1);
expect(errors[0].stack).toEqual(
"must have required property 'pass2'"
);
});
it("should return an errorSchema", () => {
expect(errorSchema.pass2!.__errors).toHaveLength(1);
expect(errorSchema.pass2!.__errors![0]).toEqual(
"must have required property 'pass2'"
);
});
});
describe("formData is not provided for nested child", () => {
beforeAll(() => {
const schema: RJSFSchema = {
type: "object",
properties: {
nested: {
type: "object",
required: ["pass1", "pass2"],
properties: {
pass1: { type: "string" },
pass2: { type: "string" },
},
},
},
};

const formData = { nested: { pass1: "a" } };
const result = validator.validateFormData(formData, schema);
errors = result.errors;
errorSchema = result.errorSchema;
});
it("should return an error list", () => {
expect(errors).toHaveLength(1);
expect(errors[0].stack).toEqual(
"must have required property 'pass2'"
);
});
it("should return an errorSchema", () => {
expect(errorSchema.nested!.pass2!.__errors).toHaveLength(1);
expect(errorSchema.nested!.pass2!.__errors![0]).toEqual(
"must have required property 'pass2'"
);
});
});
});
describe("No custom validate function, single additionalProperties value", () => {
let errors: RJSFValidationError[];
let errorSchema: ErrorSchema;
Expand Down