summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/xpcshell/test_ext_storage_managed.js
blob: 5bf6dcc3bc30a541b9a510414d148ef8e3ca5b1b (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
"use strict";

ChromeUtils.defineESModuleGetters(this, {
  MockRegistry: "resource://testing-common/MockRegistry.sys.mjs",
});

const MANIFEST = {
  name: "test-storage-managed@mozilla.com",
  description: "",
  type: "storage",
  data: {
    null: null,
    str: "hello",
    obj: {
      a: [2, 3],
      b: true,
    },
  },
};

AddonTestUtils.init(this);

const server = createHttpServer({ hosts: ["example.com"] });
server.registerDirectory("/data/", do_get_file("data"));

add_task(async function setup() {
  await ExtensionTestUtils.startAddonManager();

  let tmpDir = FileUtils.getDir("TmpD", ["native-manifests"]);
  tmpDir.createUnique(Ci.nsIFile.DIRECTORY_TYPE, FileUtils.PERMS_DIRECTORY);

  let dirProvider = {
    getFile(property) {
      if (property.endsWith("NativeManifests")) {
        return tmpDir.clone();
      }
    },
  };
  Services.dirsvc.registerProvider(dirProvider);

  let typeSlug =
    AppConstants.platform === "linux" ? "managed-storage" : "ManagedStorage";
  await IOUtils.makeDirectory(PathUtils.join(tmpDir.path, typeSlug));

  let path = PathUtils.join(tmpDir.path, typeSlug, `${MANIFEST.name}.json`);
  await IOUtils.writeJSON(path, MANIFEST);

  let registry;
  if (AppConstants.platform === "win") {
    registry = new MockRegistry();
    registry.setValue(
      Ci.nsIWindowsRegKey.ROOT_KEY_CURRENT_USER,
      `Software\\\Mozilla\\\ManagedStorage\\${MANIFEST.name}`,
      "",
      path
    );
  }

  registerCleanupFunction(() => {
    Services.dirsvc.unregisterProvider(dirProvider);
    tmpDir.remove(true);
    if (registry) {
      registry.shutdown();
    }
  });
});

add_task(async function test_storage_managed() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: { gecko: { id: MANIFEST.name } },
      permissions: ["storage"],
    },

    async background() {
      await browser.test.assertRejects(
        browser.storage.managed.set({ a: 1 }),
        /storage.managed is read-only/,
        "browser.storage.managed.set() rejects because it's read only"
      );

      await browser.test.assertRejects(
        browser.storage.managed.remove("str"),
        /storage.managed is read-only/,
        "browser.storage.managed.remove() rejects because it's read only"
      );

      await browser.test.assertRejects(
        browser.storage.managed.clear(),
        /storage.managed is read-only/,
        "browser.storage.managed.clear() rejects because it's read only"
      );

      browser.test.sendMessage(
        "results",
        await Promise.all([
          browser.storage.managed.get(),
          browser.storage.managed.get("str"),
          browser.storage.managed.get(["null", "obj"]),
          browser.storage.managed.get({ str: "a", num: 2 }),
        ])
      );
    },
  });

  await extension.startup();
  deepEqual(await extension.awaitMessage("results"), [
    MANIFEST.data,
    { str: "hello" },
    { null: null, obj: MANIFEST.data.obj },
    { str: "hello", num: 2 },
  ]);
  await extension.unload();
});

add_task(async function test_storage_managed_from_content_script() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      browser_specific_settings: { gecko: { id: MANIFEST.name } },
      permissions: ["storage"],
      content_scripts: [
        {
          js: ["contentscript.js"],
          matches: ["*://*/*"],
          run_at: "document_end",
        },
      ],
    },

    files: {
      "contentscript.js": async function () {
        browser.test.sendMessage(
          "results",
          await browser.storage.managed.get()
        );
      },
    },
  });

  await extension.startup();
  let contentPage = await ExtensionTestUtils.loadContentPage(
    "http://example.com/data/file_sample.html"
  );
  deepEqual(await extension.awaitMessage("results"), MANIFEST.data);
  await contentPage.close();
  await extension.unload();
});

add_task(async function test_manifest_not_found() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      permissions: ["storage"],
    },

    async background() {
      await browser.test.assertRejects(
        browser.storage.managed.get({ a: 1 }),
        /Managed storage manifest not found/,
        "browser.storage.managed.get() rejects when without manifest"
      );

      browser.test.notifyPass();
    },
  });

  await extension.startup();
  await extension.awaitFinish();
  await extension.unload();
});

add_task(async function test_manifest_not_found() {
  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      permissions: ["storage"],
    },

    async background() {
      const dummyListener = () => {};
      browser.storage.managed.onChanged.addListener(dummyListener);
      browser.test.assertTrue(
        browser.storage.managed.onChanged.hasListener(dummyListener),
        "addListener works according to hasListener"
      );
      browser.storage.managed.onChanged.removeListener(dummyListener);

      // We should get a warning for each registration.
      browser.storage.managed.onChanged.addListener(() => {});
      browser.storage.managed.onChanged.addListener(() => {});
      browser.storage.managed.onChanged.addListener(() => {});

      // Invoke the storage.managed API to make sure that we have made a
      // round trip to the parent process and back. This is because event
      // registration is async but we cannot await (bug 1300234).
      await browser.test.assertRejects(
        browser.storage.managed.get({ a: 1 }),
        /Managed storage manifest not found/,
        "browser.storage.managed.get() rejects when without manifest"
      );

      browser.test.notifyPass();
    },
  });

  let { messages } = await promiseConsoleOutput(async () => {
    await extension.startup();
    await extension.awaitFinish();
    await extension.unload();
  });
  const UNSUP_EVENT_WARNING = `attempting to use listener "storage.managed.onChanged", which is unimplemented`;
  messages = messages.filter(msg => msg.message.includes(UNSUP_EVENT_WARNING));
  Assert.equal(messages.length, 4, "Expected msg for each addListener call");
});