Use config schema definition for validation. #1363

tech4him1 · 2018-05-17T19:51:50Z

- Summary

Closes #487.

I was just thinking about the best method for config validation, and this seemed like a viable option. @Benaiah's validator may be better, but I think it's worth a comparison.

This kind of basic format definitely does have the downside of only being able to statically check things. Most logic is available, though, and we can import constants from other files (valid formats, for example).

- Test plan

- Description for the changelog

Validate config with schema.

- A picture of a cute animal (not mandatory but encouraged)

verythorough · 2018-05-17T19:53:42Z

Deploy preview for netlify-cms-www ready!

Built with commit ad12707

https://deploy-preview-1363--netlify-cms-www.netlify.com

verythorough · 2018-05-17T19:54:54Z

Deploy preview for cms-demo ready!

Built with commit ad12707

https://deploy-preview-1363--cms-demo.netlify.com

tech4him1 · 2018-07-01T23:54:22Z

I haven't updated the entire schema yet (this is still a WIP), but I've added all the validations we were currently doing in-code.

I think most error messages are clear enough, but for more complicated stuff like enum, oneOf, and if/then the correct options aren't actually listed.

Example error messages. I'd like opinions on which of these are unclear and need updated.

'slug.encoding' should be equal to one of the allowed values
- Should we list the allowed values in the error?
'collections[0]' must have a field that is a valid entry identifier
- This is a custom error message -- the default was incredibly unclear due to how I had to validate it in the schema.
config should have required property 'backend'
'backend' should have required property 'name'
'backend.name' should be string
config should have required property 'media_folder'
'media_folder' should be string
config should have required property 'collections'
'collections' should be array
'collections' should NOT have less than 1 items
'collections[0]' should be object
- This is in the case where a collection is not an object (null, a string, etc.).

erquhart · 2018-07-02T21:59:27Z

I think these are fine for a start, we can always improve moving forward.

tech4him1 · 2018-07-05T20:30:15Z

@erquhart Can you review this on a "real" config file (e.g. Netlify, Smashing, etc.)?

tech4him1 · 2018-07-06T20:36:49Z

@Benaiah Any thoughts on this?

jake-101 · 2018-07-09T22:57:45Z

i can't wait for this!!

tech4him1 · 2018-07-24T19:20:47Z

@erquhart @Benaiah @talves I think this should go in v2.0 if we are going for it -- that will avert any possible breaking changes caused by unintended behiviour that used to work.

erquhart

@tech4him1 this is awesome - just one change needed, otherwise LGTM. I might go ahead and rebase since it's my fault it's behind lol.

erquhart · 2018-08-03T21:07:44Z

src/constants/configSchema.js

+                      widget: { type: "string" },
+                      required: { type: "boolean" },
+                    },
+                    required: ["name", "label", "widget"],


widget isn't required, it's string by default.

tech4him1 · 2018-08-03T21:44:17Z

src/constants/configSchema.js

+            },
+          },
+        },
+        required: ["name", "label"],


Should we drop label too since that is a pending PR?

tech4him1 · 2018-08-03T21:44:28Z

src/constants/configSchema.js

+                      widget: { type: "string" },
+                      required: { type: "boolean" },
+                    },
+                    required: ["name", "label"],


Should we drop label too since that is a pending PR?

yeah, makes sense - I'm pushing another commit right now, will include that.

erquhart · 2018-08-03T21:56:15Z

CI will fail until I merge the new stuff from #1573.

…1363)

tech4him1 mentioned this pull request May 17, 2018

WIP: Use config schema definition for validation. #1305

Closed

1 task

tech4him1 force-pushed the config-schema branch from 1093e7c to 60ff807 Compare July 1, 2018 21:42

tech4him1 requested a review from talves July 1, 2018 23:59

tech4him1 force-pushed the config-schema branch 3 times, most recently from 1c8393a to 8e34db6 Compare July 3, 2018 15:06

tech4him1 changed the title ~~WIP: Use config schema definition for validation.~~ Use config schema definition for validation. Jul 5, 2018

tech4him1 requested a review from erquhart July 5, 2018 20:29

tech4him1 requested a review from Benaiah July 6, 2018 20:32

papandreou mentioned this pull request Jul 9, 2018

