summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/mochitest/test_ext_browserSettings_overrideDocumentColors.html
blob: 64862163767eafbc7cb85891489fa32e13275d14 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!DOCTYPE HTML>
<html>
<head>
  <meta charset="utf-8">
  <title>browserSettings.overrideDocumentColors</title>
  <script type="text/javascript" src="/tests/SimpleTest/SimpleTest.js"></script>
  <script type="text/javascript" src="/tests/SimpleTest/ExtensionTestUtils.js"></script>
  <script type="text/javascript" src="head.js"></script>
  <link rel="stylesheet" type="text/css" href="/tests/SimpleTest/test.css">
</head>
<body>
<script>
"use strict";

add_setup(async () => {
  // Set some defaults to make it easier to test the baseline behavior.
  await SpecialPowers.pushPrefEnv({
    set: [
      ["browser.display.background_color", "#010203"], // rgb(1, 2, 3)
      ["browser.display.foreground_color", "#fefd00"], // rgb(254, 253, 00)
      ["browser.display.use_system_colors", false],
    ],
  });
});

async function with_overrideDocumentColors(value, callbackAfterOverride) {
  async function background(value) {
    await browser.browserSettings.overrideDocumentColors.set({ value });
    browser.test.sendMessage("settings_set");
  }
  let extension = ExtensionTestUtils.loadExtension({
    useAddonManager: "temporary",
    manifest: {
      permissions: ["browserSettings"],
    },
    background: `(${background})(${JSON.stringify(value)})`,
  });
  await extension.startup();
  await extension.awaitMessage("settings_set");

  await callbackAfterOverride();

  await extension.unload();
}

async function testGetExtensionColors({ useCssLayers, useImportant } = {}) {
  let extension = ExtensionTestUtils.loadExtension({
    useAddonManager: "temporary",
    manifest: {
      // Note: using manifest_version: 2, because browser_style has been dropped
      // from manifest_version: 3, which would result in all tests passing
      // trivially because MV3 does not have style overrides.
      browser_action: {
        default_popup: "test.html",
        browser_style: true,
      },
    },
    files: {
      "test.html": `<!DOCTYPE html>
        <style id="extStyle">
        ${useCssLayers ? "@layer {" : ""}
        body {
          background-color: rgb(12, 34, 56)${useImportant ? " !important": ""};
          color: rgb(98, 76, 54) ${useImportant ? " !important": ""};
        }
        ${useCssLayers ? "}" : ""}
        </style>
        <body><script src="test.js"><\/script>`,
      "test.js": () => {
        let {
          backgroundColor: bgColor,
          color: fgColor,
        } = window.getComputedStyle(document.body);

        document.getElementById("extStyle").disabled = true;

        let { color: defaultFgColor } = window.getComputedStyle(document.body);

        browser.test.sendMessage("test_result", {
          bgColor,
          fgColor,
          defaultFgColor,
        });
      },
    },
  });
  await extension.startup();
  await AppTestDelegate.clickBrowserAction(window, extension);
  let result = await extension.awaitMessage("test_result");
  await AppTestDelegate.closeBrowserAction(window, extension);
  await extension.unload();
  return result;
}

add_task(async function overrideDocumentColors_always() {
  let result;
  await with_overrideDocumentColors("always", async () => {
    result = await testGetExtensionColors();
  });
  // Note: these colors are from add_setup. The colors from test.html should
  // be ignored.
  is(result.bgColor, "rgb(1, 2, 3)", "Bg color from user");
  is(result.fgColor, "rgb(254, 253, 0)", "Fg color from user");
  is(result.defaultFgColor, "rgb(254, 253, 0)", "Default fg color from user");
});

add_task(async function overrideDocumentColors_never() {
  let result;
  await with_overrideDocumentColors("never", async () => {
    result = await testGetExtensionColors();
  });
  // Note: these colors are from test.html in testGetExtensionColors
  is(result.bgColor, "rgb(12, 34, 56)", "Bg color from extension");
  is(result.fgColor, "rgb(98, 76, 54)", "Fg color from extension");
  if (AppConstants.platform === "android") {
    is(
      result.defaultFgColor,
      "rgb(0, 0, 0)", // = default font color without extension.css
      "Default fg color is from the UA (extension.css unavailable)"
    );
  } else {
    is(
      result.defaultFgColor,
      "rgb(34, 36, 38)", // = "color: #222426;" from extension.css
      "Default fg color is from browser_style's extension.css"
    );
  }
});

add_task(async function with_css_cascade_layers() {
  if (AppConstants.platform === "android") {
    // extension.css does not exist on Android, so overrideDocumentColors_never
    // already covers this case.
    info("Skipping - already covered by overrideDocumentColors_never");
    return;
  }
  let result;
  await with_overrideDocumentColors("never", async () => {
    result = await testGetExtensionColors({ useCssLayers: true });
  });
  // Ideally, the results are equivalent to overrideDocumentColors_never,
  // because we tried really hard to ensure that extension.css has the least
  // precedence and CSS specificity. The implementation has one limitation:
  // Layered selectors from extension themselves are always lower precedence
  // than the browser_style stylesheet. This is not ideal but has minimal impact
  // due to the minimal use of @layer in the wild:
  // https://bugzilla.mozilla.org/show_bug.cgi?id=1873024#c4
  // Besides, the same observation is true in Chrome: @layer in extensions have
  // lower precedence than the chrome_style stylesheet.
  //
  // Extensions have the following work-arounds (covered by tests):
  // - Do not use @layer (overrideDocumentColors_never)
  // - Use !important (with_css_cascade_layers_and_important)
  // - disable browser_style (browser_ext_optionsPage_browser_style.js)
  is(
    result.fgColor,
    "rgb(34, 36, 38)", // = "color: #222426;" from extension.css
    "Fg color from extension.css takes precedence over @layer from extension"
  );
});

add_task(async function with_css_cascade_layers_and_important() {
  let result;
  await with_overrideDocumentColors("never", async () => {
    result = await testGetExtensionColors({
      useCssLayers: true,
      useImportant: true,
    });
  });
  is(result.fgColor, "rgb(98, 76, 54)", "important color from extension");
});

</script>
</body>
</html>