web-ext 6.6.0 → 7.0.0

package/src/cmd/run.js

@@ -1,266 +0,0 @@
-/* @flow */
-import { fs } from 'mz';
-
-import defaultBuildExtension from './build';
-import {
-  showDesktopNotification as defaultDesktopNotifications,
-} from '../util/desktop-notifier';
-import * as defaultFirefoxApp from '../firefox';
-import {
-  connectWithMaxRetries as defaultFirefoxClient,
-} from '../firefox/remote';
-import {createLogger} from '../util/logger';
-import defaultGetValidatedManifest from '../util/manifest';
-import {UsageError} from '../../src/errors';
-import {
-  createExtensionRunner,
-  defaultReloadStrategy,
-  MultiExtensionRunner as DefaultMultiExtensionRunner,
-} from '../extension-runners';
-// Import objects that are only used as Flow types.
-import type {FirefoxPreferences} from '../firefox/preferences';
-
-const log = createLogger(__filename);
-
-
-// Run command types and implementation.
-
-export type CmdRunParams = {|
-  artifactsDir: string,
-  browserConsole: boolean,
-  pref?: FirefoxPreferences,
-  firefox: string,
-  firefoxProfile?: string,
-  profileCreateIfMissing?: boolean,
-  ignoreFiles?: Array<string>,
-  keepProfileChanges: boolean,
-  noInput?: boolean,
-  noReload: boolean,
-  preInstall: boolean,
-  sourceDir: string,
-  watchFile?: Array<string>,
-  watchIgnored?: Array<string>,
-  startUrl?: Array<string>,
-  target?: Array<string>,
-  args?: Array<string>,
-
-  // Android CLI options.
-  adbBin?: string,
-  adbHost?: string,
-  adbPort?: string,
-  adbDevice?: string,
-  adbDiscoveryTimeout?: number,
-  adbRemoveOldArtifacts?: boolean,
-  firefoxApk?: string,
-  firefoxApkComponent?: string,
-
-  // Chromium Desktop CLI options.
-  chromiumBinary?: string,
-  chromiumProfile?: string,
-|};
-
-export type CmdRunOptions = {|
-  buildExtension: typeof defaultBuildExtension,
-  desktopNotifications: typeof defaultDesktopNotifications,
-  firefoxApp: typeof defaultFirefoxApp,
-  firefoxClient: typeof defaultFirefoxClient,
-  reloadStrategy: typeof defaultReloadStrategy,
-  shouldExitProgram?: boolean,
-  MultiExtensionRunner?: typeof DefaultMultiExtensionRunner,
-  getValidatedManifest?: typeof defaultGetValidatedManifest,
-|};
-
-export default async function run(
-  {
-    artifactsDir,
-    browserConsole = false,
-    pref,
-    firefox,
-    firefoxProfile,
-    profileCreateIfMissing,
-    keepProfileChanges = false,
-    ignoreFiles,
-    noInput = false,
-    noReload = false,
-    preInstall = false,
-    sourceDir,
-    watchFile,
-    watchIgnored,
-    startUrl,
-    target,
-    args,
-    // Android CLI options.
-    adbBin,
-    adbHost,
-    adbPort,
-    adbDevice,
-    adbDiscoveryTimeout,
-    adbRemoveOldArtifacts,
-    firefoxApk,
-    firefoxApkComponent,
-    // Chromium CLI options.
-    chromiumBinary,
-    chromiumProfile,
-  }: CmdRunParams,
-  {
-    buildExtension = defaultBuildExtension,
-    desktopNotifications = defaultDesktopNotifications,
-    firefoxApp = defaultFirefoxApp,
-    firefoxClient = defaultFirefoxClient,
-    reloadStrategy = defaultReloadStrategy,
-    MultiExtensionRunner = DefaultMultiExtensionRunner,
-    getValidatedManifest = defaultGetValidatedManifest,
-  }: CmdRunOptions = {}): Promise<DefaultMultiExtensionRunner> {
-
-  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;
-  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 = fs.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,
-      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: string, tmpArtifactsDir: string) => {
-        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,
-    };
-
-    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;
-}

package/src/cmd/sign.js

