1663429 - "WebDriver:SwitchToWindow" can fail when window is closed at the same time (TypeError: can't access property "addMessageListener", this.mm is null)

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, defect, P1)

Description

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Originally filed as https://github.com/mozilla/geckodriver/issues/1770

When WebDriver:SwitchToWindow is called at the exact same time as when the target window gets closed, the following exception will be raised:

1599480854548	Marionette	DEBUG	3 -> [0,18,"WebDriver:SwitchToWindow",{"handle":"40","focus":true}]
1599480854554	Marionette	TRACE	Received DOM event TabSelect for [object XULElement]
1599480854572	Marionette	DEBUG	3 <- [1,18,{"error":"unknown error","message":"TypeError: can't access property \"addMessageListener\", this.mm is null","stacktra ... ementEventTarget@chrome://marionette/content/dom.js:46:5\nswitchToTab@chrome://marionette/content/browser.js:491:26\n"},null]
Marionette threw an error: TypeError: can't access property "addMessageListener", this.mm is null
WebElementEventTarget@chrome://marionette/content/dom.js:46:5
switchToTab@chrome://marionette/content/browser.js:491:26

The best solution here would be to move all the code in setWindowHandle() into a try/catch and raise a NoSuchWindowError instead.

Comment 1

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Attachment: Bug 1663429 - [marionette] Only throw NoSuchWindow error in "WebDriver:SwitchToWindow".

There is a race condition in the "WebDriver:SwitchToWindow" command
that would throw an UnknownError instead of NoSuchWindowError when
the window gets closed at the same time as the command gets called.

Comment 2

[Marco Mucci [:MarcoM]]

Hi Henrik. Should this bug be included as part of the Marionette MVP?

Comment 3

[Henrik Skupin [:whimboo][⌚️UTC+2]]

(In reply to Marco Mucci [:MarcoM] from comment #2)

Hi Henrik. Should this bug be included as part of the Marionette MVP?

You can consider "No" when we don't set the whiteboard entry.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/0bf5b58dcd64
[marionette] Only throw NoSuchWindow error in "WebDriver:SwitchToWindow". r=marionette-reviewers,jgraham

Comment 5

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/0bf5b58dcd64

Comment 6

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Comment on attachment 9174224 [details]
Bug 1663429 - [marionette] Only throw NoSuchWindow error in "WebDriver:SwitchToWindow".

Beta/Release Uplift Approval Request

• User impact if declined: There is a race condition where WebDriver tests can fail if a switch to a tab happens at the same time when it gets closed. In such cases we don't return the expected error type as given by the WebDriver specification.
• Is this code covered by automated tests?: No
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): The code only catches further possible errors and returns the correct error type.
• String changes made/needed: no

Comment 7

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9174224 [details]
Bug 1663429 - [marionette] Only throw NoSuchWindow error in "WebDriver:SwitchToWindow".

This needs a rebased patch for Beta.

Comment 8

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Here the try build with the rebased patch:

https://treeherder.mozilla.org/#/jobs?repo=try&revision=60c5358ed8e176cb703b45c2f36711d3780832d7

The commit is:
https://hg.mozilla.org/try/rev/91dff485fcda25fcf772f9997128441506887aad

Comment 9

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9174224 [details]
Bug 1663429 - [marionette] Only throw NoSuchWindow error in "WebDriver:SwitchToWindow".

Approved for 81.0b9.

Comment 10

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/36963fd91ea6

Comment 12

[Intermittent Failures Robot]

1 failures in 3657 pushes (0.0 failures/push) were associated with this bug in the last 7 days.

Repository breakdown:

• mozilla-central: 1

Platform and build breakdown:

• android-em-7-0-x86_64-shippable-lite-qr: 1
  • opt: 1

For more details, see:
https://treeherder.mozilla.org/intermittent-failures/bugdetails?bug=1663429&startday=2023-10-23&endday=2023-10-29&tree=all