feat: stop running schema dereferencing when running validation

__tests__/index.test.js

@@ -130,6 +130,7 @@ describe('#validate', () => {
       expect(definition.openapi).toBe('3.0.0');
       expect(Object.keys(definition.paths)).toHaveLength(14);
       expect(definition.paths['/pet'].post.operationId).toBe('addPet');
+      expect(definition.paths['/pet'].post.requestBody).toStrictEqual({ $ref: '#/components/requestBodies/Pet' });
       expect(Object.keys(definition.components.requestBodies)).toHaveLength(2);
       expect(Object.keys(definition.components.securitySchemes)).toHaveLength(2);
       expect(Object.keys(definition.components.schemas)).toHaveLength(6);
@@ -145,6 +146,7 @@ describe('#validate', () => {
       expect(definition.openapi).toBe('3.0.0');
       expect(Object.keys(definition.paths)).toHaveLength(14);
       expect(definition.paths['/pet'].post.operationId).toBe('addPet');
+      expect(definition.paths['/pet'].post.requestBody).toStrictEqual({ $ref: '#/components/requestBodies/Pet' });
       expect(Object.keys(definition.components.requestBodies)).toHaveLength(2);
       expect(Object.keys(definition.components.securitySchemes)).toHaveLength(2);
       expect(Object.keys(definition.components.schemas)).toHaveLength(6);
@@ -202,6 +204,7 @@ describe('#validate', () => {
 
       expect(definition.openapi).toBe('3.0.0');
       expect(definition.paths['/pet'].post.operationId).toBe('addPet');
+      expect(definition.paths['/pet'].post.requestBody).toStrictEqual({ $ref: '#/components/requestBodies/Pet' });
       expect(Object.keys(definition.paths)).toHaveLength(14);
       expect(Object.keys(definition.components.schemas)).toHaveLength(6);
 
@@ -214,6 +217,7 @@ describe('#validate', () => {
 
       expect(definition.openapi).toBe('3.0.0');
       expect(definition.paths['/pet'].post.operationId).toBe('addPet');
+      expect(definition.paths['/pet'].post.requestBody).toStrictEqual({ $ref: '#/components/requestBodies/Pet' });
       expect(Object.keys(definition.paths)).toHaveLength(14);
       expect(Object.keys(definition.components.schemas)).toHaveLength(6);
     });

index.js

@@ -1,8 +1,7 @@
 const fetch = require('node-fetch');
 const fs = require('fs');
-const $RefParser = require('@apidevtools/json-schema-ref-parser');
 const converter = require('swagger2openapi');
-const SwaggerParser = require('swagger-parser');
+const swaggerParser = require('@apidevtools/swagger-parser');
 const utils = require('./lib/utils');
 
 class oasNormalize {
@@ -52,7 +51,7 @@ class oasNormalize {
     if (this.cache.bundle) return Promise.resolve(this.cache.bundle);
 
     return this.load()
-      .then(schema => $RefParser.bundle(schema))
+      .then(schema => swaggerParser.bundle(schema))
       .then(bundle => {
         this.cache.bundle = bundle;
         return bundle;
@@ -63,32 +62,39 @@ class oasNormalize {
     if (this.cache.deref) return Promise.resolve(this.cache.deref);
 
     return this.load()
-      .then(schema => $RefParser.dereference(schema))
+      .then(schema => swaggerParser.dereference(schema))
       .then(dereferenced => {
         this.cache.deref = dereferenced;
         return dereferenced;
       });
   }
 
   async validate(convertToLatest) {
-    return this.deref().then(async schema => {
+    return this.load().then(async schema => {
       const baseVersion = parseInt(utils.version(schema), 10);
 
-      const resolve = out => {
-        if (!convertToLatest) {
-          return out;
-        }
-
-        return converter.convertObj(out, { anchors: true }).then(options => {
-          return options.openapi;
-        });
-      };
-
       if (baseVersion === 1) {
         return Promise.reject(new Error('Swagger v1.2 is unsupported.'));
       } else if (baseVersion === 2 || baseVersion === 3) {
-        return resolve(
-          await SwaggerParser.validate(schema).catch(err => {
+        // `swaggerParser.validate()` dereferences schemas at the same time as validation and does
+        // not give us an option to disable this. Since all we already have a dereferencing method
+        // on this library and our `validate()` method here just needs to tell us if the definition
+        // is valid or not we need to clone it before passing it over to `swagger-parser` so as to
+        // not run into pass-by-reference problems.
+        const clonedSchema = JSON.parse(JSON.stringify(schema));
+
+        return swaggerParser
+          .validate(clonedSchema)
+          .then(() => {
+            if (!convertToLatest) {
+              return schema;
+            }
+
+            return converter.convertObj(schema, { anchors: true }).then(options => {
+              return options.openapi;
+            });
+          })
+          .catch(err => {
             const error = new Error(err.message.replace(/\[object Object\]/g, 'Schema'));
             error.full = err;
 
@@ -108,8 +114,7 @@ class oasNormalize {
             }
 
             return Promise.reject(error);
-          })
-        );
+          });
       }
 
       return Promise.reject(new Error('The supplied API definition is unsupported.'));

package.json

@@ -37,10 +37,9 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^9.0.7",
+    "@apidevtools/swagger-parser": "^10.0.3",
     "js-yaml": "^4.1.0",
     "node-fetch": "^2.6.1",
-    "swagger-parser": "^10.0.1",
     "swagger2openapi": "^7.0.8"
   },
   "devDependencies": {