Bug 1830230 - [devtools] Start sending multiple events as the response data is arrives r=webdriver-reviewers,perftest-reviewers,devtools-reviewers,afinder,jdescottes

Some highlights
- Added a new RESPONSE_CONTENT_COMPLETE event
- Now fires multiple RESPONSE_CONTENT events

Differential Revision: https://phabricator.services.mozilla.com/D244948

Author: bomsy

devtools/client/netmonitor/src/components/StatusCode.js

@@ -24,6 +24,7 @@ const UPDATED_STATUS_PROPS = [
   "fromServiceWorker",
   "status",
   "statusText",
+  "blockedReason",
 ];
 
 /**

devtools/client/netmonitor/src/components/request-list/RequestListColumnTransferredSize.js

@@ -29,6 +29,8 @@ const UPDATED_TRANSFERRED_PROPS = [
   "fromCache",
   "isRacing",
   "fromServiceWorker",
+  "blockedReason",
+  "blockingExtension",
 ];
 
 class RequestListColumnTransferredSize extends Component {

devtools/client/netmonitor/src/components/request-list/RequestListItem.js

@@ -173,6 +173,8 @@ const UPDATED_REQ_ITEM_PROPS = [
   "waitingTime",
   "isEventStream",
   "priority",
+  "blockedReason",
+  "blockingExtension",
 ];
 
 const UPDATED_REQ_PROPS = [

devtools/client/netmonitor/src/utils/request-utils.js

@@ -112,13 +112,23 @@ function fetchNetworkUpdatePacket(requestData, request, updateTypes) {
   const promises = [];
   if (request) {
     updateTypes.forEach(updateType => {
-      // Only stackTrace will be handled differently
+      // stackTrace needs to be handled specially as the property to lookup
+      // on the request object follows a slightly different convention.
+      // i.e `stacktrace` not `stackTrace`
       if (updateType === "stackTrace") {
         if (request.cause.stacktraceAvailable && !request.stacktrace) {
           promises.push(requestData(request.id, updateType));
         }
         return;
       }
+      // responseContent only checks the availiability flag as there can
+      // be multiple response content events
+      if (updateType === "responseContent") {
+        if (request.responseContentAvailable) {
+          promises.push(requestData(request.id, updateType));
+        }
+        return;
+      }
 
       if (request[`${updateType}Available`] && !request[updateType]) {
         promises.push(requestData(request.id, updateType));

devtools/client/netmonitor/test/browser_net_chunked-response.js

@@ -44,11 +44,6 @@ function setupTestServer() {
 }
 
 add_task(async function () {
-  // TODO: Enable test when Bug 1557795 gets fixed.
-  // eslint-disable-next-line no-constant-condition
-  if (true) {
-    return;
-  }
   const { httpServer, completeResponse } = setupTestServer();
   const port = httpServer.identity.primaryPort;
 
@@ -72,7 +67,7 @@ add_task(async function () {
   });
   await SpecialPowers.spawn(
     tab.linkedBrowser,
-    `http://localhost:${port}/chunked-data`,
+    [`http://localhost:${port}/chunked-data`],
     async url => {
       await content.wrappedJSObject.fetch(url);
     }

devtools/client/netmonitor/test/browser_net_domain-not-found.js

@@ -7,6 +7,7 @@
  * Tests that the request for a domain that is not found shows
  * correctly.
  */
