feat: Adds binaryArgs to pass additional flags to Firefox binary (#1563)

Author: denar90

src/cmd/run.js

@@ -36,6 +36,7 @@ export type CmdRunParams = {|
   sourceDir: string,
   startUrl?: Array<string>,
   target?: Array<string>,
+  args?: Array<string>,
 
   // Android CLI options.
   adbBin?: string,
@@ -77,6 +78,7 @@ export default async function run(
     adbPort,
     adbDevice,
     firefoxApk,
+    args,
   }: CmdRunParams,
   {
     buildExtension = defaultBuildExtension,
@@ -107,6 +109,7 @@ export default async function run(
     extensions: [{sourceDir, manifestData}],
     keepProfileChanges,
     startUrl,
+    args,
     desktopNotifications,
   };
 

src/extension-runners/base.js

@@ -16,6 +16,7 @@ export type ExtensionRunnerParams = {|
   profilePath?: string,
   keepProfileChanges: boolean,
   startUrl: ?string | ?Array<string>,
+  args?: Array<string>,
 
   // Common injected dependencies.
   desktopNotifications: typeof defaultDesktopNotifications,

src/extension-runners/firefox-android.js

@@ -42,6 +42,19 @@ import type {
 
 const log = createLogger(__filename);
 
+const ignoredParams = {
+  profilePath: '--profile-path',
+  keepProfileChanges: '--keep-profile-changes',
+  browserConsole: '--browser-console',
+  preInstall: '--pre-install',
+  startUrl: '--start-url',
+  args: '--args',
+};
+
+const getIgnoredParamsWarningsMessage = (optionName) => {
+  return `The Firefox for Android target does not support ${optionName}`;
+};
+
 export type FirefoxAndroidExtensionRunnerParams = {|
   ...ExtensionRunnerParams,
 
@@ -261,35 +274,13 @@ export class FirefoxAndroidExtensionRunner {
   }
 
   printIgnoredParamsWarnings() {
-    if (this.params.profilePath) {
-      log.warn(
-        'Firefox for Android target does not support custom profile paths.'
-      );
-    }
-
-    if (this.params.keepProfileChanges) {
-      log.warn(
-        'Firefox for Android target does not support --keep-profile-changes.'
-      );
-    }
-
-    if (this.params.browserConsole) {
-      log.warn(
-        'Firefox for Android target does not support --browser-console option.'
-      );
-    }
-
-    if (this.params.preInstall) {
-      log.warn(
-        'Firefox for Android target does not support --pre-install option.'
-      );
-    }
-
-    if (this.params.startUrl) {
-      log.warn(
-        'Firefox for Android target does not support --start-url option.'
-      );
-    }
+    Object.keys(ignoredParams).forEach((ignoredParam) => {
+      if (this.params[ignoredParam]) {
+        log.warn(
+          getIgnoredParamsWarningsMessage(ignoredParams[ignoredParam])
+        );
+      }
+    });
   }
 
   async adbDevicesDiscoveryAndSelect() {

src/extension-runners/firefox-desktop.js

@@ -217,6 +217,7 @@ export class FirefoxDesktopExtensionRunner {
       startUrl,
       firefoxApp,
       firefoxClient,
+      args,
     } = this.params;
 
     const binaryArgs = [];
@@ -231,6 +232,10 @@ export class FirefoxDesktopExtensionRunner {
       }
     }
 
+    if (args) {
+      binaryArgs.push(...args);
+    }
+
     this.runningInfo = await firefoxApp.run(this.profile, {
       firefoxBinary, binaryArgs,
     });

src/program.js

@@ -503,6 +503,12 @@ Example: $0 --help run.
         demandOption: false,
         type: 'boolean',
       },
+      'args': {
+        alias: ['arg'],
+        describe: 'Additional CLI options passed to the Browser binary',
+        demandOption: false,
+        type: 'array',
+      },
       // Firefox for Android CLI options.
       'adb-bin': {
         describe: 'Specify a custom path to the adb binary',

tests/unit/test-cmd/test.run.js

@@ -106,6 +106,7 @@ describe('run', () => {
       firefox: '/path/to/custom/bin/firefox',
       pref: {'my.custom.pref': 'value'},
       firefoxProfile: '/path/to/custom/profile',
+      args: ['-headless=false'],
     };
 
     await cmd.run(runOptions);
@@ -130,6 +131,7 @@ describe('run', () => {
       firefoxBinary: runnerParams.firefoxBinary,
       customPrefs: runnerParams.customPrefs,
       firefoxProfile: runnerParams.profilePath,
+      args: runnerParams.args,
     }, expectedRunnerParams);
     assert.equal(runnerParams.extensions.length, 1);
     assert.equal(runnerParams.extensions[0].sourceDir, cmd.argv.sourceDir);

tests/unit/test-extension-runners/test.firefox-android.js

@@ -845,7 +845,7 @@ describe('util/extension-runners/firefox-android', () => {
         {
           params: {profilePath: '/fake/dir'},
           expectedMessage: (
-            /Android target does not support custom profile paths/
+            /Android target does not support --profile-path/
           ),
         },
         {
@@ -863,13 +863,19 @@ describe('util/extension-runners/firefox-android', () => {
         {
           params: {preInstall: true},
           expectedMessage: (
-            /Android target does not support --pre-install option/
+            /Android target does not support --pre-install/
           ),
         },
         {
           params: {startUrl: 'http://fake-start-url.org'},
           expectedMessage: (
-            /Android target does not support --start-url option/
+            /Android target does not support --start-url/
+          ),
+        },
+        {
+          params: {args: ['-headless=false']},
+          expectedMessage: (
+            /Android target does not support --args/
           ),
         },
       ];

tests/unit/test-extension-runners/test.firefox-desktop.js

@@ -202,6 +202,14 @@ describe('util/extension-runners/firefox-desktop', () => {
     ]);
   });
 
+  it('passes binaryArgs to Firefox', async () => {
+    await testBinaryArgs({
+      args: ['-headless=true', '-jsconsole'],
+    }, [
+      '-headless=true', '-jsconsole',
+    ]);
+  });
+
   it('passes a custom Firefox profile when specified', async () => {
     const {params} = prepareExtensionRunnerParams({
       params: {