@@ -1,198 +0,0 @@
-/* @flow */
-import path from 'path';
-
-import {fs} from 'mz';
-import {signAddon as defaultAddonSigner} from 'sign-addon';
-
-import defaultBuilder from './build';
-import getValidatedManifest, {getManifestId} from '../util/manifest';
-import {withTempDir} from '../util/temp-dir';
-import {isErrorWithCode, UsageError, WebExtError} from '../errors';
-import {prepareArtifactsDir} from '../util/artifacts';
-import {createLogger} from '../util/logger';
-import type {ExtensionManifest} from '../util/manifest';
-
-
-const log = createLogger(__filename);
-
-const defaultAsyncFsReadFile: (string) => Promise<Buffer> =
-  fs.readFile.bind(fs);
-
-export const extensionIdFile = '.web-extension-id';
-
-// Sign command types and implementation.
-
-export type SignParams = {|
-  apiKey: string,
-  apiProxy: string,
-  apiSecret: string,
-  apiUrlPrefix: string,
-  artifactsDir: string,
-  id?: string,
-  ignoreFiles?: Array<string>,
-  sourceDir: string,
-  timeout: number,
-  verbose?: boolean,
-  channel?: string,
-|};
-
-export type SignOptions = {
-  build?: typeof defaultBuilder,
-  signAddon?: typeof defaultAddonSigner,
-  preValidatedManifest?: ExtensionManifest,
-  shouldExitProgram?: boolean,
-};
-
-export type SignResult = {|
-  success: boolean,
-  id: string,
-  downloadedFiles: Array<string>,
-|};
-
-export default function sign(
-  {
-    apiKey,
-    apiProxy,
-    apiSecret,
-    apiUrlPrefix,
-    artifactsDir,
-    id,
-    ignoreFiles = [],
-    sourceDir,
-    timeout,
-    verbose,
-    channel,
-  }: SignParams,
-  {
-    build = defaultBuilder,
-    preValidatedManifest,
-    signAddon = defaultAddonSigner,
-  }: SignOptions = {}
-): Promise<SignResult> {
-  return withTempDir(
-    async function(tmpDir) {
-      await prepareArtifactsDir(artifactsDir);
-
-      let manifestData;
-
-      if (preValidatedManifest) {
-        manifestData = preValidatedManifest;
-      } else {
-        manifestData = await getValidatedManifest(sourceDir);
-      }
-
-      const [buildResult, idFromSourceDir] = await Promise.all([
-        build({sourceDir, ignoreFiles, artifactsDir: tmpDir.path()},
-              {manifestData, showReadyMessage: false}),
-        getIdFromSourceDir(sourceDir),
-      ]);
-
-      const manifestId = getManifestId(manifestData);
-
-      if (id && manifestId) {
-        throw new UsageError(
-          `Cannot set custom ID ${id} because manifest.json ` +
-          `declares ID ${manifestId}`);
-      }
-      if (id) {
-        log.debug(`Using custom ID declared as --id=${id}`);
-      }
-
-      if (manifestId) {
-        id = manifestId;
-      }
-
-      if (!id && idFromSourceDir) {
-        log.info(
-          `Using previously auto-generated extension ID: ${idFromSourceDir}`);
-        id = idFromSourceDir;
-      }
-
-      if (!id) {
-        log.warn('No extension ID specified (it will be auto-generated)');
-      }
-
-      const signingResult = await signAddon({
-        apiKey,
-        apiSecret,
-        apiUrlPrefix,
-        apiProxy,
-        timeout,
-        verbose,
-        id,
-        xpiPath: buildResult.extensionPath,
-        version: manifestData.version,
-        downloadDir: artifactsDir,
-        channel,
-      });
-
-      if (signingResult.id) {
-        await saveIdToSourceDir(sourceDir, signingResult.id);
-      }
-
-      // All information about the downloaded files would have
-      // already been logged by signAddon().
-      if (signingResult.success) {
-        log.info(`Extension ID: ${signingResult.id}`);
-        log.info('SUCCESS');
-      } else {
-        log.info('FAIL');
-        throw new WebExtError(
-          'The extension could not be signed');
-      }
-
-      return signingResult;
-    }
-  );
-}
-
-
-export async function getIdFromSourceDir(
-  sourceDir: string,
-  asyncFsReadFile: typeof defaultAsyncFsReadFile = defaultAsyncFsReadFile,
-): Promise<string | void> {
-  const filePath = path.join(sourceDir, extensionIdFile);
-
-  let content;
-
-  try {
-    content = await asyncFsReadFile(filePath);
-  } catch (error) {
-    if (isErrorWithCode('ENOENT', error)) {
-      log.debug(`No ID file found at: ${filePath}`);
-      return;
-    }
-    throw error;
-  }
-
-  let lines = content.toString().split('\n');
-  lines = lines.filter((line) => {
-    line = line.trim();
-    if (line && !line.startsWith('#')) {
-      return line;
-    }
-  });
-
-  const id = lines[0];
-  log.debug(`Found extension ID ${id} in ${filePath}`);
-
-  if (!id) {
-    throw new UsageError(`No ID found in extension ID file ${filePath}`);
-  }
-
-  return id;
-}
-
-
-export async function saveIdToSourceDir(
-  sourceDir: string, id: string
-): Promise<void> {
-  const filePath = path.join(sourceDir, extensionIdFile);
-  await fs.writeFile(filePath, [
-    '# This file was created by https://github.com/mozilla/web-ext',
-    '# Your auto-generated extension ID for addons.mozilla.org is:',
-    id.toString(),
-  ].join('\n'));
-
-  log.debug(`Saved auto-generated ID ${id} to ${filePath}`);
-}

