Node updated. Some todos.

Scripts/node_modules/@puppeteer/browsers/src/browser-data/browser-data.ts

@@ -43,31 +43,47 @@ export const executablePathByBrowser = {
   [Browser.FIREFOX]: firefox.relativeExecutablePath,
 };
 
+export const versionComparators = {
+  [Browser.CHROMEDRIVER]: chromedriver.compareVersions,
+  [Browser.CHROMEHEADLESSSHELL]: chromeHeadlessShell.compareVersions,
+  [Browser.CHROME]: chrome.compareVersions,
+  [Browser.CHROMIUM]: chromium.compareVersions,
+  [Browser.FIREFOX]: firefox.compareVersions,
+};
+
 export {Browser, BrowserPlatform, ChromeReleaseChannel};
 
 /**
- * @public
+ * @internal
  */
-export async function resolveBuildId(
+async function resolveBuildIdForBrowserTag(
   browser: Browser,
   platform: BrowserPlatform,
-  tag: string
+  tag: BrowserTag
 ): Promise<string> {
   switch (browser) {
     case Browser.FIREFOX:
-      switch (tag as BrowserTag) {
+      switch (tag) {
         case BrowserTag.LATEST:
-          return await firefox.resolveBuildId('FIREFOX_NIGHTLY');
+          return await firefox.resolveBuildId(firefox.FirefoxChannel.NIGHTLY);
         case BrowserTag.BETA:
+          return await firefox.resolveBuildId(firefox.FirefoxChannel.BETA);
+        case BrowserTag.NIGHTLY:
+          return await firefox.resolveBuildId(firefox.FirefoxChannel.NIGHTLY);
+        case BrowserTag.DEVEDITION:
+          return await firefox.resolveBuildId(
+            firefox.FirefoxChannel.DEVEDITION
+          );
+        case BrowserTag.STABLE:
+          return await firefox.resolveBuildId(firefox.FirefoxChannel.STABLE);
+        case BrowserTag.ESR:
+          return await firefox.resolveBuildId(firefox.FirefoxChannel.ESR);
         case BrowserTag.CANARY:
         case BrowserTag.DEV:
-        case BrowserTag.STABLE:
-          throw new Error(
-            `${tag} is not supported for ${browser}. Use 'latest' instead.`
-          );
+          throw new Error(`${tag.toUpperCase()} is not available for Firefox`);
       }
     case Browser.CHROME: {
-      switch (tag as BrowserTag) {
+      switch (tag) {
         case BrowserTag.LATEST:
           return await chrome.resolveBuildId(ChromeReleaseChannel.CANARY);
         case BrowserTag.BETA:
@@ -78,13 +94,11 @@ export async function resolveBuildId(
           return await chrome.resolveBuildId(ChromeReleaseChannel.DEV);
         case BrowserTag.STABLE:
           return await chrome.resolveBuildId(ChromeReleaseChannel.STABLE);
-        default:
-          const result = await chrome.resolveBuildId(tag);
-          if (result) {
-            return result;
-          }
+        case BrowserTag.NIGHTLY:
+        case BrowserTag.DEVEDITION:
+        case BrowserTag.ESR:
+          throw new Error(`${tag.toUpperCase()} is not available for Chrome`);
       }
-      return tag;
     }
     case Browser.CHROMEDRIVER: {
       switch (tag) {
@@ -97,13 +111,13 @@ export async function resolveBuildId(
           return await chromedriver.resolveBuildId(ChromeReleaseChannel.DEV);
         case BrowserTag.STABLE:
           return await chromedriver.resolveBuildId(ChromeReleaseChannel.STABLE);
-        default:
-          const result = await chromedriver.resolveBuildId(tag);
-          if (result) {
-            return result;
-          }
+        case BrowserTag.NIGHTLY:
+        case BrowserTag.DEVEDITION:
+        case BrowserTag.ESR:
+          throw new Error(
+            `${tag.toUpperCase()} is not available for ChromeDriver`
+          );
       }
-      return tag;
     }
     case Browser.CHROMEHEADLESSSHELL: {
       switch (tag) {
@@ -124,29 +138,68 @@ export async function resolveBuildId(
           return await chromeHeadlessShell.resolveBuildId(
             ChromeReleaseChannel.STABLE
           );
-        default:
-          const result = await chromeHeadlessShell.resolveBuildId(tag);
-          if (result) {
-            return result;
-          }
+        case BrowserTag.NIGHTLY:
+        case BrowserTag.DEVEDITION:
+        case BrowserTag.ESR:
+          throw new Error(`${tag} is not available for chrome-headless-shell`);
       }
-      return tag;
     }
     case Browser.CHROMIUM:
-      switch (tag as BrowserTag) {
+      switch (tag) {
         case BrowserTag.LATEST:
           return await chromium.resolveBuildId(platform);
-        case BrowserTag.BETA:
+        case BrowserTag.NIGHTLY:
         case BrowserTag.CANARY:
         case BrowserTag.DEV:
+        case BrowserTag.DEVEDITION:
+        case BrowserTag.BETA:
         case BrowserTag.STABLE:
+        case BrowserTag.ESR:
           throw new Error(
-            `${tag} is not supported for ${browser}. Use 'latest' instead.`
+            `${tag} is not supported for Chromium. Use 'latest' instead.`
           );
       }
   }
-  // We assume the tag is the buildId if it didn't match any keywords.
-  return tag;
+}
+
+/**
+ * @public
+ */
+export async function resolveBuildId(
+  browser: Browser,
+  platform: BrowserPlatform,
+  tag: string
+): Promise<string> {
+  const browserTag = tag as BrowserTag;
+  if (Object.values(BrowserTag).includes(browserTag)) {
+    return await resolveBuildIdForBrowserTag(browser, platform, browserTag);
+  }
+
+  switch (browser) {
+    case Browser.FIREFOX:
+      return tag;
+    case Browser.CHROME:
+      const chromeResult = await chrome.resolveBuildId(tag);
+      if (chromeResult) {
+        return chromeResult;
+      }
+      return tag;
+    case Browser.CHROMEDRIVER:
+      const chromeDriverResult = await chromedriver.resolveBuildId(tag);
+      if (chromeDriverResult) {
+        return chromeDriverResult;
+      }
+      return tag;
+    case Browser.CHROMEHEADLESSSHELL:
+      const chromeHeadlessShellResult =
+        await chromeHeadlessShell.resolveBuildId(tag);
+      if (chromeHeadlessShellResult) {
+        return chromeHeadlessShellResult;
+      }
+      return tag;
+    case Browser.CHROMIUM:
+      return tag;
+  }
 }
 
 /**
@@ -185,3 +238,15 @@ export function resolveSystemExecutablePath(
       return chrome.resolveSystemExecutablePath(platform, channel);
   }
 }
+
+/**
+ * Returns a version comparator for the given browser that can be used to sort
+ * browser versions.
+ *
+ * @public
+ */
+export function getVersionComparator(
+  browser: Browser
+): (a: string, b: string) => number {
+  return versionComparators[browser];
+}

Scripts/node_modules/@puppeteer/browsers/src/browser-data/chrome-headless-shell.ts

@@ -25,7 +25,7 @@ function folder(platform: BrowserPlatform): string {
 export function resolveDownloadUrl(
   platform: BrowserPlatform,
   buildId: string,
-  baseUrl = 'https://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing'
+  baseUrl = 'https://storage.googleapis.com/chrome-for-testing-public'
 ): string {
   return `${baseUrl}/${resolveDownloadPath(platform, buildId).join('/')}`;
 }
@@ -66,4 +66,4 @@ export function relativeExecutablePath(
   }
 }
 
-export {resolveBuildId} from './chrome.js';
+export {resolveBuildId, compareVersions} from './chrome.js';

Scripts/node_modules/@puppeteer/browsers/src/browser-data/chrome.ts

@@ -6,6 +6,8 @@
 
 import path from 'path';
 
+import semver from 'semver';
+
 import {getJSON} from '../httpUtil.js';
 
 import {BrowserPlatform, ChromeReleaseChannel} from './types.js';
@@ -28,7 +30,7 @@ function folder(platform: BrowserPlatform): string {
 export function resolveDownloadUrl(
   platform: BrowserPlatform,
   buildId: string,
-  baseUrl = 'https://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing'
+  baseUrl = 'https://storage.googleapis.com/chrome-for-testing-public'
 ): string {
   return `${baseUrl}/${resolveDownloadPath(platform, buildId).join('/')}`;
 }
@@ -193,3 +195,19 @@ export function resolveSystemExecutablePath(
     `Unable to detect browser executable path for '${channel}' on ${platform}.`
   );
 }
+
+export function compareVersions(a: string, b: string): number {
+  if (!semver.valid(a)) {
+    throw new Error(`Version ${a} is not a valid semver version`);
+  }
+  if (!semver.valid(b)) {
+    throw new Error(`Version ${b} is not a valid semver version`);
+  }
+  if (semver.gt(a, b)) {
+    return 1;
+  } else if (semver.lt(a, b)) {
+    return -1;
+  } else {
+    return 0;
+  }
+}

Scripts/node_modules/@puppeteer/browsers/src/browser-data/chromedriver.ts

@@ -25,7 +25,7 @@ function folder(platform: BrowserPlatform): string {
 export function resolveDownloadUrl(
   platform: BrowserPlatform,
   buildId: string,
-  baseUrl = 'https://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing'
+  baseUrl = 'https://storage.googleapis.com/chrome-for-testing-public'
 ): string {
   return `${baseUrl}/${resolveDownloadPath(platform, buildId).join('/')}`;
 }
@@ -53,4 +53,4 @@ export function relativeExecutablePath(
   }
 }
 
-export {resolveBuildId} from './chrome.js';
+export {resolveBuildId, compareVersions} from './chrome.js';

Scripts/node_modules/@puppeteer/browsers/src/browser-data/chromium.ts

@@ -86,3 +86,7 @@ export async function resolveBuildId(
     )
   );
 }
+
+export function compareVersions(a: string, b: string): number {
+  return Number(a) - Number(b);
+}

Scripts/node_modules/@puppeteer/browsers/src/browser-data/firefox.ts

@@ -11,7 +11,7 @@ import {getJSON} from '../httpUtil.js';
 
 import {BrowserPlatform, type ProfileOptions} from './types.js';
 
-function archive(platform: BrowserPlatform, buildId: string): string {
+function archiveNightly(platform: BrowserPlatform, buildId: string): string {
   switch (platform) {
     case BrowserPlatform.LINUX:
       return `firefox-${buildId}.en-US.${platform}-x86_64.tar.bz2`;
@@ -24,11 +24,63 @@ function archive(platform: BrowserPlatform, buildId: string): string {
   }
 }
 
+function archive(platform: BrowserPlatform, buildId: string): string {
+  switch (platform) {
+    case BrowserPlatform.LINUX:
+      return `firefox-${buildId}.tar.bz2`;
+    case BrowserPlatform.MAC_ARM:
+    case BrowserPlatform.MAC:
+      return `Firefox ${buildId}.dmg`;
+    case BrowserPlatform.WIN32:
+    case BrowserPlatform.WIN64:
+      return `Firefox Setup ${buildId}.exe`;
+  }
+}
+
+function platformName(platform: BrowserPlatform): string {
+  switch (platform) {
+    case BrowserPlatform.LINUX:
+      return `linux-x86_64`;
+    case BrowserPlatform.MAC_ARM:
+    case BrowserPlatform.MAC:
+      return `mac`;
+    case BrowserPlatform.WIN32:
+    case BrowserPlatform.WIN64:
+      return platform;
+  }
+}
+
+function parseBuildId(buildId: string): [FirefoxChannel, string] {
+  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];
+}
+
 export function resolveDownloadUrl(
   platform: BrowserPlatform,
   buildId: string,
-  baseUrl = 'https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central'
+  baseUrl?: string
 ): string {
+  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('/')}`;
 }
 
@@ -36,36 +88,88 @@ export function resolveDownloadPath(
   platform: BrowserPlatform,
   buildId: string
 ): string[] {
-  return [archive(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),
+      ];
+  }
 }
 
 export function relativeExecutablePath(
   platform: BrowserPlatform,
-  _buildId: string
+  buildId: string
 ): string {
-  switch (platform) {
-    case BrowserPlatform.MAC_ARM:
-    case BrowserPlatform.MAC:
-      return path.join('Firefox Nightly.app', 'Contents', 'MacOS', 'firefox');
-    case BrowserPlatform.LINUX:
-      return path.join('firefox', 'firefox');
-    case BrowserPlatform.WIN32:
-    case BrowserPlatform.WIN64:
-      return path.join('firefox', 'firefox.exe');
+  const [channel] = parseBuildId(buildId);
+  switch (channel) {
+    case FirefoxChannel.NIGHTLY:
+      switch (platform) {
+        case BrowserPlatform.MAC_ARM:
+        case BrowserPlatform.MAC:
+          return path.join(
+            'Firefox Nightly.app',
+            'Contents',
+            'MacOS',
+            'firefox'
+          );
+        case BrowserPlatform.LINUX:
+          return path.join('firefox', 'firefox');
+        case BrowserPlatform.WIN32:
+        case BrowserPlatform.WIN64:
+          return path.join('firefox', 'firefox.exe');
+      }
+    case FirefoxChannel.BETA:
+    case FirefoxChannel.DEVEDITION:
+    case FirefoxChannel.ESR:
+    case FirefoxChannel.STABLE:
+      switch (platform) {
+        case BrowserPlatform.MAC_ARM:
+        case BrowserPlatform.MAC:
+          return path.join('Firefox.app', 'Contents', 'MacOS', 'firefox');
+        case BrowserPlatform.LINUX:
+          return path.join('firefox', 'firefox');
+        case BrowserPlatform.WIN32:
+        case BrowserPlatform.WIN64:
+          return path.join('core', 'firefox.exe');
+      }
   }
 }
 
+export enum FirefoxChannel {
+  STABLE = 'stable',
+  ESR = 'esr',
+  DEVEDITION = 'devedition',
+  BETA = 'beta',
+  NIGHTLY = 'nightly',
+}
+
 export async function resolveBuildId(
-  channel: 'FIREFOX_NIGHTLY' = 'FIREFOX_NIGHTLY'
+  channel: FirefoxChannel = FirefoxChannel.NIGHTLY
 ): Promise<string> {
+  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 getJSON(
     new URL('https://product-details.mozilla.org/1.0/firefox_versions.json')
   )) as Record<string, string>;
-  const version = versions[channel];
+  const version = versions[channelToVersionKey[channel]];
   if (!version) {
     throw new Error(`Channel ${channel} is not found.`);
   }
-  return version;
+  return channel + '_' + version;
 }
 
 export async function createProfile(options: ProfileOptions): Promise<void> {
@@ -74,7 +178,7 @@ export async function createProfile(options: ProfileOptions): Promise<void> {
       recursive: true,
     });
   }
-  await writePreferences({
+  await syncPreferences({
     preferences: {
       ...defaultProfilePreferences(options.preferences),
       ...options.preferences,
@@ -235,10 +339,6 @@ function defaultProfilePreferences(
     // Disable the GFX sanity window
     'media.sanity-test.disabled': true,
 
-    // Prevent various error message on the console
-    // jest-puppeteer asserts that no error message is emitted by the console
-    'network.cookie.cookieBehavior': 0,
-
     // Disable experimental feature that is only available in Nightly
     'network.cookie.sameSite.laxByDefault': false,
 
@@ -301,30 +401,43 @@ function defaultProfilePreferences(
   return Object.assign(defaultPrefs, extraPrefs);
 }
 
+async function backupFile(input: string): Promise<void> {
+  if (!fs.existsSync(input)) {
+    return;
+  }
+  await fs.promises.copyFile(input, input + '.puppeteer');
+}
+
 /**
  * Populates the user.js file with custom preferences as needed to allow
- * Firefox's CDP support to properly function. These preferences will be
+ * 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.
- *
- * @param prefs - List of preferences to add.
- * @param profilePath - Firefox profile to write the preferences to.
  */
-async function writePreferences(options: ProfileOptions): Promise<void> {
+async function syncPreferences(options: ProfileOptions): Promise<void> {
+  const prefsPath = path.join(options.path, 'prefs.js');
+  const userPath = path.join(options.path, 'user.js');
+
   const lines = Object.entries(options.preferences).map(([key, value]) => {
     return `user_pref(${JSON.stringify(key)}, ${JSON.stringify(value)});`;
   });
 
-  await fs.promises.writeFile(
-    path.join(options.path, 'user.js'),
-    lines.join('\n')
-  );
-
-  // Create a backup of the preferences file if it already exitsts.
-  const prefsPath = path.join(options.path, 'prefs.js');
-  if (fs.existsSync(prefsPath)) {
-    const prefsBackupPath = path.join(options.path, 'prefs.js.puppeteer');
-    await fs.promises.copyFile(prefsPath, prefsBackupPath);
+  // Use allSettled to prevent corruption.
+  const result = await Promise.allSettled([
+    backupFile(userPath).then(async () => {
+      await fs.promises.writeFile(userPath, lines.join('\n'));
+    }),
+    backupFile(prefsPath),
+  ]);
+  for (const command of result) {
+    if (command.status === 'rejected') {
+      throw command.reason;
+    }
   }
 }
+
+export function compareVersions(a: string, b: string): number {
+  // TODO: this is a not very reliable check.
+  return parseInt(a.replace('.', ''), 16) - parseInt(b.replace('.', ''), 16);
+}

Scripts/node_modules/@puppeteer/browsers/src/browser-data/types.ts

@@ -36,9 +36,12 @@ export enum BrowserPlatform {
  */
 export enum BrowserTag {
   CANARY = 'canary',
+  NIGHTLY = 'nightly',
   BETA = 'beta',
   DEV = 'dev',
+  DEVEDITION = 'devedition',
   STABLE = 'stable',
+  ESR = 'esr',
   LATEST = 'latest',
 }