fix!: emit browsingContext.contextDestroyed once (#2563)

Rely on the new CDP event `Page.frameSubtreeWillBeDetached`, do not emit
extra `browsingContext.contextDestroyed`, only for the top-level frame
to be destroyed. Emit the event for nested iframes on document change.

---------

Co-authored-by: browser-automation-bot <133232582+browser-automation-bot@users.noreply.github.com>

src/bidiMapper/modules/cdp/CdpTargetManager.ts

@@ -113,6 +113,10 @@ export class CdpTargetManager {
       'Page.frameDetached',
       this.#handleFrameDetachedEvent.bind(this)
     );
+    cdpClient.on(
+      'Page.frameSubtreeWillBeDetached',
+      this.#handleFrameSubtreeWillBeDetached.bind(this)
+    );
   }
 
   #handleFrameAttachedEvent(params: Protocol.Page.FrameAttachedEvent) {
@@ -143,7 +147,13 @@ export class CdpTargetManager {
     if (params.reason === 'swap') {
       return;
     }
-    this.#browsingContextStorage.findContext(params.frameId)?.dispose();
+    this.#browsingContextStorage.findContext(params.frameId)?.dispose(true);
+  }
+
+  #handleFrameSubtreeWillBeDetached(
+    params: Protocol.Page.FrameSubtreeWillBeDetachedEvent
+  ) {
+    this.#browsingContextStorage.findContext(params.frameId)?.dispose(true);
   }
 
   #handleAttachedToTargetEvent(
@@ -327,7 +337,7 @@ export class CdpTargetManager {
     const context =
       this.#browsingContextStorage.findContextBySession(sessionId);
     if (context) {
-      context.dispose();
+      context.dispose(true);
       return;
     }
 

src/bidiMapper/modules/context/BrowsingContextImpl.ts

@@ -211,29 +211,31 @@ export class BrowsingContextImpl {
     return this.#navigationId;
   }
 
-  dispose() {
+  dispose(emitContextDestroyed: boolean) {
     this.#deleteAllChildren();
 
     this.#realmStorage.deleteRealms({
       browsingContextId: this.id,
     });
 
-    // Remove context from the parent.
+    // Delete context from the parent.
     if (!this.isTopLevelContext()) {
       this.parent!.#children.delete(this.id);
     }
 
     // Fail all ongoing navigations.
     this.#failLifecycleIfNotFinished();
 
-    this.#eventManager.registerEvent(
-      {
-        type: 'event',
-        method: ChromiumBidi.BrowsingContext.EventNames.ContextDestroyed,
-        params: this.serializeToBidiValue(),
-      },
-      this.id
-    );
+    if (emitContextDestroyed) {
+      this.#eventManager.registerEvent(
+        {
+          type: 'event',
+          method: ChromiumBidi.BrowsingContext.EventNames.ContextDestroyed,
+          params: this.serializeToBidiValue(),
+        },
+        this.id
+      );
+    }
     this.#browsingContextStorage.deleteContextById(this.id);
   }
 
@@ -307,8 +309,8 @@ export class BrowsingContextImpl {
     this.#children.add(childId);
   }
 
-  #deleteAllChildren() {
-    this.directChildren.map((child) => child.dispose());
+  #deleteAllChildren(emitContextDestroyed: boolean = false) {
+    this.directChildren.map((child) => child.dispose(emitContextDestroyed));
   }
 
   get cdpTarget(): CdpTarget {
@@ -399,7 +401,7 @@ export class BrowsingContextImpl {
 
       // At the point the page is initialized, all the nested iframes from the
       // previous page are detached and realms are destroyed.
-      // Remove children from context.
+      // Delete children from context.
       this.#deleteAllChildren();
     });
 
@@ -749,8 +751,8 @@ export class BrowsingContextImpl {
   }
 
   #documentChanged(loaderId?: Protocol.Network.LoaderId) {
-    // Same document navigation.
     if (loaderId === undefined || this.#loaderId === loaderId) {
+      // Same document navigation. Document didn't change.
       if (this.#navigation.withinDocument.isFinished) {
         this.#navigation.withinDocument = new Deferred();
       } else {
@@ -762,9 +764,11 @@ export class BrowsingContextImpl {
       return;
     }
 
+    // Document changed.
     this.#resetLifecycleIfFinished();
-
     this.#loaderId = loaderId;
+    // Delete all child iframes and notify about top level destruction.
+    this.#deleteAllChildren(true);
   }
 
   #resetLifecycleIfFinished() {

wpt-metadata/chromedriver/headful/webdriver/tests/bidi/browsing_context/navigate/error.py.ini

@@ -1,3 +1,6 @@
 [error.py]
   [test_with_new_navigation_inside_page]
-    expected: FAIL
+    expected: [FAIL, PASS]
+
+  [test_with_new_navigation]
+    expected: [FAIL, PASS]

wpt-metadata/chromedriver/headless/webdriver/tests/bidi/browsing_context/navigate/error.py.ini

@@ -1,3 +1,6 @@
 [error.py]
   [test_with_new_navigation_inside_page]
-    expected: FAIL
+    expected: [FAIL, PASS]
+
+  [test_with_new_navigation]
+    expected: [FAIL, PASS]

wpt-metadata/mapper/headless/webdriver/tests/bidi/browsing_context/navigate/error.py.ini

@@ -1,3 +1,6 @@
 [error.py]
   [test_with_new_navigation_inside_page]
-    expected: FAIL
+    expected: [FAIL, PASS]
+
+  [test_with_new_navigation]
+    expected: [FAIL, PASS]