Bump ajv from v6.12.6 to v8.10.0 (#1556)

* Bump ajv from 6.12.6 to 8.10.0

* Add docs for schema validation using ajv library

Author: pooja-sap13

broker/applications/osb-broker/package.json

@@ -12,7 +12,8 @@
     "@sf/express-commons": "*",
     "@sf/logger": "*",
     "@sf/models": "*",
-    "ajv": "6.12.6",
+    "ajv": "8.10.0",
+    "ajv-draft-04": "1.0.0",
     "bluebird": "3.7.2",
     "camelcase-keys": "7.0.2",
     "express": "4.17.3",

broker/applications/osb-broker/src/api-controllers/middleware/index.js

@@ -2,6 +2,7 @@
 
 const _ = require('lodash');
 const Ajv = require('ajv');
+const Ajv04 = require('ajv-draft-04');
 const {
   CONST,
   errors: {
@@ -210,28 +211,40 @@ exports.validateLastOperationRequest = function () {
 exports.validateSchemaForRequest = function (target, operation) {
   return function (req, res, next) {
     const plan = getPlanFromRequest(req);
-  
+
     const schema = _.get(plan, `schemas.${target}.${operation}.parameters`);
-  
+
     if (schema) {
       const parameters = _.get(req, 'body.parameters', {});
-  
+
       const schemaVersion = schema.$schema || '';
-      const validator = new Ajv({ schemaId: 'auto' });
+      const validator = new Ajv({ $schemaId: 'auto' });
+      const ajv04Validator = new Ajv04();
+      logger.info('Using Ajv04 for validating draft-04 schema');
+      let validate;
       if (schemaVersion.includes('draft-06')) {
         validator.addMetaSchema(require('ajv/lib/refs/json-schema-draft-06.json'));
+        validate = validator.compile(schema);
       } else if (schemaVersion.includes('draft-04')) {
-        validator.addMetaSchema(require('ajv/lib/refs/json-schema-draft-04.json'));
-      } else if (!schemaVersion.includes('draft-07')) {
-        validator.addMetaSchema(require('ajv/lib/refs/json-schema-draft-06.json'));
-        validator.addMetaSchema(require('ajv/lib/refs/json-schema-draft-04.json'));
+        validate = ajv04Validator.compile(schema);
       }
-      const validate = validator.compile(schema);
-  
-      const isValid = validate(parameters);
-      if (!isValid) {
-        const reason = _.map(validate.errors, ({ dataPath, message }) => `${dataPath} ${message}`).join(', ');
-        return next(new InvalidServiceParameters(`Failed to validate service parameters, reason: ${reason}`));
+      if (schemaVersion == '') {
+        validator.addMetaSchema(require('ajv/lib/refs/json-schema-draft-06.json'));
+        validate = validator.compile(schema);
+        const ajv04Validate = ajv04Validator.compile(schema);
+        if (!ajv04Validate(parameters) && !validate(parameters)) {
+          let reason = _.map(validate.errors, ({ dataPath, message }) => `${dataPath} ${message}`).join(', ');
+          if (reason == '') {
+            reason = _.map(ajv04Validate.errors, ({ dataPath, message }) => `${dataPath} ${message}`).join(', ');
+          }
+          return next(new InvalidServiceParameters(`Failed to validate service parameters, reason: ${reason}`));
+        }
+      } else {
+        const isValid = validate(parameters);
+        if (!isValid) {
+          const reason = _.map(validate.errors, ({ dataPath, message }) => `${dataPath} ${message}`).join(', ');
+          return next(new InvalidServiceParameters(`Failed to validate service parameters, reason: ${reason}`));
+        }
       }
     }
     next();

broker/applications/osb-broker/test/acceptance/service-broker-api.instances.director.spec.js

@@ -232,7 +232,7 @@ describe('service-broker-api', function () {
           .then(res => {
             expect(res).to.have.status(400);
             expect(res.body.error).to.be.eql('Bad Request');
-            expect(res.body.description).to.be.eql('Failed to validate service parameters, reason: .enum_foo should be equal to one of the allowed values');
+            expect(res.body.description).to.be.eql('Failed to validate service parameters, reason: undefined must be equal to one of the allowed values');
           });
       });
 

docs/Interoperator-Features.md

@@ -140,4 +140,30 @@ spec
       # List valid plan ids from which upgrade is accepted
       update_predecessors:
         - '39d7d4c8-6fe2-4c2a-a5ca-b826937d5a88' # default plan
-```
+```
+
+## Service plan schema validation
+
+Interoperator uses Ajv JSON schema validator for validating the schema defined for a given plan. It supports JSON Schema draft-04 & draft-06. draft-04 support requires ajv-draft-04 package.
+
+Sample drafts-04 schema supported:
+
+```yaml
+schemas: &blueprint_schemas
+        service_instance:
+          create:
+            parameters:
+              "$schema": "http://json-schema.org/draft-04/schema#"
+              additionalProperties: true
+```
+
+If $schema is not explicitly defined in the plan template, we try validating both draft-04 & draft-06 schemas. The schema validation fails if it fails for both the draft versions.
+Sample template without $schema tag:
+
+```yaml
+schemas: &blueprint_schemas
+        service_instance:
+          create:
+            parameters:
+              additionalProperties: true
+```