Bug 1988955 - [bidi] Add support for dataType=request to network data collection r=whimboo

juliandescottes · juliandescottes · commit 53654d78bd6f · 2025-11-05T18:53:51.000Z
Differential Revision: https://phabricator.services.mozilla.com/D267227
diff --git a/remote/jar.mn b/remote/jar.mn
@@ -27,6 +27,7 @@ remote.jar:
   content/shared/Navigate.sys.mjs (shared/Navigate.sys.mjs)
   content/shared/NavigationManager.sys.mjs (shared/NavigationManager.sys.mjs)
   content/shared/NetworkCacheManager.sys.mjs (shared/NetworkCacheManager.sys.mjs)
+  content/shared/NetworkDataBytes.sys.mjs (shared/NetworkDataBytes.sys.mjs)
   content/shared/NetworkDecodedBodySizeMap.sys.mjs (shared/NetworkDecodedBodySizeMap.sys.mjs)
   content/shared/NetworkRequest.sys.mjs (shared/NetworkRequest.sys.mjs)
   content/shared/NetworkResponse.sys.mjs (shared/NetworkResponse.sys.mjs)
diff --git a/remote/shared/NetworkDataBytes.sys.mjs b/remote/shared/NetworkDataBytes.sys.mjs
@@ -0,0 +1,35 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+export class NetworkDataBytes {
+  #getBytesValue;
+  #isBase64;
+
+  /**
+   * Common interface used to handle network BytesValue for collected data which
+   * might be encoded and require an additional async step in order to retrieve
+   * the actual bytes.
+   *
+   * This is a simple wrapper mostly designed to ensure a common interface in
+   * case this is used for request or response bodies.
+   *
+   * @param {object} options
+   * @param {Function} options.getBytesValue
+   *     A -potentially async- callable which returns the bytes as a string.
+   * @param {boolean} options.isBase64
+   *     Whether this represents a base64-encoded binary data.
+   */
+  constructor(options) {
+    this.#getBytesValue = options.getBytesValue;
+    this.#isBase64 = options.isBase64;
+  }
+
+  get isBase64() {
+    return this.#isBase64;
+  }
+
+  async getBytesValue() {
+    return this.#getBytesValue();
+  }
+}
diff --git a/remote/shared/NetworkRequest.sys.mjs b/remote/shared/NetworkRequest.sys.mjs
@@ -12,6 +12,7 @@ ChromeUtils.defineESModuleGetters(lazy, {
   generateUUID: "chrome://remote/content/shared/UUID.sys.mjs",
   NavigableManager: "chrome://remote/content/shared/NavigableManager.sys.mjs",
   NavigationState: "chrome://remote/content/shared/NavigationManager.sys.mjs",
+  NetworkDataBytes: "chrome://remote/content/shared/NetworkDataBytes.sys.mjs",
   notifyNavigationStarted:
     "chrome://remote/content/shared/NavigationManager.sys.mjs",
 });
