Revision control
Copy as Markdown
Other Tools
/* 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
"use strict";
var { ExtensionTestUtils } = ChromeUtils.importESModule(
);
add_task(async function test_managers() {
const account = createAccount();
const folder = await createSubfolder(
account.incomingServer.rootFolder,
"test1"
);
await createMessages(folder, 5);
const files = {
"background.js": async () => {
const [testAccount] = await browser.accounts.list();
const testFolder = testAccount.folders.find(f => f.name == "test1");
const {
messages: [testMessage],
} = await browser.messages.list(testFolder.id);
const testFolderPrettyPath =
await browser.testapi.testCanGetFolder(testFolder);
browser.test.assertEq("test1", testFolderPrettyPath);
// Check that Foldermanager.get() (used by testapi.testCanGetFolder()) also
// works for unified mailbox folders.
const [unifiedInbox] = await browser.folders.query({
isUnified: true,
specialUse: ["inbox"],
});
browser.test.assertTrue(
!!unifiedInbox,
"Should find the unified inbox folder"
);
const inboxFolderPrettyPath =
await browser.testapi.testCanGetFolder(unifiedInbox);
browser.test.assertEq("Inbox", inboxFolderPrettyPath);
const convertedFolder = await browser.testapi.testCanConvertFolder();
browser.test.assertEq(testFolder.accountId, convertedFolder.accountId);
browser.test.assertEq(testFolder.path, convertedFolder.path);
const subject = await browser.testapi.testCanGetMessage(testMessage.id);
browser.test.assertEq(testMessage.subject, subject);
const convertedMessage = await browser.testapi.testCanConvertMessage();
browser.test.log(JSON.stringify(convertedMessage));
browser.test.assertEq(testMessage.id, convertedMessage.id);
browser.test.assertEq(testMessage.subject, convertedMessage.subject);
let messageList = await browser.testapi.testCanStartMessageList();
browser.test.assertEq(36, messageList.id.length);
browser.test.assertEq(4, messageList.messages.length);
browser.test.assertEq(
testMessage.subject,
messageList.messages[0].subject
);
messageList = await browser.messages.continueList(messageList.id);
browser.test.assertEq(null, messageList.id);
browser.test.assertEq(1, messageList.messages.length);
browser.test.assertTrue(
testMessage.subject != messageList.messages[0].subject
);
const [bookUID, contactUID, listUID] =
await window.sendMessage("get UIDs");
const [foundBook, foundContact, foundList] =
await browser.testapi.testCanFindAddressBookItems(
bookUID,
contactUID,
listUID
);
browser.test.assertEq("new book", foundBook.name);
browser.test.assertEq("new contact", foundContact.properties.DisplayName);
browser.test.assertEq("new list", foundList.name);
browser.test.notifyPass("finished");
},
};
const extension = ExtensionTestUtils.loadExtension({
files: {
...files,
"schema.json": [
{
namespace: "testapi",
functions: [
{
name: "testCanGetFolder",
type: "function",
async: true,
parameters: [
{
name: "folder",
$ref: "folders.MailFolder",
},
],
},
{
name: "testCanConvertFolder",
type: "function",
async: true,
parameters: [],
},
{
name: "testCanGetMessage",
type: "function",
async: true,
parameters: [
{
name: "messageId",
type: "integer",
},
],
},
{
name: "testCanConvertMessage",
type: "function",
async: true,
parameters: [],
},
{
name: "testCanStartMessageList",
type: "function",
async: true,
parameters: [],
},
{
name: "testCanFindAddressBookItems",
type: "function",
async: true,
parameters: [
{ name: "bookUID", type: "string" },
{ name: "contactUID", type: "string" },
{ name: "listUID", type: "string" },
],
},
],
},
],
"implementation.js": () => {
var { ExtensionCommon } = ChromeUtils.importESModule(
);
var { MailServices } = ChromeUtils.importESModule(
);
this.testapi = class extends ExtensionCommon.ExtensionAPI {
getAPI(context) {
return {
testapi: {
async testCanGetFolder({ accountId, path }) {
const realFolder = context.extension.folderManager.get(
accountId,
path
);
return realFolder.prettyPath;
},
async testCanConvertFolder() {
const realFolder = MailServices.accounts.allFolders.find(
f => f.name == "test1"
);
return context.extension.folderManager.convert(realFolder);
},
async testCanGetMessage(messageId) {
const realMessage =
context.extension.messageManager.get(messageId);
return realMessage.subject;
},
async testCanConvertMessage() {
const realFolder = MailServices.accounts.allFolders.find(
f => f.name == "test1"
);
const realMessage = [...realFolder.messages][0];
return context.extension.messageManager.convert(realMessage);
},
async testCanStartMessageList() {
const realFolder = MailServices.accounts.allFolders.find(
f => f.name == "test1"
);
return context.extension.messageManager.startMessageList(
realFolder.messages
);
},
async testCanFindAddressBookItems(
bookUID,
contactUID,
listUID
) {
const foundBook =
context.extension.addressBookManager.findAddressBookById(
bookUID
);
const foundContact =
context.extension.addressBookManager.findContactById(
contactUID
);
const foundList =
context.extension.addressBookManager.findMailingListById(
listUID
);
return [
await context.extension.addressBookManager.convert(
foundBook
),
await context.extension.addressBookManager.convert(
foundContact
),
await context.extension.addressBookManager.convert(
foundList
),
];
},
},
};
}
};
},
"utils.js": await getUtilsJS(),
},
manifest: {
background: { scripts: ["utils.js", "background.js"] },
permissions: ["accountsRead", "addressBooks", "messagesRead"],
experiment_apis: {
testapi: {
schema: "schema.json",
parent: {
scopes: ["addon_parent"],
paths: [["testapi"]],
script: "implementation.js",
},
},
},
},
});
const dirPrefId = MailServices.ab.newAddressBook(
"new book",
"",
Ci.nsIAbManager.JS_DIRECTORY_TYPE
);
const book = MailServices.ab.getDirectoryFromId(dirPrefId);
let contact = Cc["@mozilla.org/addressbook/cardproperty;1"].createInstance(
Ci.nsIAbCard
);
contact.displayName = "new contact";
contact.firstName = "new";
contact.lastName = "contact";
contact.primaryEmail = "new.contact@invalid";
contact = book.addCard(contact);
let list = Cc["@mozilla.org/addressbook/directoryproperty;1"].createInstance(
Ci.nsIAbDirectory
);
list.isMailList = true;
list.dirName = "new list";
list = book.addMailList(list);
list.addCard(contact);
Services.prefs.setIntPref("extensions.webextensions.messagesPerPage", 4);
await extension.startup();
await extension.awaitMessage("get UIDs");
extension.sendMessage(book.UID, contact.UID, list.UID);
await extension.awaitFinish("finished");
await extension.unload();
Services.prefs.clearUserPref("extensions.webextensions.messagesPerPage");
await new Promise(resolve => {
const observer = {
observe() {
Services.obs.removeObserver(observer, "addrbook-directory-deleted");
resolve();
},
};
Services.obs.addObserver(observer, "addrbook-directory-deleted");
MailServices.ab.deleteAddressBook(book.URI);
});
});
registerCleanupFunction(() => {
// Make sure any open database is given a chance to close.
Services.startup.advanceShutdownPhase(
Services.startup.SHUTDOWN_PHASE_APPSHUTDOWNCONFIRMED
);
});