chore: update browser patches as of Mar 14, 2023 (microsoft#22603)

Internal commit reference:
microsoft/playwright-browsers@e994525

Author: aslushnikov

browser_patches/firefox/UPSTREAM_CONFIG.sh

@@ -1,3 +1,3 @@
 REMOTE_URL="https://github.com/mozilla/gecko-dev"
 BASE_BRANCH="release"
-BASE_REVISION="fe696abae79ffbfa13037a5d9bd3a2e2b293f2af"
+BASE_REVISION="250178df19caa1fb25bfa0e35728426cfbde95f8"

browser_patches/firefox/juggler/JugglerFrameParent.jsm

@@ -15,6 +15,13 @@ class JugglerFrameParent extends JSWindowActorParent {
   receiveMessage() { }
 
   async actorCreated() {
+    // Actors are registered per the WindowGlobalParent / WindowGlobalChild pair. We are only
+    // interested in those WindowGlobalParent actors that are matching current browsingContext
+    // window global.
+    // See https://github.com/mozilla/gecko-dev/blob/cd2121e7d83af1b421c95e8c923db70e692dab5f/testing/mochitest/BrowserTestUtils/BrowserTestUtilsParent.sys.mjs#L15
+    if (!this.manager?.isCurrentGlobal)
+      return;
+
     // Only interested in main frames for now.
     if (this.browsingContext.parent)
       return;

browser_patches/firefox/juggler/NetworkObserver.js

@@ -300,6 +300,9 @@ class NetworkRequest {
     }
     if (!credentials)
       return false;
+    const origin = aChannel.URI.scheme + '://' + aChannel.URI.hostPort;
+    if (credentials.origin && origin.toLowerCase() !== credentials.origin.toLowerCase())
+      return false;
     authInfo.username = credentials.username;
     authInfo.password = credentials.password;
     // This will produce a new request with respective auth header set.
@@ -464,9 +467,11 @@ class NetworkRequest {
   }
 
   _fallThroughInterceptController() {
-    if (!this._previousCallbacks || !(this._previousCallbacks instanceof Ci.nsINetworkInterceptController))
+    try {
+      return this._previousCallbacks?.getInterface(Ci.nsINetworkInterceptController);
+    } catch (e) {
       return undefined;
-    return this._previousCallbacks.getInterface(Ci.nsINetworkInterceptController);
+    }
   }
 
   _sendOnRequest(isIntercepted) {

browser_patches/firefox/juggler/TargetRegistry.js

@@ -386,7 +386,7 @@ class PageTarget {
     const tabBrowser = ownerWindow.gBrowser;
     // Serialize all tab-switching commands per tabbed browser
     // to disallow concurrent tab switching.
-    tabBrowser.__serializedChain = (tabBrowser.__serializedChain ?? Promise.resolve()).then(async () => {
+    const result = (tabBrowser.__serializedChain ?? Promise.resolve()).then(async () => {
       this._window.focus();
       if (tabBrowser.selectedTab !== this._tab) {
         const promise = helper.awaitEvent(ownerWindow, 'TabSwitchDone');
@@ -395,7 +395,8 @@ class PageTarget {
       }
       await callback();
     });
-    return tabBrowser.__serializedChain;
+    tabBrowser.__serializedChain = result.catch(error => { /* swallow errors to keep chain running */ });
+    return result;
   }
 
   frameIdToBrowsingContext(frameId) {
@@ -702,7 +703,17 @@ class PageTarget {
     screencastService.stopVideoRecording(screencastId);
   }
 
+  ensureContextMenuClosed() {
+    // Close context menu, if any, since it might capture mouse events on Linux
+    // and prevent browser shutdown on MacOS.
+    const doc = this._linkedBrowser.ownerDocument;
+    const contextMenu = doc.getElementById("contentAreaContextMenu");
+    if (contextMenu)
+      contextMenu.hidePopup();
+  }
+
   dispose() {
+    this.ensureContextMenuClosed();
     this._disposed = true;
     if (this._videoRecordingInfo)
       this._stopVideoRecording();

browser_patches/firefox/juggler/content/FrameTree.js

@@ -14,10 +14,12 @@ const {Runtime} = ChromeUtils.import('chrome://juggler/content/content/Runtime.j
 const helper = new Helper();
 
 class FrameTree {
-  constructor(rootDocShell) {
+  constructor(rootBrowsingContext) {
     helper.decorateAsEventEmitter(this);
 
-    this._browsingContextGroup = rootDocShell.browsingContext.group;
+    this._rootBrowsingContext = rootBrowsingContext;
+
+    this._browsingContextGroup = rootBrowsingContext.group;
     if (!this._browsingContextGroup.__jugglerFrameTrees)
       this._browsingContextGroup.__jugglerFrameTrees = new Set();
     this._browsingContextGroup.__jugglerFrameTrees.add(this);
@@ -29,12 +31,14 @@ class FrameTree {
 
     this._runtime = new Runtime(false /* isWorker */);
     this._workers = new Map();
-    this._docShellToFrame = new Map();
     this._frameIdToFrame = new Map();
     this._pageReady = false;
     this._javaScriptDisabled = false;
-    this._mainFrame = this._createFrame(rootDocShell);
-    const webProgress = rootDocShell.QueryInterface(Ci.nsIInterfaceRequestor)
+    for (const browsingContext of helper.collectAllBrowsingContexts(rootBrowsingContext))
+      this._createFrame(browsingContext);
+    this._mainFrame = this.frameForBrowsingContext(rootBrowsingContext);
+
+    const webProgress = rootBrowsingContext.docShell.QueryInterface(Ci.nsIInterfaceRequestor)
                                 .getInterface(Ci.nsIWebProgress);
     this.QueryInterface = ChromeUtils.generateQI([
       Ci.nsIWebProgressListener,
@@ -58,16 +62,20 @@ class FrameTree {
                   Ci.nsIWebProgress.NOTIFY_LOCATION;
     this._eventListeners = [
       helper.addObserver((docShell, topic, loadIdentifier) => {
-        const frame = this._docShellToFrame.get(docShell);
+        const frame = this.frameForDocShell(docShell);
         if (!frame)
           return;
         frame._pendingNavigationId = helper.toProtocolNavigationId(loadIdentifier);
         this.emit(FrameTree.Events.NavigationStarted, frame);
       }, 'juggler-navigation-started-renderer'),
       helper.addObserver(this._onDOMWindowCreated.bind(this), 'content-document-global-created'),
       helper.addObserver(this._onDOMWindowCreated.bind(this), 'juggler-dom-window-reused'),
-      helper.addObserver(subject => this._onDocShellCreated(subject.QueryInterface(Ci.nsIDocShell)), 'webnavigation-create'),
-      helper.addObserver(subject => this._onDocShellDestroyed(subject.QueryInterface(Ci.nsIDocShell)), 'webnavigation-destroy'),
+      helper.addObserver((browsingContext, topic, why) => {
+        this._onBrowsingContextAttached(browsingContext);
+      }, 'browsing-context-attached'),
+      helper.addObserver((browsingContext, topic, why) => {
+        this._onBrowsingContextDetached(browsingContext);
+      }, 'browsing-context-discarded'),
       helper.addProgressListener(webProgress, this, flags),
     ];
 
@@ -114,8 +122,7 @@ class FrameTree {
       return null;
     if (!workerDebugger.window)
       return null;
-    const docShell = workerDebugger.window.docShell;
-    return this._docShellToFrame.get(docShell) || null;
+    return this.frameForDocShell(workerDebugger.window.docShell);
   }
 
   _onDOMWindowCreated(window) {
@@ -127,7 +134,7 @@ class FrameTree {
       window.windowUtils.addSheet(sheet, styleSheetService.AGENT_SHEET);
       window[this._addedScrollbarsStylesheetSymbol] = true;
     }
-    const frame = this._docShellToFrame.get(window.docShell) || null;
+    const frame = this.frameForDocShell(window.docShell);
     if (!frame)
       return;
     frame._onGlobalObjectCleared();
@@ -202,8 +209,18 @@ class FrameTree {
       frame._addBinding(worldName, name, script);
   }
 
+  frameForBrowsingContext(browsingContext) {
+    if (!browsingContext)
+      return null;
+    const frameId = helper.browsingContextToFrameId(browsingContext);
+    return this._frameIdToFrame.get(frameId) ?? null;
+  }
+
   frameForDocShell(docShell) {
-    return this._docShellToFrame.get(docShell) || null;
+    if (!docShell)
+      return null;
+    const frameId = helper.browsingContextToFrameId(docShell.browsingContext);
+    return this._frameIdToFrame.get(frameId) ?? null;
   }
 
   frame(frameId) {
@@ -246,9 +263,9 @@ class FrameTree {
       return;
 
     const docShell = event.target.ownerGlobal.docShell;
-    const frame = this._docShellToFrame.get(docShell);
+    const frame = this.frameForDocShell(docShell);
     if (!frame) {
-      dump(`WARNING: ${event.type} for unknown frame ${docShell.browsingContext.id}\n`);
+      dump(`WARNING: ${event.type} for unknown frame ${helper.browsingContextToFrameId(docShell.browsingContext)}\n`);
       return;
     }
     if (frame._pendingNavigationId) {
@@ -292,7 +309,7 @@ class FrameTree {
       return;
     const channel = request.QueryInterface(Ci.nsIChannel);
     const docShell = progress.DOMWindow.docShell;
-    const frame = this._docShellToFrame.get(docShell);
+    const frame = this.frameForDocShell(docShell);
     if (!frame)
       return;
 
@@ -317,38 +334,37 @@ class FrameTree {
 
   onLocationChange(progress, request, location, flags) {
     const docShell = progress.DOMWindow.docShell;
-    const frame = this._docShellToFrame.get(docShell);
+    const frame = this.frameForDocShell(docShell);
     const sameDocumentNavigation = !!(flags & Ci.nsIWebProgressListener.LOCATION_CHANGE_SAME_DOCUMENT);
     if (frame && sameDocumentNavigation) {
       frame._url = location.spec;
       this.emit(FrameTree.Events.SameDocumentNavigation, frame);
     }
   }
 
-  _onDocShellCreated(docShell) {
-    // Bug 1142752: sometimes, the docshell appears to be immediately
-    // destroyed, bailout early to prevent random exceptions.
-    if (docShell.isBeingDestroyed())
+  _onBrowsingContextAttached(browsingContext) {
+    // If this browsing context doesn't belong to our frame tree - do nothing.
+    if (browsingContext.top !== this._rootBrowsingContext)
       return;
-    // If this docShell doesn't belong to our frame tree - do nothing.
-    let root = docShell;
-    while (root.parent)
-      root = root.parent;
-    if (root === this._mainFrame._docShell)
-      this._createFrame(docShell);
+    this._createFrame(browsingContext);
+  }
+
+  _onBrowsingContextDetached(browsingContext) {
+    const frame = this.frameForBrowsingContext(browsingContext);
+    if (frame)
+      this._detachFrame(frame);
   }
 
-  _createFrame(docShell) {
-    const parentFrame = this._docShellToFrame.get(docShell.parent) || null;
+  _createFrame(browsingContext) {
+    const parentFrame = this.frameForBrowsingContext(browsingContext.parent);
     if (!parentFrame && this._mainFrame) {
       dump(`WARNING: found docShell with the same root, but no parent!\n`);
       return;
     }
-    const frame = new Frame(this, this._runtime, docShell, parentFrame);
-    this._docShellToFrame.set(docShell, frame);
+    const frame = new Frame(this, this._runtime, browsingContext, parentFrame);
     this._frameIdToFrame.set(frame.id(), frame);
-    if (docShell.domWindow && docShell.domWindow.location)
-      frame._url = docShell.domWindow.location.href;
+    if (browsingContext.docShell?.domWindow && browsingContext.docShell?.domWindow.location)
+      frame._url = browsingContext.docShell.domWindow.location.href;
     this.emit(FrameTree.Events.FrameAttached, frame);
     // Create execution context **after** reporting frame.
     // This is our protocol contract.
@@ -357,12 +373,6 @@ class FrameTree {
     return frame;
   }
 
-  _onDocShellDestroyed(docShell) {
-    const frame = this._docShellToFrame.get(docShell);
-    if (frame)
-      this._detachFrame(frame);
-  }
-
   _detachFrame(frame) {
     // Detach all children first
     for (const subframe of frame._children)
@@ -372,7 +382,6 @@ class FrameTree {
       // as it confuses the client.
       return;
     }
-    this._docShellToFrame.delete(frame._docShell);
     this._frameIdToFrame.delete(frame.id());
     if (frame._parentFrame)
       frame._parentFrame._children.delete(frame);
@@ -409,12 +418,12 @@ class IsolatedWorld {
 }
 
 class Frame {
-  constructor(frameTree, runtime, docShell, parentFrame) {
+  constructor(frameTree, runtime, browsingContext, parentFrame) {
     this._frameTree = frameTree;
     this._runtime = runtime;
-    this._docShell = docShell;
+    this._browsingContext = browsingContext;
     this._children = new Set();
-    this._frameId = helper.browsingContextToFrameId(this._docShell.browsingContext);
+    this._frameId = helper.browsingContextToFrameId(browsingContext);
     this._parentFrame = null;
     this._url = '';
     if (parentFrame) {
@@ -556,7 +565,7 @@ class Frame {
 
   _onGlobalObjectCleared() {
     const webSocketService = this._frameTree._webSocketEventService;
-    if (this._webSocketListenerInnerWindowId)
+    if (this._webSocketListenerInnerWindowId && webSocketService.hasListenerFor(this._webSocketListenerInnerWindowId))
       webSocketService.removeListener(this._webSocketListenerInnerWindowId, this._webSocketListener);
     this._webSocketListenerInnerWindowId = this.domWindow().windowGlobalChild.innerWindowId;
     webSocketService.addListener(this._webSocketListenerInnerWindowId, this._webSocketListener);
@@ -591,8 +600,8 @@ class Frame {
   }
 
   _updateJavaScriptDisabled() {
-    if (this._docShell.browsingContext.currentWindowContext)
-      this._docShell.browsingContext.currentWindowContext.allowJavascript = !this._frameTree._javaScriptDisabled;
+    if (this._browsingContext.currentWindowContext)
+      this._browsingContext.currentWindowContext.allowJavascript = !this._frameTree._javaScriptDisabled;
   }
 
   mainExecutionContext() {
@@ -603,7 +612,7 @@ class Frame {
     if (!this._textInputProcessor) {
       this._textInputProcessor = Cc["@mozilla.org/text-input-processor;1"].createInstance(Ci.nsITextInputProcessor);
     }
-    this._textInputProcessor.beginInputTransactionForTests(this._docShell.DOMWindow);
+    this._textInputProcessor.beginInputTransactionForTests(this.docShell().DOMWindow);
     return this._textInputProcessor;
   }
 
@@ -616,15 +625,15 @@ class Frame {
   }
 
   docShell() {
-    return this._docShell;
+    return this._browsingContext.docShell;
   }
 
   domWindow() {
-    return this._docShell.domWindow;
+    return this.docShell()?.domWindow;
   }
 
   name() {
-    const frameElement = this._docShell.domWindow.frameElement;
+    const frameElement = this.domWindow()?.frameElement;
     let name = '';
     if (frameElement)
       name = frameElement.getAttribute('name') || frameElement.getAttribute('id') || '';

browser_patches/firefox/juggler/content/Runtime.js

@@ -311,8 +311,9 @@ class ExecutionContext {
     this._id = generateId();
     this._auxData = auxData;
     this._jsonStringifyObject = this._debuggee.executeInGlobal(`((stringify, object) => {
-      const oldToJSON = Date.prototype.toJSON;
-      Date.prototype.toJSON = undefined;
+      const oldToJSON = Date.prototype?.toJSON;
+      if (oldToJSON)
+        Date.prototype.toJSON = undefined;
       const oldArrayToJSON = Array.prototype.toJSON;
       const oldArrayHadToJSON = Array.prototype.hasOwnProperty('toJSON');
       if (oldArrayHadToJSON)
@@ -325,7 +326,8 @@ class ExecutionContext {
         return value;
       });
 
-      Date.prototype.toJSON = oldToJSON;
+      if (oldToJSON)
+        Date.prototype.toJSON = oldToJSON;
       if (oldArrayHadToJSON)
         Array.prototype.toJSON = oldArrayToJSON;
 

browser_patches/firefox/juggler/content/main.js

@@ -85,7 +85,7 @@ function initialize(browsingContext, docShell, actor) {
   docShell.overrideHasFocus = true;
   docShell.forceActiveState = true;
   docShell.disallowBFCache = true;
-  data.frameTree = new FrameTree(docShell);
+  data.frameTree = new FrameTree(browsingContext);
   for (const [name, value] of Object.entries(contextCrossProcessCookie.settings)) {
     if (value !== undefined)
       applySetting[name](value);

browser_patches/firefox/juggler/protocol/BrowserHandler.js

@@ -152,6 +152,12 @@ class BrowserHandler {
     this._targetRegistry.browserContextForId(browserContextId).extraHTTPHeaders = headers;
   }
 
+  ['Browser.clearCache']() {
+    // Clearing only the context cache does not work: https://bugzilla.mozilla.org/show_bug.cgi?id=1819147
+    Services.cache2.clear();
+    ChromeUtils.clearStyleSheetCache();
+  }
+
   ['Browser.setHTTPCredentials']({browserContextId, credentials}) {
     this._targetRegistry.browserContextForId(browserContextId).httpCredentials = nullToUndefined(credentials);
   }