feat: adding support for server variables into oas-to-har

package.json

@@ -31,7 +31,7 @@
     "@readme/emojis": "^3.0.0",
     "@readme/ui": "^1.17.8",
     "babel-polyfill": "^6.26.0",
-    "oas": "^10.2.0",
+    "oas": "^10.4.0",
     "prop-types": "^15.7.2",
     "react-hot-loader": "^4.12.16",
     "swagger2openapi": "^7.0.0",

packages/api-explorer/package.json

@@ -31,7 +31,7 @@
     "js-cookie": "^2.1.4",
     "lodash.clonedeep": "^4.5.0",
     "lodash.kebabcase": "^4.1.1",
-    "oas": "^10.2.0",
+    "oas": "^10.4.0",
     "prop-types": "^15.7.2",
     "react-copy-to-clipboard": "^5.0.1",
     "react-debounce-input": "^3.2.0",

packages/oas-to-har/README.md

@@ -1,6 +1,6 @@
 # @readme/oas-to-har
 
-Utility to transform an OAS operation into a HAR representation
+Utility to transform an OAS operation into a [HAR](http://www.softwareishard.com/blog/har-12-spec/) representation
 
 [![Build](https://github.com/readmeio/api-explorer/workflows/CI/badge.svg)](https://github.com/readmeio/api-explorer/tree/master/packages/oas-to-har)
 
@@ -19,9 +19,24 @@ const Oas = require('oas/tooling');
 const oasToHar = require('@readme/oas-to-har');
 
 const spec = new Oas('petstore.json');
-console.log(oasToHar(spec));
+console.log(oasToHar(spec, { path: '/pets', method: 'post'}));
 ```
 
+### `oasToHar(har, operationSchema, values, auth, opts) => Object`
+
+- `oas` *{Oas}*: Instance of our [oas/tooling](https://npm.im/oas) class.
+- `operationSchema` *{Object\|Operation}*: Can either be an object with `path` and `method` properties (that exist in the supplied OAS), or an instance of our `Operation` class from [oas/tooling](https://npm.im/oas) - accessed through `new Oas(spec).operation(path, method)`.
+- `values` *{Object}*: A object of payload data, with key-value data therein, that should be used to construct the request. Available data you can define here:
+  - `path`
+  - `query`
+  - `body`
+  - `cookie`
+  - `formData`
+  - `header`
+  - `server` — If the supplied OAS has multiple severs or server variables you can use this to set which server and variables to use. Shape of it should be: `{ selected: Integer, variables: { ...key-values }}`. `selected` should coorespond to index of the `servers` array in your OAS.
+- `auth` *{Object}*: Authentication information for the request.
+- `opts.proxyUrl` *{Boolean}*: Boolean to toggle if composed HAR objects should have their `url` be sent through our CORS-friendly proxy. Defaults to `false`.
+
 ## Credits
 [Jon Ursenbach](https://github.com/erunion)
 

packages/oas-to-har/__tests__/__fixtures__/server-variables.json

@@ -0,0 +1,46 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "version": "1.0.0",
+    "title": "Server variables"
+  },
+  "servers": [
+    {
+      "url": "https://{name}.example.com:{port}/{basePath}",
+      "variables": {
+        "name": {
+          "default": "demo"
+        },
+        "port": {
+          "default": "443"
+        },
+        "basePath": {
+          "default": "v2"
+        }
+      }
+    },
+    {
+      "url": "http://{name}.local/{basePath}",
+      "variables": {
+        "name": {
+          "default": "demo"
+        },
+        "basePath": {
+          "default": "v2"
+        }
+      }
+    }
+  ],
+  "paths": {
+    "/": {
+      "post": {
+        "summary": "Should fetch variables from defaults and user values",
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    }
+  }
+}

packages/oas-to-har/__tests__/index.test.js

@@ -7,6 +7,7 @@ const oasToHar = require('../src/index');
 const commonParameters = require('./__fixtures__/common-parameters.json');
 const multipartFormData = require('./__fixtures__/multipart-form-data.json');
 const multipartFormDataArrayOfFiles = require('./__fixtures__/multipart-form-data/array-of-files.json');
+const serverVariables = require('./__fixtures__/server-variables.json');
 
 const oas = new Oas();
 
@@ -53,6 +54,63 @@ describe('url', () => {
     );
   });
 
+  describe('server variables', () => {
+    const variablesOas = new Oas(serverVariables);
+    const operation = variablesOas.operation('/', 'post');
+
+    it('should use defaults if not supplied', () => {
+      const har = oasToHar(variablesOas, operation, {});
+      expect(har.log.entries[0].request.url).toBe('https://demo.example.com:443/v2/');
+    });
+
+    it('should support server variables', () => {
+      const formData = {
+        server: {
+          selected: 0,
+          variables: { name: 'buster', port: 8080, basePath: 'v2.1' },
+        },
+      };
+
+      const har = oasToHar(variablesOas, operation, formData);
+      expect(har.log.entries[0].request.url).toBe('https://buster.example.com:8080/v2.1/');
+    });
+
+    it('should support multiple/alternate servers', () => {
+      const formData = {
+        server: {
+          selected: 1,
+          variables: { name: 'buster', port: 8080, basePath: 'v2.1' },
+        },
+      };
+
+      const har = oasToHar(variablesOas, operation, formData);
+      expect(har.log.entries[0].request.url).toBe('http://buster.local/v2.1/');
+    });
+
+    it('should not error if the selected server does not exist', () => {
+      const formData = {
+        server: {
+          selected: 3,
+        },
+      };
+
+      const har = oasToHar(variablesOas, operation, formData);
+      expect(har.log.entries[0].request.url).toBe('https://example.com/');
+    });
+
+    it('should fill in missing variables with their defaults', () => {
+      const formData = {
+        server: {
+          selected: 0,
+          variables: { name: 'buster' }, // `port` and `basePath` are missing
+        },
+      };
+
+      const har = oasToHar(variablesOas, operation, formData);
+      expect(har.log.entries[0].request.url).toBe('https://buster.example.com:443/v2/');
+    });
+  });
+
   describe('proxy url', () => {
     const proxyOas = new Oas({
       [extensions.PROXY_ENABLED]: true,

packages/oas-to-har/package.json

@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "@readme/oas-extensions": "^13.1.0",
-    "oas": "^10.2.0",
+    "oas": "^10.4.0",
     "parse-data-url": "^3.0.0"
   },
   "devDependencies": {

packages/oas-to-har/src/index.js

@@ -97,7 +97,21 @@ module.exports = (
     operation = new Operation(oas, operationSchema.path, operationSchema.method, operationSchema);
   }
 
-  const formData = { ...defaultFormDataTypes, ...values };
+  const formData = {
+    ...defaultFormDataTypes,
+    server: {
+      selected: 0,
+      variables: oas.defaultVariables(0),
+    },
+    ...values,
+  };
+
+  // If the incoming `server.variables` is missing variables let's pad it out with defaults.
+  formData.server.variables = {
+    ...oas.defaultVariables(formData.server.selected),
+    ...formData.server.variables,
+  };
+
   const har = {
     cookies: [],
     headers: [],
@@ -106,7 +120,7 @@ module.exports = (
     postData: {},
     bodySize: 0,
     method: operation.method.toUpperCase(),
-    url: `${oas.url()}${operation.path}`.replace(/\s/g, '%20'),
+    url: `${oas.url(formData.server.selected, formData.server.variables)}${operation.path}`.replace(/\s/g, '%20'),
     httpVersion: 'HTTP/1.1',
   };
 

packages/oas-to-snippet/package.json

@@ -22,7 +22,7 @@
     "@readme/oas-to-har": "^13.1.0",
     "@readme/syntax-highlighter": "^10.4.1",
     "httpsnippet-client-api": "^3.0.0",
-    "oas": "^10.2.0"
+    "oas": "^10.4.0"
   },
   "devDependencies": {
     "@readme/eslint-config": "^4.0.0",