feat: remove ajv

Author: MikeRalphson

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## swagger2openapi v7.0 and oas-validator v5.0
+
+* remove use of `ajv` for fallback schema validation
+
 ## swagger2openapi v6.1.0 and oas-resolver v2.4.0
 
 New properties on the `options` object:

docs/options.md

@@ -3,7 +3,6 @@
 Parameter|Type|Input/Output|Description
 |---|---|---|---|
 agent|Object|Input|Optional http(s).Agent to be used when fetching resources
-ajv|Object|Input|Used to pass the instance of the `ajv` JSON Schema validator from the validator to the linter
 allScopes|Object|Internal|Cache of scopes by securityScheme for validation
 anchors|Boolean|Input|Allow use of YAML anchors/aliases. May break things
 cache|Object|Input|Optional cache of external resources
@@ -26,7 +25,6 @@ handlers|Object|Input|Map of additional [protocol/scheme handlers](handlers.md),
 help|Boolean|Reserved|Command-line flag to display help
 indent|String|Input|Command-line flag to control JSON indenting
 isCallback|Boolean|Input|Hint to the linter that we are within a `callback` object
-jsonschema|String|Input|Path to alternative JSON schema (in JSON or YAML) for validation
 laxDefaults|Boolean|Input|Flag to validation step to ignore default/type mismatches
 laxRefs|Boolean|Input|**No longer has any effect as this is now the default**
 laxurls|Boolean|Input|Flag to validation step to ignore empty URLs and # ? in paths
@@ -47,7 +45,6 @@ output|Boolean|Input|Internal flag to testRunner to write output openapi.yaml fi
 patch|Boolean|Input|Flag to fix-up minor errors in the source definition during conversion
 patches|Integer|Output|Count of number of patches applied during conversion
 preserveMiro|Boolean|Input|Flag to resolver as to whether to preserve old value of `$ref` in `x-miro`, default: `false`
-prettify|Boolean|Input|Flag to validator to generate pretty (but potentially misleading) schema validation error reports
 prevalidate|Boolean|Input|Whether to validate each externally `$ref`d file separately
 promise|Object|Internal|Object containing resolve and reject functions for the converter
 quiet|Boolean|Input|Command-line flag used by `testRunner`
@@ -57,7 +54,6 @@ refSiblings|string|Input|Controls handling of `$ref` which has sibling propertie
 resolve|Boolean|Input|Flag to enable resolution of external `$ref`s
 resolveInternal|Boolean|Input|Flag to enable resolution of internal `$ref`s. Also disables deduplication of `requestBodies`
 resolver|Object|Internal|Used by the resolver to track outstanding resolutions
-schema|Object|Input|Temporarily holds JSON Schema during validation step
 skip|Boolean|Reserved|Used by tools such as Speccy to skip linter rules
 stop|Boolean|Input|Command-line flag used by `testRunner`
 source|String|Input|The source filename or url of the definition, used by the resolver
@@ -67,7 +63,6 @@ text|String|Both|If not already a truthy value, will be set to the input text of
 throws|Boolean|Input|Used by tests only to indicate the fixture should throw an exception
 url|String|Input|URL of the original definition, used when reading a file to create `x-origin` extension
 valid|Boolean|Output|The result of a validation step
-validateSchema|String|Input|Set to 'first', 'last' or 'never' to control ordering of validation strategies
 verbose|Boolean|Input|Increase verbosity, e.g. show HTTP GET requests
 version|Boolean|Input|Command-line flag to show version information
 warnings|Array|Output|Warnings generated by a validation step

packages/oas-linter/index.js

@@ -5,6 +5,7 @@ const path = require('path');
 
 const yaml = require('yaml');
 const should = require('should/as-function');
+const { validator } = require('@exodus/schemasafe');
 
 let rules = [];
 let results = [];
