Merge branch 'master' into bug/1184-rfc3986-query-param-value-escaping

Author: shockey

package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-client",
-  "version": "3.3.4",
+  "version": "3.3.5",
   "description": "SwaggerJS - a collection of interfaces for OAI specs",
   "main": "dist/index.js",
   "repository": "[email protected]:swagger-api/swagger-js.git",

src/execute/index.js

@@ -104,7 +104,7 @@ export function buildRequest(options) {
 
   // Base Template
   let req = {
-    url: baseUrl({spec, scheme, contextUrl, server, serverVariables}),
+    url: '',
     credentials: 'same-origin',
     headers: {
       // This breaks CORSs... removing this line... probably breaks oAuth. Need to address that
@@ -124,6 +124,15 @@ export function buildRequest(options) {
     req.userFetch = userFetch
   }
 
+  const operationRaw = getOperationRaw(spec, operationId)
+  if (!operationRaw) {
+    throw new OperationNotFoundError(`Operation ${operationId} not found`)
+  }
+
+  const {operation = {}, method, pathName} = operationRaw
+
+  req.url += baseUrl({spec, scheme, contextUrl, server, serverVariables, pathName, method})
+
   // Mostly for testing
   if (!operationId) {
     // Not removing req.cookies causes testing issues and would
@@ -134,13 +143,6 @@ export function buildRequest(options) {
     return req
   }
 
-  const operationRaw = getOperationRaw(spec, operationId)
-  if (!operationRaw) {
-    throw new OperationNotFoundError(`Operation ${operationId} not found`)
-  }
-
-  const {operation = {}, method, pathName} = operationRaw
-
   req.url += pathName // Have not yet replaced the path parameters
   req.method = (`${method}`).toUpperCase()
 
@@ -240,8 +242,11 @@ export function baseUrl(obj) {
   return specIsOAS3 ? oas3BaseUrl(obj) : swagger2BaseUrl(obj)
 }
 
-function oas3BaseUrl({spec, server, contextUrl, serverVariables = {}}) {
-  const servers = spec.servers
+function oas3BaseUrl({spec, pathName, method, server, contextUrl, serverVariables = {}}) {
+  const servers =
+    getIn(spec, ['paths', pathName, (method || '').toLowerCase(), 'servers']) ||
+    getIn(spec, ['paths', pathName, 'servers']) ||
+    getIn(spec, ['servers'])
 
   let selectedServerUrl = ''
   let selectedServerObj = null

src/execute/oas3/build-request.js

@@ -51,7 +51,7 @@ export default function (options, req) {
             Object.keys(requestBody).forEach((k) => {
               const val = requestBody[k]
               req.form[k] = {
-                value: val
+                value: typeof val === 'object' ? JSON.stringify(val) : val
               }
             })
           }

src/specmap/index.js

@@ -83,6 +83,8 @@ class SpecMap {
     // We might consider making this (traversing & application) configurable later.
     function createKeyBasedPlugin(pluginObj) {
       return function* (patches, specmap) {
+        const traversedRefs = {}
+
         for (const patch of patches.filter(lib.isAdditiveMutation)) {
           yield* traverse(patch.value, patch.path, patch)
         }
@@ -102,9 +104,21 @@ class SpecMap {
             for (const key of Object.keys(obj)) {
               const val = obj[key]
               const updatedPath = path.concat(key)
-
-              if (lib.isObject(val)) {
-                yield* traverse(val, updatedPath, patch)
+              const isObj = lib.isObject(val)
+
+              // If the object has a meta '$$ref' - and store this $$ref
+              // in a lookaside to prevent future traversals of this $ref's tree.
+              const objRef = obj.$$ref
+              const traversed = specmap.allowMetaPatches && traversedRefs[obj.$$ref]
+
+              if (!traversed) {
+                if (isObj) {
+                  // Only store the ref if it exists
+                  if (specmap.allowMetaPatches && objRef) {
+                    traversedRefs[objRef] = true
+                  }
+                  yield* traverse(val, updatedPath, patch)
+                }
               }
 
               if (!isRootProperties && key === pluginObj.key) {

test.js

@@ -37,37 +37,27 @@ describe('execute', () => {
       })
     })
 
-    it('should include host + http + baseUrl', function () {
-      // Given
-      const spec = {
-        host: 'swagger.io',
-        basePath: '/v1',
-      }
-
-      // When
-      const req = buildRequest({spec})
-
-      // Then
-      expect(req).toEqual({
-        url: 'http://swagger.io/v1',
-        credentials: 'same-origin',
-        headers: { }
-      })
-    })
-
     it('should include host + port', function () {
       // Given
       const spec = {
         host: 'foo.com:8081',
         basePath: '/v1',
+        paths: {
+          '/': {
+            get: {
+              operationId: 'foo'
+            }
+          }
+        }
       }
 
       // When
-      const req = buildRequest({spec})
+      const req = buildRequest({spec, operationId: 'foo'})
 
       // Then
       expect(req).toEqual({
-        url: 'http://foo.com:8081/v1',
+        url: 'http://foo.com:8081/v1/',
+        method: 'GET',
         credentials: 'same-origin',
         headers: { }
       })

test/execute/main.js

@@ -169,6 +169,58 @@ describe('buildRequest - OpenAPI Specification 3.0', function () {
       })
     })
 
+    it('should stringify object values of form data bodies', function () {
+      // Given
+      const spec = {
+        openapi: '3.0.0',
+        servers: [
+          {
+            url: 'http://petstore.swagger.io/v2',
+            name: 'Petstore'
+          }
+        ],
+        paths: {
+          '/one': {
+            get: {
+              operationId: 'getOne',
+              requestBody: {
+                content: {
+                  'application/x-www-form-urlencoded': {
+                    schema: {
+                      type: 'object'
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+
+      // when
+      const req = buildRequest({
+        spec,
+        operationId: 'getOne',
+        requestBody: {
+          a: 1,
+          b: {
+            c: 3,
+            d: 4
+          }
+        }
+      })
+
+      expect(req).toEqual({
+        method: 'GET',
+        url: 'http://petstore.swagger.io/v2/one',
+        credentials: 'same-origin',
+        headers: {
+          'Content-Type': 'application/x-www-form-urlencoded'
+        },
+        body: 'a=1&b=%7B%22c%22%3A3%2C%22d%22%3A4%7D'
+      })
+    })
+
     it('should build a request for the given operationId with a requestBody, and not be overriden by an invalid Swagger2 body parameter value', function () {
       // Given
       const spec = {
@@ -419,6 +471,104 @@ describe('buildRequest - OpenAPI Specification 3.0', function () {
 
       expect(res).toEqual('https://petstore.net')
     })
+    it('should use an explicitly chosen server at the operation level', function () {
+      const spec = {
+        openapi: '3.0.0',
+        servers: [
+          {
+            url: 'https://petstore.com'
+          },
+          {
+            url: 'https://petstore.net'
+          }
+        ],
+        paths: {
+          '/': {
+            get: {
+              servers: [
+                {
+                  url: 'https://petstore-operation.net/{path}',
+                  variables: {
+                    path: {
+                      default: 'foobar'
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+
+      const res = baseUrl({
+        spec,
+        server: 'https://petstore-operation.net/{path}',
+        pathName: '/',
+        method: 'GET'
+      })
+
+      const resWithVariables = baseUrl({
+        spec,
+        server: 'https://petstore-operation.net/{path}',
+        serverVariables: {
+          path: 'fizzbuzz'
+        },
+        pathName: '/',
+        method: 'GET'
+      })
+
+      expect(res).toEqual('https://petstore-operation.net/foobar')
+      expect(resWithVariables).toEqual('https://petstore-operation.net/fizzbuzz')
+    })
+
+    it('should use an explicitly chosen server at the path level', function () {
+      const spec = {
+        openapi: '3.0.0',
+        servers: [
+          {
+            url: 'https://petstore.com'
+          },
+          {
+            url: 'https://petstore.net'
+          }
+        ],
+        paths: {
+          '/': {
+            servers: [
+              {
+                url: 'https://petstore-path.net/{path}',
+                variables: {
+                  path: {
+                    default: 'foobar'
+                  }
+                }
+              }
+            ],
+            get: {}
+          }
+        }
+      }
+
+      const res = baseUrl({
+        spec,
+        server: 'https://petstore-path.net/{path}',
+        pathName: '/',
+        method: 'GET'
+      })
+
+      const resWithVariables = baseUrl({
+        spec,
+        server: 'https://petstore-path.net/{path}',
+        serverVariables: {
+          path: 'fizzbuzz'
+        },
+        pathName: '/',
+        method: 'GET'
+      })
+
+      expect(res).toEqual('https://petstore-path.net/foobar')
+      expect(resWithVariables).toEqual('https://petstore-path.net/fizzbuzz')
+    })
     it('should not use an explicitly chosen server that is not present in the spec', function () {
       const spec = {
         openapi: '3.0.0',