Source code
Revision control
Copy as Markdown
Other Tools
Test Info:
- Manifest: netwerk/dns/tests/unit/xpcshell.toml
/* Any copyright is dedicated to the Public Domain.
"use strict";
const { PublicSuffixList } = ChromeUtils.importESModule(
);
const { TestUtils } = ChromeUtils.importESModule(
);
const CLIENT = PublicSuffixList.CLIENT;
const SIGNAL = "public-suffix-list-updated";
const PAYLOAD_UPDATED_RECORDS = {
current: [{ id: "tld-dafsa", "commit-hash": "current-commit-hash" }],
created: [],
updated: [
{
old: { id: "tld-dafsa", "commit-hash": "current-commit-hash" },
new: { id: "tld-dafsa", "commit-hash": "new-commit-hash" },
},
],
deleted: [],
};
const PAYLOAD_CREATED_RECORDS = {
current: [],
created: [
{
id: "tld-dafsa",
"commit-hash": "new-commit-hash",
attachment: {},
},
],
updated: [],
deleted: [],
};
const PAYLOAD_UPDATED_AND_CREATED_RECORDS = {
current: [{ id: "tld-dafsa", "commit-hash": "current-commit-hash" }],
created: [{ id: "tld-dafsa", "commit-hash": "another-commit-hash" }],
updated: [
{
old: { id: "tld-dafsa", "commit-hash": "current-commit-hash" },
new: { id: "tld-dafsa", "commit-hash": "new-commit-hash" },
},
],
deleted: [],
};
const fakeDafsaBinFile = do_get_file("data/fake_remote_dafsa.bin");
const mockedFilePath = fakeDafsaBinFile.path;
function setup() {
Services.prefs.setBoolPref("network.psl.onUpdate_notify", true);
}
setup();
registerCleanupFunction(() => {
Services.prefs.clearUserPref("network.psl.onUpdate_notify");
});
/**
* downloadToDiskCalled is used by mockDownloadToDisk() and resetMockDownloadToDisk()
* to keep track weather CLIENT.attachments.download is called or not
* downloadToDiskBackup will help restore CLIENT.attachments.download to original definition
* notifyUpdateBackup will help restore PublicSuffixList.notifyUpdate to original definition
*/
let downloadToDiskCalled = false;
const downloadToDiskBackup = CLIENT.attachments.downloadToDisk;
// returns a fake fileURI and sends a signal with filePath and no nsifile
function mockDownloadToDisk() {
downloadToDiskCalled = false;
CLIENT.attachments.downloadToDisk = async () => {
downloadToDiskCalled = true;
};
}
// resetMockDownloadToDisk() must be run at the end of the test that uses mockDownloadToDisk()
const resetMockDownloadToDisk = () => {
CLIENT.attachments.downloadToDisk = downloadToDiskBackup;
};
add_task(async () => {
info("File path sent when record is in DB.");
await CLIENT.db.clear(); // Make sure there's no record initially
await CLIENT.db.create({
id: "tld-dafsa",
"commit-hash": "fake-commit-hash",
attachment: {},
});
mockDownloadToDisk();
const promiseSignal = TestUtils.topicObserved(SIGNAL);
await PublicSuffixList.init();
const observed = await promiseSignal;
Assert.equal(
observed[1],
mockedFilePath,
"File path sent when record is in DB."
);
await CLIENT.db.clear(); // Clean up the mockDownloaded record
resetMockDownloadToDisk();
});
add_task(async () => {
info("File path sent when record updated.");
mockDownloadToDisk();
const promiseSignal = TestUtils.topicObserved(SIGNAL);
await PublicSuffixList.init();
await CLIENT.emit("sync", { data: PAYLOAD_UPDATED_RECORDS });
const observed = await promiseSignal;
Assert.equal(
observed[1],
mockedFilePath,
"File path sent when record updated."
);
resetMockDownloadToDisk();
});
add_task(async () => {
info("Attachment downloaded when record created.");
mockDownloadToDisk();
await PublicSuffixList.init();
await CLIENT.emit("sync", { data: PAYLOAD_CREATED_RECORDS });
Assert.equal(
downloadToDiskCalled,
true,
"Attachment downloaded when record created."
);
resetMockDownloadToDisk();
});
add_task(async () => {
info("Attachment downloaded when record updated.");
mockDownloadToDisk();
await PublicSuffixList.init();
await CLIENT.emit("sync", { data: PAYLOAD_UPDATED_RECORDS });
Assert.equal(
downloadToDiskCalled,
true,
"Attachment downloaded when record updated."
);
resetMockDownloadToDisk();
});
add_task(async () => {
info("No download when more than one record is changed.");
mockDownloadToDisk();
await PublicSuffixList.init();
await CLIENT.emit("sync", { data: PAYLOAD_UPDATED_AND_CREATED_RECORDS });
Assert.equal(
downloadToDiskCalled,
false,
"No download when more than one record is changed."
);
resetMockDownloadToDisk();
});