fix: repairing malformed HAR postData objects on the fly (readmeio#111)

erunion · web-flow · commit 7e3c79baa163 · 2022-07-21T16:43:46.000-07:00
diff --git a/src/helpers/har-validator.ts b/src/helpers/har-validator.ts
@@ -30,20 +30,6 @@ export const validateHarRequest = (request: any): request is Request => {
 
   const valid = validate(request);
   if (!valid && validate.errors) {
-    if (validate.errors.length === 1) {
-      // While not ideal, or compliant with the HAR spec, if we have an empty `postData` object in
-      // our HAR and no other errors we should let this through because it's fine and our client
-      // targets are able to handle it okay.
-      const error = validate.errors[0];
-      if (
-        error.dataPath === '.postData' &&
-        error.message === "should have required property 'mimeType'" &&
-        JSON.stringify(request.postData) === '{}'
-      ) {
-        return true;
-      }
-    }
-
     throw new HARError(validate.errors);
   }
 
diff --git a/src/index.test.ts b/src/index.test.ts
@@ -23,6 +23,54 @@ describe('HTTPSnippet', () => {
     expect(attempt).toThrow('validation failed');
   });
 
+  describe('repair malformed `postData`', () => {
+    it('should repair a HAR with an empty `postData` object', () => {
+      const snippet = new HTTPSnippet({
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {},
+      } as Request);
+
+      const request = snippet.requests[0];
+      expect(request.postData).toStrictEqual({
+        mimeType: 'application/octet-stream',
+      });
+    });
+
+    it('should repair a HAR with a `postData` params object missing `mimeType`', () => {
+      // @ts-expect-error Testing a malformed HAR case.
+      const snippet = new HTTPSnippet({
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+          params: [],
+        },
+      } as Request);
+
+      const request = snippet.requests[0];
+      expect(request.postData).toStrictEqual({
+        mimeType: 'application/octet-stream',
+        params: [],
+      });
+    });
+
+    it('should repair a HAR with a `postData` text object missing `mimeType`', () => {
+      const snippet = new HTTPSnippet({
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+          text: '',
+        },
+      } as Request);
+
+      const request = snippet.requests[0];
+      expect(request.postData).toStrictEqual({
+        mimeType: 'application/octet-stream',
+        text: '',
+      });
+    });
+  });
+
   it('should parse HAR file with multiple entries', () => {
     const snippet = new HTTPSnippet({
       log: {
diff --git a/src/index.ts b/src/index.ts
@@ -119,6 +119,11 @@ export class HTTPSnippet {
         ...request,
       };
 
+      // Per the HAR spec `mimeType` needs to always be present if we have a `postData` object.
+      if (req.postData && !req.postData.mimeType) {
+        req.postData.mimeType = 'application/octet-stream';
+      }
+
       if (validateHarRequest(req)) {
         this.requests.push(this.prepare(req, options));
       }
diff --git a/src/targets/r/httr/fixtures/postdata-malformed.r b/src/targets/r/httr/fixtures/postdata-malformed.r
@@ -2,6 +2,6 @@ library(httr)
 
 url <- "https://httpbin.org/anything"
 
-response <- VERB("POST", url, content_type("undefined"))
+response <- VERB("POST", url, content_type("application/octet-stream"))
 
 content(response, "text")
