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
|
/* 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/. */
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);
registerCleanupFunction(async () => {
// Remove the temporary MozillaMailnews folder, which is not deleted in time when
// the cleanupFunction registered by AddonTestUtils.maybeInit() checks for left over
// files in the temp folder.
// Note: PathUtils.tempDir points to the system temp folder, which is different.
let path = PathUtils.join(
Services.dirsvc.get("TmpD", Ci.nsIFile).path,
"MozillaMailnews"
);
await IOUtils.remove(path, { recursive: true });
});
// Function to start an event page extension (MV3), which can be called whenever
// the main test is about to trigger an event. The extension terminates its
// background and listens for that single event, verifying it is waking up correctly.
async function event_page_extension(eventName, actionCallback) {
let ext = ExtensionTestUtils.loadExtension({
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;
let _eventName = browser.runtime.getManifest().description;
browser.messages[_eventName].addListener(async (...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");
},
},
manifest: {
manifest_version: 3,
description: eventName,
background: { scripts: ["background.js"] },
browser_specific_settings: {
gecko: { id: "event_page_extension@mochi.test" },
},
permissions: ["accountsRead", "messagesRead", "messagesMove"],
},
});
await ext.startup();
await ext.awaitMessage("background started");
// The listener should be persistent, but not primed.
assertPersistentListeners(ext, "messages", eventName, { primed: false });
await ext.terminateBackground({ disableResetIdleForTest: true });
// Verify the primed persistent listener.
assertPersistentListeners(ext, "messages", eventName, { primed: true });
await actionCallback();
let rv = await ext.awaitMessage(`${eventName} received`);
await ext.awaitMessage("background started");
// The listener should be persistent, but not primed.
assertPersistentListeners(ext, "messages", eventName, { primed: false });
await ext.unload();
return rv;
}
add_task(async function () {
await AddonTestUtils.promiseStartupManager();
let account = createAccount();
let inbox = await createSubfolder(account.incomingServer.rootFolder, "test1");
let files = {
"background.js": async () => {
browser.messages.onNewMailReceived.addListener((folder, messageList) => {
window.assertDeepEqual(
{ accountId: "account1", name: "test1", path: "/test1" },
folder
);
browser.test.sendMessage("onNewMailReceived event received", [
folder,
messageList,
]);
});
},
"utils.js": await getUtilsJS(),
};
let extension = ExtensionTestUtils.loadExtension({
files,
manifest: {
background: { scripts: ["utils.js", "background.js"] },
permissions: ["accountsRead", "messagesRead"],
},
});
await extension.startup();
// Create a new message.
await createMessages(inbox, 1);
inbox.hasNewMessages = true;
inbox.setNumNewMessages(1);
inbox.biffState = Ci.nsIMsgFolder.nsMsgBiffState_NewMail;
let inboxMessages = [...inbox.messages];
let newMessages = await extension.awaitMessage(
"onNewMailReceived event received"
);
equal(newMessages[1].messages.length, 1);
equal(newMessages[1].messages[0].subject, inboxMessages[0].subject);
// Create 2 more new messages.
let primedOnNewMailReceivedEventData = await event_page_extension(
"onNewMailReceived",
async () => {
await createMessages(inbox, 2);
inbox.hasNewMessages = true;
inbox.setNumNewMessages(2);
inbox.biffState = Ci.nsIMsgFolder.nsMsgBiffState_NewMail;
}
);
inboxMessages = [...inbox.messages];
newMessages = await extension.awaitMessage(
"onNewMailReceived event received"
);
Assert.deepEqual(
primedOnNewMailReceivedEventData,
newMessages,
"The primed and non-primed onNewMailReceived events should return the same values"
);
equal(newMessages[1].messages.length, 2);
equal(newMessages[1].messages[0].subject, inboxMessages[1].subject);
equal(newMessages[1].messages[1].subject, inboxMessages[2].subject);
await extension.unload();
cleanUpAccount(account);
await AddonTestUtils.promiseShutdownManager();
});
|
