feat: allowing for a HAR override to be passed in for snippet creation (

#1249) * feat: allowing for a HAR override to be passed in for snippet creation * test: fixing the test i added so auth shows up
readmeio · Apr 13, 2021 · df35bb8 · df35bb8
1 parent 1492b0f
commit df35bb8
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 2 deletions.
diff --git a/packages/oas-to-snippet/__tests__/__snapshots__/index.test.js.snap b/packages/oas-to-snippet/__tests__/__snapshots__/index.test.js.snap
@@ -11,3 +11,19 @@ Object {
   "highlightMode": "shell",
 }
 `;
+
+exports[`should be able to accept a har override 1`] = `
+Object {
+  "code": "const fetch = require('node-fetch');
+
+const url = 'https://dash.readme.io/api/v1/categories/';
+
+const options = {method: 'GET', headers: {authorization: 'Basic xxx'}};
+
+fetch(url, options)
+  .then(res => res.json())
+  .then(json => console.log(json))
+  .catch(err => console.error('error:' + err));",
+  "highlightMode": "javascript",
+}
+`;
diff --git a/packages/oas-to-snippet/__tests__/index.test.js b/packages/oas-to-snippet/__tests__/index.test.js
@@ -25,6 +25,32 @@ const operation = {
 
 const formData = { path: { id: 123 } };
 
+test('should be able to accept a har override', () => {
+  const harOverride = {
+    log: {
+      entries: [
+        {
+          request: {
+            method: 'GET',
+            url: 'https://dash.readme.io/api/v1/categories/',
+            httpVersion: 'HTTPS/1.1',
+            headers: [
+              {
+                name: 'authorization',
+                value: 'Basic xxx',
+              },
+            ],
+            queryString: [],
+          },
+        },
+      ],
+    },
+  };
+
+  const codeSnippet = generateCodeSnippet(oas, operation, {}, {}, 'node', oasUrl, harOverride);
+  expect(codeSnippet).toMatchSnapshot();
+});
+
 test('should return falsy values for an unknown language', () => {
   const codeSnippet = generateCodeSnippet(oas, operation, {}, {}, 'css', oasUrl);
 

diff --git a/packages/oas-to-snippet/src/index.js b/packages/oas-to-snippet/src/index.js
@@ -11,9 +11,10 @@ const supportedLanguages = require('./supportedLanguages');
  * @param {Object} auth
  * @param {String} lang
  * @param {String} oasUrl
+ * @param {Object|undefined} harOverride
  */
-module.exports = (oas, operation, values, auth, lang, oasUrl) => {
-  const har = generateHar(oas, operation, values, auth);
+module.exports = (oas, operation, values, auth, lang, oasUrl, harOverride) => {
+  const har = harOverride || generateHar(oas, operation, values, auth);
 
   // API SDK client needs additional runtime information on the API definition we're showing the user so it can
   // generate an appropriate snippet.