Fixed issue with recursive reference causing RangeError

Author: VShingala

lib/schemaUtils.js

@@ -2271,16 +2271,21 @@ module.exports = {
    * @param {object} components - components defined in the OAS spec. These are used to
    * resolve references while generating params.
    * @param {object} options - a standard list of options that's globally passed around. Check options.js for more.
+   * @param {*} seenRef - References that are repeated. Used to identify circular references.
    * @returns {Object} reference object from the saved components
    * @no-unit-tests
    */
-  getRefObject: function($ref, components, options) {
+  getRefObject: function($ref, components, options, seenRef = {}) {
     var refObj, savedSchema;
 
     if (typeof $ref !== 'string') {
       return { value: `Invalid $ref: ${$ref} was found` };
     }
 
+    if (seenRef[$ref]) {
+      return { value: `<Error: "${$ref}" contains circular references in it.` };
+    }
+
     savedSchema = $ref.split('/').slice(1).map((elem) => {
       // https://swagger.io/docs/specification/using-ref#escape
       // since / is the default delimiter, slashes are escaped with ~1
@@ -2311,10 +2316,16 @@ module.exports = {
       return { value: `reference ${$ref} not found in the given specification` };
     }
 
+    // Mark current $ref as seen while processing it further
+    seenRef[$ref] = true;
+
     if (refObj.$ref) {
-      return this.getRefObject(refObj.$ref, components, options);
+      return this.getRefObject(refObj.$ref, components, options, seenRef);
     }
 
+    // Unmark current $ref once resolved
+    seenRef[$ref] = false;
+
     return refObj;
   },
 

test/unit/base.test.js

@@ -92,7 +92,9 @@ describe('CONVERT FUNCTION TESTS ', function() {
       specWithNullParams =
         path.join(__dirname, VALID_OPENAPI_PATH, '/specWithNullParams.yaml'),
       acceptHeaderExample =
-        path.join(__dirname, VALID_OPENAPI_PATH, '/acceptHeaderExample.json');
+        path.join(__dirname, VALID_OPENAPI_PATH, '/acceptHeaderExample.json'),
+      recursiveRefComponents =
+        path.join(__dirname, VALID_OPENAPI_PATH, '/recursiveRefComponents.yaml');
 
 
     it('Should add collection level auth with type as `bearer`' +
@@ -1888,6 +1890,35 @@ describe('CONVERT FUNCTION TESTS ', function() {
           done();
         });
     });
+
+    it('Should handle recursive references for non-schema $refs correctly', function(done) {
+      var openapi = fs.readFileSync(recursiveRefComponents, 'utf8');
+      Converter.convert({ type: 'string', data: openapi }, {},
+        (err, conversionResult) => {
+          expect(err).to.be.null;
+          expect(conversionResult.result).to.equal(true);
+          expect(conversionResult.output.length).to.equal(1);
+          expect(conversionResult.output[0].type).to.equal('collection');
+          expect(conversionResult.output[0].data).to.have.property('info');
+          expect(conversionResult.output[0].data).to.have.property('item');
+          expect(conversionResult.output[0].data.item.length).to.equal(1);
+
+          const item = conversionResult.output[0].data.item[0];
+
+          expect(item.request.header).to.be.undefined;
+          expect(item.request.url.query).to.be.empty;
+          expect(item.response.length).to.eql(2);
+          expect(item.response[0].header.length).to.eql(1);
+          expect(item.response[0].header[0].key).to.eql('Content-Type');
+          expect(item.response[0].header[0].value).to.eql('text/plain');
+          expect(item.response[0].body).to.be.empty;
+          expect(item.response[1].header.length).to.eql(1);
+          expect(item.response[1].header[0].key).to.eql('Content-Type');
+          expect(item.response[1].header[0].value).to.eql('text/plain');
+          expect(item.response[1].body).to.be.empty;
+          done();
+        });
+    });
   });
 
   describe('Converting swagger 2.0 files', function() {

test/unit/convertV2.test.js

@@ -87,7 +87,9 @@ const expect = require('chai').expect,
   specWithNullParams =
     path.join(__dirname, VALID_OPENAPI_PATH, '/specWithNullParams.yaml'),
   acceptHeaderExample =
-    path.join(__dirname, VALID_OPENAPI_PATH, '/acceptHeaderExample.json');
+    path.join(__dirname, VALID_OPENAPI_PATH, '/acceptHeaderExample.json'),
+  recursiveRefComponents =
+    path.join(__dirname, VALID_OPENAPI_PATH, '/recursiveRefComponents.yaml');
 
 
 describe('The convert v2 Function', function() {
@@ -2179,4 +2181,29 @@ describe('The convert v2 Function', function() {
         done();
       });
   });
+
+  it('Should handle recursive references for non-schema $refs correctly', function(done) {
+    var openapi = fs.readFileSync(recursiveRefComponents, 'utf8');
+    Converter.convertV2({ type: 'string', data: openapi }, {},
+      (err, conversionResult) => {
+        expect(err).to.be.null;
+        expect(conversionResult.result).to.equal(true);
+        expect(conversionResult.output.length).to.equal(1);
+        expect(conversionResult.output[0].type).to.equal('collection');
+        expect(conversionResult.output[0].data).to.have.property('info');
+        expect(conversionResult.output[0].data).to.have.property('item');
+        expect(conversionResult.output[0].data.item.length).to.equal(1);
+
+        const item = conversionResult.output[0].data.item[0].item[0];
+
+        expect(item.request.header).to.be.undefined;
+        expect(item.request.url.query).to.be.empty;
+        expect(item.response.length).to.eql(2);
+        expect(item.response[0].header).to.be.empty;
+        expect(item.response[0].body).to.be.undefined;
+        expect(item.response[1].header).to.be.empty;
+        expect(item.response[1].body).to.be.undefined;
+        done();
+      });
+  });
 });