Source code
Revision control
Copy as Markdown
Other Tools
Test Info:
/* Any copyright is dedicated to the Public Domain.
// Makes sure the moz_origins table and origin frecency stats are updated
// correctly.
"use strict";
// Visiting a URL with a new origin should immediately update moz_origins.
add_task(async function visit() {
await checkDB([]);
await checkDB([]);
await cleanUp();
});
// Repeatedly visiting a URL with an initially new origin should update
// moz_origins (with the correct frecency).
add_task(async function visitRepeatedly() {
await PlacesTestUtils.addVisits([
]);
await checkDB([]);
await cleanUp();
});
// Same as previous, but visits are added sequentially.
add_task(async function visitRepeatedlySequential() {
await checkDB([]);
await cleanUp();
});
// After removing an origin's URLs, visiting a URL with the origin should
// immediately update moz_origins.
add_task(async function vistAfterDelete() {
await checkDB([]);
await checkDB([]);
await cleanUp();
});
// Visiting different URLs with the same origin should update moz_origins, and
// moz_origins.frecency should be the sum of the URL frecencies.
add_task(async function visitDifferentURLsSameOrigin() {
await PlacesTestUtils.addVisits([
]);
await checkDB([
[
"http://",
"example.com",
],
]);
await checkDB([
[
"http://",
"example.com",
],
]);
await checkDB([]);
await cleanUp();
});
// Same as previous, but visits are added sequentially.
add_task(async function visitDifferentURLsSameOriginSequential() {
await checkDB([
[
"http://",
"example.com",
],
]);
await checkDB([
[
"http://",
"example.com",
],
]);
await checkDB([
[
"http://",
"example.com",
],
]);
await checkDB([]);
await cleanUp();
});
// Repeatedly visiting different URLs with the same origin should update
// moz_origins (with the correct frecencies), and moz_origins.frecency should be
// the sum of the URL frecencies.
add_task(async function visitDifferentURLsSameOriginRepeatedly() {
await PlacesTestUtils.addVisits([
]);
await checkDB([
[
"http://",
"example.com",
],
]);
await checkDB([
[
"http://",
"example.com",
],
]);
await checkDB([]);
await cleanUp();
});
// Visiting URLs with different origins should update moz_origins.
add_task(async function visitDifferentOrigins() {
await PlacesTestUtils.addVisits([
]);
await checkDB([
]);
await checkDB([
]);
await checkDB([]);
await cleanUp();
});
// Same as previous, but visits are added sequentially.
add_task(async function visitDifferentOriginsSequential() {
await checkDB([
]);
await checkDB([
]);
await checkDB([
]);
await checkDB([]);
await cleanUp();
});
// Repeatedly visiting URLs with different origins should update moz_origins
// (with the correct frecencies).
add_task(async function visitDifferentOriginsRepeatedly() {
await PlacesTestUtils.addVisits([
]);
await checkDB([
]);
await checkDB([
]);
await checkDB([]);
await cleanUp();
});
// Visiting URLs, some with the same and some with different origins, should
// update moz_origins.
add_task(async function visitDifferentOriginsDifferentURLs() {
await PlacesTestUtils.addVisits([
]);
await checkDB([
[
"http://",
"example1.com",
[
],
],
[
"http://",
"example2.com",
],
]);
await checkDB([
[
"http://",
"example1.com",
],
[
"http://",
"example2.com",
],
]);
await checkDB([
[
"http://",
"example2.com",
],
]);
await checkDB([
[
"http://",
"example2.com",
],
]);
await checkDB([
]);
await checkDB([]);
});
// Same as previous, but visits are added sequentially.
add_task(async function visitDifferentOriginsDifferentURLsSequential() {
await checkDB([
[
"http://",
"example1.com",
],
]);
await checkDB([
[
"http://",
"example1.com",
[
],
],
]);
await checkDB([
[
"http://",
"example1.com",
[
],
],
]);
await checkDB([
[
"http://",
"example1.com",
[
],
],
[
"http://",
"example2.com",
],
]);
await checkDB([
[
"http://",
"example1.com",
[
],
],
[
"http://",
"example2.com",
],
]);
await checkDB([
[
"http://",
"example1.com",
],
[
"http://",
"example2.com",
],
]);
await checkDB([
[
"http://",
"example2.com",
],
]);
await checkDB([
[
"http://",
"example2.com",
],
]);
await checkDB([
]);
await checkDB([]);
});
// Repeatedly visiting URLs, some with the same and some with different origins,
// should update moz_origins (with the correct frecencies).
add_task(async function visitDifferentOriginsDifferentURLsRepeatedly() {
await PlacesTestUtils.addVisits([
]);
await checkDB([
[
"http://",
"example1.com",
[
],
],
[
"http://",
"example2.com",
],
]);
await checkDB([
[
"http://",
"example1.com",
],
[
"http://",
"example2.com",
],
]);
await checkDB([
[
"http://",
"example2.com",
],
]);
await checkDB([
[
"http://",
"example2.com",
],
]);
await checkDB([
]);
await checkDB([]);
});
// Makes sure URIs with the same TLD but different www subdomains are recognized
// as different origins. Makes sure removing one doesn't remove the others.
add_task(async function www1() {
await PlacesTestUtils.addVisits([
]);
await checkDB([
]);
await checkDB([
]);
await checkDB([
]);
await checkDB([]);
await cleanUp();
});
// Same as www1, but removes URIs in a different order.
add_task(async function www2() {
await PlacesTestUtils.addVisits([
]);
await checkDB([
]);
await checkDB([
]);
await checkDB([]);
await cleanUp();
});
// Makes sure removing an origin without a port doesn't remove the same host
// with a port.
add_task(async function ports1() {
await PlacesTestUtils.addVisits([
]);
await checkDB([
]);
await checkDB([
]);
await checkDB([]);
await cleanUp();
});
// Makes sure removing an origin with a port doesn't remove the same host
// without a port.
add_task(async function ports2() {
await PlacesTestUtils.addVisits([
]);
await checkDB([
]);
await checkDB([]);
await cleanUp();
});
// Makes sure multiple URIs with the same origin don't create duplicate origins.
add_task(async function duplicates() {
await PlacesTestUtils.addVisits([
{ uri: "bar:example.com/" },
{ uri: "bar:example.com/dupe" },
]);
await checkDB([
[
"http://",
"example.com",
],
[
"http://",
"www.example.com",
],
[
"http://",
"www.www.example.com",
],
[
"https://",
"example.com",
],
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
[
"http://",
"www.example.com",
],
[
"http://",
"www.www.example.com",
],
[
"https://",
"example.com",
],
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
[
"http://",
"www.example.com",
],
[
"http://",
"www.www.example.com",
],
[
"https://",
"example.com",
],
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
[
"http://",
"www.www.example.com",
],
[
"https://",
"example.com",
],
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
[
"http://",
"www.www.example.com",
],
[
"https://",
"example.com",
],
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
[
"https://",
"example.com",
],
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
[
"https://",
"example.com",
],
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await checkDB([
["bar:", "example.com", ["bar:example.com/", "bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await PlacesUtils.history.remove("bar:example.com/");
await checkDB([
["bar:", "example.com", ["bar:example.com/dupe"]],
[
"http://",
"example.com:8888",
],
]);
await PlacesUtils.history.remove("bar:example.com/dupe");
await checkDB([
[
"http://",
"example.com:8888",
],
]);
await checkDB([
]);
await checkDB([]);
await cleanUp();
});
// Makes sure adding and removing bookmarks creates origins.
add_task(async function addRemoveBookmarks() {
let bookmarks = [];
for (let url of urls) {
bookmarks.push(
await PlacesUtils.bookmarks.insert({
url,
parentGuid: PlacesUtils.bookmarks.unfiledGuid,
})
);
}
await checkDB([
]);
await PlacesUtils.bookmarks.remove(bookmarks[0]);
await PlacesUtils.history.clear();
await PlacesUtils.bookmarks.remove(bookmarks[1]);
await PlacesUtils.history.clear();
await checkDB([]);
await cleanUp();
});
// Makes sure changing bookmarks also changes the corresponding origins.
add_task(async function changeBookmarks() {
let bookmarks = [];
for (let url of urls) {
bookmarks.push(
await PlacesUtils.bookmarks.insert({
url,
parentGuid: PlacesUtils.bookmarks.unfiledGuid,
})
);
}
await checkDB([
]);
await PlacesUtils.bookmarks.update({
guid: bookmarks[0].guid,
});
await PlacesUtils.history.clear();
await cleanUp();
});
// A slightly more complex test to make sure origin frecency stats are updated
// when visits and bookmarks are added and removed.
add_task(async function moreOriginFrecencyStats() {
await checkDB([]);
// Add a URL 0 visit.
// Add a URL 1 visit.
await checkDB([
[
"http://",
"example.com",
],
]);
// Add a URL 2 visit.
await checkDB([
[
"http://",
"example.com",
],
]);
// Add another URL 2 visit.
await checkDB([
[
"http://",
"example.com",
],
]);
// Remove URL 2's visits.
await checkDB([
[
"http://",
"example.com",
],
]);
// Bookmark URL 1.
let bookmark = await PlacesUtils.bookmarks.insert({
parentGuid: PlacesUtils.bookmarks.unfiledGuid,
title: "A bookmark",
});
await checkDB([
[
"http://",
"example.com",
],
]);
// Remove URL 1's visit.
await checkDB([
[
"http://",
"example.com",
],
]);
// Remove URL 1's bookmark. Also need to call history.remove() again to
// remove the URL from moz_places. Otherwise it sticks around and keeps
// contributing to the frecency stats.
await PlacesUtils.bookmarks.remove(bookmark);
// Remove URL 0.
await checkDB([]);
await cleanUp();
});
add_task(async function test_cutoff() {
// Add first page with visit.
// Add a second page last visited before the cutoff, it should be ignored.
let visitDate = PlacesUtils.toPRTime(
new Date(
new Date().setDate(
-Services.prefs.getIntPref("places.frecency.originsCutOffDays", 90)
)
)
);
// Add a third page with visit both before and after the cutoff, should count.
await PlacesTestUtils.addVisits([
]);
await checkDB([
[
"http://",
"example.com",
],
]);
await cleanUp();
});
/**
* Returns the expected frecency of the origin of the given URLs, i.e., the sum
* of their frecencies. Each URL is expected to have the same origin.
*
* @param urls
* An array of URL strings.
* @return The expected origin frecency.
*/
async function expectedOriginFrecency(urls) {
let value = 0;
for (let url of urls) {
let v = Math.max(
(await PlacesTestUtils.getDatabaseValue("moz_places", "frecency", {
url,
last_visit_date: [">", 0],
})) ?? 0,
0
);
value += v;
}
return value || 1.0;
}
/**
* Asserts that the moz_origins table and the origin frecency stats are correct.
*
* @param expectedOrigins
* An array of expected origins. Each origin in the array is itself an
* array that looks like this:
* [prefix, host, [url1, url2, ..., urln]]
* The element at index 2 is an array of all the URLs with the origin.
* If you don't care about checking frecencies and origin frecency stats,
* this element can be `undefined`.
*/
async function checkDB(expectedOrigins) {
await PlacesFrecencyRecalculator.recalculateAnyOutdatedFrecencies();
let db = await PlacesUtils.promiseDBConnection();
let rows = await db.execute(`
SELECT prefix, host, frecency
FROM moz_origins
ORDER BY id ASC
`);
let checkFrecencies =
!expectedOrigins.length || expectedOrigins[0][2] !== undefined;
let actualOrigins = rows.map(row => {
let o = [];
for (let c = 0; c < (checkFrecencies ? 3 : 2); c++) {
o.push(row.getResultByIndex(c));
}
return o;
});
let expected = [];
for (let origin of expectedOrigins) {
expected.push(
origin
.slice(0, 2)
.concat(checkFrecencies ? await expectedOriginFrecency(origin[2]) : [])
);
}
Assert.deepEqual(actualOrigins, expected);
if (checkFrecencies) {
info("Checking threshold");
await PlacesTestUtils.dumpTable({ db, table: "moz_origins" });
await checkThreshold(expected.map(o => o[2]));
}
}
/**
* Asserts that the origin frecency threshold is correct.
*
* @param expectedOriginFrecencies
* An array of expected origin frecencies.
*/
async function checkThreshold(expectedOriginFrecencies) {
const DEFAULT_THRESHOLD = 2.0;
let threshold = await PlacesUtils.metadata.get(
"origin_frecency_threshold",
DEFAULT_THRESHOLD
);
Assert.equal(
threshold,
expectedOriginFrecencies.length
? expectedOriginFrecencies.reduce((a, b) => a + b, 0) /
expectedOriginFrecencies.length
: DEFAULT_THRESHOLD
);
}
async function cleanUp() {
await PlacesUtils.bookmarks.eraseEverything();
await PlacesUtils.history.clear();
}