Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix duplicated required items #16

Merged
merged 1 commit into from
May 7, 2024
Merged

Fix duplicated required items #16

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions common/mockData/formatterMockData.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,57 @@ export const JSON_SCHEMA_DUPLICATED_CHOICES_SINGLE_SELECT_FAKE_DATA = '{\n' +
' }\n' +
'}';

export const JSON_SCHEMA_DUPLICATED_REQUIRED_PROPERTIES_FAKE_DATA = '{\n' +
' "definition": [\n' +
' "fieldset__title_abnormalities_info",\n' +
' "fieldset__title_general_info",\n' +
' "fieldset__title_markings_info",\n' +
' "fieldset__title_tagging_info"\n' +
' ],\n' +
' "schema": {\n' +
' "icon_id": "reptiles_amphibians_rep",\n' +
' "image_url": "https://mobile-bash.pamdas.org/static/sprite-src/reptiles_amphibians_rep.svg",\n' +
' "properties": {\n' +
' "fieldset__title_abnormalities_info": {\n' +
' "display": "header",\n' +
' "isHidden": false,\n' +
' "readOnly": true,\n' +
' "title": "Abnormalities info",\n' +
' "type": "string"\n' +
' },\n' +
' "fieldset__title_general_info": {\n' +
' "display": "header",\n' +
' "isHidden": false,\n' +
' "readOnly": true,\n' +
' "title": "General info",\n' +
' "type": "string"\n' +
' },\n' +
' "fieldset__title_markings_info": {\n' +
' "display": "header",\n' +
' "isHidden": false,\n' +
' "readOnly": true,\n' +
' "title": "Markings info",\n' +
' "type": "string"\n' +
' },\n' +
' "fieldset__title_tagging_info": {\n' +
' "display": "header",\n' +
' "isHidden": false,\n' +
' "readOnly": true,\n' +
' "title": "Tagging info",\n' +
' "type": "string"\n' +
' }\n' +
' },\n' +
' "required": [\n' +
' "fieldset__title_abnormalities_info",\n' +
' "fieldset__title_general_info",\n' +
' "fieldset__title_markings_info",\n' +
' "fieldset__title_markings_info"\n' +
' ],\n' +
' "title": "Turtle data Report",\n' +
' "type": "object"\n' +
' }\n' +
'}';

export const JSON_SCHEMA_DATE_TIME_FIELD_SETS = '{\n' +
' "schema": {\n' +
' "$schema": "http://json-schema.org/draft-04/schema#",\n' +
Expand Down
2 changes: 1 addition & 1 deletion src/utils/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ export const isInactiveChoice = (item: any) => item.type === STRING_TYPE
export const isDisabledChoice = (item: any) => isObject(item) && item.type === CHECKBOXES && item.inactive_titleMap?.length > 0
&& item.titleMap?.length > 0;

export const hasEnumDuplicatedItems = (options: string[]) => (new Set(options).size !== options.length);
export const hasDuplicatedItems = (items: string[]) => (new Set(items).size !== items.length);
9 changes: 6 additions & 3 deletions src/validateJsonSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import {
ElementDisplay,
getFieldSetTitleKey,
getSchemaValidations,
hasEnumDuplicatedItems,
hasDuplicatedItems,
HELP_VALUE,
isArrayProperty,
isCheckbox,
Expand Down Expand Up @@ -236,9 +236,9 @@ const validateSchema = (validations: any, schema: any) => {
// Detect duplicated enum items
if (
schema.schema.properties[key].enum?.length > 0
&& hasEnumDuplicatedItems(schema.schema.properties[key].enum)
&& hasDuplicatedItems(schema.schema.properties[key].enum)
) {
throw new Error('Duplicated items');
throw new Error('Duplicated enum items');
}
}
}
Expand Down Expand Up @@ -270,6 +270,9 @@ export const validateJSONSchema = (stringSchema: string) => {

if (stringSchema.includes(REQUIRED_PROPERTY)) {
schema.schema = cleanUpRequiredProperty(schema.schema);
if (schema.schema.required?.length > 0 && hasDuplicatedItems(schema.schema.required)) {
throw new Error('Duplicated required properties');
}
}
return schema;
};
13 changes: 9 additions & 4 deletions test/JsonFormatter.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
JSON_SCHEMA_DATE_TIME_FIELD_SETS,
JSON_SCHEMA_DEFAULT_VALUES,
JSON_SCHEMA_DUPLICATED_CHOICES_SINGLE_SELECT_FAKE_DATA,
JSON_SCHEMA_DUPLICATED_REQUIRED_PROPERTIES_FAKE_DATA,
JSON_SCHEMA_EMPTY_CHOICES_FAKE_DATA,
JSON_SCHEMA_FIELD_SETS_FAKE_DATA,
JSON_SCHEMA_ID_$SCHEMA_FAKE_DATA,
Expand Down Expand Up @@ -39,9 +40,9 @@ describe("JSON Schema validation", () => {

it("Validate empty choices", () => {
const validSchema = validateJSONSchema(JSON_SCHEMA_EMPTY_CHOICES_FAKE_DATA).toString;
expect(validSchema).not.toContain(/\"enum\"\n*\s*\:\n*\s*\[\n*\s*\]/g);
expect(validSchema).not.toContain(/\"enumNames\"\n*\s*\:\n*\s*\{\n*\s*\}/g);
expect(validSchema).not.toContain(/\"titleMap\"\n*\s*\:\n*\s*\[\n*\s*\]/g);
expect(validSchema).not.toContain(/"enum"\n*\s*:\n*\s*\[\n*\s*\]/g);
expect(validSchema).not.toContain(/"enumNames"\n*\s*:\n*\s*\{\n*\s*\}/g);
expect(validSchema).not.toContain(/"titleMap"\n*\s*:\n*\s*\[\n*\s*\]/g);
});

it("Validate remove $schema and id properties", () => {
Expand Down Expand Up @@ -88,7 +89,11 @@ describe("JSON Schema validation", () => {
});

it('Validate duplicated items in single select', () => {
expect(() => validateJSONSchema(JSON_SCHEMA_DUPLICATED_CHOICES_SINGLE_SELECT_FAKE_DATA)).toThrow('Duplicated items');
expect(() => validateJSONSchema(JSON_SCHEMA_DUPLICATED_CHOICES_SINGLE_SELECT_FAKE_DATA)).toThrow('Duplicated enum items');
});

it('Validate duplicated required properties', () => {
expect(() => validateJSONSchema(JSON_SCHEMA_DUPLICATED_REQUIRED_PROPERTIES_FAKE_DATA)).toThrow('Duplicated required properties');
});

it("Format schema definition location", () => {
Expand Down