Merge pull request #25 from juliandescottes/ignore-frame-contexts

Ignore frame contexts

Author: juliandescottes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ff-test-bidi-har-export",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "Experimental helper to export HAR files from WebDriverBiDi network events",
   "main": "index.js",
   "scripts": {

src/adapters/events-collection-exporter.js

@@ -6,6 +6,7 @@ const HarRecorder = require("../har-recorder");
 
 const EVENT_ORDER = [
   "network.beforeRequestSent",
+  "browsingContext.contextCreated",
   "browsingContext.domContentLoaded",
   "network.responseCompleted",
   "browsingContext.load",
@@ -25,6 +26,7 @@ const EVENT_ORDER = [
  * The expected events are:
  * - network.beforeRequestSent
  * - network.responseCompleted
+ * - browsingContext.contextCreated
  * - browsingContext.domContentLoaded
  * - browsingContext.load
  */

src/adapters/selenium-bidi-har-recorder.js

@@ -46,18 +46,22 @@ class SeleniumBiDiHarRecorder {
 
     this.bidi = await this._driver.getBidi();
 
+    await this.bidi.subscribe(
+      "browsingContext.contextCreated",
+      this._browsingContextIds,
+    );
     await this.bidi.subscribe(
       "browsingContext.domContentLoaded",
-      this._browsingContextIds
+      this._browsingContextIds,
     );
     await this.bidi.subscribe("browsingContext.load", this._browsingContextIds);
     await this.bidi.subscribe(
       "network.beforeRequestSent",
-      this._browsingContextIds
+      this._browsingContextIds,
     );
     await this.bidi.subscribe(
       "network.responseCompleted",
-      this._browsingContextIds
+      this._browsingContextIds,
     );
 
     this.ws = await this.bidi.socket;
@@ -76,21 +80,25 @@ class SeleniumBiDiHarRecorder {
   async stopRecording() {
     this.ws.off("message", this._onMessage);
 
+    await this.bidi.unsubscribe(
+      "browsingContext.contextCreated",
+      this._browsingContextIds,
+    );
     await this.bidi.unsubscribe(
       "browsingContext.domContentLoaded",
-      this._browsingContextIds
+      this._browsingContextIds,
     );
     await this.bidi.unsubscribe(
       "browsingContext.load",
-      this._browsingContextIds
+      this._browsingContextIds,
     );
     await this.bidi.unsubscribe(
       "network.beforeRequestSent",
-      this._browsingContextIds
+      this._browsingContextIds,
     );
     await this.bidi.unsubscribe(
       "network.responseCompleted",
-      this._browsingContextIds
+      this._browsingContextIds,
     );
 
     const lastPageUrl = await this._getPageUrl();
@@ -108,13 +116,13 @@ class SeleniumBiDiHarRecorder {
       try {
         const browsingContextId = this._browsingContextIds[0];
         const params = {
-          method: 'browsingContext.getTree',
+          method: "browsingContext.getTree",
           params: {
             root: browsingContextId,
           },
-        }
+        };
 
-        const response = await this.bidi.send(params)
+        const response = await this.bidi.send(params);
         pageUrl = response.result.contexts[0].url;
       } catch (e) {
         // Could not fetch page url.

src/har-recorder.js

@@ -35,6 +35,7 @@ class HarRecorder {
 
     this.networkEntries = [];
     this.pageTimings = [];
+    this.topLevelContexts = [];
   }
 
   recordEvent(event) {
@@ -56,6 +57,9 @@ class HarRecorder {
       case "network.responseCompleted":
         this._onResponseCompleted(params);
         break;
+      case "browsingContext.contextCreated":
+        this._onContextCreatedEvent(params);
+        break;
       case "browsingContext.domContentLoaded":
         this._onBrowsingContextEvent("domContentLoaded", params);
         break;
@@ -331,6 +335,15 @@ class HarRecorder {
   _onBrowsingContextEvent(type, params) {
     let { context, timestamp, url } = params;
 
+    if (!this.topLevelContexts.includes(context)) {
+      this._log(
+        `Browsing context event "${type}" for url: ${this._shortUrl(
+          url,
+        )} discarded (not a top-level context)`,
+      );
+      return;
+    }
+
     let relativeTime = +Infinity,
       startedTime = -1;
 
@@ -417,6 +430,12 @@ class HarRecorder {
     });
   }
 
+  _onContextCreatedEvent(params) {
+    if (!params.parent) {
+      this.topLevelContexts.push(params.context);
+    }
+  }
+
   _onResponseCompleted(params) {
     const id = params.request.request + "-" + params.redirectCount;
     const url = params.request.url;

test/adapters/events-collection-exporter.test.js

@@ -8,29 +8,34 @@ test("EventsCollectionExporter generates simple har export", () => {
   const startTime = Date.now();
   const {
     beforeRequestSentEvent,
+    contextCreatedEvent,
     domContentLoadedEvent,
     loadEvent,
     responseCompletedEvent,
   } = getMockEvents(startTime);
 
-  const testCases = [{
-    name: "Expected order",
-    events: [
-      beforeRequestSentEvent,
-      domContentLoadedEvent,
-      loadEvent,
-      responseCompletedEvent,
-    ],
-  },
-  {
-    name: "random order",
-    events: [
-      loadEvent,
-      domContentLoadedEvent,
-      responseCompletedEvent,
-      beforeRequestSentEvent,
-    ],
-  }];
+  const testCases = [
+    {
+      name: "Expected order",
+      events: [
+        beforeRequestSentEvent,
+        contextCreatedEvent,
+        domContentLoadedEvent,
+        loadEvent,
+        responseCompletedEvent,
+      ],
+    },
+    {
+      name: "random order",
+      events: [
+        loadEvent,
+        domContentLoadedEvent,
+        responseCompletedEvent,
+        contextCreatedEvent,
+        beforeRequestSentEvent,
+      ],
+    },
+  ];
 
   for (const { name, events } of testCases) {
     console.log("Test case: " + name);
@@ -47,4 +52,4 @@ test("EventsCollectionExporter generates simple har export", () => {
     expect(harExport.log.pages.length).toBe(1);
     expect(harExport.log.entries.length).toBe(1);
   }
-});
+});

test/har-recorder.initial-page.test.js

@@ -13,10 +13,11 @@ test("HarRecorder generates har export with default initial page", () => {
   const {
     beforeRequestSentEvent: earlyBeforeRequestSentEvent,
     responseCompletedEvent: earlyResponseCompletedEvent,
-  } = getMockEvents(startTime, { url: "https://other.example.com/"});
+  } = getMockEvents(startTime, { url: "https://other.example.com/" });
 
   const {
     beforeRequestSentEvent,
+    contextCreatedEvent,
     domContentLoadedEvent,
     loadEvent,
     responseCompletedEvent,
@@ -26,6 +27,7 @@ test("HarRecorder generates har export with default initial page", () => {
   recorder.recordEvent(earlyResponseCompletedEvent);
   recorder.recordEvent(beforeRequestSentEvent);
   recorder.recordEvent(responseCompletedEvent);
+  recorder.recordEvent(contextCreatedEvent);
   recorder.recordEvent(domContentLoadedEvent);
   recorder.recordEvent(loadEvent);
 
@@ -54,10 +56,11 @@ test("HarRecorder generates har export with provided initial page", () => {
   const {
     beforeRequestSentEvent: earlyBeforeRequestSentEvent,
     responseCompletedEvent: earlyResponseCompletedEvent,
-  } = getMockEvents(startTime, { url: "https://other.example.com/"});
+  } = getMockEvents(startTime, { url: "https://other.example.com/" });
 
   const {
     beforeRequestSentEvent,
+    contextCreatedEvent,
     domContentLoadedEvent,
     loadEvent,
     responseCompletedEvent,
@@ -67,6 +70,7 @@ test("HarRecorder generates har export with provided initial page", () => {
   recorder.recordEvent(earlyResponseCompletedEvent);
   recorder.recordEvent(beforeRequestSentEvent);
   recorder.recordEvent(responseCompletedEvent);
+  recorder.recordEvent(contextCreatedEvent);
   recorder.recordEvent(domContentLoadedEvent);
   recorder.recordEvent(loadEvent);
 

test/resources/mock-events.js

@@ -5,7 +5,11 @@ let { requestHeaders, responseHeaders } = require("./common-resources");
 let gRequestId = 10;
 
 function getMockEvents(startTime, options = {}) {
-  const { contextId = "context-1", useLegacyHeaderFormat = false } = options;
+  const {
+    contextId = "context-1",
+    parentContextId = null,
+    useLegacyHeaderFormat = false,
+  } = options;
   const highResStartTime = startTime * 1000;
   const requestId = (options.requestId || gRequestId++) + "";
 
@@ -112,6 +116,17 @@ function getMockEvents(startTime, options = {}) {
     },
   };
 
+  const contextCreatedEvent = {
+    method: "browsingContext.contextCreated",
+    params: {
+      context: contextId,
+      parent: parentContextId,
+      url: options.url || "https://example.com/",
+      userContext: "default",
+      timestamp: startTime + 4,
+    },
+  };
+
   const domContentLoadedEvent = {
     method: "browsingContext.domContentLoaded",
     params: {
@@ -132,6 +147,7 @@ function getMockEvents(startTime, options = {}) {
 
   return {
     beforeRequestSentEvent,
+    contextCreatedEvent,
     domContentLoadedEvent,
     loadEvent,
     responseCompletedEvent,