Relation Widget —TypeError: Cannot read property 'isValid' of undefined #1490

Closed

tech4him1 added status: 2-code-review release: 2.0 labels Jul 24, 2018

erquhart suggested changes Aug 3, 2018

View reviewed changes

erquhart force-pushed the config-schema branch from cbc73b8 to e5b1e3b Compare August 3, 2018 21:32

tech4him1 commented Aug 3, 2018

View reviewed changes

erquhart force-pushed the config-schema branch from d6b1463 to 8e9f28d Compare August 4, 2018 12:11

erquhart approved these changes Aug 4, 2018

View reviewed changes

tech4him1 added 4 commits August 7, 2018 12:01

Validate config schema using AJV.

07c7aac

cleanup

59f20df

Port error to schema.

ce5eb54

cleanup

c4f9d01

tech4him1 and others added 18 commits August 7, 2018 12:01

Collection validation.

042b599

Fix circular dependency problem.

3470274

Cleanup formats.js

6c760ce

testing

cadb248

update tests

db6a0bd

update

b9ff799

Add basic schema.

8e71ec3

add custom error message

5f0b4a2

Fix fields validation.

a5e4957

Fix broken tests.

4b1014c

Move validation to schema file.

7f8c162

Use error class for errors.

44361f3

update dependencies

88e86f2

update field required properties

23a9f28

widget is not required

71d86dd

fix bugs from rebase

3dc122f

De-duplicate field config.

c113f94

block logging of expected test errors

ad12707

erquhart force-pushed the config-schema branch from 0532910 to ad12707 Compare August 7, 2018 16:01

erquhart merged commit 576d23d into decaporg:master Aug 7, 2018

erquhart pushed a commit that referenced this pull request Aug 7, 2018

improvement(validation): use config schema definition for validation (#…

8cc6dc7

…1363)

tech4him1 deleted the config-schema branch August 7, 2018 16:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Use config schema definition for validation. #1363

Use config schema definition for validation. #1363

Uh oh!

tech4him1 commented May 17, 2018 •

edited

Loading

Uh oh!

verythorough commented May 17, 2018 •

edited

Loading

Uh oh!

verythorough commented May 17, 2018 •

edited

Loading

Uh oh!

tech4him1 commented Jul 1, 2018 •

edited

Loading

Uh oh!

erquhart commented Jul 2, 2018

Uh oh!

tech4him1 commented Jul 5, 2018

Uh oh!

tech4him1 commented Jul 6, 2018

Uh oh!

jake-101 commented Jul 9, 2018

Uh oh!

tech4him1 commented Jul 24, 2018

Uh oh!

erquhart left a comment

Uh oh!

erquhart Aug 3, 2018

Uh oh!

tech4him1 Aug 3, 2018

Uh oh!

tech4him1 Aug 3, 2018

Uh oh!

erquhart Aug 3, 2018

Uh oh!

erquhart commented Aug 3, 2018

Uh oh!

Uh oh!

Uh oh!

Use config schema definition for validation. #1363

Use config schema definition for validation. #1363

Uh oh!

Conversation

tech4him1 commented May 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

verythorough commented May 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

verythorough commented May 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tech4him1 commented Jul 1, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erquhart commented Jul 2, 2018

Uh oh!

tech4him1 commented Jul 5, 2018

Uh oh!

tech4him1 commented Jul 6, 2018

Uh oh!

jake-101 commented Jul 9, 2018

Uh oh!

tech4him1 commented Jul 24, 2018

Uh oh!

erquhart left a comment

Choose a reason for hiding this comment

Uh oh!

erquhart Aug 3, 2018

Choose a reason for hiding this comment

Uh oh!

tech4him1 Aug 3, 2018

Choose a reason for hiding this comment

Uh oh!

tech4him1 Aug 3, 2018

Choose a reason for hiding this comment

Uh oh!

erquhart Aug 3, 2018

Choose a reason for hiding this comment

Uh oh!

erquhart commented Aug 3, 2018

Uh oh!

Uh oh!

tech4him1 commented May 17, 2018 •

edited

Loading

verythorough commented May 17, 2018 •

edited

Loading

verythorough commented May 17, 2018 •

edited

Loading

tech4him1 commented Jul 1, 2018 •

edited

Loading