Source code
Revision control
Copy as Markdown
Other Tools
Test Info:
/* Any copyright is dedicated to the Public Domain.
"use strict";
const TRACKING_PAGE =
// eslint-disable-next-line @microsoft/sdl/no-insecure-url
const CM_PROTECTION_PREF = "privacy.trackingprotection.cryptomining.enabled";
let cmHistogram;
add_setup(async function () {
await SpecialPowers.pushPrefEnv({
set: [
[
"urlclassifier.features.cryptomining.blacklistHosts",
"cryptomining.example.com",
],
[
"urlclassifier.features.cryptomining.annotate.blacklistHosts",
"cryptomining.example.com",
],
["privacy.trackingprotection.enabled", false],
["privacy.trackingprotection.annotate_channels", false],
["privacy.trackingprotection.fingerprinting.enabled", false],
["urlclassifier.features.fingerprinting.annotate.blacklistHosts", ""],
],
});
cmHistogram = Services.telemetry.getHistogramById(
"CRYPTOMINERS_BLOCKED_COUNT"
);
registerCleanupFunction(() => {
cmHistogram.clear();
});
});
async function testIdentityState(hasException) {
cmHistogram.clear();
let promise = BrowserTestUtils.openNewForegroundTab({
url: TRACKING_PAGE,
gBrowser,
});
let [tab] = await Promise.all([promise, waitForContentBlockingEvent()]);
if (hasException) {
let loaded = BrowserTestUtils.browserLoaded(
tab.linkedBrowser,
false,
TRACKING_PAGE
);
gProtectionsHandler.disableForCurrentPage();
await loaded;
}
await openProtectionsPanel();
ok(
!gProtectionsHandler._protectionsPopup.hasAttribute("detected"),
"cryptominers are not detected"
);
ok(
BrowserTestUtils.isVisible(gProtectionsHandler.iconBox),
"icon box is visible regardless the exception"
);
promise = waitForContentBlockingEvent();
await SpecialPowers.spawn(tab.linkedBrowser, [], function () {
content.postMessage("cryptomining", "*");
});
await promise;
ok(
gProtectionsHandler._protectionsPopup.hasAttribute("detected"),
"trackers are detected"
);
ok(
BrowserTestUtils.isVisible(gProtectionsHandler.iconBox),
"icon box is visible"
);
is(
gProtectionsHandler.iconBox.hasAttribute("hasException"),
hasException,
"Shows an exception when appropriate"
);
if (hasException) {
let loaded = BrowserTestUtils.browserLoaded(
tab.linkedBrowser,
false,
TRACKING_PAGE
);
gProtectionsHandler.enableForCurrentPage();
await loaded;
}
let loads = hasException ? 3 : 1;
testTelemetry(loads, 1, hasException);
BrowserTestUtils.removeTab(tab);
}
async function testSubview(hasException) {
cmHistogram.clear();
let promise = BrowserTestUtils.openNewForegroundTab({
url: TRACKING_PAGE,
gBrowser,
});
let [tab] = await Promise.all([promise, waitForContentBlockingEvent()]);
if (hasException) {
let loaded = BrowserTestUtils.browserLoaded(
tab.linkedBrowser,
false,
TRACKING_PAGE
);
gProtectionsHandler.disableForCurrentPage();
await loaded;
}
promise = waitForContentBlockingEvent();
await SpecialPowers.spawn(tab.linkedBrowser, [], function () {
content.postMessage("cryptomining", "*");
});
await promise;
await openProtectionsPanel();
let categoryItem = document.getElementById(
"protections-popup-category-cryptominers"
);
// Explicitly waiting for the category item becoming visible.
await TestUtils.waitForCondition(() => {
return BrowserTestUtils.isVisible(categoryItem);
});
ok(BrowserTestUtils.isVisible(categoryItem), "TP category item is visible");
/* eslint-disable mozilla/no-arbitrary-setTimeout */
// We have to wait until the ContentBlockingLog gets updated in the content.
// Unfortunately, we need to use the setTimeout here since we don't have an
// easy to know whether the log is updated in the content. This should be
await new Promise(resolve => {
setTimeout(resolve, 500);
});
/* eslint-enable mozilla/no-arbitrary-setTimeout */
let subview = document.getElementById("protections-popup-cryptominersView");
let viewShown = BrowserTestUtils.waitForEvent(subview, "ViewShown");
categoryItem.click();
await viewShown;
let trackersViewShimHint = document.getElementById(
"protections-popup-cryptominersView-shim-allow-hint"
);
ok(trackersViewShimHint.hidden, "Shim hint is hidden");
let listItems = subview.querySelectorAll(".protections-popup-list-item");
is(listItems.length, 1, "We have 1 item in the list");
let listItem = listItems[0];
ok(BrowserTestUtils.isVisible(listItem), "List item is visible");
is(
listItem.querySelector("label").value,
// eslint-disable-next-line @microsoft/sdl/no-insecure-url
"Has the correct host"
);
is(
listItem.classList.contains("allowed"),
hasException,
"Indicates the miner was blocked or allowed"
);
let mainView = document.getElementById("protections-popup-mainView");
viewShown = BrowserTestUtils.waitForEvent(mainView, "ViewShown");
let backButton = subview.querySelector(".subviewbutton-back");
backButton.click();
await viewShown;
ok(true, "Main view was shown");
if (hasException) {
let loaded = BrowserTestUtils.browserLoaded(
tab.linkedBrowser,
false,
TRACKING_PAGE
);
gProtectionsHandler.enableForCurrentPage();
await loaded;
}
let loads = hasException ? 3 : 1;
testTelemetry(loads, 1, hasException);
BrowserTestUtils.removeTab(tab);
}
async function testCategoryItem() {
Services.prefs.setBoolPref(CM_PROTECTION_PREF, false);
let promise = BrowserTestUtils.openNewForegroundTab({
url: TRACKING_PAGE,
gBrowser,
});
let [tab] = await Promise.all([promise, waitForContentBlockingEvent()]);
await openProtectionsPanel();
let categoryItem = document.getElementById(
"protections-popup-category-cryptominers"
);
ok(
!categoryItem.classList.contains("blocked"),
"Category not marked as blocked"
);
ok(
categoryItem.classList.contains("notFound"),
"Category marked as not found"
);
Services.prefs.setBoolPref(CM_PROTECTION_PREF, true);
ok(categoryItem.classList.contains("blocked"), "Category marked as blocked");
ok(
categoryItem.classList.contains("notFound"),
"Category marked as not found"
);
Services.prefs.setBoolPref(CM_PROTECTION_PREF, false);
ok(
!categoryItem.classList.contains("blocked"),
"Category not marked as blocked"
);
ok(
categoryItem.classList.contains("notFound"),
"Category marked as not found"
);
await closeProtectionsPanel();
promise = waitForContentBlockingEvent();
await SpecialPowers.spawn(tab.linkedBrowser, [], function () {
content.postMessage("cryptomining", "*");
});
await promise;
await openProtectionsPanel();
ok(
!categoryItem.classList.contains("blocked"),
"Category not marked as blocked"
);
ok(
!categoryItem.classList.contains("notFound"),
"Category not marked as not found"
);
Services.prefs.setBoolPref(CM_PROTECTION_PREF, true);
ok(categoryItem.classList.contains("blocked"), "Category marked as blocked");
ok(
!categoryItem.classList.contains("notFound"),
"Category not marked as not found"
);
Services.prefs.setBoolPref(CM_PROTECTION_PREF, false);
ok(
!categoryItem.classList.contains("blocked"),
"Category not marked as blocked"
);
ok(
!categoryItem.classList.contains("notFound"),
"Category not marked as not found"
);
await closeProtectionsPanel();
BrowserTestUtils.removeTab(tab);
}
function testTelemetry(pagesVisited, pagesWithBlockableContent, hasException) {
let results = cmHistogram.snapshot();
Assert.equal(
results.values[0],
pagesVisited,
"The correct number of page loads have been recorded"
);
let expectedValue = hasException ? 2 : 1;
Assert.equal(
results.values[expectedValue],
pagesWithBlockableContent,
"The correct number of cryptominers have been recorded as blocked or allowed."
);
}
add_task(async function test() {
Services.prefs.setBoolPref(CM_PROTECTION_PREF, true);
await testIdentityState(false);
await testIdentityState(true);
await testSubview(false);
await testSubview(true);
await testCategoryItem();
Services.prefs.clearUserPref(CM_PROTECTION_PREF);
Services.prefs.setStringPref("browser.contentblocking.category", "standard");
});