Source code
Revision control
Copy as Markdown
Other Tools
Test Info:
/*
* Test that the Tracking Protection section is visible in the Control Center
* and has the correct state for the cases when:
*
* In a normal window as well as a private window,
* With TP enabled
* 1) A page with no tracking elements is loaded.
* 2) A page with tracking elements is loaded and they are blocked.
* 3) A page with tracking elements is loaded and they are not blocked.
* With TP disabled
* 1) A page with no tracking elements is loaded.
* 2) A page with tracking elements is loaded.
*
* See also Bugs 1175327, 1043801, 1178985
*/
const TP_PREF = "privacy.trackingprotection.enabled";
const TP_PB_PREF = "privacy.trackingprotection.pbmode.enabled";
const APS_PREF =
"privacy.partition.always_partition_third_party_non_cookie_storage";
const TPC_PREF = "network.cookie.cookieBehavior";
const BENIGN_PAGE =
// eslint-disable-next-line @microsoft/sdl/no-insecure-url
const TRACKING_PAGE =
// eslint-disable-next-line @microsoft/sdl/no-insecure-url
const COOKIE_PAGE =
// eslint-disable-next-line @microsoft/sdl/no-insecure-url
var gProtectionsHandler = null;
var TrackingProtection = null;
var ThirdPartyCookies = null;
var tabbrowser = null;
var gTrackingPageURL = TRACKING_PAGE;
registerCleanupFunction(function () {
TrackingProtection =
gProtectionsHandler =
ThirdPartyCookies =
tabbrowser =
null;
UrlClassifierTestUtils.cleanupTestTrackers();
Services.prefs.clearUserPref(TP_PREF);
Services.prefs.clearUserPref(TP_PB_PREF);
Services.prefs.clearUserPref(TPC_PREF);
});
function notFound(id) {
let doc = tabbrowser.ownerGlobal.document;
return doc.getElementById(id).classList.contains("notFound");
}
async function testBenignPage() {
info("Non-tracking content must not be blocked");
ok(!gProtectionsHandler.anyDetected, "no trackers are detected");
ok(!gProtectionsHandler.hasException, "content shows no exception");
ok(
!gProtectionsHandler.iconBox.hasAttribute("active"),
"shield is not active"
);
ok(
!gProtectionsHandler.iconBox.hasAttribute("hasException"),
"icon box shows no exception"
);
is(
gProtectionsHandler._trackingProtectionIconTooltipLabel.getAttribute(
"data-l10n-id"
),
"tracking-protection-icon-no-trackers-detected",
"correct tooltip"
);
ok(
BrowserTestUtils.isVisible(gProtectionsHandler.iconBox),
"icon box is visible"
);
let win = tabbrowser.ownerGlobal;
await openProtectionsPanel(false, win);
ok(
notFound("protections-popup-category-cookies"),
"Cookie restrictions category is not found"
);
ok(
notFound("protections-popup-category-trackers"),
"Trackers category is not found"
);
await closeProtectionsPanel(win);
}
async function testBenignPageWithException() {
info("Non-tracking content must not be blocked");
ok(!gProtectionsHandler.anyDetected, "no trackers are detected");
ok(gProtectionsHandler.hasException, "content shows exception");
ok(
!gProtectionsHandler.iconBox.hasAttribute("active"),
"shield is not active"
);
ok(
gProtectionsHandler.iconBox.hasAttribute("hasException"),
"shield shows exception"
);
is(
gProtectionsHandler._trackingProtectionIconTooltipLabel.getAttribute(
"data-l10n-id"
),
"tracking-protection-icon-disabled",
"correct tooltip"
);
ok(
!BrowserTestUtils.isHidden(gProtectionsHandler.iconBox),
"icon box is not hidden"
);
let win = tabbrowser.ownerGlobal;
await openProtectionsPanel(false, win);
ok(
notFound("protections-popup-category-cookies"),
"Cookie restrictions category is not found"
);
ok(
notFound("protections-popup-category-trackers"),
"Trackers category is not found"
);
await closeProtectionsPanel(win);
}
function areTrackersBlocked(isPrivateBrowsing) {
let blockedByTP = Services.prefs.getBoolPref(
isPrivateBrowsing ? TP_PB_PREF : TP_PREF
);
let blockedByTPC = [
Ci.nsICookieService.BEHAVIOR_REJECT_TRACKER,
Ci.nsICookieService.BEHAVIOR_REJECT_TRACKER_AND_PARTITION_FOREIGN,
].includes(Services.prefs.getIntPref(TPC_PREF));
return blockedByTP || blockedByTPC;
}
async function testTrackingPage(window) {
info("Tracking content must be blocked");
ok(gProtectionsHandler.anyDetected, "trackers are detected");
ok(!gProtectionsHandler.hasException, "content shows no exception");
let isWindowPrivate = PrivateBrowsingUtils.isWindowPrivate(window);
let blockedByTP = areTrackersBlocked(isWindowPrivate);
ok(
BrowserTestUtils.isVisible(gProtectionsHandler.iconBox),
"icon box is always visible"
);
is(
gProtectionsHandler.iconBox.hasAttribute("active"),
blockedByTP,
"shield is" + (blockedByTP ? "" : " not") + " active"
);
ok(
!gProtectionsHandler.iconBox.hasAttribute("hasException"),
"icon box shows no exception"
);
is(
gProtectionsHandler._trackingProtectionIconTooltipLabel.getAttribute(
"data-l10n-id"
),
blockedByTP
? "tracking-protection-icon-active"
: "tracking-protection-icon-no-trackers-detected",
"correct tooltip"
);
await openProtectionsPanel(false, window);
ok(
!notFound("protections-popup-category-trackers"),
"Trackers category is detected"
);
if (gTrackingPageURL == COOKIE_PAGE) {
ok(
!notFound("protections-popup-category-cookies"),
"Cookie restrictions category is detected"
);
} else {
ok(
notFound("protections-popup-category-cookies"),
"Cookie restrictions category is not found"
);
}
await closeProtectionsPanel(window);
}
async function testTrackingPageUnblocked(blockedByTP, window) {
info("Tracking content must be in the exception list and not blocked");
ok(gProtectionsHandler.anyDetected, "trackers are detected");
ok(gProtectionsHandler.hasException, "content shows exception");
ok(
!gProtectionsHandler.iconBox.hasAttribute("active"),
"shield is not active"
);
ok(
gProtectionsHandler.iconBox.hasAttribute("hasException"),
"shield shows exception"
);
is(
gProtectionsHandler._trackingProtectionIconTooltipLabel.getAttribute(
"data-l10n-id"
),
"tracking-protection-icon-disabled",
"correct tooltip"
);
ok(
BrowserTestUtils.isVisible(gProtectionsHandler.iconBox),
"icon box is visible"
);
await openProtectionsPanel(false, window);
ok(
!notFound("protections-popup-category-trackers"),
"Trackers category is detected"
);
if (gTrackingPageURL == COOKIE_PAGE) {
ok(
!notFound("protections-popup-category-cookies"),
"Cookie restrictions category is detected"
);
} else {
ok(
notFound("protections-popup-category-cookies"),
"Cookie restrictions category is not found"
);
}
await closeProtectionsPanel(window);
}
async function testContentBlocking(tab) {
info("Testing with Tracking Protection ENABLED.");
info("Load a test page not containing tracking elements");
await promiseTabLoadEvent(tab, BENIGN_PAGE);
await testBenignPage();
info(
"Load a test page not containing tracking elements which has an exception."
);
ContentBlockingAllowList.add(tab.linkedBrowser);
// Load another page from the same origin to ensure there is an onlocationchange
// notification which would trigger an oncontentblocking notification for us.
await testBenignPageWithException();
ContentBlockingAllowList.remove(tab.linkedBrowser);
info("Load a test page containing tracking elements");
await promiseTabLoadEvent(tab, gTrackingPageURL);
await testTrackingPage(tab.ownerGlobal);
info("Disable CB for the page (which reloads the page)");
let tabReloadPromise = promiseTabLoadEvent(tab);
tab.ownerGlobal.gProtectionsHandler.disableForCurrentPage();
await tabReloadPromise;
let isPrivateBrowsing = PrivateBrowsingUtils.isWindowPrivate(tab.ownerGlobal);
let blockedByTP = areTrackersBlocked(isPrivateBrowsing);
await testTrackingPageUnblocked(blockedByTP, tab.ownerGlobal);
info("Re-enable TP for the page (which reloads the page)");
tabReloadPromise = promiseTabLoadEvent(tab);
tab.ownerGlobal.gProtectionsHandler.enableForCurrentPage();
await tabReloadPromise;
await testTrackingPage(tab.ownerGlobal);
}
add_task(async function testNormalBrowsing() {
await SpecialPowers.pushPrefEnv({ set: [[APS_PREF, false]] });
await UrlClassifierTestUtils.addTestTrackers();
tabbrowser = gBrowser;
let tab = (tabbrowser.selectedTab = BrowserTestUtils.addTab(tabbrowser));
gProtectionsHandler = gBrowser.ownerGlobal.gProtectionsHandler;
ok(
gProtectionsHandler,
"gProtectionsHandler is attached to the browser window"
);
TrackingProtection =
gBrowser.ownerGlobal.gProtectionsHandler.blockers.TrackingProtection;
ok(TrackingProtection, "TP is attached to the browser window");
is(
TrackingProtection.enabled,
Services.prefs.getBoolPref(TP_PREF),
"TP.enabled is based on the original pref value"
);
Services.prefs.setIntPref(TPC_PREF, Ci.nsICookieService.BEHAVIOR_ACCEPT);
await testContentBlocking(tab);
Services.prefs.setBoolPref(TP_PREF, true);
ok(TrackingProtection.enabled, "TP is enabled after setting the pref");
await testContentBlocking(tab);
gBrowser.removeCurrentTab();
Services.prefs.clearUserPref(TPC_PREF);
});
add_task(async function testPrivateBrowsing() {
await SpecialPowers.pushPrefEnv({
set: [
["dom.security.https_first_pbm", false],
[APS_PREF, false],
],
});
let privateWin = await BrowserTestUtils.openNewBrowserWindow({
private: true,
});
tabbrowser = privateWin.gBrowser;
let tab = (tabbrowser.selectedTab = BrowserTestUtils.addTab(tabbrowser));
// Set the normal mode pref to false to check the pbmode pref.
Services.prefs.setBoolPref(TP_PREF, false);
Services.prefs.setIntPref(TPC_PREF, Ci.nsICookieService.BEHAVIOR_ACCEPT);
gProtectionsHandler = tabbrowser.ownerGlobal.gProtectionsHandler;
ok(
gProtectionsHandler,
"gProtectionsHandler is attached to the private window"
);
TrackingProtection =
tabbrowser.ownerGlobal.gProtectionsHandler.blockers.TrackingProtection;
ok(TrackingProtection, "TP is attached to the private window");
is(
TrackingProtection.enabled,
Services.prefs.getBoolPref(TP_PB_PREF),
"TP.enabled is based on the pb pref value"
);
await testContentBlocking(tab);
Services.prefs.setBoolPref(TP_PB_PREF, true);
ok(TrackingProtection.enabled, "TP is enabled after setting the pref");
await testContentBlocking(tab);
privateWin.close();
Services.prefs.clearUserPref(TPC_PREF);
});
add_task(async function testThirdPartyCookies() {
requestLongerTimeout(3);
await SpecialPowers.pushPrefEnv({ set: [[APS_PREF, false]] });
await UrlClassifierTestUtils.addTestTrackers();
gTrackingPageURL = COOKIE_PAGE;
tabbrowser = gBrowser;
let tab = (tabbrowser.selectedTab = BrowserTestUtils.addTab(tabbrowser));
gProtectionsHandler = gBrowser.ownerGlobal.gProtectionsHandler;
ok(
gProtectionsHandler,
"gProtectionsHandler is attached to the browser window"
);
ThirdPartyCookies =
gBrowser.ownerGlobal.gProtectionsHandler.blockers.ThirdPartyCookies;
ok(ThirdPartyCookies, "TP is attached to the browser window");
is(
ThirdPartyCookies.enabled,
[
Ci.nsICookieService.BEHAVIOR_REJECT_TRACKER,
Ci.nsICookieService.BEHAVIOR_REJECT_TRACKER_AND_PARTITION_FOREIGN,
].includes(Services.prefs.getIntPref(TPC_PREF)),
"TPC.enabled is based on the original pref value"
);
await testContentBlocking(tab);
Services.prefs.setIntPref(
TPC_PREF,
Ci.nsICookieService.BEHAVIOR_REJECT_TRACKER
);
ok(ThirdPartyCookies.enabled, "TPC is enabled after setting the pref");
await testContentBlocking(tab);
Services.prefs.clearUserPref(TPC_PREF);
gBrowser.removeCurrentTab();
});