fix(oas-to-har): clean up formatting of raw json bodies (#1197)

* fix(oas-to-har): clean up formatting of raw json bodies * Update packages/oas-to-har/src/index.js Co-authored-by: Jon Ursenbach <erunion@users.noreply.github.com>
readmeio · Feb 25, 2021 · 0d4cead · 0d4cead
1 parent 7fc9557
commit 0d4cead
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 21 deletions.
diff --git a/packages/oas-to-har/__tests__/index.test.js b/packages/oas-to-har/__tests__/index.test.js
@@ -1124,6 +1124,30 @@ describe('requestBody', () => {
         ).toBe(JSON.stringify({ a: '{ "b": invalid json' }));
       });
 
+      // TODO: Why do I have to json encode the resulting string? website doesn't seem to need that....
+      it('should parse valid arbitrary JSON request bodies', () => {
+        expect(
+          oasToHar(
+            oas,
+            {
+              path: '/body',
+              method: 'post',
+              requestBody: {
+                content: {
+                  'application/json': {
+                    schema: {
+                      type: 'string',
+                      format: 'json',
+                    },
+                  },
+                },
+              },
+            },
+            { body: '{ "a": { "b": "valid json" } }' }
+          ).log.entries[0].request.postData.text
+        ).toBe('{"a":{"b":"valid json"}}');
+      });
+
       it('should parse valid JSON as an object', () => {
         expect(
           oasToHar(

diff --git a/packages/oas-to-har/src/index.js b/packages/oas-to-har/src/index.js
@@ -303,33 +303,43 @@ module.exports = (
           } else {
             har.postData.mimeType = contentType;
 
-            // Find all `{ type: string, format: json }` properties in the schema because we need to manually JSON.parse
-            // them before submit, otherwise they'll be escaped instead of actual objects.
-            // We also only want values that the user has entered, so we drop any undefined cleanBody keys
-            const jsonTypes = Object.keys(requestBody.schema.properties).filter(
-              key => requestBody.schema.properties[key].format === 'json' && cleanBody[key] !== undefined
-            );
+            // Handle arbitrary JSON input via a string.
+            // In OAS you usually find this in an application/json content type.
+            //   with a schema type=string, format=json.
+            // In the UI this is represented by an arbitrary text input
+            // This ensures we remove any newlines or tabs and use a clean json block in the example
+            if (requestBody.schema.type === 'string') {
+              har.postData.text = JSON.stringify(JSON.parse(cleanBody));
+            } else {
+              // Handle formatted JSON objects that have properties that accept arbitrary JSON
+              // Find all `{ type: string, format: json }` properties in the schema because we need to manually JSON.parse
+              // them before submit, otherwise they'll be escaped instead of actual objects.
+              // We also only want values that the user has entered, so we drop any undefined cleanBody keys
+              const jsonTypes = Object.keys(requestBody.schema.properties).filter(
+                key => requestBody.schema.properties[key].format === 'json' && cleanBody[key] !== undefined
+              );
+
+              if (jsonTypes.length) {
+                try {
+                  jsonTypes.forEach(prop => {
+                    try {
+                      cleanBody[prop] = JSON.parse(cleanBody[prop]);
+                    } catch (e) {
+                      // leave the prop as a string value
+                    }
+                  });
 
-            if (jsonTypes.length) {
-              try {
-                jsonTypes.forEach(prop => {
-                  try {
-                    cleanBody[prop] = JSON.parse(cleanBody[prop]);
-                  } catch (e) {
-                    // leave the prop as a string value
+                  if (typeof cleanBody.RAW_BODY !== 'undefined') {
+                    cleanBody = cleanBody.RAW_BODY;
                   }
-                });
 
-                if (typeof cleanBody.RAW_BODY !== 'undefined') {
-                  cleanBody = cleanBody.RAW_BODY;
+                  har.postData.text = JSON.stringify(cleanBody);
+                } catch (e) {
+                  har.postData.text = stringify(formData.body);
                 }
-
-                har.postData.text = JSON.stringify(cleanBody);
-              } catch (e) {
+              } else {
                 har.postData.text = stringify(formData.body);
               }
-            } else {
-              har.postData.text = stringify(formData.body);
             }
           }
         } catch (e) {