+
 add_task(async function () {
   const URL = "https://not-existed.com/";
   const { monitor } = await initNetMonitor(URL, {
@@ -31,10 +32,7 @@ add_task(async function () {
     const value = firstItem.querySelector(
       ".requests-list-transferred"
     ).innerText;
-    if (value == "") {
-      return false;
-    }
-    return value;
+    return value.includes("NS_ERROR") ? value : false;
   });
 
   is(

devtools/client/netmonitor/test/browser_net_sse-basic.js

@@ -213,11 +213,6 @@ add_task(async function testBasicServerSentEvents() {
  * 3) Assert that the close connection message is displayed when the connection is closed.
  */
 add_task(async function testServerSentEventsDetails() {
-  // TODO: Should enable this test when Bug 1557795 gets fixed.
-  // eslint-disable-next-line no-constant-condition
-  if (true) {
-    return null;
-  }
   const { httpServer, sendResponseMessages, completeResponse } =
     setupTestServer();
   const port = httpServer.identity.primaryPort;
@@ -279,7 +274,7 @@ add_task(async function testServerSentEventsDetails() {
   const waitForMoreMessages = waitForDOM(
     document,
     "#messages-view .message-list-table .message-list-item",
-    3
+    4
   );
   info("Send a couple of more messages");
   sendResponseMessages();

devtools/server/actors/network-monitor/network-event-actor.js

@@ -638,14 +638,33 @@ class NetworkEventActor extends Actor {
     });
   }
 
+  /**
+   * Add network response content end.
+   *
+   * @param object
+   */
+  addResponseContentComplete({ blockedReason, blockingExtension }) {
+    // Ignore calls when this actor is already destroyed
+    if (this.isDestroyed()) {
+      return;
+    }
+
+    this._onEventUpdate(
+      lazy.NetworkUtils.NETWORK_EVENT_TYPES.RESPONSE_CONTENT_COMPLETE,
+      {
+        blockedReason,
+        blockingExtension,
+      }
+    );
+  }
+
   /**
    * Add network response content.
    *
    * @param object content
    *        The response content.
-   * @param object
    */
-  addResponseContent(content, { blockedReason, blockingExtension }) {
+  addResponseContent(content) {
     // Ignore calls when this actor is already destroyed
     if (this.isDestroyed()) {
       return;
@@ -664,8 +683,6 @@ class NetworkEventActor extends Actor {
         mimeType: content.mimeType,
         contentSize: content.size,
         transferredSize: content.transferredSize,
-        blockedReason,
-        blockingExtension,
       }
     );
   }

devtools/server/actors/resources/network-events-content.js

@@ -231,15 +231,13 @@ class NetworkEventContentWatcher {
         {} /* offsets */
       );
       networkEventActor.addServerTimings({});
-      networkEventActor.addResponseContent(
-        {
-          mimeType: channel.contentType,
-          size: channel.contentLength,
-          text: "",
-          transferredSize: 0,
-        },
-        {}
-      );
+      networkEventActor.addResponseContent({
+        mimeType: channel.contentType,
+        size: channel.contentLength,
+        text: "",
+        transferredSize: 0,
+      });
+      networkEventActor.addResponseContentComplete({});
     } else if (type == RESOURCE_TYPES.DATA_CHANNEL) {
       lazy.NetworkUtils.handleDataChannel(channel, networkEventActor);
     }
@@ -301,7 +299,7 @@ class NetworkEventContentWatcher {
     // responseContent.
     const isResponseComplete =
       receivedUpdates.includes(NETWORK_EVENT_TYPES.RESPONSE_START) &&
-      receivedUpdates.includes(NETWORK_EVENT_TYPES.RESPONSE_CONTENT) &&
+      receivedUpdates.includes(NETWORK_EVENT_TYPES.RESPONSE_CONTENT_COMPLETE) &&
       receivedUpdates.includes(NETWORK_EVENT_TYPES.EVENT_TIMINGS);
 
     if (isResponseComplete) {
@@ -314,6 +312,7 @@ class NetworkEventContentWatcher {
 
     if (
       updateResource.updateType == NETWORK_EVENT_TYPES.RESPONSE_START ||
+      updateResource.updateType == NETWORK_EVENT_TYPES.RESPONSE_CONTENT ||
       isResponseComplete
     ) {
       this._emitUpdate(networkEvent);

devtools/server/actors/resources/network-events.js

@@ -403,6 +403,8 @@ class NetworkEventWatcher {
         resourceUpdates.contentSize = updateResource.contentSize;
         resourceUpdates.transferredSize = updateResource.transferredSize;
         resourceUpdates.mimeType = updateResource.mimeType;
+        break;
+      case NETWORK_EVENT_TYPES.RESPONSE_CONTENT_COMPLETE:
         resourceUpdates.blockingExtension = updateResource.blockingExtension;
         resourceUpdates.blockedReason = updateResource.blockedReason;
         break;
@@ -423,7 +425,7 @@ class NetworkEventWatcher {
 
     const isResponseComplete =
       receivedUpdates.includes(NETWORK_EVENT_TYPES.EVENT_TIMINGS) &&
-      receivedUpdates.includes(NETWORK_EVENT_TYPES.RESPONSE_CONTENT) &&
+      receivedUpdates.includes(NETWORK_EVENT_TYPES.RESPONSE_CONTENT_COMPLETE) &&
       receivedUpdates.includes(NETWORK_EVENT_TYPES.SECURITY_INFO);
 
     if (isResponseComplete) {
@@ -436,6 +438,7 @@ class NetworkEventWatcher {
 
     if (
       updateResource.updateType == NETWORK_EVENT_TYPES.RESPONSE_START ||
+      updateResource.updateType == NETWORK_EVENT_TYPES.RESPONSE_CONTENT ||
       isResponseComplete
     ) {
       this._emitUpdate(networkEvent);