fix: parse JSON post data in grabRecordedNetworkTraffics so every helper returns the same type

Author: landon-medme

lib/helper/network/actions.js

@@ -56,6 +56,15 @@ async function seeTraffic({ name, url, parameters, requestPostData, timeout = 10
   }
 }
 
+function parsePostData(postData) {
+  if (typeof postData !== 'string') return postData
+  try {
+    return JSON.parse(postData)
+  } catch (e) {
+    return postData
+  }
+}
+
 async function grabRecordedNetworkTraffics() {
   if (!this.recordedAtLeastOnce) {
     throw new Error('Failure in test automation. You use "I.grabRecordedNetworkTraffics", but "I.startRecordingTraffic" was never called before.');
@@ -67,7 +76,7 @@ async function grabRecordedNetworkTraffics() {
       url: request.url,
       method: request.method,
       headers: request.requestHeaders,
-      postData: request.requestPostData,
+      postData: parsePostData(request.requestPostData),
     }
 
     if (!resp) {

test/helper/webapi.js

@@ -2479,6 +2479,20 @@ export function tests() {
       expect(headerNames).to.include('user-agent')
     })
 
+    it('should grab JSON post data of recorded traffics as an object', async () => {
+      await I.amOnPage('https://codecept.io/')
+      await I.startRecordingTraffic()
+      await I.executeScript(() =>
+        fetch('https://codecept.io/traffic-post-data', { method: 'POST', body: JSON.stringify({ name: 'codecept' }) })
+          .then(res => res.status)
+          .catch(() => 0),
+      )
+      await I.seeTraffic({ name: 'post', url: 'https://codecept.io/traffic-post-data' })
+      const traffics = await I.grabRecordedNetworkTraffics()
+      const post = traffics.find(t => t.request.method === 'POST')
+      expect(post.request.postData).to.deep.equal({ name: 'codecept' })
+    })
+
     it('should stop the network recording', async () => {
       await I.startRecordingTraffic()
       await I.amOnPage('https://codecept.io/')