@readme/oas-to-har 14.0.2 → 14.1.0

package/.github/workflows/ci.yml

@@ -13,13 +13,10 @@ jobs:
       - uses: actions/checkout@v2.4.0
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.5.0
+        uses: actions/setup-node@v2.5.1
         with:
           node-version: ${{ matrix.node-version }}
 
-      - name: Install npm@7
-        run: npm install -g npm@7
-
       - name: Install deps
         run: npm ci
 

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+## 14.1.0 (2022-01-25)
+
+* chore(deps): bumping all out of date deps (#51) ([926763b](https://github.com/readmeio/oas-to-har/commit/926763b)), closes [#51](https://github.com/readmeio/oas-to-har/issues/51)
+* chore(deps): bumping node-fetch ([1405d30](https://github.com/readmeio/oas-to-har/commit/1405d30))
+* feat: add support for styles on multipart/form-data request bodies (#50) ([e7596bd](https://github.com/readmeio/oas-to-har/commit/e7596bd)), closes [#50](https://github.com/readmeio/oas-to-har/issues/50)
+* fix: check for orphaned apiDefinition-less pages (#52) ([04ed408](https://github.com/readmeio/oas-to-har/commit/04ed408)), closes [#52](https://github.com/readmeio/oas-to-har/issues/52)
+
+
+
+## <small>14.0.5 (2022-01-03)</small>
+
+* chore(deps-dev): bump @commitlint/cli from 15.0.0 to 16.0.1 (#45) ([4ce0b94](https://github.com/readmeio/oas-to-har/commit/4ce0b94)), closes [#45](https://github.com/readmeio/oas-to-har/issues/45)
+* chore(deps-dev): bump @commitlint/config-conventional (#48) ([dc5195a](https://github.com/readmeio/oas-to-har/commit/dc5195a)), closes [#48](https://github.com/readmeio/oas-to-har/issues/48)
+* chore(deps-dev): bump @readme/eslint-config from 8.0.4 to 8.1.1 (#46) ([8788c1e](https://github.com/readmeio/oas-to-har/commit/8788c1e)), closes [#46](https://github.com/readmeio/oas-to-har/issues/46)
+* chore(deps-dev): bump eslint from 8.4.1 to 8.6.0 (#47) ([e211feb](https://github.com/readmeio/oas-to-har/commit/e211feb)), closes [#47](https://github.com/readmeio/oas-to-har/issues/47)
+* chore(deps): bump actions/setup-node from 2.5.0 to 2.5.1 (#43) ([a05def3](https://github.com/readmeio/oas-to-har/commit/a05def3)), closes [#43](https://github.com/readmeio/oas-to-har/issues/43)
+* chore(deps): bump oas from 17.3.2 to 17.4.0 (#44) ([8abb825](https://github.com/readmeio/oas-to-har/commit/8abb825)), closes [#44](https://github.com/readmeio/oas-to-har/issues/44)
+* chore(deps): upgrading oas and @readme/oas-extensions (#49) ([822cb6d](https://github.com/readmeio/oas-to-har/commit/822cb6d)), closes [#49](https://github.com/readmeio/oas-to-har/issues/49)
+
+
+
+## <small>14.0.4 (2021-12-16)</small>
+
+* fix: issue where we'd try to stylize iterate over a nullilsh value (#42) ([5baa462](https://github.com/readmeio/oas-to-har/commit/5baa462)), closes [#42](https://github.com/readmeio/oas-to-har/issues/42)
+
+
+
+## <small>14.0.3 (2021-12-16)</small>
+
+* fix: cleaning up engine requirements and updating dev deps (#40) ([c377906](https://github.com/readmeio/oas-to-har/commit/c377906)), closes [#40](https://github.com/readmeio/oas-to-har/issues/40)
+* test: overhauling the test suite to make it easier to maintain (#41) ([e04944d](https://github.com/readmeio/oas-to-har/commit/e04944d)), closes [#41](https://github.com/readmeio/oas-to-har/issues/41)
+
+
+
 ## <small>14.0.2 (2021-12-01)</small>
 
 * chore(deps-dev): bump @commitlint/cli from 14.1.0 to 15.0.0 (#33) ([64cf308](https://github.com/readmeio/oas-to-har/commit/64cf308)), closes [#33](https://github.com/readmeio/oas-to-har/issues/33)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@readme/oas-to-har",
   "description": "Utility to transform an OAS operation into a HAR representation",
-  "version": "14.0.2",
+  "version": "14.1.0",
   "main": "src/index.js",
   "author": "Jon Ursenbach <jon@ursenba.ch>",
   "license": "ISC",
@@ -10,33 +10,32 @@
     "url": "git://github.com/readmeio/oas-to-har.git"
   },
   "engines": {
-    "node": "^12 || ^14 || ^16",
-    "npm": "^7"
+    "node": "^12 || ^14 || ^16"
   },
   "scripts": {
     "lint": "eslint .",
     "prepare": "husky install",
     "pretest": "npm run lint",
-    "prettier": "prettier --list-different --write \"./**/**.{js,jsx}\"",
+    "prettier": "prettier --list-different --write \"./**/**.{js}\"",
     "release": "npx conventional-changelog-cli -i CHANGELOG.md -s && git add CHANGELOG.md",
     "test": "jest --coverage"
   },
   "dependencies": {
-    "@readme/oas-extensions": "^14.0.0",
-    "oas": "^17.1.0",
+    "@readme/oas-extensions": "^14.1.0",
+    "oas": "^17.5.0",
     "parse-data-url": "^4.0.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^15.0.0",
-    "@commitlint/config-conventional": "^15.0.0",
-    "@readme/eslint-config": "^8.0.2",
-    "@readme/oas-examples": "^4.3.2",
+    "@commitlint/cli": "^16.1.0",
+    "@commitlint/config-conventional": "^16.0.0",
+    "@readme/eslint-config": "^8.1.2",
+    "@readme/oas-examples": "^4.3.3",
     "datauri": "^4.1.0",
-    "eslint": "^8.2.0",
+    "eslint": "^8.7.0",
     "husky": "^7.0.4",
-    "jest": "^27.3.1",
-    "jest-expect-har": "^3.0.0",
-    "prettier": "^2.4.1"
+    "jest": "^27.4.7",
+    "jest-expect-har": "^3.0.1",
+    "prettier": "^2.5.1"
   },
   "prettier": "@readme/eslint-config/prettier",
   "commitlint": {

package/src/index.js

@@ -18,6 +18,7 @@ function formatter(values, param, type, onlyIfExists) {
 
   let value;
 
+  // Handle missing values
   if (typeof values[type][param.name] !== 'undefined') {
     value = values[type][param.name];
   } else if (onlyIfExists && !param.required) {
@@ -30,6 +31,11 @@ function formatter(values, param, type, onlyIfExists) {
     return param.name;
   }
 
+  // Handle file uploads. Specifically arrays of file uploads which need to be formatted very specifically.
+  if (param.schema && param.schema.type === 'array' && param.schema.items && param.schema.items.format === 'binary') {
+    return JSON.stringify(value);
+  }
+
   if (value !== undefined) {
     // Query params should always be formatted, even if they don't have a `style` serialization configured.
     if (type === 'query') {
@@ -42,6 +48,39 @@ function formatter(values, param, type, onlyIfExists) {
   return undefined;
 }
 
+function multipartBodyToFormatterParams(multipartBody, oasMediaTypeObject) {
+  const schema = oasMediaTypeObject.schema;
+  const encoding = oasMediaTypeObject.encoding;
+
+  if (typeof multipartBody === 'object' && multipartBody !== null) {
+    return Object.keys(multipartBody)
+      .map(key => {
+        // If we have an incoming parameter, but it's not in the schema
+        //    ignore it
+        if (!schema.properties[key]) {
+          return false;
+        }
+
+        const paramEncoding = encoding ? encoding[key] : undefined;
+
+        return {
+          name: key,
+          // If the style isn't defined, use the default
+          style: paramEncoding ? paramEncoding.style : undefined,
+          // If explode isn't defined, use the default
+          explode: paramEncoding ? paramEncoding.explode : undefined,
+          required: schema.required && schema.required.includes(key),
+          schema: schema.properties[key],
+          in: 'body',
+        };
+      })
+      .filter(Boolean);
+  }
+
+  // Pretty sure that we'll never have anything but an object for multipart bodies, so returning empty array if we get anything else.
+  return [];
+}
+
 const defaultFormDataTypes = Object.keys(jsonSchemaTypes).reduce((prev, curr) => {
   return Object.assign(prev, { [curr]: {} });
 }, {});
@@ -75,7 +114,7 @@ function stringifyParameter(param) {
   return JSON.stringify(param);
 }
 
-function appendHarValue(harParam, name, value) {
+function appendHarValue(harParam, name, value, addtlData = {}) {
   if (typeof value === 'undefined') return;
 
   if (Array.isArray(value)) {
@@ -91,6 +130,7 @@ function appendHarValue(harParam, name, value) {
   } else {
     // If the formatter gives us a non-array, non-object, we add it as is
     harParam.push({
+      ...addtlData,
       name,
       value: String(value),
     });
@@ -161,7 +201,12 @@ module.exports = (
   operation.getParameters().forEach(addParameter);
 
   // Does this operation have any common parameters?
-  if (apiDefinition.paths && apiDefinition.paths[operation.path] && apiDefinition.paths[operation.path].parameters) {
+  if (
+    apiDefinition &&
+    apiDefinition.paths &&
+    apiDefinition.paths[operation.path] &&
+    apiDefinition.paths[operation.path].parameters
+  ) {
     apiDefinition.paths[operation.path].parameters.forEach(addParameter);
   }
 
@@ -230,7 +275,7 @@ module.exports = (
     });
   }
 
-  // Are there `x-static` static headers configured for this OAS?
+  // Are there `x-headers` static headers configured for this OAS?
   const userDefinedHeaders = extensions.getExtension(extensions.HEADERS, oas, operation);
   if (userDefinedHeaders) {
     userDefinedHeaders.forEach(header => {
@@ -300,39 +345,32 @@ module.exports = (
             );
 
             if (cleanBody !== undefined) {
-              Object.keys(cleanBody).forEach(name => {
-                // We neither have an easy way to transform `name` into `name[]` to signify that it's an array payload
-                // (and for all we know it might be an array of objects!), but also at the same time the HAR spec
-                // doesn't give any guidance for these kinds of cases so instead we're just falling back to
-                // stringifying the content instead of potentially including `fileName` properties.
-                if (Array.isArray(cleanBody[name])) {
-                  har.postData.params.push({
-                    name,
-                    value: JSON.stringify(cleanBody[name]),
-                  });
+              const multipartParams = multipartBodyToFormatterParams(
+                formData.body,
+                operation.schema.requestBody.content['multipart/form-data']
+              );
 
-                  return;
-                }
+              Object.keys(cleanBody).forEach(name => {
+                const param = multipartParams.find(multipartParam => multipartParam.name === name);
 
-                const data = {
-                  name,
-                  value: String(cleanBody[name]),
-                };
+                const value = formatter(formData, param, 'body', true);
 
                 // If we're dealing with a binary type, and the value is a valid data URL we should parse out any
                 // available filename and content type to send along with the parameter to interpreters like `fetch-har`
                 // can make sense of it and send a usable payload.
+                const addtlData = {};
+
                 if (binaryTypes.includes(name)) {
-                  const parsed = parseDataUrl(data.value);
+                  const parsed = parseDataUrl(value);
                   if (parsed) {
-                    data.fileName = 'name' in parsed ? parsed.name : 'unknown';
+                    addtlData.fileName = 'name' in parsed ? parsed.name : 'unknown';
                     if ('contentType' in parsed) {
-                      data.contentType = parsed.contentType;
+                      addtlData.contentType = parsed.contentType;
                     }
                   }
                 }
 
-                har.postData.params.push(data);
+                appendHarValue(har.postData.params, name, value, addtlData);
               });
             }
           } else {
@@ -364,6 +402,7 @@ module.exports = (
                     }
                   });
 
+                  // `RAW_BODY` is a ReadMe-specific thing where we'll interpret its contents as raw JSON.
                   if (typeof cleanBody.RAW_BODY !== 'undefined') {
                     cleanBody = cleanBody.RAW_BODY;
                   }
@@ -378,6 +417,8 @@ module.exports = (
             }
           }
         } catch (e) {
+          // you should log this error if you're debugging why data is showing up in text, when it  should show up in params
+          // console.log('catching ', e);
           // If anything above fails for whatever reason, assume that whatever we had is invalid JSON and just treat it
           // as raw text.
           har.postData.text = stringify(formData.body);

package/src/lib/style-formatting/index.js

@@ -114,7 +114,7 @@ function handleExplode(value, parameter) {
     });
   }
 
-  if (typeof value === 'object') {
+  if (typeof value === 'object' && value !== null) {
     const newObj = {};
 
     Object.keys(value).forEach(key => {

package/src/lib/style-formatting/style-serializer.js

@@ -195,7 +195,7 @@ function encodePrimitive({ location, key, value, style, escape }) {
   const valueEncoder = str =>
     module.exports.encodeDisallowedCharacters(str, {
       escape,
-      returnIfEncoded: location === 'query',
+      returnIfEncoded: location === 'query' || location === 'body',
     });
 
   if (style === 'simple') {