Source code
Revision control
Copy as Markdown
Other Tools
Test Info:
/* Any copyright is dedicated to the Public Domain.
"use strict";
let listService;
let url =
add_setup(async function () {
await SpecialPowers.pushPrefEnv({
set: [["privacy.query_stripping.strip_list", "stripParam"]],
});
// Get the list service so we can wait for it to be fully initialized before running tests.
listService = Cc["@mozilla.org/query-stripping-list-service;1"].getService(
Ci.nsIURLQueryStrippingListService
);
await listService.testWaitForInit();
});
/*
Tests the strip-on-share feature for in-content links
*/
// Tests that the menu item does not show if the pref is disabled
add_task(async function testPrefDisabled() {
await testStripOnShare({
originalURI: validUrl,
strippedURI: shortenedUrl,
prefEnabled: false,
useTestList: false,
});
});
// Menu item should be visible, url should be stripped.
add_task(async function testQueryParamIsStrippedSelectURL() {
await testStripOnShare({
originalURI: validUrl,
strippedURI: shortenedUrl,
prefEnabled: true,
useTestList: false,
});
});
// Menu item should be visible, ensuring only parameters on the list are stripped
add_task(async function testQueryParamIsStripped() {
await testStripOnShare({
originalURI: validUrl,
strippedURI: shortenedUrl,
prefEnabled: true,
useTestList: false,
});
});
// Menu item should be visible, if there is nothing to strip, url should remain the same
add_task(async function testURLIsCopiedWithNoParams() {
await testStripOnShare({
originalURI: validUrl,
strippedURI: shortenedUrl,
prefEnabled: true,
useTestList: false,
});
});
// Testing site specific parameter stripping
add_task(async function testQueryParamIsStrippedForSiteSpecific() {
await testStripOnShare({
originalURI: validUrl,
strippedURI: shortenedUrl,
prefEnabled: true,
useTestList: true,
});
});
// Ensuring site specific parameters are not stripped for other sites
add_task(async function testQueryParamIsNotStrippedForWrongSiteSpecific() {
await testStripOnShare({
originalURI: validUrl,
strippedURI: shortenedUrl,
prefEnabled: true,
useTestList: true,
});
});
/**
* Opens a new tab, opens the context menu and checks that the strip-on-share menu item is visible.
* Checks that the stripped version of the url is copied to the clipboard.
*
* @param {string} originalURI - The orginal url before the stripping occurs
* @param {string} strippedURI - The expected url after stripping occurs
* @param {boolean} prefEnabled - Whether StripOnShare pref is enabled
* @param {boolean} useTestList - Whether the StripOnShare or Test list should be used
*/
async function testStripOnShare({
originalURI,
strippedURI,
prefEnabled,
useTestList,
}) {
await SpecialPowers.pushPrefEnv({
set: [
["privacy.query_stripping.strip_on_share.enabled", prefEnabled],
["privacy.query_stripping.strip_on_share.enableTestMode", useTestList],
],
});
if (useTestList) {
let testJson = {
global: {
queryParams: ["utm_ad"],
topLevelSites: ["*"],
},
example: {
queryParams: ["test_2", "test_1"],
topLevelSites: ["www.example.com"],
},
exampleNet: {
queryParams: ["test_3", "test_4"],
topLevelSites: ["www.example.net"],
},
};
await listService.testSetList(testJson);
}
await BrowserTestUtils.withNewTab(url, async function (browser) {
// Prepare a link
await SpecialPowers.spawn(
browser,
[originalURI],
async function (startingURI) {
let link = content.document.createElement("a");
link.href = startingURI;
link.textContent = "link with query param";
link.id = "link";
content.document.body.appendChild(link);
}
);
let contextMenu = document.getElementById("contentAreaContextMenu");
// Open the context menu
let awaitPopupShown = BrowserTestUtils.waitForEvent(
contextMenu,
"popupshown"
);
await BrowserTestUtils.synthesizeMouseAtCenter(
"#link",
{ type: "contextmenu", button: 2 },
browser
);
await awaitPopupShown;
let awaitPopupHidden = BrowserTestUtils.waitForEvent(
contextMenu,
"popuphidden"
);
let stripOnShare = contextMenu.querySelector("#context-stripOnShareLink");
if (prefEnabled) {
Assert.ok(
BrowserTestUtils.isVisible(stripOnShare),
"Menu item is visible"
);
// Make sure the stripped link will be copied to the clipboard
await SimpleTest.promiseClipboardChange(strippedURI, () => {
contextMenu.activateItem(stripOnShare);
});
} else {
Assert.ok(
!BrowserTestUtils.isVisible(stripOnShare),
"Menu item is not visible"
);
contextMenu.hidePopup();
}
await awaitPopupHidden;
});
}