summaryrefslogtreecommitdiffstats
path: root/comm/mail/components/extensions/test/xpcshell/test_ext_identities_mv3_event_pages.js
blob: 0b12f8ca1cb2923b376ca6b90acac02ae0e78360 (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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

var { ExtensionTestUtils } = ChromeUtils.importESModule(
  "resource://testing-common/ExtensionXPCShellUtils.sys.mjs"
);

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

ExtensionTestUtils.mockAppInfo();
AddonTestUtils.maybeInit(this);

add_task(async function test_identities_MV3_event_pages() {
  await AddonTestUtils.promiseStartupManager();

  let account1 = createAccount();
  addIdentity(account1, "id1@invalid");

  let files = {
    "background.js": async () => {
      // Whenever the extension starts or wakes up, hasFired is set to false. In
      // case of a wake-up, the first fired event is the one that woke up the background.
      let hasFired = false;

      for (let eventName of ["onCreated", "onUpdated", "onDeleted"]) {
        browser.identities[eventName].addListener((...args) => {
          // Only send the first event after background wake-up, this should be the
          // only one expected.
          if (!hasFired) {
            hasFired = true;
            browser.test.sendMessage(`${eventName} received`, args);
          }
        });
      }

      browser.test.sendMessage("background started");
    },
    "utils.js": await getUtilsJS(),
  };
  let extension = ExtensionTestUtils.loadExtension({
    files,
    manifest: {
      manifest_version: 3,
      background: { scripts: ["utils.js", "background.js"] },
      permissions: ["accountsRead", "accountsIdentities"],
      browser_specific_settings: { gecko: { id: "identities@xpcshell.test" } },
    },
  });

  function checkPersistentListeners({ primed }) {
    // A persistent event is referenced by its moduleName as defined in
    // ext-mails.json, not by its actual namespace.
    const persistent_events = [
      "identities.onCreated",
      "identities.onUpdated",
      "identities.onDeleted",
    ];

    for (let event of persistent_events) {
      let [moduleName, eventName] = event.split(".");
      assertPersistentListeners(extension, moduleName, eventName, {
        primed,
      });
    }
  }

  await extension.startup();

  await extension.awaitMessage("background started");
  // Verify persistent listener, not yet primed.
  checkPersistentListeners({ primed: false });
  await extension.terminateBackground({ disableResetIdleForTest: true });
  // Verify the primed persistent listeners.
  checkPersistentListeners({ primed: true });

  // Create.

  let id2 = addIdentity(account1, "id2@invalid");
  let createData = await extension.awaitMessage("onCreated received");
  Assert.deepEqual(
    [
      "id2",
      {
        accountId: "account1",
        id: "id2",
        label: "",
        name: "",
        email: "id2@invalid",
        replyTo: "",
        organization: "",
        composeHtml: true,
        signature: "",
        signatureIsPlainText: true,
      },
    ],
    createData,
    "The primed onCreated event should return the correct values"
  );

  await extension.awaitMessage("background started");
  // Verify persistent listener, not yet primed.
  checkPersistentListeners({ primed: false });
  await extension.terminateBackground({ disableResetIdleForTest: true });
  // Verify the primed persistent listeners.
  checkPersistentListeners({ primed: true });

  // Update

  id2.fullName = "Updated Name";
  let updateData = await extension.awaitMessage("onUpdated received");
  Assert.deepEqual(
    ["id2", { name: "Updated Name", accountId: "account1", id: "id2" }],
    updateData,
    "The primed onUpdated event should return the correct values"
  );
  await extension.awaitMessage("background started");
  // Verify persistent listener, not yet primed.
  checkPersistentListeners({ primed: false });
  await extension.terminateBackground({ disableResetIdleForTest: true });
  // Verify the primed persistent listeners.
  checkPersistentListeners({ primed: true });

  // Delete

  account1.removeIdentity(id2);
  let deleteData = await extension.awaitMessage("onDeleted received");
  Assert.deepEqual(
    ["id2"],
    deleteData,
    "The primed onDeleted event should return the correct values"
  );
  // The background should have been restarted.
  await extension.awaitMessage("background started");
  // The listener should no longer be primed.
  checkPersistentListeners({ primed: false });

  await extension.unload();

  cleanUpAccount(account1);
  await AddonTestUtils.promiseShutdownManager();
});