summaryrefslogtreecommitdiffstats
path: root/browser/components/extensions/test/xpcshell/test_ext_chrome_settings_overrides_home.js
blob: 24ee403cb6db9dc8d4b05d92ac7903a897f6decf (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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";

const { AddonTestUtils } = ChromeUtils.importESModule(
  "resource://testing-common/AddonTestUtils.sys.mjs"
);

ChromeUtils.defineESModuleGetters(this, {
  RemoteSettings: "resource://services-settings/remote-settings.sys.mjs",
  TelemetryTestUtils: "resource://testing-common/TelemetryTestUtils.sys.mjs",
  sinon: "resource://testing-common/Sinon.sys.mjs",
});

XPCOMUtils.defineLazyModuleGetters(this, {
  HomePage: "resource:///modules/HomePage.jsm",
});

function promisePrefChanged(expectedValue) {
  return TestUtils.waitForPrefChange("browser.startup.homepage", value =>
    value.endsWith(expectedValue)
  );
}

const HOMEPAGE_EXTENSION_CONTROLLED =
  "browser.startup.homepage_override.extensionControlled";

AddonTestUtils.init(this);
AddonTestUtils.overrideCertDB();

AddonTestUtils.createAppInfo(
  "xpcshell@tests.mozilla.org",
  "XPCShell",
  "1",
  "42"
);

async function setupRemoteSettings() {
  const settings = await RemoteSettings("hijack-blocklists");
  sinon.stub(settings, "get").returns([
    {
      id: "homepage-urls",
      matches: ["ignore=me"],
      _status: "synced",
    },
  ]);
}

add_task(async function setup() {
  await AddonTestUtils.promiseStartupManager();
  await setupRemoteSettings();
});

add_task(async function test_overriding_with_ignored_url() {
  // Manually poke into the ignore list a value to be ignored.
  HomePage._ignoreList.push("ignore=me");
  Services.prefs.setBoolPref(HOMEPAGE_EXTENSION_CONTROLLED, false);

  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: {
        gecko: {
          id: "ignore_homepage@example.com",
        },
      },
      chrome_settings_overrides: { homepage: "https://example.com/?ignore=me" },
      name: "extension",
    },
    useAddonManager: "temporary",
  });

  await extension.startup();

  Assert.ok(HomePage.isDefault, "Should still have the default homepage");
  Assert.equal(
    Services.prefs.getBoolPref(
      "browser.startup.homepage_override.extensionControlled"
    ),
    false,
    "Should not be extension controlled."
  );
  TelemetryTestUtils.assertEvents(
    [
      {
        object: "ignore",
        value: "set_blocked_extension",
        extra: { webExtensionId: "ignore_homepage@example.com" },
      },
    ],
    {
      category: "homepage",
      method: "preference",
    }
  );

  await extension.unload();
  HomePage._ignoreList.pop();
});

add_task(async function test_overriding_cancelled_after_ignore_update() {
  const oldHomePageIgnoreList = HomePage._ignoreList;
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: {
        gecko: {
          id: "ignore_homepage1@example.com",
        },
      },
      chrome_settings_overrides: {
        homepage: "https://example.com/?ignore1=me",
      },
      name: "extension",
    },
    useAddonManager: "temporary",
  });

  await extension.startup();

  Assert.ok(!HomePage.isDefault, "Should have overriden the new homepage");
  Assert.equal(
    Services.prefs.getBoolPref(
      "browser.startup.homepage_override.extensionControlled"
    ),
    true,
    "Should be extension controlled."
  );

  let prefChanged = TestUtils.waitForPrefChange(
    "browser.startup.homepage_override.extensionControlled"
  );

  await HomePage._handleIgnoreListUpdated({
    data: {
      current: [{ id: "homepage-urls", matches: ["ignore1=me"] }],
    },
  });

  await prefChanged;

  await TestUtils.waitForCondition(
    () =>
      !Services.prefs.getBoolPref(
        "browser.startup.homepage_override.extensionControlled",
        false
      ),
    "Should not longer be extension controlled"
  );

  Assert.ok(HomePage.isDefault, "Should have reset the homepage");

  TelemetryTestUtils.assertEvents(
    [
      {
        object: "ignore",
        value: "saved_reset",
      },
    ],
    {
      category: "homepage",
      method: "preference",
    }
  );

  await extension.unload();
  HomePage._ignoreList = oldHomePageIgnoreList;
});

add_task(async function test_overriding_homepage_locale() {
  Services.locale.availableLocales = ["en-US", "es-ES"];

  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: {
        gecko: {
          id: "homepage@example.com",
        },
      },
      chrome_settings_overrides: {
        homepage: "/__MSG_homepage__",
      },
      name: "extension",
      default_locale: "en",
    },
    useAddonManager: "permanent",

    files: {
      "_locales/en/messages.json": {
        homepage: {
          message: "homepage.html",
          description: "homepage",
        },
      },

      "_locales/es_ES/messages.json": {
        homepage: {
          message: "default.html",
          description: "homepage",
        },
      },
    },
  });

  let prefPromise = promisePrefChanged("homepage.html");
  await extension.startup();
  await prefPromise;

  Assert.equal(
    HomePage.get(),
    `moz-extension://${extension.uuid}/homepage.html`,
    "Should have overridden the new homepage"
  );

  // Set the new locale now, and disable the L10nRegistry reset
  // when shutting down the addon mananger.  This allows us to
  // restart under a new locale without a lot of fuss.
  let reqLoc = Services.locale.requestedLocales;
  Services.locale.requestedLocales = ["es-ES"];

  prefPromise = promisePrefChanged("default.html");
  await AddonTestUtils.promiseShutdownManager({ clearL10nRegistry: false });
  await AddonTestUtils.promiseStartupManager();
  await extension.awaitStartup();
  await prefPromise;

  Assert.equal(
    HomePage.get(),
    `moz-extension://${extension.uuid}/default.html`,
    "Should have overridden the new homepage"
  );

  await extension.unload();

  Services.locale.requestedLocales = reqLoc;
});