Bug 1580155: Rename event constants used only for tests r=Honza.

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

devtools/client/netmonitor/src/connector/chrome/events.js

@@ -3,7 +3,10 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 "use strict";
-const { EVENTS } = require("devtools/client/netmonitor/src/constants");
+const {
+  EVENTS,
+  TEST_EVENTS,
+} = require("devtools/client/netmonitor/src/constants");
 const {
   Payloads,
 } = require("devtools/client/netmonitor/src/connector/chrome/utils");
@@ -119,7 +122,7 @@ class CDPConnector {
     this.update(requestId, {
       requestHeaders: header,
     }).then(() => {
-      window.emit(EVENTS.RECEIVED_REQUEST_HEADERS, header);
+      window.emit(TEST_EVENTS.RECEIVED_REQUEST_HEADERS, header);
     });
   }
 
@@ -136,7 +139,7 @@ class CDPConnector {
 
   updateResponseState(requestId, state) {
     this.update(requestId, state).then(() => {
-      window.emit(EVENTS.STARTED_RECEIVING_RESPONSE, requestId);
+      window.emit(TEST_EVENTS.STARTED_RECEIVING_RESPONSE, requestId);
     });
   }
 
@@ -147,7 +150,7 @@ class CDPConnector {
     this.update(requestId, {
       responseHeaders: header,
     }).then(() => {
-      window.emit(EVENTS.RECEIVED_RESPONSE_HEADERS, header);
+      window.emit(TEST_EVENTS.RECEIVED_RESPONSE_HEADERS, header);
     });
   }
 
@@ -188,7 +191,7 @@ class CDPConnector {
       return;
     }
     this.actions.updateRequest(requestId, payload, true).then(() => {
-      window.emit(EVENTS.RECEIVED_RESPONSE_CONTENT, requestId);
+      window.emit(TEST_EVENTS.RECEIVED_RESPONSE_CONTENT, requestId);
     });
   }
 
@@ -199,7 +202,7 @@ class CDPConnector {
     this.update(requestId, {
       requestPostData: postData,
     }).then(() => {
-      window.emit(EVENTS.RECEIVED_REQUEST_POST_DATA, requestId);
+      window.emit(TEST_EVENTS.RECEIVED_REQUEST_POST_DATA, requestId);
     });
   }
 

devtools/client/netmonitor/src/connector/firefox-connector.js

@@ -8,6 +8,7 @@ const Services = require("Services");
 const {
   ACTIVITY_TYPE,
   EVENTS,
+  TEST_EVENTS,
 } = require("devtools/client/netmonitor/src/constants");
 const FirefoxDataProvider = require("devtools/client/netmonitor/src/connector/firefox-data-provider");
 const {
@@ -304,7 +305,7 @@ class FirefoxConnector {
       this.actions.addTimingMarker(event);
     }
 
-    this.emitForTests(EVENTS.TIMELINE_EVENT, event);
+    this.emitForTests(TEST_EVENTS.TIMELINE_EVENT, event);
   }
 
   /**
@@ -499,7 +500,7 @@ class FirefoxConnector {
       });
     }
 
-    this.emitForTests(EVENTS.THROTTLING_CHANGED, { profile });
+    this.emitForTests(TEST_EVENTS.THROTTLING_CHANGED, { profile });
   }
 
   /**

devtools/client/netmonitor/src/connector/firefox-data-provider.js

@@ -5,7 +5,10 @@
 
 "use strict";
 
-const { EVENTS } = require("devtools/client/netmonitor/src/constants");
+const {
+  EVENTS,
+  TEST_EVENTS,
+} = require("devtools/client/netmonitor/src/constants");
 const { CurlUtils } = require("devtools/client/shared/curl");
 const {
   fetchHeaders,
@@ -344,7 +347,7 @@ class FirefoxDataProvider {
    */
   getLongString(stringGrip) {
     return this.webConsoleFront.getString(stringGrip).then(payload => {
-      this.emitForTests(EVENTS.LONGSTRING_RESOLVED, { payload });
+      this.emitForTests(TEST_EVENTS.LONGSTRING_RESOLVED, { payload });
       return payload;
     });
   }
@@ -383,7 +386,7 @@ class FirefoxDataProvider {
       channelId,
     });
 
