fix: don't classify remote document references as indirect circrefs (#1265)

Author: shockey

src/specmap/lib/refs.js

@@ -330,8 +330,11 @@ function pointerIsAParent(pointer, parentPointer) {
     return true
   }
   const nextChar = pointer.charAt(parentPointer.length)
+  const lastParentChar = parentPointer.slice(-1)
+
   return pointer.indexOf(parentPointer) === 0
     && (!nextChar || nextChar === '/' || nextChar === '#')
+    && lastParentChar !== '#'
 }
 
 

test/specmap/refs.js

@@ -435,7 +435,7 @@ describe('refs', function () {
   })
 
   describe('deeply resolved', function () {
-    it('should resolve deeply nested $refs, across documents', function () {
+    it('should resolve deeply serial $refs, across documents', function () {
       xmock().get('http://example.com/doc-a', function (req, res, next) {
         xmock().restore()
         return res.send({
@@ -462,5 +462,57 @@ describe('refs', function () {
         })
       })
     })
+    it('should resolve deeply nested $refs, across documents', function () {
+      xmock().get('http://example.com/doc-a', function (req, res, next) {
+        xmock().restore()
+        return res.send({
+          two: {
+            innerTwo: {
+              $ref: '#/three'
+            }
+          },
+          three: {
+            innerThree: {
+              $ref: '#/four'
+            }
+          },
+          four: {
+            four: 4,
+          }
+        })
+      })
+
+      return mapSpec({
+        plugins: [plugins.refs],
+        spec: {
+          result: {
+            $ref: 'http://example.com/doc-a#'
+          }
+        },
+        context: {
+          baseDoc: 'http://example.com/main.json'
+        }
+      }).then((res) => {
+        expect(res.spec).toEqual({
+          result: {
+            two: {
+              innerTwo: {
+                innerThree: {
+                  four: 4
+                }
+              }
+            },
+            three: {
+              innerThree: {
+                four: 4
+              }
+            },
+            four: {
+              four: 4
+            }
+          }
+        })
+      })
+    })
   })
 })

test/subtree-resolver.js

@@ -1,7 +1,22 @@
 import expect, {spyOn, createSpy} from 'expect'
+import xmock from 'xmock'
 import resolve from '../src/subtree-resolver'
 
 describe('subtree $ref resolver', function () {
+  let xapp
+
+  before(() => {
+    xapp = xmock()
+  })
+
+  after(() => {
+    xapp.restore()
+  })
+
+  beforeEach(() => {
+    // refs.clearCache()
+  })
+
   it('should resolve a subtree of an object, and return the targeted subtree', async function () {
     const input = {
       a: {
@@ -253,4 +268,47 @@ describe('subtree $ref resolver', function () {
       }
     })
   })
+  it('should fully resolve across remote documents correctly', async () => {
+    const input = {
+      foo: {
+        bar: {
+          $ref: './remote.json'
+        }
+      }
+    }
+
+    xmock().get('http://example.com/remote.json', function (req, res, next) {
+      xmock().restore()
+      return res.send({
+        baz: {
+          $ref: '#/remoteOther'
+        },
+        remoteOther: {
+          result: 'it works!'
+        }
+      })
+    })
+
+    const res = await resolve(input, [], {
+      baseDoc: 'http://example.com/main.json'
+    })
+
+    expect(res).toEqual({
+      errors: [],
+      spec: {
+        foo: {
+          bar: {
+            $$ref: './remote.json',
+            baz: {
+              $$ref: '#/remoteOther',
+              result: 'it works!'
+            },
+            remoteOther: {
+              result: 'it works!'
+            }
+          }
+        }
+      }
+    })
+  })
 })