fix: check node type before treating object as reference (#1719) (#1720)

ref #1719

Author: tim-lai

src/specmap/helpers.js

@@ -1,5 +1,6 @@
 import traverse from 'traverse';
 import URL from 'url';
+import isString from 'lodash/isString';
 
 // This will match if the direct parent's key exactly matches an item.
 const freelyNamedKeyParents = ['properties'];
@@ -58,7 +59,7 @@ export function generateAbsoluteRefPatches(
   const patches = [];
 
   traverse(obj).forEach(function callback() {
-    if (targetKeys.indexOf(this.key) > -1) {
+    if (targetKeys.includes(this.key) && isString(this.node)) {
       const nodePath = this.path; // this node's path, relative to `obj`
       const fullPath = basePath.concat(this.path);
 

test/bugs/1719.js

@@ -0,0 +1,34 @@
+// https://github.com/swagger-api/swagger-js/issues/1719
+
+import path from 'path';
+import fs from 'fs';
+import jsYaml from 'js-yaml';
+
+import resolveSubtree from '../../src/subtree-resolver';
+
+const testDoc = jsYaml.safeLoad(
+  fs.readFileSync(path.join('test', 'data', 'issue-1719-ref-object-reference.yaml'), 'utf8')
+);
+
+test('#1719: $ref object should not be treated as a reference (string)', async () => {
+  const specPath = ['paths', '/throwError', 'post'];
+  const res = await resolveSubtree(testDoc, specPath);
+
+  expect(res.errors.length).toEqual(0);
+  expect(res.spec).toHaveProperty(
+    [
+      'requestBody',
+      'content',
+      'application/json',
+      'schema',
+      'properties',
+      'propertyOne',
+      'items',
+      'properties',
+      'propertyTwo',
+      'properties',
+      '$ref',
+    ],
+    { type: 'string' }
+  );
+});

test/data/issue-1719-ref-object-reference.yaml

@@ -0,0 +1,55 @@
+openapi: 3.0.0
+servers:
+  - description: "mock definition for swagger-client issue #1719"
+    url: https://test.com/v1
+info:
+  version: "0.0.1"
+  title: Test Defect
+  description: >-
+    A client side JS error occured when the throwError endpoint was expanded in
+    the UI Docs panel. This error was specifically visible when a $ref is seen 
+    by the subtree resolver after an allOf or after an anyOf. E.g. the subtree
+    resolver was treating the $ref as a reference instead as an object.
+paths:
+  /throwError:
+    post:
+      summary: Opening this documentation (previously) throws an error
+      description: Allows baskets of new prospects to be imported in to a portal
+      responses:
+        '200':
+          description: OK
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/1_SchemaRef'
+        description: the data to import
+        required: true
+components:
+  schemas:
+    1_SchemaRef:
+      type: object
+      properties:
+        propertyOne:
+          type: array
+          items:
+            $ref: '#/components/schemas/2_RefWithAllOf'
+
+    2_RefWithAllOf:
+      allOf:
+        - $ref: '#/components/schemas/3_InnerAllOfRef'
+    
+    3_InnerAllOfRef:
+      type: object
+      properties:
+        propertyTwo:
+          $ref: '#/components/schemas/0_TargetRef'
+
+    0_TargetRef:
+      type: object
+      properties:
+        $ref: # this $ref should be treated as an object, not a reference string
+          type: string
+        devTestRefId:
+          type: string
+