package/src/config.js

@@ -1,187 +0,0 @@
-/* @flow */
-import os from 'os';
-import path from 'path';
-
-import importFresh from 'import-fresh';
-import camelCase from 'camelcase';
-import decamelize from 'decamelize';
-
-import fileExists from './util/file-exists';
-import {createLogger} from './util/logger';
-import {UsageError, WebExtError} from './errors';
-
-const log = createLogger(__filename);
-
-type ApplyConfigToArgvParams = {|
-  // This is the argv object which will get updated by each
-  // config applied.
-  argv: Object,
-  // This is the argv that only has CLI values applied to it.
-  argvFromCLI: Object,
-  configObject: Object,
-  options: Object,
-  configFileName: string,
-|};
-
-export function applyConfigToArgv({
-  argv,
-  argvFromCLI,
-  configObject,
-  options,
-  configFileName,
-}: ApplyConfigToArgvParams): Object {
-  let newArgv = {...argv};
-
-  for (const option of Object.keys(configObject)) {
-    if (camelCase(option) !== option) {
-      throw new UsageError(
-        `The config option "${option}" must be ` +
-        `specified in camel case: "${camelCase(option)}"`);
-    }
-
-    // A config option cannot be a sub-command config
-    // object if it is an array.
-    if (!Array.isArray(configObject[option]) &&
-      typeof options[option] === 'object' &&
-      typeof configObject[option] === 'object') {
-      // Descend into the nested configuration for a sub-command.
-      newArgv = applyConfigToArgv({
-        argv: newArgv,
-        argvFromCLI,
-        configObject: configObject[option],
-        options: options[option],
-        configFileName});
-      continue;
-    }
-
-    const decamelizedOptName = decamelize(option, {separator: '-'});
-
-    if (typeof options[decamelizedOptName] !== 'object') {
-      throw new UsageError(`The config file at ${configFileName} specified ` +
-        `an unknown option: "${option}"`);
-    }
-    if (options[decamelizedOptName].type === undefined) {
-      // This means yargs option type wasn't not defined correctly
-      throw new WebExtError(
-        `Option: ${option} was defined without a type.`);
-    }
-
-    const expectedType = options[decamelizedOptName].type ===
-      'count' ? 'number' : options[decamelizedOptName].type;
-
-    const optionType = (
-      Array.isArray(configObject[option]) ?
-        'array' : typeof configObject[option]
-    );
-
-    if (optionType !== expectedType) {
-      throw new UsageError(`The config file at ${configFileName} specified ` +
-        `the type of "${option}" incorrectly as "${optionType}"` +
-        ` (expected type "${expectedType}")`);
-    }
-
-    let defaultValue;
-    if (options[decamelizedOptName]) {
-      if (options[decamelizedOptName].default !== undefined) {
-        defaultValue = options[decamelizedOptName].default;
-      } else if (expectedType === 'boolean') {
-        defaultValue = false;
-      }
-    }
-
-    // This is our best effort (without patching yargs) to detect
-    // if a value was set on the CLI instead of in the config.
-    // It looks for a default value and if the argv value is
-    // different, it assumes that the value was configured on the CLI.
-
-    const wasValueSetOnCLI =
-      typeof argvFromCLI[option] !== 'undefined' &&
-      argvFromCLI[option] !== defaultValue;
-    if (wasValueSetOnCLI) {
-      log.debug(
-        `Favoring CLI: ${option}=${argvFromCLI[option]} over ` +
-        `configuration: ${option}=${configObject[option]}`);
-      newArgv[option] = argvFromCLI[option];
-      continue;
-    }
-
-    newArgv[option] = configObject[option];
-
-    const coerce = options[decamelizedOptName].coerce;
-    if (coerce) {
-      log.debug(
-        `Calling coerce() on configured value for ${option}`);
-      newArgv[option] = coerce(newArgv[option]);
-    }
-
-    newArgv[decamelizedOptName] = newArgv[option];
-  }
-  return newArgv;
-}
-
-export function loadJSConfigFile(filePath: string): Object {
-  const resolvedFilePath = path.resolve(filePath);
-  log.debug(
-    `Loading JS config file: "${filePath}" ` +
-    `(resolved to "${resolvedFilePath}")`);
-  let configObject;
-  try {
-    configObject = importFresh(resolvedFilePath);
-  } catch (error) {
-    log.debug('Handling error:', error);
-    throw new UsageError(
-      `Cannot read config file: ${resolvedFilePath}\n` +
-      `Error: ${error.message}`);
-  }
-  if (filePath.endsWith('package.json')) {
-    log.debug('Looking for webExt key inside package.json file');
-    configObject = configObject.webExt || {};
-  }
-  if (Object.keys(configObject).length === 0) {
-    log.debug(`Config file ${resolvedFilePath} did not define any options. ` +
-      'Did you set module.exports = {...}?');
-  }
-  return configObject;
-}
-
-type DiscoverConfigFilesParams = {|
-  getHomeDir: () => string,
-|};
-
-export async function discoverConfigFiles(
-  {getHomeDir = os.homedir}: DiscoverConfigFilesParams = {}
-): Promise<Array<string>> {
-  const magicConfigName = 'web-ext-config.js';
-
-  // Config files will be loaded in this order.
-  const possibleConfigs = [
-    // Look for a magic hidden config (preceded by dot) in home dir.
-    path.join(getHomeDir(), `.${magicConfigName}`),
-    // Look for webExt key inside package.json file
-    path.join(process.cwd(), 'package.json'),
-    // Look for a magic config in the current working directory.
-    path.join(process.cwd(), magicConfigName),
-  ];
-
-  const configs = await Promise.all(possibleConfigs.map(
-    async (fileName) => {
-      const resolvedFileName = path.resolve(fileName);
-      if (await fileExists(resolvedFileName)) {
-        return resolvedFileName;
-      } else {
-        log.debug(
-          `Discovered config "${resolvedFileName}" does not ` +
-          'exist or is not readable');
-        return undefined;
-      }
-    }
-  ));
-
-  const existingConfigs = [];
-  configs.forEach((f) => {
-    if (typeof f === 'string') {
-      existingConfigs.push(f);
-    }
-  });
-  return existingConfigs;
-}

