JSON Schema Validation @Camunda Modeler

Why we chose ajv for our utility and why it's maybe not a good idea (anymore).

Transcript

1. JSON Schema Validation @Camunda Modeler Why we chose ajv for our utility and why it's maybe not a good idea (anymore) Niklas
2. 2 Element Templates Validation in the Camunda Modeler
3. 3 How it’s done (v1) ElementTemplatesLoader#setTemplates Validator#_validateTemplates - validate Versioning - validate Compatibility - validate for missing id, name, appliesTo, ... - validate all properties - validate all scopes - ... validTemplates errors bpmn-js-properties-panel @camunda/element-templates-json-schema only compatibility
4. 4 How it’s done (v1) ElementTemplatesLoader#setTemplates Validator#_validateTemplates - validate Versioning - validate Compatibility - validate for missing id, name, appliesTo, ... - validate all properties - validate all scopes - ... validTemplates errors bpmn-js-properties-panel @camunda/element-templates-json-schema only compatibility Element-Templates-Modal
6. 6 How it’s done (v1) ElementTemplatesLoader#setTemplates Validator#_validateTemplates - validate Versioning - validate Compatibility - validate for missing id, name, appliesTo, ... - validate all properties - validate all scopes - ... validTemplates errors bpmn-js-properties-panel @camunda/element-templates-json-schema only compatibility
7. 7 How it’s done (v2) ElementTemplatesLoader#setTemplates Validator#_validateTemplates - validate Versioning - validate Compatibility - validate for missing id, name, appliesTo, ... - validate all properties - validate all scopes - ... validTemplates errors bpmn-js-properties-panel @camunda/element-templates-json-schema only compatibility
8. 8 How it’s done (v2) ElementTemplatesLoader#setTemplates Validator#_validateTemplates - validate Versioning - validate Compatibility - validate Schema compliant validTemplates errors bpmn-js-properties-panel @camunda/element-templates-json-schema @bpmn-io/json-schema-validator ajv
11. 11 How it’s done (v2) ElementTemplatesLoader#setTemplates Validator#_validateTemplates - validate Versioning - validate Compatibility - validate Schema compliant validTemplates errors bpmn-js-properties-panel @camunda/element-templates-json-schema @bpmn-io/json-schema-validator ajv
12. 12 How it’s done (v2) ElementTemplatesLoader#setTemplates Validator#_validateTemplates - validate Versioning - validate Compatibility - validate Schema compliant validTemplates errors bpmn-js-properties-panel @camunda/element-templates-json-schema @bpmn-io/json-schema-validator ajv One Template at a time
13. 13 How it’s done (v2) ElementTemplatesLoader#setTemplates Validator#_validateTemplates - validate Versioning - validate Compatibility - validate Schema compliant validTemplates errors bpmn-js-properties-panel @camunda/element-templates-json-schema @bpmn-io/json-schema-validator ajv One Template at a time
14. 14 What is “ajv”?
15. 15 Why we chose it in the past • Customizable error messages • Configurable • Extendable • Community • Performance • Support the latest JSON Schema definition (we use draft-07) + features
16. 16 https://ajv.js.org/guide/why-ajv.html#super-fast-secure
18. 18 Why we chose it in the past @camunda/element-templates-json-schema
19. 19 Problems
20. 20 Alternatives? https://json-schema.org/implementations.html#validator-javascript • tdegrunt/jsonschema • hyperjump-io/json-schema-validator • mafintosh/is-my-json-valid • korzio/djv • build our own
21. 21 Why we chose it in the past • Customizable error messages • Configurable • Extendable • Community • Performance • Support the latest JSON Schema definition (we use draft-07) + features Reminder
22. 22 Why we chose it in the past • Customizable error messages • Configurable • Extendable • Community • Performance • Support the latest JSON Schema definition (we use draft-07) + features Reminder
23. Thank you!