Bug 1810009 - [devtools] Avoid firing DOCUMENT_EVENT will-navigate for non-top-level targets. r=devtools-reviewers,jdescottes

The legacy listener was explicitely avoiding emitting this event for non top-level targets.
It seems like all frontend code listening to will-navigate ignore the event is targetFront.isTopLevel is false,
so it looks like no code would expect these event.
So let's try to avoid emitting them if they aren't used by anyone.
(and can be confusing/buggy in the context of the browser toolbox)

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

devtools/server/actors/resources/parent-process-document-event.js

@@ -120,12 +120,18 @@ class ParentProcessDocumentEventWatcher {
         return;
       }
 
-      // Ignore remote iframe targets which are restoring from the bfcache.
-      // onStateChange is called before the related target is instantiated
-      // and this isn't quite a navigation, we will respawn a new target.
+      // Only emit will-navigate for top-level targets.
+      if (
+        this.watcherActor.sessionContext.type == "all" &&
+        browsingContext.isContent
+      ) {
+        // Never emit will-navigate for content browsing contexts in the Browser Toolbox.
+        // They might verify `browsingContext.top == browsingContext` because of the chrome/content
+        // boundary, but they do not represent a top-level target for this DevTools session.
+        return;
+      }
       const isTopLevel = browsingContext.top == browsingContext;
-      const isRestoring = flag & Ci.nsIWebProgressListener.STATE_RESTORING;
-      if (!isTopLevel && isRestoring) {
+      if (!isTopLevel) {
         return;
       }
 

devtools/shared/commands/resource/tests/browser_resources_document_events.js

@@ -239,11 +239,11 @@ async function testIframeNavigation() {
 
   // We are switching to a new target only when fission is enabled...
   if (isFissionEnabled() || isEveryFrameTargetEnabled()) {
-    await waitFor(() => documentEvents.length >= 4);
+    await waitFor(() => documentEvents.length >= 3);
     is(
       documentEvents.length,
-      4,
-      "With fission/EFT, we switch to a new target and get a will-navigate followed by a new set of events: dom-loading, dom-interactive, dom-complete"
+      3,
+      "With fission/EFT, we switch to a new target and get: dom-loading, dom-interactive, dom-complete (but no will-navigate as that's only for the top BrowsingContext)"
     );
     const [, newIframeTarget] = await commands.targetCommand.getAllTargets([
       commands.targetCommand.TYPES.FRAME,
@@ -251,7 +251,7 @@ async function testIframeNavigation() {
     assertEvents({
       commands,
       targetBeforeNavigation: iframeTarget,
-      documentEvents,
+      documentEvents: [null /* no will-navigate */, ...documentEvents],
       expectedTargetFront: newIframeTarget,
       expectedNewURI: secondPageUrl,
     });