Bug 1988955 - [devtools] Update DevTools readPostDataFromRequest helper to expose text decoding errors r=devtools-reviewers,bomsy

juliandescottes · juliandescottes · commit 532a5614499d · 2025-11-05T18:53:49.000Z
Differential Revision: https://phabricator.services.mozilla.com/D270272
diff --git a/devtools/shared/network-observer/NetworkHelper.sys.mjs b/devtools/shared/network-observer/NetworkHelper.sys.mjs
@@ -123,10 +123,13 @@ export var NetworkHelper = {
    *        Text to convert.
    * @param string charset
    *        Charset to convert the text to.
+   * @param boolean throwOnFailure
+   *        Whether exceptions should be bubbled up or swallowed. Defaults to
+   *        false.
    * @returns string
    *          Converted text.
    */
-  convertToUnicode(text, charset) {
+  convertToUnicode(text, charset, throwOnFailure) {
     // FIXME: We need to throw when text can't be converted e.g. the contents of
     // an image. Until we have a way to do so with TextEncoder and TextDecoder
     // we need to use nsIScriptableUnicodeConverter instead.
@@ -137,6 +140,9 @@ export var NetworkHelper = {
       conv.charset = charset || "UTF-8";
       return conv.ConvertToUnicode(text);
     } catch (ex) {
+      if (throwOnFailure) {
+        throw ex;
+      }
       return text;
     }
   },
@@ -160,42 +166,65 @@ export var NetworkHelper = {
   },
 
   /**
-   * Reads the posted text from request.
+   * Reads the post data from request.
    *
    * @param nsIHttpChannel request
    * @param string charset
    *        The content document charset, used when reading the POSTed data.
-   * @returns string or null
-   *          Returns the posted string if it was possible to read from request
-   *          otherwise null.
+   *
+   * @returns object or null
+   *          Returns an object with the following properties:
+   *            - {string|null} data: post data as string if it was possible to
+   *              read from request, otherwise null.
+   *            - {boolean} isDecodedAsText: if the data could be successfully read with
+   *              the specified charset.
+   *          Returns null if the channel does not implement nsIUploadChannel,
+   *          and therefore cannot upload a data stream.
    */
-  readPostTextFromRequest(request, charset) {
-    if (request instanceof Ci.nsIUploadChannel) {
-      const iStream = request.uploadStream;
+  readPostDataFromRequest(request, charset) {
+    if (!(request instanceof Ci.nsIUploadChannel)) {
+      return null;
+    }
+    const iStream = request.uploadStream;
 
-      let isSeekableStream = false;
-      if (iStream instanceof Ci.nsISeekableStream) {
-        isSeekableStream = true;
-      }
+    let isSeekableStream = false;
+    if (iStream instanceof Ci.nsISeekableStream) {
+      isSeekableStream = true;
+    }
 
-      let prevOffset;
-      if (isSeekableStream) {
-        prevOffset = iStream.tell();
-        iStream.seek(Ci.nsISeekableStream.NS_SEEK_SET, 0);
-      }
+    let prevOffset;
+    if (isSeekableStream) {
+      prevOffset = iStream.tell();
+      iStream.seek(Ci.nsISeekableStream.NS_SEEK_SET, 0);
+    }
 
-      // Read data from the stream.
-      const text = this.readAndConvertFromStream(iStream, charset);
+    let data = null;
+    let isDecodedAsText = true;
 
-      // Seek locks the file, so seek to the beginning only if necko hasn't
-      // read it yet, since necko doesn't seek to 0 before reading (at lest
-      // not till 459384 is fixed).
-      if (isSeekableStream && prevOffset == 0) {
-        iStream.seek(Ci.nsISeekableStream.NS_SEEK_SET, 0);
-      }
-      return text;
+    // Read data from the stream.
+    try {
+      data = lazy.NetUtil.readInputStreamToString(iStream, iStream.available());
+    } catch {
+      // If we failed to read the stream, assume there is no valid request post
+      // data to display.
+      return null;
     }
-    return null;
+
+    // Decode the data as text with the provided charset.
+    try {
+      data = this.convertToUnicode(data, charset, true);
+    } catch (err) {
+      isDecodedAsText = false;
+    }
+
+    // Seek locks the file, so seek to the beginning only if necko hasn't
+    // read it yet, since necko doesn't seek to 0 before reading (at lest
+    // not till 459384 is fixed).
+    if (isSeekableStream && prevOffset == 0) {
+      iStream.seek(Ci.nsISeekableStream.NS_SEEK_SET, 0);
+    }
+
+    return { data, isDecodedAsText };
   },
 
   /**
diff --git a/devtools/shared/network-observer/NetworkObserver.sys.mjs b/devtools/shared/network-observer/NetworkObserver.sys.mjs
@@ -1225,13 +1225,13 @@ export class NetworkObserver {
       return;
     }
 
-    const sentBody = lazy.NetworkHelper.readPostTextFromRequest(
+    const sentBody = lazy.NetworkHelper.readPostDataFromRequest(
       httpActivity.channel,
       httpActivity.charset
     );
 
     if (sentBody !== null) {
-      httpActivity.sentBody = sentBody;
+      httpActivity.sentBody = sentBody.data;
     }
   }
 

Original file line number	Diff line number	Diff line change
`@@ -1225,13 +1225,13 @@ export class NetworkObserver {`
`1225`	`1225`	`return;`
`1226`	`1226`	`}`
`1227`	`1227`
`1228`		`- const sentBody = lazy.NetworkHelper.readPostTextFromRequest(`
	`1228`	`+ const sentBody = lazy.NetworkHelper.readPostDataFromRequest(`
`1229`	`1229`	`httpActivity.channel,`
`1230`	`1230`	`httpActivity.charset`
`1231`	`1231`	`);`
`1232`	`1232`
`1233`	`1233`	`if (sentBody !== null) {`
`1234`		`- httpActivity.sentBody = sentBody;`
	`1234`	`+ httpActivity.sentBody = sentBody.data;`
`1235`	`1235`	`}`
`1236`	`1236`	`}`
`1237`	`1237`