390 lines
18 KiB
JavaScript
390 lines
18 KiB
JavaScript
"use strict";
|
|
/**
|
|
* @license
|
|
* Copyright 2023 Google Inc.
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
};
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.FirefoxChannel = void 0;
|
|
exports.resolveDownloadUrl = resolveDownloadUrl;
|
|
exports.resolveDownloadPath = resolveDownloadPath;
|
|
exports.relativeExecutablePath = relativeExecutablePath;
|
|
exports.changeBaseVersionUrlForTesting = changeBaseVersionUrlForTesting;
|
|
exports.resetBaseVersionUrlForTesting = resetBaseVersionUrlForTesting;
|
|
exports.resolveBuildId = resolveBuildId;
|
|
exports.createProfile = createProfile;
|
|
exports.compareVersions = compareVersions;
|
|
const node_fs_1 = __importDefault(require("node:fs"));
|
|
const node_path_1 = __importDefault(require("node:path"));
|
|
const httpUtil_js_1 = require("../httpUtil.js");
|
|
const types_js_1 = require("./types.js");
|
|
function getFormat(buildId) {
|
|
const majorVersion = Number(buildId.split('.').shift());
|
|
return majorVersion >= 135 ? 'xz' : 'bz2';
|
|
}
|
|
function archiveNightly(platform, buildId) {
|
|
switch (platform) {
|
|
case types_js_1.BrowserPlatform.LINUX:
|
|
return `firefox-${buildId}.en-US.linux-x86_64.tar.${getFormat(buildId)}`;
|
|
case types_js_1.BrowserPlatform.LINUX_ARM:
|
|
return `firefox-${buildId}.en-US.linux-aarch64.tar.${getFormat(buildId)}`;
|
|
case types_js_1.BrowserPlatform.MAC_ARM:
|
|
case types_js_1.BrowserPlatform.MAC:
|
|
return `firefox-${buildId}.en-US.mac.dmg`;
|
|
case types_js_1.BrowserPlatform.WIN32:
|
|
case types_js_1.BrowserPlatform.WIN64:
|
|
return `firefox-${buildId}.en-US.${platform}.zip`;
|
|
}
|
|
}
|
|
function archive(platform, buildId) {
|
|
switch (platform) {
|
|
case types_js_1.BrowserPlatform.LINUX_ARM:
|
|
case types_js_1.BrowserPlatform.LINUX:
|
|
return `firefox-${buildId}.tar.${getFormat(buildId)}`;
|
|
case types_js_1.BrowserPlatform.MAC_ARM:
|
|
case types_js_1.BrowserPlatform.MAC:
|
|
return `Firefox ${buildId}.dmg`;
|
|
case types_js_1.BrowserPlatform.WIN32:
|
|
case types_js_1.BrowserPlatform.WIN64:
|
|
return `Firefox Setup ${buildId}.exe`;
|
|
}
|
|
}
|
|
function platformName(platform) {
|
|
switch (platform) {
|
|
case types_js_1.BrowserPlatform.LINUX:
|
|
return `linux-x86_64`;
|
|
case types_js_1.BrowserPlatform.LINUX_ARM:
|
|
return `linux-aarch64`;
|
|
case types_js_1.BrowserPlatform.MAC_ARM:
|
|
case types_js_1.BrowserPlatform.MAC:
|
|
return `mac`;
|
|
case types_js_1.BrowserPlatform.WIN32:
|
|
case types_js_1.BrowserPlatform.WIN64:
|
|
return platform;
|
|
}
|
|
}
|
|
function parseBuildId(buildId) {
|
|
for (const value of Object.values(FirefoxChannel)) {
|
|
if (buildId.startsWith(value + '_')) {
|
|
buildId = buildId.substring(value.length + 1);
|
|
return [value, buildId];
|
|
}
|
|
}
|
|
// Older versions do not have channel as the prefix.«
|
|
return [FirefoxChannel.NIGHTLY, buildId];
|
|
}
|
|
function resolveDownloadUrl(platform, buildId, baseUrl) {
|
|
const [channel] = parseBuildId(buildId);
|
|
switch (channel) {
|
|
case FirefoxChannel.NIGHTLY:
|
|
baseUrl ??=
|
|
'https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central';
|
|
break;
|
|
case FirefoxChannel.DEVEDITION:
|
|
baseUrl ??= 'https://archive.mozilla.org/pub/devedition/releases';
|
|
break;
|
|
case FirefoxChannel.BETA:
|
|
case FirefoxChannel.STABLE:
|
|
case FirefoxChannel.ESR:
|
|
baseUrl ??= 'https://archive.mozilla.org/pub/firefox/releases';
|
|
break;
|
|
}
|
|
return `${baseUrl}/${resolveDownloadPath(platform, buildId).join('/')}`;
|
|
}
|
|
function resolveDownloadPath(platform, buildId) {
|
|
const [channel, resolvedBuildId] = parseBuildId(buildId);
|
|
switch (channel) {
|
|
case FirefoxChannel.NIGHTLY:
|
|
return [archiveNightly(platform, resolvedBuildId)];
|
|
case FirefoxChannel.DEVEDITION:
|
|
case FirefoxChannel.BETA:
|
|
case FirefoxChannel.STABLE:
|
|
case FirefoxChannel.ESR:
|
|
return [
|
|
resolvedBuildId,
|
|
platformName(platform),
|
|
'en-US',
|
|
archive(platform, resolvedBuildId),
|
|
];
|
|
}
|
|
}
|
|
function relativeExecutablePath(platform, buildId) {
|
|
const [channel] = parseBuildId(buildId);
|
|
switch (channel) {
|
|
case FirefoxChannel.NIGHTLY:
|
|
switch (platform) {
|
|
case types_js_1.BrowserPlatform.MAC_ARM:
|
|
case types_js_1.BrowserPlatform.MAC:
|
|
return node_path_1.default.join('Firefox Nightly.app', 'Contents', 'MacOS', 'firefox');
|
|
case types_js_1.BrowserPlatform.LINUX_ARM:
|
|
case types_js_1.BrowserPlatform.LINUX:
|
|
return node_path_1.default.join('firefox', 'firefox');
|
|
case types_js_1.BrowserPlatform.WIN32:
|
|
case types_js_1.BrowserPlatform.WIN64:
|
|
return node_path_1.default.join('firefox', 'firefox.exe');
|
|
}
|
|
case FirefoxChannel.BETA:
|
|
case FirefoxChannel.DEVEDITION:
|
|
case FirefoxChannel.ESR:
|
|
case FirefoxChannel.STABLE:
|
|
switch (platform) {
|
|
case types_js_1.BrowserPlatform.MAC_ARM:
|
|
case types_js_1.BrowserPlatform.MAC:
|
|
return node_path_1.default.join('Firefox.app', 'Contents', 'MacOS', 'firefox');
|
|
case types_js_1.BrowserPlatform.LINUX_ARM:
|
|
case types_js_1.BrowserPlatform.LINUX:
|
|
return node_path_1.default.join('firefox', 'firefox');
|
|
case types_js_1.BrowserPlatform.WIN32:
|
|
case types_js_1.BrowserPlatform.WIN64:
|
|
return node_path_1.default.join('core', 'firefox.exe');
|
|
}
|
|
}
|
|
}
|
|
var FirefoxChannel;
|
|
(function (FirefoxChannel) {
|
|
FirefoxChannel["STABLE"] = "stable";
|
|
FirefoxChannel["ESR"] = "esr";
|
|
FirefoxChannel["DEVEDITION"] = "devedition";
|
|
FirefoxChannel["BETA"] = "beta";
|
|
FirefoxChannel["NIGHTLY"] = "nightly";
|
|
})(FirefoxChannel || (exports.FirefoxChannel = FirefoxChannel = {}));
|
|
let baseVersionUrl = 'https://product-details.mozilla.org/1.0';
|
|
function changeBaseVersionUrlForTesting(url) {
|
|
baseVersionUrl = url;
|
|
}
|
|
function resetBaseVersionUrlForTesting() {
|
|
baseVersionUrl = 'https://product-details.mozilla.org/1.0';
|
|
}
|
|
async function resolveBuildId(channel = FirefoxChannel.NIGHTLY) {
|
|
const channelToVersionKey = {
|
|
[FirefoxChannel.ESR]: 'FIREFOX_ESR',
|
|
[FirefoxChannel.STABLE]: 'LATEST_FIREFOX_VERSION',
|
|
[FirefoxChannel.DEVEDITION]: 'FIREFOX_DEVEDITION',
|
|
[FirefoxChannel.BETA]: 'FIREFOX_DEVEDITION',
|
|
[FirefoxChannel.NIGHTLY]: 'FIREFOX_NIGHTLY',
|
|
};
|
|
const versions = (await (0, httpUtil_js_1.getJSON)(new URL(`${baseVersionUrl}/firefox_versions.json`)));
|
|
const version = versions[channelToVersionKey[channel]];
|
|
if (!version) {
|
|
throw new Error(`Channel ${channel} is not found.`);
|
|
}
|
|
return channel + '_' + version;
|
|
}
|
|
async function createProfile(options) {
|
|
if (!node_fs_1.default.existsSync(options.path)) {
|
|
await node_fs_1.default.promises.mkdir(options.path, {
|
|
recursive: true,
|
|
});
|
|
}
|
|
await syncPreferences({
|
|
preferences: {
|
|
...defaultProfilePreferences(options.preferences),
|
|
...options.preferences,
|
|
},
|
|
path: options.path,
|
|
});
|
|
}
|
|
function defaultProfilePreferences(extraPrefs) {
|
|
const server = 'dummy.test';
|
|
const defaultPrefs = {
|
|
// Make sure Shield doesn't hit the network.
|
|
'app.normandy.api_url': '',
|
|
// Disable Firefox old build background check
|
|
'app.update.checkInstallTime': false,
|
|
// Disable automatically upgrading Firefox
|
|
'app.update.disabledForTesting': true,
|
|
// Increase the APZ content response timeout to 1 minute
|
|
'apz.content_response_timeout': 60000,
|
|
// Disables backup service to improve startup performance and stability. See
|
|
// https://github.com/puppeteer/puppeteer/issues/14194. TODO: can be removed
|
|
// once the service is disabled on the Firefox side for WebDriver (see
|
|
// https://bugzilla.mozilla.org/show_bug.cgi?id=1988250).
|
|
'browser.backup.enabled': false,
|
|
// Prevent various error message on the console
|
|
// jest-puppeteer asserts that no error message is emitted by the console
|
|
'browser.contentblocking.features.standard': '-tp,tpPrivate,cookieBehavior0,-cryptoTP,-fp',
|
|
// Enable the dump function: which sends messages to the system
|
|
// console
|
|
// https://bugzilla.mozilla.org/show_bug.cgi?id=1543115
|
|
'browser.dom.window.dump.enabled': true,
|
|
// Disable topstories
|
|
'browser.newtabpage.activity-stream.feeds.system.topstories': false,
|
|
// Always display a blank page
|
|
'browser.newtabpage.enabled': false,
|
|
// Background thumbnails in particular cause grief: and disabling
|
|
// thumbnails in general cannot hurt
|
|
'browser.pagethumbnails.capturing_disabled': true,
|
|
// Disable safebrowsing components.
|
|
'browser.safebrowsing.blockedURIs.enabled': false,
|
|
'browser.safebrowsing.downloads.enabled': false,
|
|
'browser.safebrowsing.malware.enabled': false,
|
|
'browser.safebrowsing.phishing.enabled': false,
|
|
// Disable updates to search engines.
|
|
'browser.search.update': false,
|
|
// Do not restore the last open set of tabs if the browser has crashed
|
|
'browser.sessionstore.resume_from_crash': false,
|
|
// Skip check for default browser on startup
|
|
'browser.shell.checkDefaultBrowser': false,
|
|
// Disable newtabpage
|
|
'browser.startup.homepage': 'about:blank',
|
|
// Do not redirect user when a milstone upgrade of Firefox is detected
|
|
'browser.startup.homepage_override.mstone': 'ignore',
|
|
// Start with a blank page about:blank
|
|
'browser.startup.page': 0,
|
|
// 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
|
|
'browser.tabs.disableBackgroundZombification': false,
|
|
// Do not warn when closing all other open tabs
|
|
'browser.tabs.warnOnCloseOtherTabs': false,
|
|
// Do not warn when multiple tabs will be opened
|
|
'browser.tabs.warnOnOpen': false,
|
|
// Do not automatically offer translations, as tests do not expect this.
|
|
'browser.translations.automaticallyPopup': false,
|
|
// Disable the UI tour.
|
|
'browser.uitour.enabled': false,
|
|
// Turn off search suggestions in the location bar so as not to trigger
|
|
// network connections.
|
|
'browser.urlbar.suggest.searches': false,
|
|
// Disable first run splash page on Windows 10
|
|
'browser.usedOnWindows10.introURL': '',
|
|
// Do not warn on quitting Firefox
|
|
'browser.warnOnQuit': false,
|
|
// Defensively disable data reporting systems
|
|
'datareporting.healthreport.documentServerURI': `http://${server}/dummy/healthreport/`,
|
|
'datareporting.healthreport.logging.consoleEnabled': false,
|
|
'datareporting.healthreport.service.enabled': false,
|
|
'datareporting.healthreport.service.firstRun': false,
|
|
'datareporting.healthreport.uploadEnabled': false,
|
|
// Do not show datareporting policy notifications which can interfere with tests
|
|
'datareporting.policy.dataSubmissionEnabled': false,
|
|
'datareporting.policy.dataSubmissionPolicyBypassNotification': true,
|
|
// DevTools JSONViewer sometimes fails to load dependencies with its require.js.
|
|
// This doesn't affect Puppeteer but spams console (Bug 1424372)
|
|
'devtools.jsonview.enabled': false,
|
|
// Disable popup-blocker
|
|
'dom.disable_open_during_load': false,
|
|
// Enable the support for File object creation in the content process
|
|
// Required for |Page.setFileInputFiles| protocol method.
|
|
'dom.file.createInChild': true,
|
|
// Disable the ProcessHangMonitor
|
|
'dom.ipc.reportProcessHangs': false,
|
|
// Disable slow script dialogues
|
|
'dom.max_chrome_script_run_time': 0,
|
|
'dom.max_script_run_time': 0,
|
|
// Only load extensions from the application and user profile
|
|
// AddonManager.SCOPE_PROFILE + AddonManager.SCOPE_APPLICATION
|
|
'extensions.autoDisableScopes': 0,
|
|
'extensions.enabledScopes': 5,
|
|
// Disable metadata caching for installed add-ons by default
|
|
'extensions.getAddons.cache.enabled': false,
|
|
// Disable installing any distribution extensions or add-ons.
|
|
'extensions.installDistroAddons': false,
|
|
// Turn off extension updates so they do not bother tests
|
|
'extensions.update.enabled': false,
|
|
// Turn off extension updates so they do not bother tests
|
|
'extensions.update.notifyUser': false,
|
|
// Make sure opening about:addons will not hit the network
|
|
'extensions.webservice.discoverURL': `http://${server}/dummy/discoveryURL`,
|
|
// Allow the application to have focus even it runs in the background
|
|
'focusmanager.testmode': true,
|
|
// Disable useragent updates
|
|
'general.useragent.updates.enabled': false,
|
|
// Always use network provider for geolocation tests so we bypass the
|
|
// macOS dialog raised by the corelocation provider
|
|
'geo.provider.testing': true,
|
|
// Do not scan Wifi
|
|
'geo.wifi.scan': false,
|
|
// No hang monitor
|
|
'hangmonitor.timeout': 0,
|
|
// Show chrome errors and warnings in the error console
|
|
'javascript.options.showInConsole': true,
|
|
// Disable download and usage of OpenH264: and Widevine plugins
|
|
'media.gmp-manager.updateEnabled': false,
|
|
// Disable the GFX sanity window
|
|
'media.sanity-test.disabled': true,
|
|
// Disable experimental feature that is only available in Nightly
|
|
'network.cookie.sameSite.laxByDefault': false,
|
|
// Do not prompt for temporary redirects
|
|
'network.http.prompt-temp-redirect': false,
|
|
// Disable speculative connections so they are not reported as leaking
|
|
// when they are hanging around
|
|
'network.http.speculative-parallel-limit': 0,
|
|
// Do not automatically switch between offline and online
|
|
'network.manage-offline-status': false,
|
|
// Make sure SNTP requests do not hit the network
|
|
'network.sntp.pools': server,
|
|
// Disable Flash.
|
|
'plugin.state.flash': 0,
|
|
'privacy.trackingprotection.enabled': false,
|
|
// Can be removed once Firefox 89 is no longer supported
|
|
// https://bugzilla.mozilla.org/show_bug.cgi?id=1710839
|
|
'remote.enabled': true,
|
|
// Disabled screenshots component
|
|
'screenshots.browser.component.enabled': false,
|
|
// Don't do network connections for mitm priming
|
|
'security.certerrors.mitm.priming.enabled': false,
|
|
// Local documents have access to all other local documents,
|
|
// including directory listings
|
|
'security.fileuri.strict_origin_policy': false,
|
|
// Do not wait for the notification button security delay
|
|
'security.notification_enable_delay': 0,
|
|
// Ensure blocklist updates do not hit the network
|
|
'services.settings.server': `http://${server}/dummy/blocklist/`,
|
|
// Do not automatically fill sign-in forms with known usernames and
|
|
// passwords
|
|
'signon.autofillForms': false,
|
|
// Disable password capture, so that tests that include forms are not
|
|
// influenced by the presence of the persistent doorhanger notification
|
|
'signon.rememberSignons': false,
|
|
// Disable first-run welcome page
|
|
'startup.homepage_welcome_url': 'about:blank',
|
|
// Disable first-run welcome page
|
|
'startup.homepage_welcome_url.additional': '',
|
|
// Disable browser animations (tabs, fullscreen, sliding alerts)
|
|
'toolkit.cosmeticAnimations.enabled': false,
|
|
// Prevent starting into safe mode after application crashes
|
|
'toolkit.startup.max_resumed_crashes': -1,
|
|
};
|
|
return Object.assign(defaultPrefs, extraPrefs);
|
|
}
|
|
async function backupFile(input) {
|
|
if (!node_fs_1.default.existsSync(input)) {
|
|
return;
|
|
}
|
|
await node_fs_1.default.promises.copyFile(input, input + '.puppeteer');
|
|
}
|
|
/**
|
|
* Populates the user.js file with custom preferences as needed to allow
|
|
* Firefox's support to properly function. These preferences will be
|
|
* automatically copied over to prefs.js during startup of Firefox. To be
|
|
* able to restore the original values of preferences a backup of prefs.js
|
|
* will be created.
|
|
*/
|
|
async function syncPreferences(options) {
|
|
const prefsPath = node_path_1.default.join(options.path, 'prefs.js');
|
|
const userPath = node_path_1.default.join(options.path, 'user.js');
|
|
const lines = Object.entries(options.preferences).map(([key, value]) => {
|
|
return `user_pref(${JSON.stringify(key)}, ${JSON.stringify(value)});`;
|
|
});
|
|
// Use allSettled to prevent corruption.
|
|
const result = await Promise.allSettled([
|
|
backupFile(userPath).then(async () => {
|
|
await node_fs_1.default.promises.writeFile(userPath, lines.join('\n'));
|
|
}),
|
|
backupFile(prefsPath),
|
|
]);
|
|
for (const command of result) {
|
|
if (command.status === 'rejected') {
|
|
throw command.reason;
|
|
}
|
|
}
|
|
}
|
|
function compareVersions(a, b) {
|
|
// TODO: this is a not very reliable check.
|
|
return parseInt(a.replace('.', ''), 16) - parseInt(b.replace('.', ''), 16);
|
|
}
|
|
//# sourceMappingURL=firefox.js.map
|