1401691 - Consider allowing windowId for browser.theme.reset

Status: VERIFIED FIXED

(WebExtensions :: General, defect, P5)

Description

[Jonathan Kingston [:jkt] he/him]

Reset clears my styles to native which is super useful, however I then have to calculate all the visible windows again.

If I could pass a windowId to browser.theme.reset() this would be simpler and less janky.

Comment 1

[Jonathan Kingston [:jkt] he/him]

As mentioned on irc the current code doesn't work with reset.
I created a branch here: https://github.com/jonathanKingston/containers-theme/tree/reset-theme
This currently works across containers, however when you change to a default tab it will retain the containers theme.

:ntim I can double check the code works when you have a patch (which it sounds like you have).

Comment 2

[Tim Nguyen :ntim]

Seems to work, thanks!

Comment 3

[Tim Nguyen :ntim]

Attachment: Bug 1401691 - Accept windowId parameter for browser.theme.reset().

Review commit: https://reviewboard.mozilla.org/r/185126/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/185126/

Comment 4

[Tim Nguyen :ntim]

I think this can be considered for 57, as the patch is pretty straightforward and low-risk.

Comment 5

[Jared Wein [:jaws] (please needinfo? me)]

Comment on attachment 8913738 [details]
Bug 1401691 - Accept windowId parameter for browser.theme.reset().

https://reviewboard.mozilla.org/r/185126/#review190294

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/55e00fb0f00b
Accept windowId parameter for browser.theme.reset(). r=jaws

Comment 7

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/55e00fb0f00b

Comment 8

[Tim Nguyen :ntim]

Comment on attachment 8913738 [details]
Bug 1401691 - Accept windowId parameter for browser.theme.reset().

Approval Request Comment
[Feature/Bug causing the regression]: bug 1342712
[User impact if declined]: None for users, but the API introduced in bug 1342712 will be incomplete, as its equivalent for reset() won't be supported
[Is this code covered by automated tests?]: No
[Has the fix been verified in Nightly?]: not yet
[Needs manual test from QE? If yes, steps to reproduce]: no
[List of other uplifts needed for the feature/fix]: none
[Is the change risky?]: no
[Why is the change risky/not risky?]: Straightforward JS changes, that have the same logic as bug 1342712, which has been well tested.
[String changes made/needed]: none

Comment 9

[Tim Nguyen :ntim]

:jkt, can you please verify that this works for your add-on in Nightly ? Thanks!

Comment 10

[Jonathan Kingston [:jkt] he/him]

I can confirm that the patch in Nightly now works with the branch that I made, thank you!

Comment 11

[Sylvestre Ledru [:Sylvestre]]

What kind of extension would use this?
By the way, there is no test?

Comment 12

[Tim Nguyen :ntim]

(In reply to Sylvestre Ledru [:sylvestre] from comment #11)
> What kind of extension would use this?

Theme related extensions: VivaldiFox (I'm working on a port for 57 atm), Containers theme.

> By the way, there is no test?

Both bug 1342712 and this bug don't have testing coverage, since I landed those in a rush to be able to port my own extensions in time for 57.

I do plan to add tests later separately though.

Comment 13

[Sylvestre Ledru [:Sylvestre]]

Comment on attachment 8913738 [details]
Bug 1401691 - Accept windowId parameter for browser.theme.reset().

OK, taking it to help theme support.
Tim, please report a new bug to make sure we don't forget about adding tests.
Thanks

Comment 14

[Tim Nguyen :ntim]

Thanks! Filed bug 1404855 for tests

Comment 15

[Tim Nguyen :ntim]

https://hg.mozilla.org/releases/mozilla-beta/rev/35998341106ce20629c30154ba5263b93ccceb70

Comment 16

[Will Bamberg [:wbamberg]]

Updated doc (thanks ntim):

https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/theme/reset