gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: add widgets schema validation (#3841)

Browse Source
This commit is contained in:
Bartholomew
2020-06-03 14:43:34 +01:00
committed by GitHub
parent 995739a85c
commit 2b46608f86
27 changed files with 304 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
packages/netlify-cms-core/src/constants/__tests__/configSchema.spec.js
View File

@ -1,6 +1,8 @@
import { merge } from 'lodash';
import { validateConfig } from '../configSchema';
jest.mock('../../lib/registry');
describe('config', () => {
/**
* Suppress error logging to reduce noise during testing. Jest will still
@ -10,6 +12,9 @@ describe('config', () => {
jest.spyOn(console, 'error').mockImplementation(() => {});
});
const { getWidgets } = require('../../lib/registry');
getWidgets.mockImplementation(() => [{}]);
describe('validateConfig', () => {
const validConfig = {
foo: 'bar',
@ -234,5 +239,82 @@ describe('config', () => {
);
}).not.toThrow();
});
describe('nested validation', () => {
const { getWidgets } = require('../../lib/registry');
getWidgets.mockImplementation(() => [
{
name: 'relation',
schema: {
properties: {
searchFields: { type: 'array', items: { type: 'string' } },
displayFields: { type: 'array', items: { type: 'string' } },
},
},
},
]);
it('should throw if nested relation displayFields and searchFields are not arrays', () => {
expect(() => {
validateConfig(
merge(validConfig, {
collections: [
{
fields: [
{ name: 'title', label: 'title', widget: 'string' },
{
name: 'object',
label: 'Object',
widget: 'object',
fields: [
{ name: 'title', label: 'title', widget: 'string' },
{
name: 'relation',
label: 'relation',
widget: 'relation',
displayFields: 'title',
searchFields: 'title',
},
],
},
],
},
],
}),
);
}).toThrowError("'searchFields' should be array\n'displayFields' should be array");
});
it('should not throw if nested relation displayFields and searchFields are arrays', () => {
expect(() => {
validateConfig(
merge(validConfig, {
collections: [
{
fields: [
{ name: 'title', label: 'title', widget: 'string' },
{
name: 'object',
label: 'Object',
widget: 'object',
fields: [
{ name: 'title', label: 'title', widget: 'string' },
{
name: 'relation',
label: 'relation',
widget: 'relation',
displayFields: ['title'],
searchFields: ['title'],
},
],
},
],
},
],
}),
);
}).not.toThrow();
});
});
});
});

30
packages/netlify-cms-core/src/constants/configSchema.js
View File

@ -1,27 +1,39 @@
import AJV from 'ajv';
import uniqueItemProperties from 'ajv-keywords/keywords/uniqueItemProperties';
import { select, uniqueItemProperties } from 'ajv-keywords/keywords';
import ajvErrors from 'ajv-errors';
import { formatExtensions, frontmatterFormats, extensionFormatters } from 'Formats/formats';
import { getWidgets } from 'Lib/registry';
/**
* Config for fields in both file and folder collections.
*/
const fieldsConfig = {
const fieldsConfig = () => ({
$id: 'fields',
type: 'array',
minItems: 1,
items: {
// ------- Each field: -------
$id: 'field',
type: 'object',
properties: {
name: { type: 'string' },
label: { type: 'string' },
widget: { type: 'string' },
required: { type: 'boolean' },
hint: { type: 'string' },
pattern: { type: 'array', minItems: 2, items: { type: 'string' } },
field: { $ref: 'field' },
fields: { $ref: 'fields' },
types: { $ref: 'fields' },
},
select: { $data: '0/widget' },
selectCases: {
...getWidgetSchemas(),
},
required: ['name'],
},
uniqueItemProperties: ['name'],
};
});
const viewFilters = {
type: 'array',
@ -133,7 +145,7 @@ const getConfigSchema = () => ({
label_singular: { type: 'string' },
description: { type: 'string' },
file: { type: 'string' },
fields: fieldsConfig,
fields: fieldsConfig(),
},
required: ['name', 'label', 'file', 'fields'],
},
@ -163,7 +175,7 @@ const getConfigSchema = () => ({
type: 'string',
},
},
fields: fieldsConfig,
fields: fieldsConfig(),
sortableFields: {
type: 'array',
items: {
@ -199,6 +211,11 @@ const getConfigSchema = () => ({
anyOf: [{ required: ['media_folder'] }, { required: ['media_library'] }],
});
function getWidgetSchemas() {
const schemas = getWidgets().map(widget => ({ [widget.name]: widget.schema }));
return Object.assign(...schemas);
}
class ConfigError extends Error {
constructor(errors, ...args) {
const message = errors
@ -228,8 +245,9 @@ class ConfigError extends Error {
* the config that is passed in.
*/
export function validateConfig(config) {
const ajv = new AJV({ allErrors: true, jsonPointers: true });
const ajv = new AJV({ allErrors: true, jsonPointers: true, $data: true });
uniqueItemProperties(ajv);
select(ajv);
ajvErrors(ajv);
const valid = ajv.validate(getConfigSchema(), config);

14
packages/netlify-cms-core/src/lib/registry.js
View File

@ -82,7 +82,7 @@ export function getPreviewTemplate(name) {
/**
* Editor Widgets
*/
export function registerWidget(name, control, preview) {
export function registerWidget(name, control, preview, schema = {}) {
if (Array.isArray(name)) {
name.forEach(widget => {
if (typeof widget !== 'object') {
@ -95,12 +95,13 @@ export function registerWidget(name, control, preview) {
// A registered widget control can be reused by a new widget, allowing
// multiple copies with different previews.
const newControl = typeof control === 'string' ? registry.widgets[control].control : control;
registry.widgets[name] = { control: newControl, preview };
registry.widgets[name] = { control: newControl, preview, schema };
} else if (typeof name === 'object') {
const {
name: widgetName,
controlComponent: control,
previewComponent: preview,
schema = {},
allowMapValue,
globalStyles,
...options
@ -114,7 +115,14 @@ export function registerWidget(name, control, preview) {
if (!control) {
throw Error(`Widget "${widgetName}" registered without \`controlComponent\`.`);
}
registry.widgets[widgetName] = { control, preview, globalStyles, allowMapValue, ...options };
registry.widgets[widgetName] = {
control,
preview,
schema,
globalStyles,
allowMapValue,
...options,
};
} else {
console.error('`registerWidget` failed, called with incorrect arguments.');
}