1518598 - this.viewNode is null error when calling window.close()

Status: VERIFIED FIXED

(WebExtensions :: Untriaged, defect, P2)

Description

[Sun Knudsen]

Attachment: Screen Shot 2019-01-08 at 1.50.04 PM.png

User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:64.0) Gecko/20100101 Firefox/64.0

Steps to reproduce:

Porting an extension from Chrome to Firefox (works fine in Chrome, but love Firefox).

When a user clicks on the extension, if credentials are not found in chrome.storage.local, chrome.runtime.openOptionsPage() is called followed by window.close().

In a nutshell, the user then logs in via options and the cycle repeats but credentials are found this time so the popup is rendered.

This works fine the first time around, but when the extension is clicked again (no login attempted, same cycle), the following error is thrown.

this.viewNode is null ExtensionPopups.jsm:492
attach
resource:///modules/ExtensionPopups.jsm:492:5
InterpretGeneratorResume self-hosted:1255:8 next self-hosted:1210:9 onViewShowing
chrome://browser/content/parent/ext-browserAction.js:196:33
next self-hosted:1210:9 wrapWidgetEventHandler/aWidget[aEventName]
resource:///modules/CustomizableUI.jsm:2509:16
dispatchCustomEvent
resource:///modules/PanelMultiView.jsm:194:5
dispatchCustomEvent
resource:///modules/PanelMultiView.jsm:1254:12
dispatchAsyncEvent/this._blockersPromise<
resource:///modules/PanelMultiView.jsm:228:20
InterpretGeneratorResume self-hosted:1255:8 next self-hosted:1210:9

For reference, this bug has been discussed with erosman and @freaktechnik on IRC #webextensions.

Actual results:

The content of the popup is cleared, but the popup isn't closed.

Expected results:

The popup should close.

Comment 1

[Rob Wu [:robwu]]

Attachment: popup-close.zip

Steps to reproduce:

1. Load extension, e.g. at about:debugging
2. Click on the popup

Expected:

• Popup should close.

Actual:

• Popup is not closed.
• The global JS console (Ctrl-Shift-J) contains the following error:
  this.viewNode is null ExtensionPopups.jsm:492

Reproduced on Firefox 64.0 and Firefox 66.0a1 buildID 20190103094209

Comment 2

[Rob Wu [:robwu]]

I've also observed the following error in a local build:

"TypeError: this.browser is null ExtensionPopups.jsm:338:7"

Edit: that is likely bug 1394019

Comment 3

[Rob Wu [:robwu]]

Attachment: Bug 1518598 - Return early if popup has already been closed

Comment 4

[Rob Wu [:robwu]]

There is already an existing unit test that tests the scenario of closing a popup on load:
https://searchfox.org/mozilla-central/rev/c3ebaf6de2d481c262c04bb9657eaf76bf47e2ac/browser/components/extensions/test/browser/browser_ext_browserAction_popup.js#55-61
The test does however not fail, possibly because it does not trigger the pre-load branch.

I've locally verified that my proposed patch fixes the reported bug, but QA should also confirm that the bug has been fixed when the patch lands.

Comment 5

[Shane Caraveo (:mixedpuppy)]

IIUC the popup doesn't close in this situation. Does the test popup also not close? If so, can we add a check that the popup actually closes?

Comment 6

[Rob Wu [:robwu]]

The test file that I referenced does not test preloaded popups.
I have just added a new test that does test preloaded popups, and I verified that the test fails before my fix and passes after with the patch. I have also made some other small changes to fix errors (including bug 1394019, which is triggered by my new test).

Comment 7

[Sun Knudsen]

I see you guys are doing great progress. Thanks. :) Do you have ETAs for when the fix will be released to Nightly and then to everyone?

I will keep an eye open and try the fix as soon as its published.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d27e22f625f2
Return early if popup has already been closed r=mixedpuppy

Comment 9

[Raul Gurzau (:RaulG)]

https://hg.mozilla.org/mozilla-central/rev/d27e22f625f2

Comment 10

[Mike de Boer [:mikedeboer]]

https://hg.mozilla.org/projects/cedar/rev/d27e22f625f26ba6ae485d5da99f4b5ded52e065
Bug 1518598 - Return early if popup has already been closed r=mixedpuppy

Comment 11

[Vlad Jiman]

Verified the fix using FF 66.0a1 and the latest Nightly (20190203214209), I did manage to reproduce the issue using the attached extension from comment #1 while using Fx 64, 65 but the error was no longer showing on versions above 66. Testing was done on Windows 10 x64 bit.