feat(cloud-element-templates): validate against JSON Schema

Closes #561
bpmn-io · Feb 18, 2022 · 72f486b · 72f486b
1 parent f1e8d9e
commit 72f486b
Show file tree

Hide file tree

Showing 22 changed files with 1,160 additions and 8 deletions.
diff --git a/src/index.js b/src/index.js
@@ -8,3 +8,6 @@ export { DescriptionProvider as ZeebeDescriptionProvider } from './contextProvid
 
 // hooks
 export { useService } from './hooks';
+
+// utils
+export { Validator as CloudElementTemplatesValidator } from './provider/cloud-element-templates/Validator';
diff --git a/src/provider/cloud-element-templates/Validator.js b/src/provider/cloud-element-templates/Validator.js
@@ -1,5 +1,19 @@
-import { Validator as BaseValidator } from '../element-templates/Validator';
+import {
+  Validator as BaseValidator,
+  filteredSchemaErrors,
+  getSchemaVersion
+} from '../element-templates/Validator';
 
+import semver from 'semver';
+
+import {
+  validateZeebe as validateAgainstSchema,
+  getZeebeSchemaPackage as getTemplateSchemaPackage,
+  getZeebeSchemaVersion as getTemplateSchemaVersion
+} from '@bpmn-io/element-templates-validator';
+
+const SUPPORTED_SCHEMA_VERSION = getTemplateSchemaVersion();
+const SUPPORTED_SCHEMA_PACKAGE = getTemplateSchemaPackage();
 
 /**
  * A Camunda Cloud element template validator.
@@ -10,8 +24,6 @@ export class Validator extends BaseValidator {
   }
 
   /**
-   * TODO(pinussilvestrus): we disable JSON schema validation for now.
-   *
    * Validate given template and return error (if any).
    *
    * @param {TemplateDescriptor} template
@@ -22,9 +34,34 @@ export class Validator extends BaseValidator {
     let err;
 
     const id = template.id,
-          version = template.version || '_';
+          version = template.version || '_',
+          schema = template.$schema,
+          schemaVersion = schema && getSchemaVersion(schema);
+
+    // (1) compatibility
+    if (schemaVersion && (semver.compare(SUPPORTED_SCHEMA_VERSION, schemaVersion) < 0)) {
+      return this._logError(
+        `unsupported element template schema version <${ schemaVersion }>. Your installation only supports up to version <${ SUPPORTED_SCHEMA_VERSION }>. Please update your installation`,
+        template
+      );
+    }
+
+    // (2) $schema attribute defined
+    if (!schema) {
+      return this._logError(
+        'missing $schema attribute.',
+        template
+      );
+    }
+
+    if (!this.isSchemaValid(schema)) {
+      return this._logError(
+        `unsupported $schema attribute <${ schema }>.`,
+        template
+      );
+    }
 
-    // (1) versioning
+    // (3) versioning
     if (this._templatesById[ id ] && this._templatesById[ id ][ version ]) {
       if (version === '_') {
         return this._logError(`template id <${ id }> already used`, template);
@@ -33,6 +70,26 @@ export class Validator extends BaseValidator {
       }
     }
 
+    // (4) JSON schema compliance
+    const validationResult = validateAgainstSchema(template);
+
+    const {
+      errors,
+      valid
+    } = validationResult;
+
+    if (!valid) {
+      err = new Error('invalid template');
+
+      filteredSchemaErrors(errors).forEach((error) => {
+        this._logError(error.message, template);
+      });
+    }
+
     return err;
   }
-}
+
+  isSchemaValid(schema) {
+    return schema && schema.includes(SUPPORTED_SCHEMA_PACKAGE);
+  }
+}
diff --git a/src/provider/element-templates/Validator.js b/src/provider/element-templates/Validator.js
@@ -167,7 +167,7 @@ export class Validator {
  *
  * @return {String} for example '99.99.99'
  */
-function getSchemaVersion(schemaUri) {
+export function getSchemaVersion(schemaUri) {
   const re = /\d+\.\d+\.\d+/g;
 
   const match = schemaUri.match(re);
@@ -189,7 +189,7 @@ function getSchemaVersion(schemaUri) {
  *
  * @return {Array}
  */
-function filteredSchemaErrors(schemaErrors) {
+export function filteredSchemaErrors(schemaErrors) {
   return filter(schemaErrors, (err) => {
     const {
       dataPath,