feat: install and run an extension with custom Firefox preferences (#658

)
mozilla · Dec 19, 2016 · a650164 · a650164
1 parent df188f2
commit a650164
Show file tree

Hide file tree

Showing 7 changed files with 173 additions and 18 deletions.
diff --git a/src/cmd/run.js b/src/cmd/run.js
@@ -16,6 +16,7 @@ const log = createLogger(__filename);
 
 // Import objects that are only used as Flow types.
 import type FirefoxProfile from 'firefox-profile';
+import type {FirefoxPreferences} from '../firefox/preferences';
 import type {OnSourceChangeFn} from '../watcher';
 import type Watchpack from 'watchpack';
 import type {
@@ -151,6 +152,7 @@ export type CmdRunParams = {
   firefoxProfile: string,
   preInstall: boolean,
   noReload: boolean,
+  customPrefs?: FirefoxPreferences,
 };
 
 export type CmdRunOptions = {
@@ -163,6 +165,7 @@ export default async function run(
   {
     sourceDir, artifactsDir, firefox, firefoxProfile,
     preInstall = false, noReload = false,
+    customPrefs,
   }: CmdRunParams,
   {
     firefoxApp = defaultFirefoxApp,
@@ -195,6 +198,7 @@ export default async function run(
     firefox,
     manifestData,
     profilePath: firefoxProfile,
+    customPrefs,
   });
 
   profile = await runner.getProfile();
@@ -265,6 +269,7 @@ export type ExtensionRunnerParams = {
   profilePath: string,
   firefoxApp: typeof defaultFirefoxApp,
   firefox: string,
+  customPrefs?: FirefoxPreferences,
 };
 
 export class ExtensionRunner {
@@ -273,29 +278,31 @@ export class ExtensionRunner {
   profilePath: string;
   firefoxApp: typeof defaultFirefoxApp;
   firefox: string;
+  customPrefs: FirefoxPreferences;
 
   constructor(
     {
       firefoxApp, sourceDir, manifestData,
-      profilePath, firefox,
+      profilePath, firefox, customPrefs = {},
     }: ExtensionRunnerParams
   ) {
     this.sourceDir = sourceDir;
     this.manifestData = manifestData;
     this.profilePath = profilePath;
     this.firefoxApp = firefoxApp;
     this.firefox = firefox;
+    this.customPrefs = customPrefs;
   }
 
   getProfile(): Promise<FirefoxProfile> {
-    const {firefoxApp, profilePath} = this;
+    const {firefoxApp, profilePath, customPrefs} = this;
     return new Promise((resolve) => {
       if (profilePath) {
         log.debug(`Copying Firefox profile from ${profilePath}`);
-        resolve(firefoxApp.copyProfile(profilePath));
+        resolve(firefoxApp.copyProfile(profilePath, {customPrefs}));
       } else {
         log.debug('Creating new Firefox profile');
-        resolve(firefoxApp.createProfile());
+        resolve(firefoxApp.createProfile({customPrefs}));
       }
     });
   }

diff --git a/src/firefox/index.js b/src/firefox/index.js
@@ -33,6 +33,7 @@ import type {
 } from './preferences';
 
 import type {ExtensionManifest} from '../util/manifest';
+import type {FirefoxPreferences} from '../firefox/preferences';
 
 
 // defaultRemotePortFinder types and implementation.
@@ -190,6 +191,7 @@ export async function run(
 export type ConfigureProfileOptions = {
   app?: PreferencesAppName,
   getPrefs?: PreferencesGetterFn,
+  customPrefs?: FirefoxPreferences,
 };
 
 export type ConfigureProfileFn = (
@@ -208,16 +210,22 @@ export function configureProfile(
   {
     app = 'firefox',
     getPrefs = defaultPrefGetter,
-  }: ConfigureProfileOptions = {}
+    customPrefs = {},
+  }: ConfigureProfileOptions = {},
 ): Promise<FirefoxProfile> {
   // Set default preferences. Some of these are required for the add-on to
   // operate, such as disabling signatures.
-  // TODO: support custom preferences.
-  // https://github.com/mozilla/web-ext/issues/88
   let prefs = getPrefs(app);
   Object.keys(prefs).forEach((pref) => {
     profile.setPreference(pref, prefs[pref]);
   });
+  if (Object.keys(customPrefs).length > 0) {
+    const customPrefsStr = JSON.stringify(customPrefs, null, 2);
+    log.info(`Setting custom Firefox preferences: ${customPrefsStr}`);
+    Object.keys(customPrefs).forEach((custom) => {
+      profile.setPreference(custom, customPrefs[custom]);
+    });
+  }
   profile.updatePreferences();
   return Promise.resolve(profile);
 }
@@ -228,6 +236,7 @@ export function configureProfile(
 export type CreateProfileParams = {
   app?: PreferencesAppName,
   configureThisProfile?: ConfigureProfileFn,
+  customPrefs?: FirefoxPreferences,
 };
 
 /*
@@ -236,19 +245,24 @@ export type CreateProfileParams = {
  * The profile will be deleted when the system process exits.
  */
 export async function createProfile(
-  {app, configureThisProfile = configureProfile}: CreateProfileParams = {}
+  {
+    app,
+    configureThisProfile = configureProfile,
+    customPrefs = {},
+  }: CreateProfileParams = {},
 ): Promise<FirefoxProfile> {
   const profile = new FirefoxProfile();
-  return await configureThisProfile(profile, {app});
+  return await configureThisProfile(profile, {app, customPrefs});
 }
 
 
 // copyProfile types and implementation.
 
 export type CopyProfileOptions = {
   app?: PreferencesAppName,
-  copyFromUserProfile?: Function,
   configureThisProfile?: ConfigureProfileFn,
+  copyFromUserProfile?: Function,
+  customPrefs?: FirefoxPreferences,
 };
 
 /*
@@ -266,10 +280,11 @@ export type CopyProfileOptions = {
 export async function copyProfile(
   profileDirectory: string,
   {
-    copyFromUserProfile = defaultUserProfileCopier,
-    configureThisProfile = configureProfile,
     app,
-  }: CopyProfileOptions = {}
+    configureThisProfile = configureProfile,
+    copyFromUserProfile = defaultUserProfileCopier,
+    customPrefs = {},
+  }: CopyProfileOptions = {},
 ): Promise<FirefoxProfile> {
 
   let copy = promisify(FirefoxProfile.copy);
@@ -288,7 +303,7 @@ export async function copyProfile(
       profile = await copyByName({name: profileDirectory});
     }
 
-    return configureThisProfile(profile, {app});
+    return configureThisProfile(profile, {app, customPrefs});
   } catch (error) {
     throw new WebExtError(
       `Could not copy Firefox profile from ${profileDirectory}: ${error}`);

diff --git a/src/firefox/preferences.js b/src/firefox/preferences.js
@@ -1,6 +1,12 @@
 /* @flow */
-import {WebExtError} from '../errors';
+import {WebExtError, UsageError} from '../errors';
+import {createLogger} from '../util/logger';
 
+const log = createLogger(__filename);
+export const nonOverridablePreferences = [
+  'devtools.debugger.remote-enabled', 'devtools.debugger.prompt-connection',
+  'xpinstall.signatures.required',
+];
 
 // Flow Types
 
@@ -117,3 +123,35 @@ export function getPrefs(
     ...appPrefs,
   };
 }
+
+export function coerceCLICustomPreference(
+  cliPrefs: string | Array<string>
+): FirefoxPreferences {
+  let customPrefs = {};
+
+  if (!Array.isArray(cliPrefs)) {
+    cliPrefs = [cliPrefs];
+  }
+
+  for (let pref of cliPrefs) {
+    let [key, value] = pref.split('=');
+
+    if (/[^\w{@}.-]/.test(key)) {
+      throw new UsageError(`Invalid custom preference name: ${key}`);
+    }
+
+    if (value === `${parseInt(value)}`) {
+      value = parseInt(value, 10);
+    } else if (value === 'true' || value === 'false') {
+      value = (value === 'true');
+    }
+
+    if (nonOverridablePreferences.includes(key)) {
+      log.warn(`'${key}' preference cannot be customized.`);
+      continue;
+    }
+    customPrefs[`${key}`] = value;
+  }
+
+  return customPrefs;
+}
diff --git a/src/program.js b/src/program.js
@@ -8,6 +8,7 @@ import yargs from 'yargs';
 import defaultCommands from './cmd';
 import {UsageError} from './errors';
 import {createLogger, consoleStream as defaultLogStream} from './util/logger';
+import {coerceCLICustomPreference} from './firefox/preferences';
 
 const log = createLogger(__filename);
 const envPrefix = 'WEB_EXT';
@@ -94,6 +95,9 @@ export class Program {
     const argv = this.yargs.argv;
     const cmd = argv._[0];
 
+    // Command line option (pref) renamed for internal use (customPref).
+    argv.customPrefs = argv.pref;
+
     let runCommand = this.commands[cmd];
 
     if (argv.verbose) {
@@ -286,6 +290,14 @@ Example: $0 --help run.
         demand: false,
         type: 'boolean',
       },
+      'pref': {
+        describe: 'Launch firefox with custom preferences. Lightweight ' +
+                  'alternative to creating custom profile.',
+        demand: false,
+        requiresArg: true,
+        type: 'string',
+        coerce: coerceCLICustomPreference,
+      },
     })
     .command('lint', 'Validate the web extension source', commands.lint, {
       'output': {

diff --git a/tests/unit/test-firefox/test.firefox.js b/tests/unit/test-firefox/test.firefox.js
@@ -235,7 +235,7 @@ describe('firefox', () => {
           sinon.spy((profile) => Promise.resolve(profile));
 
         return firefox.copyProfile(baseProfile.path(),
-          {configureThisProfile, app})
+          {app, configureThisProfile})
           .then((profile) => {
             assert.equal(configureThisProfile.called, true);
             assert.equal(configureThisProfile.firstCall.args[0], profile);
@@ -345,6 +345,22 @@ describe('firefox', () => {
       }
     ));
 
+    it('writes custom preferences', () => withTempProfile(
+      (profile) => {
+        const customPrefs = {'extensions.checkCompatibility.nightly': true};
+        return firefox.configureProfile(profile, {customPrefs})
+          .then((profile) => fs.readFile(path.join(profile.path(), 'user.js')))
+          .then((prefFile) => {
+            // Check for custom pref set by configureProfile().
+            assert.include(prefFile.toString(),
+                           '"extensions.checkCompatibility.nightly", true');
+            // Check that one of the default preferences is set as well
+            assert.include(prefFile.toString(),
+                           '"devtools.debugger.remote-enabled", true');
+          });
+      }
+    ));
+
   });
 
   describe('installExtension', () => {

diff --git a/tests/unit/test-firefox/test.preferences.js b/tests/unit/test-firefox/test.preferences.js
@@ -2,8 +2,10 @@
 import {describe, it} from 'mocha';
 import {assert} from 'chai';
 
-import {WebExtError} from '../../../src/errors';
-import {getPrefs} from '../../../src/firefox/preferences';
+import {WebExtError, UsageError} from '../../../src/errors';
+import {
+  getPrefs, coerceCLICustomPreference, nonOverridablePreferences,
+} from '../../../src/firefox/preferences';
 
 
 describe('firefox/preferences', () => {
@@ -34,4 +36,54 @@ describe('firefox/preferences', () => {
 
   });
 
+  describe('coerceCLICustomPreference', () => {
+
+    it('converts a single --pref cli option from string to object', () => {
+      const prefs = coerceCLICustomPreference('valid.preference=true');
+      assert.isObject(prefs);
+      assert.equal(prefs['valid.preference'], true);
+    });
+
+    it('converts array of --pref cli option values into object', () => {
+      const prefs = coerceCLICustomPreference([
+        'valid.preference=true', 'valid.preference2=false',
+      ]);
+      assert.isObject(prefs);
+      assert.equal(prefs['valid.preference'], true);
+      assert.equal(prefs['valid.preference2'], false);
+    });
+
+    it('converts boolean values', () => {
+      const prefs = coerceCLICustomPreference('valid.preference=true');
+      assert.equal(prefs['valid.preference'], true);
+    });
+
+    it('converts number values', () => {
+      const prefs = coerceCLICustomPreference('valid.preference=455');
+      assert.equal(prefs['valid.preference'], 455);
+    });
+
+    it('converts float values', () => {
+      const prefs = coerceCLICustomPreference('valid.preference=4.55');
+      assert.equal(prefs['valid.preference'], '4.55');
+    });
+
+    it('does not allow certain default preferences to be customized', () => {
+      const nonChangeablePrefs = nonOverridablePreferences.map((prop) => {
+        return prop += '=true';
+      });
+      const prefs = coerceCLICustomPreference(nonChangeablePrefs);
+      for (let pref of nonChangeablePrefs) {
+        assert.isUndefined(prefs[pref], `${pref} should be undefined`);
+      }
+    });
+
+    it('throws an error for invalid preferences', () => {
+      assert.throws(() => coerceCLICustomPreference('*&%£=true'),
+                    UsageError,
+                    'UsageError: Invalid custom preference name: *&%£');
+    });
+
+  });
+
 });
diff --git a/tests/unit/test.program.js b/tests/unit/test.program.js
@@ -327,6 +327,21 @@ describe('program.main', () => {
       });
   });
 
+  it('converts custom preferences into an object', () => {
+    const fakeCommands = fake(commands, {
+      run: () => Promise.resolve(),
+    });
+    return execProgram(
+      ['run', '--pref', 'prop=true', '--pref', 'prop2=value2'],
+      {commands: fakeCommands})
+      .then(() => {
+        const {customPrefs} = fakeCommands.run.firstCall.args[0];
+        assert.isObject(customPrefs);
+        assert.equal(customPrefs.prop, true);
+        assert.equal(customPrefs.prop2, 'value2');
+      });
+  });
+
 });