mozilla-central/browser/components/urlbar/tests/browser/browser_strip_on_share.js (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Errors

/* Any copyright is dedicated to the Public Domain.
"use strict";
let listService;
// Tests for the strip on share functionality of the urlbar.
add_setup(async function () {
await SpecialPowers.pushPrefEnv({
set: [
["privacy.query_stripping.strip_list", "stripParam"],
["privacy.query_stripping.enabled", false],
],
});
// 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();
});
// Selection is not a valid URI, menu item should be hidden
add_task(async function testInvalidURI() {
await testMenuItemDisabled(
true,
true
);
});
// Pref is not enabled, menu item should be hidden
add_task(async function testPrefDisabled() {
await testMenuItemDisabled(
false,
false
);
});
// Menu item should be visible, the whole url is copied without a selection, url should be stripped.
add_task(async function testQueryParamIsStripped() {
let shortenedUrl = "https://www.example.com/";
await testMenuItemEnabled({
selectWholeUrl: false,
validUrl: originalUrl,
strippedUrl: shortenedUrl,
useTestList: false,
});
});
// Menu item should be visible, selecting the whole url, url should be stripped.
add_task(async function testQueryParamIsStrippedSelectURL() {
let shortenedUrl = "https://www.example.com/";
await testMenuItemEnabled({
selectWholeUrl: true,
validUrl: originalUrl,
strippedUrl: shortenedUrl,
useTestList: false,
});
});
// Menu item should be visible, selecting the whole url, url should be the same.
add_task(async function testURLIsCopiedWithNoParams() {
let originalUrl = "https://www.example.com/";
let shortenedUrl = "https://www.example.com/";
await testMenuItemEnabled({
selectWholeUrl: true,
validUrl: originalUrl,
strippedUrl: shortenedUrl,
useTestList: false,
});
});
// Testing site specific parameter stripping
add_task(async function testQueryParamIsStrippedForSiteSpecific() {
let shortenedUrl = "https://www.example.com/";
await testMenuItemEnabled({
selectWholeUrl: true,
validUrl: originalUrl,
strippedUrl: shortenedUrl,
useTestList: true,
});
});
// Ensuring site specific parameters are not stripped for other sites
add_task(async function testQueryParamIsNotStrippedForWrongSiteSpecific() {
let shortenedUrl = "https://www.example.com/?test_3=1234";
await testMenuItemEnabled({
selectWholeUrl: true,
validUrl: originalUrl,
strippedUrl: shortenedUrl,
useTestList: true,
});
});
/**
* Opens a new tab, opens the ulr bar context menu and checks that the strip-on-share menu item is not visible
*
* @param {string} url - The url to be loaded
* @param {boolean} prefEnabled - Whether privacy.query_stripping.strip_on_share.enabled should be enabled for the test
* @param {boolean} selection - True: The whole url will be selected, false: Only part of the url will be selected
*/
async function testMenuItemDisabled(url, prefEnabled, selection) {
await SpecialPowers.pushPrefEnv({
set: [["privacy.query_stripping.strip_on_share.enabled", prefEnabled]],
});
await BrowserTestUtils.withNewTab(url, async function () {
gURLBar.focus();
if (selection) {
//select only part of the url
gURLBar.selectionStart = url.indexOf("example");
gURLBar.selectionEnd = url.indexOf("4");
}
let menuitem = await promiseContextualMenuitem("strip-on-share");
Assert.ok(
!BrowserTestUtils.isVisible(menuitem),
"Menu item is not visible"
);
let hidePromise = BrowserTestUtils.waitForEvent(
menuitem.parentElement,
"popuphidden"
);
menuitem.parentElement.hidePopup();
await hidePromise;
});
}
/**
* Opens a new tab, opens the url bar 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 {object} options - method options
* @param {boolean} options.selectWholeUrl - Whether the whole url should be selected
* @param {string} options.validUrl - The original url before the stripping occurs
* @param {string} options.strippedUrl - The expected url after stripping occurs
* @param {boolean} options.useTestList - Whether the StripOnShare or Test list should be used
*/
async function testMenuItemEnabled({
selectWholeUrl,
validUrl,
strippedUrl,
useTestList,
}) {
await SpecialPowers.pushPrefEnv({
set: [
["privacy.query_stripping.strip_on_share.enabled", true],
["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(validUrl, async function () {
gURLBar.focus();
if (selectWholeUrl) {
gURLBar.select();
}
let menuitem = await promiseContextualMenuitem("strip-on-share");
Assert.ok(BrowserTestUtils.isVisible(menuitem), "Menu item is visible");
let hidePromise = BrowserTestUtils.waitForEvent(
menuitem.parentElement,
"popuphidden"
);
// Make sure the clean copy of the link will be copied to the clipboard
await SimpleTest.promiseClipboardChange(strippedUrl, () => {
menuitem.closest("menupopup").activateItem(menuitem);
});
await hidePromise;
});
await SpecialPowers.popPrefEnv();
}