@@ -29,6 +30,7 @@ export class NetworkRequest {
   #isDataURL;
   #navigationId;
   #navigationManager;
+  #postData;
   #postDataSize;
   #rawHeaders;
   #redirectCount;
@@ -97,9 +99,10 @@ export class NetworkRequest {
     this.#contextId = this.#getContextId();
     this.#navigationId = this.#getNavigationId();
 
-    // The postDataSize will no longer be available after the channel is closed.
-    // Compute and cache the value, to be updated when `setRequestBody` is used.
-    this.#postDataSize = this.#computePostDataSize();
+    // The postData will no longer be available after the channel is closed.
+    // Compute the postData and postDataSize properties, to be updated later if
+    // `setRequestBody` is used.
+    this.#updatePostData();
   }
 
   get alreadyCompleted() {
@@ -159,6 +162,10 @@ export class NetworkRequest {
     return this.#navigationId;
   }
 
+  get postData() {
+    return this.#postData;
+  }
+
   get postDataSize() {
     return this.#postDataSize;
   }
@@ -216,6 +223,19 @@ export class NetworkRequest {
     );
   }
 
+  /**
+   * Returns the NetworkDataBytes instance representing the request body for
+   * this request.
+   *
+   * @returns {NetworkDataBytes}
+   */
+  readAndProcessRequestBody = () => {
+    return new lazy.NetworkDataBytes({
+      getBytesValue: () => this.#postData.text,
+      isBase64: this.#postData.isBase64,
+    });
+  };
+
   /**
    * Redirect the request to another provided URL.
    *
@@ -253,7 +273,7 @@ export class NetworkRequest {
     } finally {
       // Make sure to reset the flag once the modification was attempted.
       this.#channel.requestObserversCalled = true;
-      this.#postDataSize = this.#computePostDataSize();
+      this.#updatePostData();
     }
   }
 
@@ -337,6 +357,7 @@ export class NetworkRequest {
       initiatorType: this.initiatorType,
       method: this.method,
       navigationId: this.navigationId,
+      postData: this.postData,
       postDataSize: this.postDataSize,
       redirectCount: this.redirectCount,
       requestId: this.requestId,
@@ -348,15 +369,6 @@ export class NetworkRequest {
     };
   }
 
-  #computePostDataSize() {
-    const charset = lazy.NetworkUtils.getCharset(this.#channel);
-    const sentBody = lazy.NetworkHelper.readPostTextFromRequest(
-      this.#channel,
-      charset
-    );
-    return sentBody ? sentBody.length : 0;
-  }
-
   /**
    * Convert the provided request timing to a timing relative to the beginning
    * of the request. Note that https://w3c.github.io/resource-timing/#dfn-convert-fetch-timestamp
@@ -517,4 +529,31 @@ export class NetworkRequest {
     );
     return !browsingContext.parent;
   }
+
+  #readPostDataFromRequestAsUTF8() {
+    const postData = lazy.NetworkHelper.readPostDataFromRequest(
+      this.#channel,
+      "UTF-8"
+    );
+
+    if (postData === null || postData.data === null) {
+      return null;
+    }
+
+    return {
+      text: postData.isDecodedAsText ? postData.data : btoa(postData.data),
+      isBase64: !postData.isDecodedAsText,
+    };
+  }
+
+  #updatePostData() {
+    const sentBody = this.#readPostDataFromRequestAsUTF8();
+    if (sentBody) {
+      this.#postData = sentBody;
+      this.#postDataSize = sentBody.text.length;
+    } else {
+      this.#postData = null;
+      this.#postDataSize = 0;
+    }
+  }
 }
diff --git a/remote/shared/NetworkResponse.sys.mjs b/remote/shared/NetworkResponse.sys.mjs
@@ -6,6 +6,8 @@ const lazy = {};
 ChromeUtils.defineESModuleGetters(lazy, {
   NetworkUtils:
     "resource://devtools/shared/network-observer/NetworkUtils.sys.mjs",
+
+  NetworkDataBytes: "chrome://remote/content/shared/NetworkDataBytes.sys.mjs",
 });
 
 /**
@@ -157,34 +159,37 @@ export class NetworkResponse {
     );
   }
 
-  async readResponseBody() {
-    return this.#responseBodyReady.promise;
-  }
+  /**
+   * Returns the NetworkDataBytes instance representing the response body for
+   * this response.
+   *
+   * @returns {NetworkDataBytes}
+   */
+  readAndProcessResponseBody = async () => {
+    const responseContent = await this.#responseBodyReady.promise;
+
+    return new lazy.NetworkDataBytes({
+      getBytesValue: async () => {
+        if (responseContent.isContentEncoded) {
+          return lazy.NetworkUtils.decodeResponseChunks(
+            responseContent.encodedData,
+            {
+              // Should always attempt to decode as UTF-8.
+              charset: "UTF-8",
+              compressionEncodings: responseContent.compressionEncodings,
+              encodedBodySize: responseContent.encodedBodySize,
+              encoding: responseContent.encoding,
+            }
+          );
+        }
+        return responseContent.text;
+      },
+      isBase64: responseContent.encoding === "base64",
+    });
+  };
 
   setResponseContent(responseContent) {
-    // Extract the properties necessary to decode the response body later on.
-    let encodedResponseBody;
-
-    if (responseContent.isContentEncoded) {
-      encodedResponseBody = {
-        encoding: responseContent.encoding,
-        getDecodedResponseBody: async () =>
-          lazy.NetworkUtils.decodeResponseChunks(responseContent.encodedData, {
-            // Should always attempt to decode as UTF-8.
-            charset: "UTF-8",
-            compressionEncodings: responseContent.compressionEncodings,
-            encodedBodySize: responseContent.encodedBodySize,
-            encoding: responseContent.encoding,
-          }),
-      };
-    } else {
-      encodedResponseBody = {
-        encoding: responseContent.encoding,
-        getDecodedResponseBody: () => responseContent.text,
-      };
-    }
-
-    this.#responseBodyReady.resolve(encodedResponseBody);
+    this.#responseBodyReady.resolve(responseContent);
   }
 
   /**
diff --git a/remote/webdriver-bidi/modules/root/network.sys.mjs b/remote/webdriver-bidi/modules/root/network.sys.mjs