package/src/extension-runners/base.js

@@ -1,40 +0,0 @@
-/* @flow */
-
-import {
-  showDesktopNotification as defaultDesktopNotifications,
-} from '../util/desktop-notifier';
-import type {ExtensionManifest} from '../util/manifest';
-
-export type Extension = {|
-  sourceDir: string,
-  manifestData: ExtensionManifest,
-|};
-
-export type ExtensionRunnerParams = {|
-  // Common cli params.
-  extensions: Array<Extension>,
-  profilePath?: string,
-  keepProfileChanges: boolean,
-  startUrl: ?string | ?Array<string>,
-  args?: Array<string>,
-
-  // Common injected dependencies.
-  desktopNotifications: typeof defaultDesktopNotifications,
-|};
-
-export type ExtensionRunnerReloadResult = {|
-  runnerName: string,
-  reloadError?: Error,
-  sourceDir?: string,
-|};
-
-export interface IExtensionRunner {
-  getName(): string,
-  run(): Promise<void>,
-  reloadAllExtensions(): Promise<Array<ExtensionRunnerReloadResult>>,
-  reloadExtensionBySourceDir(
-    extensionSourceDir: string
-  ): Promise<Array<ExtensionRunnerReloadResult>>,
-  registerCleanup(fn: Function): void,
-  exit(): Promise<void>,
-}