1928082 - Default theme keeps getting re-enabled since Firefox 132

Status: VERIFIED FIXED

(Toolkit :: Add-ons Manager, defect, P1)

Description

[Rob Wu [:robwu]]

A user reported that Firefox Color does not work, at https://old.reddit.com/r/firefox/comments/1geu6lg/firefox_1320_see_all_new_features_updates/luilmcx/ :

This new update broke Firefox Color somehow. My theme just isn't working at all, and I have to load it every time I open Firefox.

I can confirm some form of brokenness when I launch a new profile:

1. Start Firefox with a new profile.
2. Visit https://addons.mozilla.org/en-US/firefox/addon/firefox-color/ and install it.
3. Go to a preset theme and select any theme.
4. Quit Firefox and start it again.

Expected:

• The theme should still be applied.

Actual:

• The theme sometimes flickers at startup, and sometimes disappears altogether.

Additional information:

• The console displays "WARN addon with ID [e-mail] already installed, older version will be disabled" at every startup.
• The default theme is installed if needed at https://searchfox.org/mozilla-central/rev/5fdbe0d78d61581aa4b37ce82bbf31c2bd7826f1/toolkit/mozapps/extensions/internal/XPIProvider.sys.mjs#2536-2540
  • Currently the specified version there is 1.3
• The actual version is 1.4.1 (reported at about:addons) and specified at https://searchfox.org/mozilla-central/rev/5fdbe0d78d61581aa4b37ce82bbf31c2bd7826f1/toolkit/mozapps/extensions/default-theme/manifest.json#13
• This mismatch in version causes the default theme to be installed repeatedly.

The version was bumped from 1.3 to 1.4 in bug 1918317, and later to 1.4.1 in bug 1915862.

Comment 1

[Rob Wu [:robwu]]

I'm moving this to Toolkit::Add-ons Manager because the relevant (inconsistency) in version is in the XPIProvider.sys.mjs file.

Besides fixing the version, it may also be worth investigating whether we should update the implementation of ext-theme.js to avoid replacing the current theme when the default theme is updated. Otherwise the observation of this bug could still continue to happen at the first startup when a static theme is updated (whether built-in or third-party). This is the result of the implementation that immediately activates a static theme when it is installed.

Comment 2

[Rob Wu [:robwu]]

Attachment: Bug 1928082 - Specify correct version of default-theme

Comment 3

[Rob Wu [:robwu]]

The test coverage in bug 1922526 was not enough to prevent this regression from happening, so I added one that really verifies that the built-in theme version matches the call to AddonManager.maybeInstallBuiltinAddon.

Comment 4

[Luca Greco [:rpl] [:luca] [:lgreco]]

(In reply to Rob Wu [:robwu] from comment #3)

The test coverage in bug 1922526 was not enough to prevent this regression from happening, so I added one that really verifies that the built-in theme version matches the call to AddonManager.maybeInstallBuiltinAddon.

Definitely, The test from Bug 1922526 had nothing to do with this regression and clearly not expected to catch this one, we need a separate regression test for this issue (Bug 1922526 was specifically about BuiltInThemes calls to maybeInstallBuiltinAddon, while the issue here is about a call originated from inside the XPIProvider.startup).

Comment 6

[BugBot [:suhaib / :marco/ :calixte]]

The bug is marked as tracked for firefox132 (release), tracked for firefox133 (beta) and tracked for firefox134 (nightly). However, the bug still has low severity.

:mixedpuppy, could you please increase the severity for this tracked bug? If you disagree with the tracking decision, please talk with the release managers.

For more information, please visit BugBot documentation.

Comment 8

[Rob Wu [:robwu]]

Attachment: Bug 1928082 - Specify correct version of default-theme

Original Revision: https://phabricator.services.mozilla.com/D227363

Comment 9

[Rob Wu [:robwu]]

Attachment: Bug 1928082 - Specify correct version of default-theme

Original Revision: https://phabricator.services.mozilla.com/D227363

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/96a295779152
Specify correct version of default-theme r=rpl,willdurand

Comment 11

[Phabricator Automation]

beta Uplift Approval Request

• User impact if declined: User's preferred theme is often lost at browser startup.
• Code covered by automated testing: yes
• Fix verified in Nightly: no
• Needs manual QE test: no
• Steps to reproduce for manual QE testing: https://bugzilla.mozilla.org/show_bug.cgi?id=1928082#c0
• Risk associated with taking this patch: Low
• Explanation of risk level: One line change to make version number consisten + new unit tests
• String changes made/needed: None
• Is Android affected?: no

Comment 12

[Phabricator Automation]

release Uplift Approval Request

• User impact if declined: User's preferred theme is often lost at browser startup.
• Code covered by automated testing: yes
• Fix verified in Nightly: no
• Needs manual QE test: no
• Steps to reproduce for manual QE testing: https://bugzilla.mozilla.org/show_bug.cgi?id=1928082#c0
• Risk associated with taking this patch: Low
• Explanation of risk level: One line change to make version number consisten + new unit tests
• String changes made/needed: None
• Is Android affected?: no

Comment 13

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-beta/rev/444024a98a69

Comment 14

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/96a295779152

Comment 15

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-release/rev/05ae29c63b95

Comment 21

[Rob Wu [:robwu]]

(In reply to Rob Wu [:robwu] from comment #1)

Besides fixing the version, it may also be worth investigating whether we should update the implementation of ext-theme.js to avoid replacing the current theme when the default theme is updated. Otherwise the observation of this bug could still continue to happen at the first startup when a static theme is updated (whether built-in or third-party). This is the result of the implementation that immediately activates a static theme when it is installed.

I have filed bug 1928902 to track this suggestion.

Comment 22

[Alex Cornestean]

Verified as Fixed. Tested on the latest Nightly (134.0a1/20241103214544), Beta (133.0b3/20241101115900) and Release (132.0.1/20241101140617 from https://treeherder.mozilla.org/jobs?repo=mozilla-release&revision=05ae29c63b956658418a4fea78374b00121474ca) under Windows 10 and Ubuntu 22.04 LTS.

The themes from Firefox Color remain applied after closing and restarting the browser.