Merge pull request #1161 from shockey/bug/ui-3763-ref-interceptors

Interceptors for $ref download

Author: shockey

src/index.js

@@ -69,7 +69,9 @@ Swagger.prototype = {
     return Swagger.resolve({
       spec: this.spec,
       url: this.url,
-      allowMetaPatches: this.allowMetaPatches
+      allowMetaPatches: this.allowMetaPatches,
+      requestInterceptor: this.requestInterceptor || null,
+      responseInterceptor: this.responseInterceptor || null
     }).then((obj) => {
       this.originalSpec = this.spec
       this.spec = obj.spec

src/resolver.js

@@ -2,11 +2,14 @@ import Http from './http'
 import mapSpec, {plugins} from './specmap'
 import {normalizeSwagger} from './helpers'
 
-export function makeFetchJSON(http) {
+export function makeFetchJSON(http, opts = {}) {
+  const {requestInterceptor, responseInterceptor} = opts
   return (docPath) => {
     return http({
       url: docPath,
       loadSpec: true,
+      requestInterceptor,
+      responseInterceptor,
       headers: {
         Accept: 'application/json'
       },
@@ -23,10 +26,17 @@ export function clearCache() {
   plugins.refs.clearCache()
 }
 
-export default function resolve({
-  http, fetch, spec, url, baseDoc, mode, allowMetaPatches = true,
-  modelPropertyMacro, parameterMacro
-}) {
+export default function resolve(obj) {
+  const {
+    fetch, spec, url, mode, allowMetaPatches = true,
+    modelPropertyMacro, parameterMacro, requestInterceptor,
+    responseInterceptor
+  } = obj
+
+  let {http, baseDoc} = obj
+
+  // console.log(obj)
+
   // @TODO Swagger-UI uses baseDoc instead of url, this is to allow both
   // need to fix and pick one.
   baseDoc = baseDoc || url
@@ -36,7 +46,7 @@ export default function resolve({
   http = fetch || http || Http
 
   if (!spec) {
-    return makeFetchJSON(http)(baseDoc).then(doResolve)
+    return makeFetchJSON(http, {requestInterceptor, responseInterceptor})(baseDoc).then(doResolve)
   }
 
   return doResolve(spec)
@@ -47,7 +57,7 @@ export default function resolve({
     }
 
     // Build a json-fetcher ( ie: give it a URL and get json out )
-    plugins.refs.fetchJSON = makeFetchJSON(http)
+    plugins.refs.fetchJSON = makeFetchJSON(http, {requestInterceptor, responseInterceptor})
 
     const plugs = [plugins.refs]
 

test/index.js

@@ -494,17 +494,27 @@ describe('constructor', () => {
 
   describe('interceptor', function () {
     beforeEach(() => {
+      Swagger.clearCache()
       const xapp = xmock()
       xapp
         .get('http://petstore.swagger.io/v2/swagger.json', () => require('./data/petstore.json'))
         .get('http://petstore.swagger.io/v2/pet/3', () => ({id: 3}))
         .get('http://petstore.swagger.io/v2/pet/4', () => ({id: 4}))
+        .get('http://petstore.swagger.io/v2/ref.json', () => ({b: 2}))
+        .get('http://petstore.swagger.io/v2/base.json', () => (
+          {
+            $ref: 'http://petstore.swagger.io/v2/ref.json#b'
+          }
+        ))
     })
 
     it('should support request interceptor', function (cb) {
       new Swagger({
         url: 'http://petstore.swagger.io/v2/swagger.json',
         requestInterceptor: (req) => {
+          if (req.loadSpec) {
+            return req
+          }
           req.url = 'http://petstore.swagger.io/v2/pet/4'
         }
       }).then((client) => {
@@ -528,5 +538,44 @@ describe('constructor', () => {
         })
       }, cb)
     })
+
+    it('should support request interceptor when fetching a spec and remote ref', function (cb) {
+      const spy = createSpy().andCall(a => a)
+      new Swagger({
+        url: 'http://petstore.swagger.io/v2/base.json',
+        requestInterceptor: spy
+      }).then((client) => {
+        expect(spy.calls.length).toEqual(2)
+        cb()
+      }).catch(cb)
+    })
+
+    it('should support response interceptor when fetching a spec and remote ref', function (cb) {
+      const spy = createSpy().andCall((a) => {
+        return a
+      })
+
+      new Swagger({
+        url: 'http://petstore.swagger.io/v2/base.json',
+        responseInterceptor: spy
+      }).then((client) => {
+        expect(spy.calls.length).toEqual(2)
+        cb()
+      }).catch(cb)
+    })
+
+    it('should support request and response interceptor when fetching a spec and remote ref', function (cb) {
+      const reqSpy = createSpy().andCall(a => a)
+      const resSpy = createSpy().andCall(a => a)
+      new Swagger({
+        url: 'http://petstore.swagger.io/v2/base.json',
+        responseInterceptor: reqSpy,
+        requestInterceptor: resSpy
+      }).then((client) => {
+        expect(reqSpy.calls.length).toEqual(2)
+        expect(resSpy.calls.length).toEqual(2)
+        cb()
+      }).catch(cb)
+    })
   })
 })