mozilla-central/toolkit/components/places/tests/favicons/test_setFaviconForPage.js (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Warnings

/* Any copyright is dedicated to the Public Domain.
/*
* Tests for setFaviconForPage()
*/
add_task(async function test_validHistoryURI() {
let pageURI = uri("http://test1.bar/");
await PlacesTestUtils.addVisits(pageURI);
let favicon = await createFavicon("favicon1.png");
await doTestSetFaviconForPage({
pageURI,
faviconURI: favicon.uri,
dataURL: await createDataURLForFavicon(favicon),
expectedFaviconData: favicon.data,
expectedFaviconMimeType: favicon.mimeType,
});
await IOUtils.remove(favicon.file.path);
await PlacesUtils.history.clear();
});
add_task(async function test_overrideDefaultFavicon() {
let pageURI = uri("http://test2.bar/");
await PlacesTestUtils.addVisits(pageURI);
let firstFavicon = await createFavicon("favicon2.png");
let secondFavicon = await createFavicon("favicon3.png");
await doTestSetFaviconForPage({
pageURI,
faviconURI: firstFavicon.uri,
dataURL: await createDataURLForFavicon(secondFavicon),
expectedFaviconData: secondFavicon.data,
expectedFaviconMimeType: secondFavicon.mimeType,
});
await IOUtils.remove(firstFavicon.file.path);
await IOUtils.remove(secondFavicon.file.path);
await PlacesUtils.history.clear();
});
add_task(async function test_replaceExisting() {
let pageURI = uri("http://test3.bar");
await PlacesTestUtils.addVisits(pageURI);
let firstFavicon = await createFavicon("favicon4.png");
let secondFavicon = await createFavicon("favicon5.png");
let firstFaviconDataURL = await createDataURLForFavicon(firstFavicon);
await PlacesTestUtils.setFaviconForPage(
pageURI,
firstFavicon.uri,
firstFaviconDataURL
);
await new Promise(resolve => {
PlacesUtils.favicons.getFaviconDataForPage(
pageURI,
function (aURI, aDataLen, aData, aMimeType) {
Assert.equal(aMimeType, firstFavicon.mimeType);
Assert.ok(compareArrays(aData, firstFavicon.data));
checkFaviconDataForPage(
pageURI,
firstFavicon.mimeType,
firstFavicon.data,
resolve
);
}
);
});
await doTestSetFaviconForPage({
pageURI,
faviconURI: firstFavicon.uri,
dataURL: await createDataURLForFavicon(secondFavicon),
expectedFaviconData: secondFavicon.data,
expectedFaviconMimeType: secondFavicon.mimeType,
});
await IOUtils.remove(firstFavicon.file.path);
await IOUtils.remove(secondFavicon.file.path);
await PlacesUtils.history.clear();
});
add_task(async function test_twiceReplace() {
let pageURI = uri("http://test5.bar/");
await PlacesTestUtils.addVisits(pageURI);
let firstFavicon = await createFavicon("favicon9.png");
let secondFavicon = await createFavicon("favicon10.png");
let firstFaviconDataURL = await createDataURLForFavicon(firstFavicon);
await PlacesUtils.favicons.setFaviconForPage(
pageURI,
firstFavicon.uri,
firstFaviconDataURL
);
await doTestSetFaviconForPage({
pageURI,
faviconURI: firstFavicon.uri,
dataURL: await createDataURLForFavicon(secondFavicon),
expectedFaviconData: secondFavicon.data,
expectedFaviconMimeType: secondFavicon.mimeType,
});
await IOUtils.remove(firstFavicon.file.path);
await IOUtils.remove(secondFavicon.file.path);
await PlacesUtils.history.clear();
});
add_task(async function test_userpass() {
let pageURI = uri("http://user:pass@test1.bar/");
await PlacesTestUtils.addVisits(pageURI);
let favicon = await createFavicon("favicon1.png");
let faviconURI = uri("http://user:pass@test1.bar/favicon1.png");
await doTestSetFaviconForPage({
pageURI,
faviconURI,
dataURL: await createDataURLForFavicon(favicon),
expectedFaviconData: favicon.data,
expectedFaviconMimeType: favicon.mimeType,
});
await IOUtils.remove(favicon.file.path);
await PlacesUtils.history.clear();
});
add_task(async function test_svg() {
let pageURI = uri("http://example.com/");
await PlacesTestUtils.addVisits(pageURI);
const svgContent = "<svg><rect width='1px' height='1px'/></svg>";
await doTestSetFaviconForPage({
pageURI,
faviconURI: uri("http://example.com/favicon.svg"),
dataURL: uri(`data:image/svg+xml;utf8,${svgContent}`),
expectedFaviconData: Array.from(new TextEncoder().encode(svgContent)),
expectedFaviconMimeType: "image/svg+xml",
});
await PlacesUtils.history.clear();
});
add_task(async function test_invalidPageURI() {
await PlacesTestUtils.addVisits(uri("http://example.com/"));
let favicon = await createFavicon("favicon-invalidPageURI.png");
const TEST_DATA = [
{
pageURI: null,
expected: "NS_ERROR_ILLEGAL_VALUE",
},
{
pageURI: "",
expected: "NS_ERROR_XPC_BAD_CONVERT_JS",
},
{
pageURI: "http://example.com",
expected: "NS_ERROR_XPC_BAD_CONVERT_JS",
},
];
for (let { pageURI, expected } of TEST_DATA) {
try {
info(`Invalid page URI test for [${pageURI}]`);
await PlacesUtils.favicons.setFaviconForPage(
pageURI,
favicon.uri,
await createDataURLForFavicon(favicon)
);
Assert.ok(false, "Error should happened");
} catch (e) {
Assert.equal(
e.name,
expected,
`Expected error happened for [${pageURI}]`
);
}
}
});
add_task(async function test_invalidFaviconURI() {
let pageURI = uri("http://example.com/");
await PlacesTestUtils.addVisits(pageURI);
let favicon = await createFavicon("favicon-invalidFaviconURI.png");
const TEST_DATA = [
{
faviconURI: null,
expected: "NS_ERROR_ILLEGAL_VALUE",
},
{
faviconURI: "",
expected: "NS_ERROR_XPC_BAD_CONVERT_JS",
},
{
faviconURI: "favicon.uri.spec",
expected: "NS_ERROR_XPC_BAD_CONVERT_JS",
},
];
for (let { faviconURI, expected } of TEST_DATA) {
try {
info(`Invalid favicon URI test for [${faviconURI}]`);
await PlacesUtils.favicons.setFaviconForPage(
pageURI,
faviconURI,
await createDataURLForFavicon(favicon)
);
Assert.ok(false, "Error should happened");
} catch (e) {
Assert.equal(
e.name,
expected,
`Expected error happened for [${faviconURI}]`
);
}
}
});
add_task(async function test_invalidFaviconDataURI() {
let pageURI = uri("http://example.com/");
await PlacesTestUtils.addVisits(pageURI);
let faviconURI = uri("http://example.com/favicon.svg");
const TEST_DATA = [
{
faviconDataURI: null,
expected: "NS_ERROR_ILLEGAL_VALUE",
},
{
faviconDataURI: "",
expected: "NS_ERROR_XPC_BAD_CONVERT_JS",
},
{
faviconDataURI: "data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==",
expected: "NS_ERROR_XPC_BAD_CONVERT_JS",
},
{
// nsIFaviconService::MAX_FAVICON_BUFFER_SIZE = 65536
faviconDataURI: uri(
`data:image/svg+xml;utf8,<svg><text>${Array(65536)}</text></svg>`
),
expected: "NS_ERROR_FILE_TOO_BIG",
},
];
for (let { faviconDataURI, expected } of TEST_DATA) {
try {
info(`Invalid favicon data URI test for [${faviconDataURI}]`);
await PlacesUtils.favicons.setFaviconForPage(
pageURI,
faviconURI,
faviconDataURI
);
Assert.ok(false, "Error should happened");
} catch (e) {
Assert.equal(
e.name,
expected,
`Expected error happened for [${faviconDataURI}]`
);
}
}
});
// Error handled by this test will fire from AsyncSetIconForPage Runnable.
add_task(async function test_noVisitData() {
let pageURI = uri("http://test1.bar/");
let favicon = await createFavicon("favicon1.png");
try {
await PlacesUtils.favicons.setFaviconForPage(
pageURI,
favicon.uri,
await createDataURLForFavicon(favicon)
);
Assert.ok(false, "Error should happened");
} catch (e) {
Assert.equal(e.name, "NS_ERROR_NOT_AVAILABLE", "Expected error happened");
}
await IOUtils.remove(favicon.file.path);
await PlacesUtils.history.clear();
});
add_task(async function test_sameHostRedirect() {
// Add a bookmarked page that redirects to another page, set a favicon on the
// latter and check the former gets it too, if they are in the same host.
let srcUrl = "http://bookmarked.com/";
await PlacesTestUtils.addVisits([
{ uri: srcUrl, transition: TRANSITION_LINK },
{
uri: destUrl,
transition: TRANSITION_REDIRECT_TEMPORARY,
referrer: srcUrl,
},
]);
await PlacesUtils.bookmarks.insert({
parentGuid: PlacesUtils.bookmarks.unfiledGuid,
url: srcUrl,
});
let promise = PlacesTestUtils.waitForNotification("favicon-changed", events =>
events.some(e => e.url == srcUrl && e.faviconUrl == SMALLPNG_DATA_URI.spec)
);
await PlacesUtils.favicons.setFaviconForPage(
Services.io.newURI(destUrl),
SMALLPNG_DATA_URI,
SMALLPNG_DATA_URI
);
await promise;
// The favicon should be set also on the bookmarked url that redirected.
let { dataLen } = await PlacesUtils.promiseFaviconData(srcUrl);
Assert.equal(dataLen, SMALLPNG_DATA_LEN, "Check favicon dataLen");
await PlacesUtils.bookmarks.eraseEverything();
await PlacesUtils.history.clear();
});
add_task(async function test_otherHostRedirect() {
// Add a bookmarked page that redirects to another page, set a favicon on the
// latter and check the former gets it too, if they are in the same host.
let srcUrl = "http://first.com/";
let destUrl = "https://notfirst.com/";
await PlacesTestUtils.addVisits([
{ uri: srcUrl, transition: TRANSITION_LINK },
{
uri: destUrl,
transition: TRANSITION_REDIRECT_TEMPORARY,
referrer: srcUrl,
},
]);
await PlacesUtils.bookmarks.insert({
parentGuid: PlacesUtils.bookmarks.unfiledGuid,
url: srcUrl,
});
let promise = Promise.race([
PlacesTestUtils.waitForNotification("favicon-changed", events =>
events.some(
e => e.url == srcUrl && e.faviconUrl == SMALLPNG_DATA_URI.spec
)
),
new Promise((resolve, reject) =>
do_timeout(300, () => reject(new Error("timeout")))
),
]);
PlacesUtils.favicons.setFaviconForPage(
Services.io.newURI(destUrl),
SMALLPNG_DATA_URI,
SMALLPNG_DATA_URI
);
await Assert.rejects(promise, /timeout/);
});
async function doTestSetFaviconForPage({
pageURI,
faviconURI,
dataURL,
expectedFaviconData,
expectedFaviconMimeType,
}) {
let result = await PlacesUtils.favicons.setFaviconForPage(
pageURI,
faviconURI,
dataURL
);
info("Check the result of setFaviconForPage");
Assert.equal(result, null, "If succeeded, the promise has no data");
await new Promise(resolve => {
checkFaviconDataForPage(
pageURI,
expectedFaviconMimeType,
expectedFaviconData,
resolve
);
});
}
add_task(async function test_incorrectMimeTypeDataURI() {
let pageURI = uri("http://example.com/");
await PlacesTestUtils.addVisits(pageURI);
const svgContent = "<svg><rect width='1px' height='1px'/></svg>";
await doTestSetFaviconForPage({
pageURI,
faviconURI: uri("http://example.com/favicon.svg"),
dataURL: uri(`data:image/png;utf8,${svgContent}`),
expectedFaviconData: Array.from(new TextEncoder().encode(svgContent)),
expectedFaviconMimeType: "image/svg+xml",
});
await PlacesUtils.history.clear();
});
add_task(async function test_pageURIProtocols() {
let favicon = await createFavicon("favicon.png");
let invalidPageURIs = [
];
let validPageURIs = [
];
for (let pageURI of invalidPageURIs) {
await PlacesTestUtils.addBookmarkWithDetails({ uri: pageURI });
try {
await PlacesUtils.favicons.setFaviconForPage(
uri(pageURI),
favicon.uri,
await createDataURLForFavicon(favicon)
);
Assert.ok(false, "Error should occur");
} catch (e) {
Assert.ok(true, `Expected error [${e.message}]`);
}
await PlacesUtils.bookmarks.eraseEverything();
}
for (let pageURI of validPageURIs) {
await PlacesTestUtils.addBookmarkWithDetails({ uri: pageURI });
try {
await PlacesUtils.favicons.setFaviconForPage(
uri(pageURI),
favicon.uri,
await createDataURLForFavicon(favicon)
);
Assert.ok(true, "Favicon should be set for page");
} catch (e) {
Assert.ok(false, `Unexpected error [${e.message}]`);
}
await PlacesUtils.bookmarks.eraseEverything();
}
});