web-ext-run/lib/cmd/run.js

A tool to open and run web extensions

import path from 'path';
import fs from 'fs/promises';
import nodeFs from 'fs';
import defaultBuildExtension from './build.js';
import { showDesktopNotification as defaultDesktopNotifications } from '../util/desktop-notifier.js';
import * as defaultFirefoxApp from '../firefox/index.js';
import { connectWithMaxRetries as defaultFirefoxClient } from '../firefox/remote.js';
import { createLogger } from '../util/logger.js';
import defaultGetValidatedManifest from '../util/manifest.js';
import { UsageError } from '../errors.js';
import { createExtensionRunner, defaultReloadStrategy, MultiExtensionRunner as DefaultMultiExtensionRunner } from '../extension-runners/index.js';
const log = createLogger(import.meta.url);

// Run command types and implementation.

export default async function run({
  artifactsDir,
  browserConsole = false,
  devtools = false,
  pref,
  firefox,
  firefoxProfile,
  profileCreateIfMissing,
  keepProfileChanges = false,
  ignoreFiles,
  noInput = false,
  noReload = false,
  preInstall = false,
  noReloadManagerExtension = false,
  sourceDir,
  watchFile,
  watchIgnored,
  startUrl,
  target,
  args,
  // Android CLI options.
  adbBin,
  adbHost,
  adbPort,
  adbDevice,
  adbDiscoveryTimeout,
  adbRemoveOldArtifacts,
  firefoxApk,
  firefoxApkComponent,
  // Chromium CLI options.
  chromiumBinary,
  chromiumPref,
  chromiumProfile,
  chromiumPort
}, {
  buildExtension = defaultBuildExtension,
  desktopNotifications = defaultDesktopNotifications,
  firefoxApp = defaultFirefoxApp,
  firefoxClient = defaultFirefoxClient,
  reloadStrategy = defaultReloadStrategy,
  MultiExtensionRunner = DefaultMultiExtensionRunner,
  getValidatedManifest = defaultGetValidatedManifest
} = {}) {
  sourceDir = path.resolve(sourceDir);
  log.info(`Running web extension from ${sourceDir}`);
  if (preInstall) {
    log.info("Disabled auto-reloading because it's not possible with " + '--pre-install');
    noReload = true;
  }
  if (watchFile != null && (!Array.isArray(watchFile) || !watchFile.every(el => typeof el === 'string'))) {
    throw new UsageError('Unexpected watchFile type');
  }

  // Create an alias for --pref since it has been transformed into an
  // object containing one or more preferences.
  const customPrefs = {
    ...pref
  };

  // Create an alias for --chromium-pref since it has been transformed into an
  // object containing one or more preferences.
  const customChromiumPrefs = {
    ...chromiumPref
  };
  const manifestData = await getValidatedManifest(sourceDir);
  const profileDir = firefoxProfile || chromiumProfile;
  if (profileCreateIfMissing) {
    if (!profileDir) {
      throw new UsageError('--profile-create-if-missing requires ' + '--firefox-profile or --chromium-profile');
    }
    const isDir = nodeFs.existsSync(profileDir);
    if (isDir) {
      log.info(`Profile directory ${profileDir} already exists`);
    } else {
      log.info(`Profile directory not found. Creating directory ${profileDir}`);
      await fs.mkdir(profileDir);
    }
  }
  const runners = [];
  const commonRunnerParams = {
    // Common options.
    extensions: [{
      sourceDir,
      manifestData
    }],
    keepProfileChanges,
    startUrl,
    args,
    desktopNotifications
  };
  if (!target || target.length === 0 || target.includes('firefox-desktop')) {
    const firefoxDesktopRunnerParams = {
      ...commonRunnerParams,
      // Firefox specific CLI options.
      firefoxBinary: firefox,
      profilePath: firefoxProfile,
      customPrefs,
      browserConsole,
      devtools,
      preInstall,
      // Firefox runner injected dependencies.
      firefoxApp,
      firefoxClient
    };
    const firefoxDesktopRunner = await createExtensionRunner({
      target: 'firefox-desktop',
      params: firefoxDesktopRunnerParams
    });
    runners.push(firefoxDesktopRunner);
  }
  if (target && target.includes('firefox-android')) {
    const firefoxAndroidRunnerParams = {
      ...commonRunnerParams,
      // Firefox specific CLI options.
      profilePath: firefoxProfile,
      customPrefs,
      browserConsole,
      preInstall,
      firefoxApk,
      firefoxApkComponent,
      adbDevice,
      adbHost,
      adbPort,
      adbBin,
      adbDiscoveryTimeout,
      adbRemoveOldArtifacts,
      // Injected dependencies.
      firefoxApp,
      firefoxClient,
      desktopNotifications: defaultDesktopNotifications,
      buildSourceDir: (extensionSourceDir, tmpArtifactsDir) => {
        return buildExtension({
          sourceDir: extensionSourceDir,
          ignoreFiles,
          asNeeded: false,
          // Use a separate temporary directory for building the extension zip file
          // that we are going to upload on the android device.
          artifactsDir: tmpArtifactsDir
        }, {
          // Suppress the message usually logged by web-ext build.
          showReadyMessage: false
        });
      }
    };
    const firefoxAndroidRunner = await createExtensionRunner({
      target: 'firefox-android',
      params: firefoxAndroidRunnerParams
    });
    runners.push(firefoxAndroidRunner);
  }
  if (target && target.includes('chromium')) {
    const chromiumRunnerParams = {
      ...commonRunnerParams,
      chromiumBinary,
      chromiumProfile,
      customChromiumPrefs,
      chromiumPort,
      noReloadManagerExtension
    };
    const chromiumRunner = await createExtensionRunner({
      target: 'chromium',
      params: chromiumRunnerParams
    });
    runners.push(chromiumRunner);
  }
  const extensionRunner = new MultiExtensionRunner({
    desktopNotifications,
    runners
  });
  await extensionRunner.run();
  if (noReload) {
    log.info('Automatic extension reloading has been disabled');
  } else {
    log.info('The extension will reload if any source file changes');
    reloadStrategy({
      extensionRunner,
      sourceDir,
      watchFile,
      watchIgnored,
      artifactsDir,
      ignoreFiles,
      noInput
    });
  }
  return extensionRunner;
}
//# sourceMappingURL=run.js.map