tor-browser

FirefoxLauncher.ts (5885B)

---

/**
* @license
* Copyright 2023 Google Inc.
* SPDX-License-Identifier: Apache-2.0
*/

import fs from 'node:fs';
import {rename, unlink, mkdtemp} from 'node:fs/promises';
import os from 'node:os';
import path from 'node:path';

import {Browser as SupportedBrowsers, createProfile} from '@puppeteer/browsers';

import {debugError} from '../common/util.js';
import {assert} from '../util/assert.js';

import {BrowserLauncher, type ResolvedLaunchArgs} from './BrowserLauncher.js';
import type {LaunchOptions} from './LaunchOptions.js';
import type {PuppeteerNode} from './PuppeteerNode.js';
import {rm} from './util/fs.js';

/**
* @internal
*/
export class FirefoxLauncher extends BrowserLauncher {
 constructor(puppeteer: PuppeteerNode) {
   super(puppeteer, 'firefox');
 }

 static getPreferences(
   extraPrefsFirefox?: Record<string, unknown>,
 ): Record<string, unknown> {
   return {
     ...extraPrefsFirefox,
     // Force all web content to use a single content process. TODO: remove
     // this once Firefox supports mouse event dispatch from the main frame
     // context. See https://bugzilla.mozilla.org/show_bug.cgi?id=1773393.
     'fission.webContentIsolationStrategy': 0,
   };
 }

 /**
  * @internal
  */
 override async computeLaunchArguments(
   options: LaunchOptions = {},
 ): Promise<ResolvedLaunchArgs> {
   const {
     ignoreDefaultArgs = false,
     args = [],
     executablePath,
     pipe = false,
     extraPrefsFirefox = {},
     debuggingPort = null,
   } = options;

   const firefoxArguments = [];
   if (!ignoreDefaultArgs) {
     firefoxArguments.push(...this.defaultArgs(options));
   } else if (Array.isArray(ignoreDefaultArgs)) {
     firefoxArguments.push(
       ...this.defaultArgs(options).filter(arg => {
         return !ignoreDefaultArgs.includes(arg);
       }),
     );
   } else {
     firefoxArguments.push(...args);
   }

   if (
     !firefoxArguments.some(argument => {
       return argument.startsWith('--remote-debugging-');
     })
   ) {
     if (pipe) {
       assert(
         debuggingPort === null,
         'Browser should be launched with either pipe or debugging port - not both.',
       );
     }
     firefoxArguments.push(`--remote-debugging-port=${debuggingPort || 0}`);
   }

   let userDataDir: string | undefined;
   let isTempUserDataDir = true;

   // Check for the profile argument, which will always be set even
   // with a custom directory specified via the userDataDir option.
   const profileArgIndex = firefoxArguments.findIndex(arg => {
     return ['-profile', '--profile'].includes(arg);
   });

   if (profileArgIndex !== -1) {
     userDataDir = firefoxArguments[profileArgIndex + 1];
     if (!userDataDir) {
       throw new Error(`Missing value for profile command line argument`);
     }

     // When using a custom Firefox profile it needs to be populated
     // with required preferences.
     isTempUserDataDir = false;
   } else {
     userDataDir = await mkdtemp(this.getProfilePath());
     firefoxArguments.push('--profile');
     firefoxArguments.push(userDataDir);
   }

   await createProfile(SupportedBrowsers.FIREFOX, {
     path: userDataDir,
     preferences: FirefoxLauncher.getPreferences(extraPrefsFirefox),
   });

   let firefoxExecutable: string;
   if (this.puppeteer._isPuppeteerCore || executablePath) {
     assert(
       executablePath,
       `An \`executablePath\` must be specified for \`puppeteer-core\``,
     );
     firefoxExecutable = executablePath;
   } else {
     firefoxExecutable = this.executablePath(undefined);
   }

   return {
     isTempUserDataDir,
     userDataDir,
     args: firefoxArguments,
     executablePath: firefoxExecutable,
   };
 }

 /**
  * @internal
  */
 override async cleanUserDataDir(
   userDataDir: string,
   opts: {isTemp: boolean},
 ): Promise<void> {
   if (opts.isTemp) {
     try {
       await rm(userDataDir);
     } catch (error) {
       debugError(error);
       throw error;
     }
   } else {
     try {
       const backupSuffix = '.puppeteer';
       const backupFiles = ['prefs.js', 'user.js'];

       const results = await Promise.allSettled(
         backupFiles.map(async file => {
           const prefsBackupPath = path.join(userDataDir, file + backupSuffix);
           if (fs.existsSync(prefsBackupPath)) {
             const prefsPath = path.join(userDataDir, file);
             await unlink(prefsPath);
             await rename(prefsBackupPath, prefsPath);
           }
         }),
       );
       for (const result of results) {
         if (result.status === 'rejected') {
           throw result.reason;
         }
       }
     } catch (error) {
       debugError(error);
     }
   }
 }

 override executablePath(_: unknown, validatePath = true): string {
   return this.resolveExecutablePath(
     undefined,
     /* validatePath=*/ validatePath,
   );
 }

 override defaultArgs(options: LaunchOptions = {}): string[] {
   const {
     devtools = false,
     headless = !devtools,
     args = [],
     userDataDir = null,
   } = options;

   const firefoxArguments = [];

   switch (os.platform()) {
     case 'darwin':
       firefoxArguments.push('--foreground');
       break;
     case 'win32':
       firefoxArguments.push('--wait-for-browser');
       break;
   }
   if (userDataDir) {
     firefoxArguments.push('--profile');
     firefoxArguments.push(userDataDir);
   }
   if (headless) {
     firefoxArguments.push('--headless');
   }
   if (devtools) {
     firefoxArguments.push('--devtools');
   }
   if (
     args.every(arg => {
       return arg.startsWith('-');
     })
   ) {
     firefoxArguments.push('about:blank');
   }
   firefoxArguments.push(...args);
   return firefoxArguments;
 }
}