1542023 - browser.theme.getCurrent() no longer returns empty object (`{}`) when default theme is enabled

Status: RESOLVED WONTFIX

(WebExtensions :: Themes, defect, P3)

Description

[Tim Nguyen :ntim]

Now returns:

{
  "colors": null,
  "icons": null,
  "images": null,
  "properties": null
}

instead.

Comment 1

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

The priority flag is not set for this bug.
:mikedeboer, could you have a look please?

For more information, please visit auto_nag documentation.

Comment 2

[ExE Boss]

I think browser.theme.getCurrent() should return the colours used by the default theme.

That way, it’d possible to write theme agnostic code without needing to hardcode Photon theme values.

Comment 3

[Tim Nguyen :ntim]

(In reply to ExE Boss from comment #2)

I think browser.theme.getCurrent() should return the colours used by the default theme.

That way, it’d possible to write theme agnostic code without needing to hardcode Photon theme values.

This bug is just about restoring the old behaviour to avoid breaking add-ons, returning default theme colors is a different bug.

Comment 4

[David Durst [:ddurst]]

This is a defect compared to what it used to do, but what it used to do was different based on what the built-ins were.

Now that they're static themes, we should revisit the question of what they should return. I assume that's the call of the Front-end team?

Comment 5

[Rob Wu [:robwu]]

I checked all public add-ons on AMO, and none of them rely on the existence of the key.

They typically check with if (theme.colors) { instead of something like if ("colors" in theme) {. Given that, and the absence of other bug reports, I'm going to:

• WONTFIX this bug.
• Update the documentation at https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/Theme/getCurrent
• Let the API deterministically return { colors: null, images: null, properties: null } by default (https://bugzilla.mozilla.org/show_bug.cgi?id=1581886#c11).

Comment 6

[Rob Wu [:robwu]]

Tim, does comment 5 sound like an acceptable approach?

Comment 7

[Tim Nguyen :ntim]

I guess the change in behaviour for theme.getCurrent() is fine if it doesn't break add-ons, but it'd be nice if we had a clear definition of the ideal behaviour that's not just a side effect of implementation.

Comment 8

[Rob Wu [:robwu]]

All tasks from comment 5 have been completed.