@@ -242,13 +243,15 @@ function lint(objectName,object,key,options) {
             }
             if (rule.schema) {
                 matched = true;
-                const validate = options.ajv.compile(rule.schema);
-                const valid = validate(object);
+                if (!rule.$schema) {
+                  rule.$schema = validator(rule.schema, { includeErrors: true, allErrors: true, mode: 'default' });
+                }
+                const valid = rule.$schema(object);
                 if (!valid) {
-                    const pointer = (options.context && options.context.length > 0 ? options.context[options.context.length-1] : null);
-                    for (let error of validate.errors) {
-                        results.push({ pointer, rule, ruleName: rule.name, error, dataPath: pointer, keyword: 'lint', message: error.dataPath + ' ' + error.message, url: rules.url });
-                    }
+                  const pointer = (options.context && options.context.length > 0 ? options.context[options.context.length-1] : null);
+                  for (let error of rule.$schema.errors) {
+                    results.push({ pointer, rule, ruleName: rule.name, error, dataPath: pointer, keyword: 'lint', message: error.instanceLocation, url: rules.url });
+                  }
                 }
             }
             if (!matched && options.verbose) console.warn('Linter rule did not match any known rule-types',rule.name);

packages/oas-linter/package-lock.json

@@ -16,8 +16,9 @@
   "author": "Mike Ralphson",
   "license": "BSD-3-Clause",
   "dependencies": {
+    "@exodus/schemasafe": "^1.0.0-rc.2",
     "should": "^13.2.1",
-    "yaml": "^1.8.3"
+    "yaml": "^1.10.0"
   },
   "repository": {
     "type": "git",

packages/oas-linter/package.json

@@ -26,7 +26,7 @@
     "node-fetch-h2": "^2.3.0",
     "oas-kit-common": "^1.0.8",
     "reftools": "^1.1.5",
-    "yaml": "^1.8.3",
+    "yaml": "^1.10.0",
     "yargs": "^15.3.1"
   },
   "repository": {

packages/oas-resolver/package-lock.json

@@ -7,39 +7,6 @@ const url = require('url');
 const yaml = require('yaml');
 const should = require('should/as-function');
 const maybe = require('call-me-maybe');
-let ajv = require('ajv')({
-    $data: true,
-    allErrors: true,
-    verbose: true,
-    jsonPointers: true,
-    patternGroups: true,
-    extendRefs: true // optional, current default is to 'fail', spec behaviour is to 'ignore'
-});
-//meta: false, // optional, to prevent adding draft-06 meta-schema
-
-let ajvFormats = require('ajv/lib/compile/formats.js');
-ajv.addFormat('uriref', ajvFormats.full['uri-reference']);
-ajv.addMetaSchema(require('ajv/lib/refs/json-schema-draft-04.json'));
-ajv._refs['http://json-schema.org/schema'] = 'http://json-schema.org/draft-04/schema'; // optional, using unversioned URI is out of spec
-let metaSchema = require('ajv/lib/refs/json-schema-v5.json');
-ajv.addMetaSchema(metaSchema);
-ajv._opts.defaultMeta = metaSchema.id;
-
-const bae = require('better-ajv-errors');
-
-class JSONSchemaError extends Error {
-  constructor(message) {
-    super(message);
-    this.name = 'JSONSchemaError';
-  }
-}
-
-class CLIError extends Error {
-  constructor(message) {
-    super(message);
-    this.name = 'CLIError';
-  }
-}
 
 const common = require('oas-kit-common');
 const jptr = require('reftools/lib/jptr.js');
@@ -51,11 +18,6 @@ const sw = require('oas-schema-walker');
 const linter = require('oas-linter');
 const resolver = require('oas-resolver');
 
-const jsonSchema = require('./schemas/json_v5.json');
-const validateMetaSchema = ajv.compile(jsonSchema);
-let openapi3Schema = require('./schemas/openapi-3.0.json');
-let validateOpenAPI3 = ajv.compile(openapi3Schema);
-
 const dummySchema = { anyOf: {} };
 const emptySchema = {};
 let refSeen = {};
@@ -95,20 +57,6 @@ function validateHeaderName(name) {
     return /^[A-Za-z0-9!#\-\$%&'\*\+\\\.\^_`\|~]+$/.test(name);
 }
 
-function validateSchema(schema, openapi, options) {
-    validateMetaSchema(schema);
-    let errors = validateSchema.errors;
-    if (errors && errors.length) {
-        if (options.prettify) {
-            const errorStr = bae(schema, openapi, errors);
-            throw (new CLIError(errorStr));
-        }
-        throw (new JSONSchemaError('Schema invalid:\n'+ yaml.stringify(errors)));
-    }
-    options.schema = schema;
-    return !(errors && errors.length);
-}
-
 function checkSubSchema(schema, parent, state) {
     let prop = state.property;
     if (prop) contextAppend(state.options, prop);
@@ -334,7 +282,6 @@ function checkSubSchema(schema, parent, state) {
         if (state.options.lint) state.options.linter('externalDocs',schema.externalDocs,'externalDocs',state.options);
     }
     if (prop) state.options.context.pop();
-    if (!prop || prop === 'schema') validateSchema(schema, state.openapi, state.options); // top level only
 }
 
 function checkSchema(schema,parent,prop,openapi,options) {
@@ -497,7 +444,7 @@ function checkLink(link, openapi, options) {
     if (typeof link.$ref !== 'undefined') {
         let ref = link.$ref;
         should(ref).be.type('string');
-        if (refSeen[ref]) return true;
+        if (refSeen[ref]) return true; // bail out
         refSeen[ref] = true;
         if (options.lint) options.linter('reference',link,'$ref',options);
         link = resolveInternal(openapi, ref);
@@ -536,7 +483,7 @@ function checkHeader(header, contextServers, openapi, options) {
     if (typeof header.$ref !== 'undefined') {
         let ref = header.$ref;
         should(ref).be.type('string');
-        if (refSeen[ref]) return true;
+        if (refSeen[ref]) return true; // bail out
         refSeen[ref] = true;
         if (options.lint) options.linter('reference',header,'$ref',options);
         header = resolveInternal(openapi, ref);
@@ -582,7 +529,7 @@ function checkResponse(response, key, contextServers, openapi, options) {
     if (typeof response.$ref !== 'undefined') {
         let ref = response.$ref;
         should(ref).be.type('string');
-        if (refSeen[ref]) return true;
+        if (refSeen[ref]) return true; // bail out
         refSeen[ref] = true;
         if (options.lint) options.linter('reference',response,'$ref',options);
         response = resolveInternal(openapi, ref);
@@ -620,13 +567,16 @@ function checkResponse(response, key, contextServers, openapi, options) {
 }
 
 function checkParam(param, index, path, contextServers, openapi, options) {
-    contextAppend(options, index);
     const ref = param.$ref;
+    contextAppend(options, index);
     if (typeof param.$ref !== 'undefined') {
         should(ref).be.type('string');
-        if (refSeen[ref]) return refSeen[ref];
         if (options.lint) options.linter('reference',param,'$ref',options);
         param = resolveInternal(openapi, ref);
+        if (refSeen[ref] && (param.in !== 'path')) {
+          options.context.pop();
+          return param; // bail out
+        }
         should(param).not.be.exactly(false, 'Cannot resolve reference: ' + ref);
     }
     should(param).have.property('name');
@@ -954,16 +904,6 @@ function validateInner(openapi, options, callback) {
     setupOptions(options,openapi);
     let contextServers = [];
 
-    if (options.jsonschema) {
-        let schemaStr = fs.readFileSync(options.jsonschema, 'utf8');
-        openapi3Schema = yaml.parse(schemaStr, { schema:'core' });
-        validateOpenAPI3 = ajv.compile(openapi3Schema);
-    }
-
-    if (options.validateSchema === 'first') {
-        schemaValidate(openapi, options);
-    }
-
     should(openapi).be.an.Object();
     should(openapi).not.have.key('swagger');
     should(openapi).have.key('openapi');
@@ -1383,10 +1323,6 @@ function validateInner(openapi, options, callback) {
         options.context.pop();
     }
 
-    if (!options.validateSchema || (options.validateSchema === 'last')) {
-        schemaValidate(openapi, options);
-    }
-
     options.valid = !options.expectFailure;
     if (options.lint) options.linter('openapi',openapi,'',options);
 
@@ -1418,18 +1354,6 @@ function validateInner(openapi, options, callback) {
     }));
 }
 
-function schemaValidate(openapi, options) {
-    validateOpenAPI3(openapi);
-    let errors = validateOpenAPI3.errors;
-    if (errors && errors.length) {
-        if (options.prettify) {
-            const errorStr = bae(options.schema, openapi, errors, { indent: 2 });
-            throw (new CLIError(errorStr));
-        }
-        throw (new JSONSchemaError('Failed OpenAPI3 schema validation: ' + JSON.stringify(errors, null, 2)));
-    }
-}
-
 function setupOptions(options,openapi) {
     refSeen = {};
     options.valid = false;
@@ -1446,10 +1370,8 @@ function setupOptions(options,openapi) {
         options.linterResults = linter.getResults;
     }
     if (!options.cache) options.cache = {};
-    options.schema = openapi3Schema;
     options.metadata = { lines: -1, count: {} };
     if ((options.text) && (typeof options.text === 'string')) options.metadata.lines = options.text.split('\n').length;
-    options.ajv = ajv;
 }
 
 function validate(openapi, options, callback) {
@@ -1494,7 +1416,5 @@ module.exports = {
     validateInner: validateInner,
     validate: validate,
     microValidate: microValidate,
-    optionallyValidate: optionallyValidate,
-    JSONSchemaError: JSONSchemaError,
-    CLIError: CLIError
+    optionallyValidate: optionallyValidate
 }

packages/oas-resolver/package.json

@@ -17,16 +17,14 @@
   "author": "Mike Ralphson",
   "license": "BSD-3-Clause",
   "dependencies": {
-    "ajv": "^5.5.2",
-    "better-ajv-errors": "^0.6.7",
     "call-me-maybe": "^1.0.1",
     "oas-kit-common": "^1.0.8",
     "oas-linter": "^3.1.3",
     "oas-resolver": "^2.4.3",
     "oas-schema-walker": "^1.1.5",
     "reftools": "^1.1.5",
     "should": "^13.2.1",
-    "yaml": "^1.8.3"
+    "yaml": "^1.10.0"
   },
   "repository": {
     "type": "git",

packages/oas-validator/index.js

@@ -41,6 +41,6 @@
     "mocha": "^8.0.1",
     "nyc": "^15.0.0",
     "should": "^13.2.1",
-    "yaml": "^1.8.3"
+    "yaml": "^1.10.0"
   }
 }

packages/oas-validator/package-lock.json

@@ -7,8 +7,7 @@
 const fs = require('fs');
 
 const yaml = require('yaml');
-const fetch = require('node-fetch-h2');
-const bae = require('better-ajv-errors');
+const fetch = require('node-fetch');
 
 const swagger2openapi = require('./index.js');
 const validator = require('oas-validator');
@@ -21,9 +20,6 @@ let argv = require('yargs')
     .boolean('all')
     .alias('a','all')
     .describe('all','show all lint warnings')
-    .boolean('bae')
-    .alias('b','bae')
-    .describe('bae','enable better-ajv-errors')
     .string('encoding')
     .alias('e','encoding')
     .default('encoding','utf8')
@@ -71,11 +67,8 @@ function main(){
         argv.fatal = true;
         argv.laxurls = true;
         argv.laxDefaults = true;
+        argv.fetch = fetch;
         if (argv.all) argv.lintLimit = Number.MAX_SAFE_INTEGER;
-        if (argv.bae) {
-            argv.validateSchema = 'first';
-            argv.prettify = true;
-        }
         if (argv.internal) {
             argv.resolveInternal = true;
         }
@@ -114,11 +107,7 @@ function main(){
             jsonOutput.warnings = [];
             if (options.warnings) {
                 for (let warning of options.warnings) {
-                    if (argv.bae) {
-                        const display = bae(options.schema,options.openapi,[warning]);
-                        console.warn(display);
-                    }
-                    else if (options.json) {
+                    if (options.json) {
                         jsonOutput.warnings.push({ message:warning.message, pointer:warning.pointer, ruleName:warning.ruleName, ruleUrl:warning.rule.url });
                     }
                     else {

packages/oas-validator/package.json

@@ -142,6 +142,10 @@ function fixUpSubSchema(schema,parent,options) {
     if (schema.xml && typeof schema.xml.namespace === 'string') {
         if (!schema.xml.namespace) delete schema.xml.namespace;
     }
+    if (typeof schema.allowEmptyValue !== 'undefined') {
+      options.patches++;
+      delete schema.allowEmptyValue;
+    }
 }
 
 function fixUpSubSchemaExtensions(schema,parent) {

packages/oas-validator/schemas/json_v5.json

@@ -49,9 +49,6 @@ let argv = yargs
     .string('output')
     .alias('o', 'output')
     .describe('output', 'output conversion result')
-    .boolean('prettify')
-    .alias('p','prettify')
-    .describe('prettify','pretty schema validation errors')
     .boolean('quiet')
     .alias('q', 'quiet')
     .describe('quiet', 'do not show test passes on console, for CI')
@@ -88,8 +85,6 @@ let fail = 0;
 let failures = [];
 let warnings = [];
 
-let genStack = [];
-
 let options = argv;
 options.patch = !argv.nopatch;
 options.fatal = true;
@@ -148,7 +143,6 @@ function finalise(err, options) {
         if (options.file != 'unknown') failures.push(options.file);
         if (argv.stop) process.exit(1);
     }
-    genStackNext();
 }
 
 function handleResult(err, options) {
@@ -203,14 +197,7 @@ function handleResult(err, options) {
     }
 }
 
-function genStackNext() {
-    if (!genStack.length) return false;
-    let gen = genStack.shift();
-    gen.next();
-    return true;
-}
-
-function* check(file, force, expectFailure) {
+async function check(file, force, expectFailure) {
     let result = false;
     options.context = [];
     options.expectFailure = expectFailure;
@@ -242,7 +229,6 @@ function* check(file, force, expectFailure) {
             }
 
             if (!src || ((!src.swagger && !src.openapi))) {
-                genStackNext();
                 return true;
             }
         }
@@ -278,7 +264,6 @@ function* check(file, force, expectFailure) {
                     failures.push('Converter failed ' + options.source);
                     fail++;
                 }
-                genStackNext();
                 result = false;
             });
         }
@@ -297,65 +282,63 @@ function* check(file, force, expectFailure) {
                     failures.push('Converter failed ' + options.source);
                     fail++;
                 }
-                genStackNext();
                 result = false;
             });
         }
     }
     else {
-        genStackNext();
         result = true;
     }
     return result;
 }
 
-function processPathSpec(pathspec, expectFailure) {
+async function processPathSpec(pathspec, expectFailure) {
     globalExpectFailure = expectFailure;
     if (pathspec.startsWith('@')) {
         pathspec = pathspec.substr(1, pathspec.length - 1);
         let list = fs.readFileSync(pathspec, 'utf8').split('\r').join('').split('\n');
         for (let file of list) {
-            genStack.push(check(file, false, expectFailure));
+            await check(file, false, expectFailure);
         }
-        genStackNext();
     }
     else if (pathspec.startsWith('http')) {
-        genStack.push(check(pathspec, true, expectFailure));
-        genStackNext();
+        await check(pathspec, true, expectFailure);
     }
     else if (fs.statSync(path.resolve(pathspec)).isFile()) {
-        genStack.push(check(pathspec, true, expectFailure));
-        genStackNext();
+        await check(pathspec, true, expectFailure);
     }
     else {
         readfiles(pathspec, { readContents: false, filenameFormat: readfiles.FULL_PATH }, function (err) {
             if (err) console.warn(yaml.stringify(err));
         })
-        .then(files => {
+        .then(async function(files) {
             files = files.sort();
             for (let file of files) {
-                genStack.push(check(file, false, expectFailure));
+                await check(file, false, expectFailure);
             }
-            genStackNext();
         })
         .catch(err => {
             handleResult(err,options);
         });
     }
 }
 
-process.exitCode = 1;
-console.warn('Gathering...');
-for (let pathspec of argv._) {
-    processPathSpec(pathspec, false);
-}
-if (argv.fail) {
+async function main() {
+  process.exitCode = 1;
+  console.warn('Gathering...');
+  for (let pathspec of argv._) {
+    await processPathSpec(pathspec, false);
+  }
+  if (argv.fail) {
     if (!Array.isArray(argv.fail)) argv.fail = [argv.fail];
     for (let pathspec of argv.fail) {
-        processPathSpec(pathspec, true);
+      await processPathSpec(pathspec, true);
     }
+  }
 }
 
+main();
+
 process.on('unhandledRejection', r => console.warn('UPR',r));
 
 process.on('exit', function () {

packages/oas-validator/schemas/openapi-3.0.json

@@ -34,7 +34,6 @@
   "author": "Mike Ralphson <mike.ralphson@gmail.com>",
   "license": "BSD-3-Clause",
   "dependencies": {
-    "better-ajv-errors": "^0.6.1",
     "call-me-maybe": "^1.0.1",
     "node-fetch-h2": "^2.3.0",
     "node-readfiles": "^0.2.0",
@@ -43,7 +42,7 @@
     "oas-schema-walker": "^1.1.5",
     "oas-validator": "^4.0.8",
     "reftools": "^1.1.5",
-    "yaml": "^1.8.3",
+    "yaml": "^1.10.0",
     "yargs": "^15.3.1"
   },
   "keywords": [