summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/xpcshell/test_ext_startup_cache.js
blob: ac815d6010c3a6490967429d7ee63d0cba115d63 (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
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";

const { AddonManager } = ChromeUtils.importESModule(
  "resource://gre/modules/AddonManager.sys.mjs"
);
const { Preferences } = ChromeUtils.importESModule(
  "resource://gre/modules/Preferences.sys.mjs"
);

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

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

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

const ADDON_ID = "test-startup-cache@xpcshell.mozilla.org";

function makeExtension(opts) {
  return {
    useAddonManager: "permanent",

    manifest: {
      version: opts.version,
      browser_specific_settings: { gecko: { id: ADDON_ID } },

      name: "__MSG_name__",

      default_locale: "en_US",
    },

    files: {
      "_locales/en_US/messages.json": {
        name: {
          message: `en-US ${opts.version}`,
          description: "Name.",
        },
      },
      "_locales/fr/messages.json": {
        name: {
          message: `fr ${opts.version}`,
          description: "Name.",
        },
      },
    },

    background() {
      browser.test.onMessage.addListener(msg => {
        if (msg === "get-manifest") {
          browser.test.sendMessage("manifest", browser.runtime.getManifest());
        }
      });
    },
  };
}

add_task(async function test_langpack_startup_cache() {
  Preferences.set("extensions.logging.enabled", false);
  await AddonTestUtils.promiseStartupManager();

  // Install langpacks to get proper locale startup.
  let langpack = {
    "manifest.json": {
      name: "test Language Pack",
      version: "1.0",
      manifest_version: 2,
      browser_specific_settings: {
        gecko: {
          id: "@test-langpack",
          strict_min_version: "42.0",
          strict_max_version: "42.0",
        },
      },
      langpack_id: "fr",
      languages: {
        fr: {
          chrome_resources: {
            global: "chrome/fr/locale/fr/global/",
          },
          version: "20171001190118",
        },
      },
      sources: {
        browser: {
          base_path: "browser/",
        },
      },
    },
  };

  let [, { addon }] = await Promise.all([
    TestUtils.topicObserved("webextension-langpack-startup"),
    AddonTestUtils.promiseInstallXPI(langpack),
  ]);

  let extension = ExtensionTestUtils.loadExtension(
    makeExtension({ version: "1.0" })
  );

  function getManifest() {
    extension.sendMessage("get-manifest");
    return extension.awaitMessage("manifest");
  }

  // At the moment extension language negotiation is tied to Firefox language
  // negotiation result. That means that to test an extension in `fr`, we need
  // to mock `fr` being available in Firefox and then request it.
  //
  // In the future, we should provide some way for tests to decouple their
  // language selection from that of Firefox.
  ok(Services.locale.availableLocales.includes("fr"), "fr locale is avialable");

  await extension.startup();

  equal(extension.version, "1.0", "Expected extension version");
  let manifest = await getManifest();
  equal(manifest.name, "en-US 1.0", "Got expected manifest name");

  info("Restart and re-check");
  await AddonTestUtils.promiseRestartManager();
  await extension.awaitBackgroundStarted();

  equal(extension.version, "1.0", "Expected extension version");
  manifest = await getManifest();
  equal(manifest.name, "en-US 1.0", "Got expected manifest name");

  info("Change locale to 'fr' and restart");
  Services.locale.requestedLocales = ["fr"];
  await AddonTestUtils.promiseRestartManager();
  await extension.awaitBackgroundStarted();

  equal(extension.version, "1.0", "Expected extension version");
  manifest = await getManifest();
  equal(manifest.name, "fr 1.0", "Got expected manifest name");

  info("Update to version 1.1");
  await extension.upgrade(makeExtension({ version: "1.1" }));

  equal(extension.version, "1.1", "Expected extension version");
  manifest = await getManifest();
  equal(manifest.name, "fr 1.1", "Got expected manifest name");

  info("Change locale to 'en-US' and restart");
  Services.locale.requestedLocales = ["en-US"];
  await AddonTestUtils.promiseRestartManager();
  await extension.awaitBackgroundStarted();

  equal(extension.version, "1.1", "Expected extension version");
  manifest = await getManifest();
  equal(manifest.name, "en-US 1.1", "Got expected manifest name");

  info("Disable locale 'fr'");
  addon = await AddonManager.getAddonByID("@test-langpack");

  // We disable the installed langpack instead of uninstalling it
  // because the xpi file may technically be still in use by the
  // time the XPIProvider will try to remove the file and will
  // make this test to fail intermittently on windows.
  //
  // Disabling the addon is equivalent from the perspective of this
  // test case, and the langpack xpi will be uninstalled automatically
  // at the end of this test case by AddonTestUtils (from its
  // cleanupTempXPIs method, which will also force a GC if the
  // file fails to be removed after we flushed the jar cache).
  await addon.disable();
  ok(!Services.locale.availableLocales.includes("fr"), "fr locale is removed");

  await extension.unload();
});