-    this.emitForTests(EVENTS.NETWORK_EVENT, actor);
+    this.emitForTests(TEST_EVENTS.NETWORK_EVENT, actor);
   }
 
   /**
@@ -413,7 +416,7 @@ class FirefoxDataProvider {
           statusText: networkInfo.response.statusText,
           headersSize: networkInfo.response.headersSize,
         });
-        this.emitForTests(EVENTS.STARTED_RECEIVING_RESPONSE, actor);
+        this.emitForTests(TEST_EVENTS.STARTED_RECEIVING_RESPONSE, actor);
         break;
       case "responseContent":
         this.pushRequestToQueue(actor, {
@@ -439,7 +442,7 @@ class FirefoxDataProvider {
 
     this.onPayloadDataReceived(actor);
 
-    this.emitForTests(EVENTS.NETWORK_EVENT_UPDATED, actor);
+    this.emitForTests(TEST_EVENTS.NETWORK_EVENT_UPDATED, actor);
   }
 
   /**
@@ -658,7 +661,7 @@ class FirefoxDataProvider {
     const payload = await this.updateRequest(response.from, {
       requestHeaders: response,
     });
-    this.emitForTests(EVENTS.RECEIVED_REQUEST_HEADERS, response.from);
+    this.emitForTests(TEST_EVENTS.RECEIVED_REQUEST_HEADERS, response.from);
     return payload.requestHeaders;
   }
 
@@ -671,7 +674,7 @@ class FirefoxDataProvider {
     const payload = await this.updateRequest(response.from, {
       responseHeaders: response,
     });
-    this.emitForTests(EVENTS.RECEIVED_RESPONSE_HEADERS, response.from);
+    this.emitForTests(TEST_EVENTS.RECEIVED_RESPONSE_HEADERS, response.from);
     return payload.responseHeaders;
   }
 
@@ -684,7 +687,7 @@ class FirefoxDataProvider {
     const payload = await this.updateRequest(response.from, {
       requestCookies: response,
     });
-    this.emitForTests(EVENTS.RECEIVED_REQUEST_COOKIES, response.from);
+    this.emitForTests(TEST_EVENTS.RECEIVED_REQUEST_COOKIES, response.from);
     return payload.requestCookies;
   }
 
@@ -697,7 +700,7 @@ class FirefoxDataProvider {
     const payload = await this.updateRequest(response.from, {
       requestPostData: response,
     });
-    this.emitForTests(EVENTS.RECEIVED_REQUEST_POST_DATA, response.from);
+    this.emitForTests(TEST_EVENTS.RECEIVED_REQUEST_POST_DATA, response.from);
     return payload.requestPostData;
   }
 
@@ -710,7 +713,7 @@ class FirefoxDataProvider {
     const payload = await this.updateRequest(response.from, {
       securityInfo: response.securityInfo,
     });
-    this.emitForTests(EVENTS.RECEIVED_SECURITY_INFO, response.from);
+    this.emitForTests(TEST_EVENTS.RECEIVED_SECURITY_INFO, response.from);
     return payload.securityInfo;
   }
 
@@ -723,7 +726,7 @@ class FirefoxDataProvider {
     const payload = await this.updateRequest(response.from, {
       responseCookies: response,
     });
-    this.emitForTests(EVENTS.RECEIVED_RESPONSE_COOKIES, response.from);
+    this.emitForTests(TEST_EVENTS.RECEIVED_RESPONSE_COOKIES, response.from);
     return payload.responseCookies;
   }
 
@@ -735,7 +738,7 @@ class FirefoxDataProvider {
     const payload = await this.updateRequest(response.from, {
       responseCache: response,
     });
-    this.emitForTests(EVENTS.RECEIVED_RESPONSE_CACHE, response.from);
+    this.emitForTests(TEST_EVENTS.RECEIVED_RESPONSE_CACHE, response.from);
     return payload.responseCache;
   }
 
@@ -752,7 +755,7 @@ class FirefoxDataProvider {
       mimeType: response.content.mimeType,
       responseContent: response,
     });
-    this.emitForTests(EVENTS.RECEIVED_RESPONSE_CONTENT, response.from);
+    this.emitForTests(TEST_EVENTS.RECEIVED_RESPONSE_CONTENT, response.from);
     return payload.responseContent;
   }
 
@@ -783,7 +786,7 @@ class FirefoxDataProvider {
     const payload = await this.updateRequest(response.from, {
       stacktrace: response.stacktrace,
     });
-    this.emitForTests(EVENTS.RECEIVED_EVENT_STACKTRACE, response.from);
+    this.emitForTests(TEST_EVENTS.RECEIVED_EVENT_STACKTRACE, response.from);
     return payload.stacktrace;
   }
 

devtools/client/netmonitor/src/constants.js

@@ -93,60 +93,79 @@ const ACTIVITY_TYPE = {
 
 // The panel's window global is an EventEmitter firing the following events:
 const EVENTS = {
-  // When a network or timeline event is received.
-  // See https://developer.mozilla.org/docs/Tools/Web_Console/remoting for
-  // more information about what each packet is supposed to deliver.
-  NETWORK_EVENT: "NetMonitor:NetworkEvent",
-  NETWORK_EVENT_UPDATED: "NetMonitor:NetworkEventUpdated",
-  TIMELINE_EVENT: "NetMonitor:TimelineEvent",
-
   // When a network event is added to the view
   REQUEST_ADDED: "NetMonitor:RequestAdded",
 
-  // When request headers begin and finish receiving.
+  // When request headers begin receiving.
   UPDATING_REQUEST_HEADERS: "NetMonitor:NetworkEventUpdating:RequestHeaders",
-  RECEIVED_REQUEST_HEADERS: "NetMonitor:NetworkEventUpdated:RequestHeaders",
 
-  // When request cookies begin and finish receiving.
+  // When request cookies begin receiving.
   UPDATING_REQUEST_COOKIES: "NetMonitor:NetworkEventUpdating:RequestCookies",
-  RECEIVED_REQUEST_COOKIES: "NetMonitor:NetworkEventUpdated:RequestCookies",
 
-  // When request post data begins and finishes receiving.
+  // When request post data begins receiving.
   UPDATING_REQUEST_POST_DATA: "NetMonitor:NetworkEventUpdating:RequestPostData",
-  RECEIVED_REQUEST_POST_DATA: "NetMonitor:NetworkEventUpdated:RequestPostData",
 
-  // When security information begins and finishes receiving.
+  // When security information begins receiving.
   UPDATING_SECURITY_INFO: "NetMonitor:NetworkEventUpdating:SecurityInfo",
-  RECEIVED_SECURITY_INFO: "NetMonitor:NetworkEventUpdated:SecurityInfo",
 
-  // When response headers begin and finish receiving.
+  // When response headers begin receiving.
   UPDATING_RESPONSE_HEADERS: "NetMonitor:NetworkEventUpdating:ResponseHeaders",
-  RECEIVED_RESPONSE_HEADERS: "NetMonitor:NetworkEventUpdated:ResponseHeaders",
 
-  // When response cookies begin and finish receiving.
+  // When response cookies begin receiving.
   UPDATING_RESPONSE_COOKIES: "NetMonitor:NetworkEventUpdating:ResponseCookies",
-  RECEIVED_RESPONSE_COOKIES: "NetMonitor:NetworkEventUpdated:ResponseCookies",
 
   // When event timings begin and finish receiving.
   UPDATING_EVENT_TIMINGS: "NetMonitor:NetworkEventUpdating:EventTimings",
   RECEIVED_EVENT_TIMINGS: "NetMonitor:NetworkEventUpdated:EventTimings",
 
-  // When response content begins, updates and finishes receiving.
-  STARTED_RECEIVING_RESPONSE: "NetMonitor:NetworkEventUpdating:ResponseStart",
+  // When response content updates receiving.
   UPDATING_RESPONSE_CONTENT: "NetMonitor:NetworkEventUpdating:ResponseContent",
-  RECEIVED_RESPONSE_CONTENT: "NetMonitor:NetworkEventUpdated:ResponseContent",
-
-  // When stack-trace finishes receiving.
-  RECEIVED_EVENT_STACKTRACE: "NetMonitor:NetworkEventUpdated:StackTrace",
 
   UPDATING_RESPONSE_CACHE: "NetMonitor:NetworkEventUpdating:ResponseCache",
-  RECEIVED_RESPONSE_CACHE: "NetMonitor:NetworkEventUpdated:ResponseCache",
 
   // Fired once the connection is established
   CONNECTED: "connected",
 
   // When request payload (HTTP details data) are fetched from the backend.
   PAYLOAD_READY: "NetMonitor:PayloadReady",
+};
+
+const TEST_EVENTS = {
+  // When a network or timeline event is received.
+  // See https://developer.mozilla.org/docs/Tools/Web_Console/remoting for
+  // more information about what each packet is supposed to deliver.
+  NETWORK_EVENT: "NetMonitor:NetworkEvent",
+  NETWORK_EVENT_UPDATED: "NetMonitor:NetworkEventUpdated",
+  TIMELINE_EVENT: "NetMonitor:TimelineEvent",
+
+  // When response content begins receiving.
+  STARTED_RECEIVING_RESPONSE: "NetMonitor:NetworkEventUpdating:ResponseStart",
+
+  // When request headers finish receiving.
+  RECEIVED_REQUEST_HEADERS: "NetMonitor:NetworkEventUpdated:RequestHeaders",
+
+  // When response headers finish receiving.
+  RECEIVED_RESPONSE_HEADERS: "NetMonitor:NetworkEventUpdated:ResponseHeaders",
+
+  // When request cookies finish receiving.
+  RECEIVED_REQUEST_COOKIES: "NetMonitor:NetworkEventUpdated:RequestCookies",
+
+  // When request post data finishes receiving.
+  RECEIVED_REQUEST_POST_DATA: "NetMonitor:NetworkEventUpdated:RequestPostData",
+
+  // When security information finishes receiving.
+  RECEIVED_SECURITY_INFO: "NetMonitor:NetworkEventUpdated:SecurityInfo",
+
+  // When response cookies finish receiving.
+  RECEIVED_RESPONSE_COOKIES: "NetMonitor:NetworkEventUpdated:ResponseCookies",
+
+  RECEIVED_RESPONSE_CACHE: "NetMonitor:NetworkEventUpdated:ResponseCache",
+
+  // When response content finishes receiving.
+  RECEIVED_RESPONSE_CONTENT: "NetMonitor:NetworkEventUpdated:ResponseContent",
+
+  // When stack-trace finishes receiving.
+  RECEIVED_EVENT_STACKTRACE: "NetMonitor:NetworkEventUpdated:StackTrace",
 
   // When throttling is set on the backend.
   THROTTLING_CHANGED: "NetMonitor:ThrottlingChanged",
@@ -514,6 +533,7 @@ const BLOCKED_REASON_MESSAGES = {
 const general = {
   ACTIVITY_TYPE,
   EVENTS,
+  TEST_EVENTS,
   FILTER_SEARCH_DELAY: 200,
   UPDATE_PROPS,
   HEADERS,

devtools/client/netmonitor/test/browser_net_brotli.js

@@ -53,7 +53,7 @@ add_task(async function() {
 
   const wait = waitForDOM(document, ".CodeMirror-code");
   const onResponseContent = monitor.panelWin.api.once(
-    EVENTS.RECEIVED_RESPONSE_CONTENT
+    TEST_EVENTS.RECEIVED_RESPONSE_CONTENT
   );
   store.dispatch(Actions.toggleNetworkDetails());
   EventUtils.sendMouseEvent(

devtools/client/netmonitor/test/browser_net_columns_reset.js

@@ -73,13 +73,13 @@ function waitForRequestsFinished(monitor, event) {
       }
 
       // All requests are done - unsubscribe from events and resolve!
-      window.api.off(EVENTS.NETWORK_EVENT, onRequest);
+      window.api.off(TEST_EVENTS.NETWORK_EVENT, onRequest);
       window.api.off(EVENTS.RECEIVED_EVENT_TIMINGS, onEventRequest);
       info("All requests finished");
       resolve();
     }
 
-    window.api.on(EVENTS.NETWORK_EVENT, onRequest);
+    window.api.on(TEST_EVENTS.NETWORK_EVENT, onRequest);
     window.api.on(EVENTS.RECEIVED_EVENT_TIMINGS, onEventRequest);
   });
 }

devtools/client/netmonitor/test/browser_net_content-type.js

@@ -314,7 +314,7 @@ add_task(async function() {
 
   async function selectIndexAndWaitForJSONView(index) {
     const onResponseContent = monitor.panelWin.api.once(
-      EVENTS.RECEIVED_RESPONSE_CONTENT
+      TEST_EVENTS.RECEIVED_RESPONSE_CONTENT
     );
     const tabpanel = document.querySelector("#response-panel");
     const waitDOM = waitForDOM(tabpanel, ".treeTable");
@@ -329,7 +329,7 @@ add_task(async function() {
 
   async function selectIndexAndWaitForImageView(index) {
     const onResponseContent = monitor.panelWin.api.once(
-      EVENTS.RECEIVED_RESPONSE_CONTENT
+      TEST_EVENTS.RECEIVED_RESPONSE_CONTENT
     );
     const tabpanel = document.querySelector("#response-panel");
     const waitDOM = waitForDOM(tabpanel, ".response-image");

devtools/client/netmonitor/test/browser_net_pane-toggle.js

@@ -13,7 +13,9 @@ add_task(async function() {
 
   const { document, store, windowRequire } = monitor.panelWin;
   const Actions = windowRequire("devtools/client/netmonitor/src/actions/index");
-  const { EVENTS } = windowRequire("devtools/client/netmonitor/src/constants");
+  const { TEST_EVENTS } = windowRequire(
+    "devtools/client/netmonitor/src/constants"
+  );
   const { getSelectedRequest, getSortedRequests } = windowRequire(
     "devtools/client/netmonitor/src/selectors/index"
   );
@@ -35,7 +37,7 @@ add_task(async function() {
     "There should be no selected item in the requests menu."
   );
 
-  const networkEvent = monitor.panelWin.api.once(EVENTS.NETWORK_EVENT);
+  const networkEvent = monitor.panelWin.api.once(TEST_EVENTS.NETWORK_EVENT);
   tab.linkedBrowser.reload();
   await networkEvent;