From 3a32b14f3297961850f1576b660e6272f268b634 Mon Sep 17 00:00:00 2001 From: Andrey Lushnikov Date: Tue, 11 Feb 2020 14:32:15 -0800 Subject: [PATCH] devops: bundle firefox preferences alongside with build. --- browser_patches/firefox/BUILD_NUMBER | 2 +- browser_patches/firefox/archive.sh | 1 + browser_patches/firefox/build.sh | 3 + .../firefox/install-preferences.js | 96 ++++++++ .../preferences/00-playwright-prefs.js | 3 + .../firefox/preferences/playwright.cfg | 233 ++++++++++++++++++ 6 files changed, 337 insertions(+), 1 deletion(-) create mode 100644 browser_patches/firefox/install-preferences.js create mode 100644 browser_patches/firefox/preferences/00-playwright-prefs.js create mode 100644 browser_patches/firefox/preferences/playwright.cfg diff --git a/browser_patches/firefox/BUILD_NUMBER b/browser_patches/firefox/BUILD_NUMBER index d90f2b1d5b..327f63bda8 100644 --- a/browser_patches/firefox/BUILD_NUMBER +++ b/browser_patches/firefox/BUILD_NUMBER @@ -1 +1 @@ -1026 +1027 diff --git a/browser_patches/firefox/archive.sh b/browser_patches/firefox/archive.sh index e173a93721..1f652001b7 100755 --- a/browser_patches/firefox/archive.sh +++ b/browser_patches/firefox/archive.sh @@ -39,6 +39,7 @@ if [[ $OBJ_FOLDER == "" ]]; then fi ./mach package +node ../install-preferences.js $PWD/$OBJ_FOLDER/dist/firefox if ! [[ -d $OBJ_FOLDER/dist/firefox ]]; then echo "ERROR: cannot find $OBJ_FOLDER/dist/firefox folder in the checkout/. Did you build?" diff --git a/browser_patches/firefox/build.sh b/browser_patches/firefox/build.sh index a2cd370054..3c4397ce16 100755 --- a/browser_patches/firefox/build.sh +++ b/browser_patches/firefox/build.sh @@ -37,3 +37,6 @@ else fi ./mach build +OBJ_FOLDER=$(ls -1 | grep obj-) +node ../install-preferences.js $PWD/$OBJ_FOLDER/dist/bin + diff --git a/browser_patches/firefox/install-preferences.js b/browser_patches/firefox/install-preferences.js new file mode 100644 index 0000000000..f00f526392 --- /dev/null +++ b/browser_patches/firefox/install-preferences.js @@ -0,0 +1,96 @@ +/** + * Copyright 2018 Google Inc. All rights reserved. + * Modifications copyright (c) Microsoft Corporation. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +const os = require('os'); +const fs = require('fs'); +const path = require('path'); +const util = require('util'); + +const writeFileAsync = util.promisify(fs.writeFile.bind(fs)); +const mkdirAsync = util.promisify(fs.mkdir.bind(fs)); + +// Install browser preferences after downloading and unpacking +// firefox instances. +// Based on: https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Enterprise_deployment_before_60#Configuration +async function installFirefoxPreferences(distpath) { + let executablePath = ''; + if (os.platform() === 'linux') + executablePath = path.join(distpath, 'firefox'); + else if (os.platform() === 'darwin') + executablePath = path.join(distpath, 'Nightly.app', 'Contents', 'MacOS', 'firefox'); + else if (os.platform() === 'win32') + executablePath = path.join(distpath, 'firefox.exe'); + + const firefoxFolder = path.dirname(executablePath); + + let prefPath = ''; + let configPath = ''; + if (os.platform() === 'darwin') { + prefPath = path.join(firefoxFolder, '..', 'Resources', 'defaults', 'pref'); + configPath = path.join(firefoxFolder, '..', 'Resources'); + } else if (os.platform() === 'linux') { + if (!fs.existsSync(path.join(firefoxFolder, 'browser', 'defaults'))) + await mkdirAsync(path.join(firefoxFolder, 'browser', 'defaults')); + if (!fs.existsSync(path.join(firefoxFolder, 'browser', 'defaults', 'preferences'))) + await mkdirAsync(path.join(firefoxFolder, 'browser', 'defaults', 'preferences')); + prefPath = path.join(firefoxFolder, 'browser', 'defaults', 'preferences'); + configPath = firefoxFolder; + } else if (os.platform() === 'win32') { + prefPath = path.join(firefoxFolder, 'defaults', 'pref'); + configPath = firefoxFolder; + } else { + throw new Error('Unsupported platform: ' + os.platform()); + } + + await Promise.all([ + copyFile({ + from: path.join(__dirname, 'preferences', '00-playwright-prefs.js'), + to: path.join(prefPath, '00-playwright-prefs.js'), + }), + copyFile({ + from: path.join(__dirname, 'preferences', 'playwright.cfg'), + to: path.join(configPath, 'playwright.cfg'), + }), + ]); +} + +function copyFile({from, to}) { + const rd = fs.createReadStream(from); + const wr = fs.createWriteStream(to); + return new Promise(function(resolve, reject) { + rd.on('error', reject); + wr.on('error', reject); + wr.on('finish', resolve); + rd.pipe(wr); + }).catch(function(error) { + rd.destroy(); + wr.end(); + throw error; + }); +} + +if (process.argv.length !== 3) { + console.log('ERROR: expected a path to the directory with browser build'); + process.exit(1); + return; +} + +installFirefoxPreferences(process.argv[2]).catch(error => { + console.error('ERROR: failed to put preferences!'); + console.error(error); + process.exit(1); +}); diff --git a/browser_patches/firefox/preferences/00-playwright-prefs.js b/browser_patches/firefox/preferences/00-playwright-prefs.js new file mode 100644 index 0000000000..1895d2d1b7 --- /dev/null +++ b/browser_patches/firefox/preferences/00-playwright-prefs.js @@ -0,0 +1,3 @@ +// Any comment. You must start the file with a single-line comment! +pref("general.config.filename", "playwright.cfg"); +pref("general.config.obscure_value", 0); diff --git a/browser_patches/firefox/preferences/playwright.cfg b/browser_patches/firefox/preferences/playwright.cfg new file mode 100644 index 0000000000..4e724051fd --- /dev/null +++ b/browser_patches/firefox/preferences/playwright.cfg @@ -0,0 +1,233 @@ +// Any comment. You must start the file with a comment! + +// Make sure Shield doesn't hit the network. +pref("app.normandy.api_url", ""); +pref("app.normandy.enabled", false); + +// Disable updater +pref("app.update.enabled", false); +// Disable Firefox old build background check +pref("app.update.checkInstallTime", false); +// Disable automatically upgrading Firefox +pref("app.update.disabledForTesting", true); + +// make absolutely sure it is really off +pref("app.update.auto", false); +pref("app.update.mode", 0); +pref("app.update.service.enabled", false); +// Dislabe newtabpage +pref("browser.startup.homepage", "about:blank"); +pref("browser.startup.page", 0); +pref("browser.newtabpage.enabled", false); +// Do not redirect user when a milstone upgrade of Firefox is detected +pref("browser.startup.homepage_override.mstone", "ignore"); + +// Disable topstories +pref("browser.newtabpage.activity-stream.feeds.section.topstories", false); +// DevTools JSONViewer sometimes fails to load dependencies with its require.js. +// This doesn't affect Puppeteer operations, but spams console with a lot of +// unpleasant errors. +// (bug 1424372) +pref("devtools.jsonview.enabled", false); + +// Prevent various error message on the console +pref("browser.contentblocking.features.standard", "-tp,tpPrivate,cookieBehavior0,-cm,-fp"); +pref("network.cookie.cookieBehavior", 0); + +// Increase the APZ content response timeout in tests to 1 minute. +// This is to accommodate the fact that test environments tends to be +// slower than production environments (with the b2g emulator being +// the slowest of them all), resulting in the production timeout value +// sometimes being exceeded and causing false-positive test failures. +// +// (bug 1176798, bug 1177018, bug 1210465) +pref("apz.content_response_timeout", 60000); + +// Allow creating files in content process - required for +// |Page.setFileInputFiles| protocol method. +pref("dom.file.createInChild", true); + +// Indicate that the download panel has been shown once so that +// whichever download test runs first doesn't show the popup +// inconsistently. +pref("browser.download.panel.shown", true); +// Background thumbnails in particular cause grief, and disabling +// thumbnails in general cannot hurt +pref("browser.pagethumbnails.capturing_disabled", true); +// Disable safebrowsing components. +pref("browser.safebrowsing.blockedURIs.enabled", false); +pref("browser.safebrowsing.downloads.enabled", false); +pref("browser.safebrowsing.passwords.enabled", false); +pref("browser.safebrowsing.malware.enabled", false); +pref("browser.safebrowsing.phishing.enabled", false); +// Disable updates to search engines. +pref("browser.search.update", false); +// Do not restore the last open set of tabs if the browser has crashed +pref("browser.sessionstore.resume_from_crash", false); +// Don't check for the default web browser during startup. +pref("browser.shell.checkDefaultBrowser", false); + +// Disable browser animations (tabs, fullscreen, sliding alerts) +pref("toolkit.cosmeticAnimations.enabled", false); + +// Close the window when the last tab gets closed +pref("browser.tabs.closeWindowWithLastTab", true); + +// Do not allow background tabs to be zombified on Android, otherwise for +// tests that open additional tabs, the test harness tab itself might get +// unloaded +pref("browser.tabs.disableBackgroundZombification", false); + +// Do not warn when closing all open tabs +pref("browser.tabs.warnOnClose", false); + +// Do not warn when closing all other open tabs +pref("browser.tabs.warnOnCloseOtherTabs", false); + +// Do not warn when multiple tabs will be opened +pref("browser.tabs.warnOnOpen", false); + +// Disable first run splash page on Windows 10 +pref("browser.usedOnWindows10.introURL", ""); + +// Disable the UI tour. +// +// Should be set in profile. +pref("browser.uitour.enabled", false); + +// Turn off search suggestions in the location bar so as not to trigger +// network connections. +pref("browser.urlbar.suggest.searches", false); + +// Do not warn on quitting Firefox +pref("browser.warnOnQuit", false); + +// Do not show datareporting policy notifications which can +// interfere with tests +pref("datareporting.healthreport.documentServerURI", "http://dummydummy.test/dummy/healthreport/"); +pref("datareporting.healthreport.about.reportUrl", "http://dummydummy.test/dummy/abouthealthreport/"); +pref("datareporting.healthreport.logging.consoleEnabled", false); +pref("datareporting.healthreport.service.enabled", false); +pref("datareporting.healthreport.service.firstRun", false); +pref("datareporting.healthreport.uploadEnabled", false); +pref("datareporting.policy.dataSubmissionEnabled", false); +pref("datareporting.policy.dataSubmissionPolicyAccepted", false); +pref("datareporting.policy.dataSubmissionPolicyBypassNotification", true); + +// Automatically unload beforeunload alerts +pref("dom.disable_beforeunload", false); + +// Disable popup-blocker +pref("dom.disable_open_during_load", false); + +// Disable the ProcessHangMonitor +pref("dom.ipc.reportProcessHangs", false); +pref("hangmonitor.timeout", 0); + +// Disable slow script dialogues +pref("dom.max_chrome_script_run_time", 0); +pref("dom.max_script_run_time", 0); + +// Only load extensions from the application and user profile +// AddonManager.SCOPE_PROFILE + AddonManager.SCOPE_APPLICATION +pref("extensions.autoDisableScopes", 0); +pref("extensions.enabledScopes", 5); + +// Disable metadata caching for installed add-ons by default +pref("extensions.getAddons.cache.enabled", false); + +// Disable installing any distribution extensions or add-ons. +pref("extensions.installDistroAddons", false); + +// Turn off extension updates so they do not bother tests +pref("extensions.update.enabled", false); +pref("extensions.update.notifyUser", false); + +// Make sure opening about:addons will not hit the network +pref("extensions.webservice.discoverURL", "http://dummydummy.test/dummy/discoveryURL"); + +pref("extensions.screenshots.disabled", true); +pref("extensions.screenshots.upload-disabled", true); + +// Allow the application to have focus even it runs in the background +pref("focusmanager.testmode", true); + +// Disable useragent updates +pref("general.useragent.updates.enabled", false); + +// No ICC color correction. +// See https://developer.mozilla.org/en/docs/Mozilla/Firefox/Releases/3.5/ICC_color_correction_in_Firefox. +pref("gfx.color_management.mode", 0); +pref("gfx.color_management.rendering_intent", 3); + +// Always use network provider for geolocation tests so we bypass the +// macOS dialog raised by the corelocation provider +pref("geo.provider.testing", true); + +// Do not scan Wifi +pref("geo.wifi.scan", false); + +// Show chrome errors and warnings in the error console +pref("javascript.options.showInConsole", true); + +// Disable download and usage of OpenH264: and Widevine plugins +pref("media.gmp-manager.updateEnabled", false); + +// Do not prompt with long usernames or passwords in URLs +pref("network.http.phishy-userpass-length", 255); + +// Do not prompt for temporary redirects +pref("network.http.prompt-temp-redirect", false); + +// Disable speculative connections so they are not reported as leaking +// when they are hanging around +pref("network.http.speculative-parallel-limit", 0); + +// Do not automatically switch between offline and online +pref("network.manage-offline-status", false); + +// Make sure SNTP requests do not hit the network +pref("network.sntp.pools", "dummydummy.test"); + +// Disable Flash +pref("plugin.state.flash", 0); + +pref("privacy.trackingprotection.enabled", false); + +pref("security.certerrors.mitm.priming.enabled", false); + +// Local documents have access to all other local documents, +// including directory listings +pref("security.fileuri.strict_origin_policy", false); + +// Tests do not wait for the notification button security delay +pref("security.notification_enable_delay", 0); + +// Ensure blocklist updates do not hit the network +pref("services.settings.server", "http://dummydummy.test/dummy/blocklist/"); + +// Disable DocumentChannel. +// See https://github.com/microsoft/playwright/pull/451 +pref("browser.tabs.documentchannel", false); + +// Do not automatically fill sign-in forms with known usernames and +// passwords +pref("signon.autofillForms", false); + +// Disable password capture, so that tests that include forms are not +// influenced by the presence of the persistent doorhanger notification +pref("signon.rememberSignons", false); + +// Disable first-run welcome page +pref("startup.homepage_welcome_url", "about:blank"); +pref("startup.homepage_welcome_url.additional", ""); + +// Prevent starting into safe mode after application crashes +pref("toolkit.startup.max_resumed_crashes", -1); +lockPref("toolkit.crashreporter.enabled", false); + +pref("toolkit.telemetry.enabled", false); +pref("toolkit.telemetry.server", "https://dummydummy.test/dummy/telemetry"); + +// Disable crash reporter. +Components.classes["@mozilla.org/toolkit/crash-reporter;1"].getService(Components.interfaces.nsICrashReporter).submitReports = false;