feat: Added web-ext run --start-url to start Firefox on a specific page (#709)

Author: saintsebastian

src/cmd/run.js

@@ -153,6 +153,7 @@ export type CmdRunParams = {
   noReload: boolean,
   browserConsole: boolean,
   customPrefs?: FirefoxPreferences,
+  startUrl?: string | Array<string>,
 };
 
 export type CmdRunOptions = {
@@ -165,7 +166,7 @@ export default async function run(
   {
     sourceDir, artifactsDir, firefox, firefoxProfile,
     preInstall = false, noReload = false,
-    browserConsole = false, customPrefs,
+    browserConsole = false, customPrefs, startUrl,
   }: CmdRunParams,
   {
     firefoxApp = defaultFirefoxApp,
@@ -197,6 +198,7 @@ export default async function run(
     manifestData,
     profilePath: firefoxProfile,
     customPrefs,
+    startUrl,
   });
 
   const profile = await runner.getProfile();
@@ -269,6 +271,7 @@ export type ExtensionRunnerParams = {
   firefox: string,
   browserConsole: boolean,
   customPrefs?: FirefoxPreferences,
+  startUrl?: string | Array<string>,
 };
 
 export class ExtensionRunner {
@@ -279,11 +282,12 @@ export class ExtensionRunner {
   firefox: string;
   browserConsole: boolean;
   customPrefs: FirefoxPreferences;
+  startUrl: ?string | ?Array<string>;
 
   constructor(
     {
       firefoxApp, sourceDir, manifestData,
-      profilePath, firefox, browserConsole,
+      profilePath, firefox, browserConsole, startUrl,
       customPrefs = {},
     }: ExtensionRunnerParams
   ) {
@@ -294,6 +298,7 @@ export class ExtensionRunner {
     this.firefox = firefox;
     this.browserConsole = browserConsole;
     this.customPrefs = customPrefs;
+    this.startUrl = startUrl;
   }
 
   getProfile(): Promise<FirefoxProfile> {
@@ -329,12 +334,18 @@ export class ExtensionRunner {
 
   run(profile: FirefoxProfile): Promise<FirefoxProcess> {
     const binaryArgs = [];
-    const {firefoxApp, firefox} = this;
+    const {firefoxApp, firefox, startUrl} = this;
     if (this.browserConsole) {
       binaryArgs.push('-jsconsole');
     }
-    return firefoxApp.run(
-      profile, {firefoxBinary: firefox, binaryArgs}
-    );
+    if (startUrl) {
+      const urls = Array.isArray(startUrl) ? startUrl : [startUrl];
+      for (const url of urls) {
+        binaryArgs.push('--url', url);
+      }
+    }
+    return firefoxApp.run(profile, {
+      firefoxBinary: firefox, binaryArgs,
+    });
   }
 }

src/program.js

@@ -316,6 +316,13 @@ Example: $0 --help run.
         type: 'string',
         coerce: coerceCLICustomPreference,
       },
+      'start-url': {
+        alias: ['u', 'url'],
+        describe: 'Launch firefox at specified page',
+        demand: false,
+        requiresArg: true,
+        type: 'string',
+      },
       'browser-console': {
         alias: ['bc'],
         describe: 'Open the DevTools Browser Console.',

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

@@ -127,6 +127,34 @@ describe('run', () => {
     });
   });
 
+  it('passes single url parameter to Firefox when specified', () => {
+    const cmd = prepareRun();
+    const {firefoxApp} = cmd.options;
+    const expectedBinaryArgs = ['--url', 'www.example.com'];
+
+    return cmd.run({startUrl: 'www.example.com'}).then(() => {
+      assert.ok(firefoxApp.run.called);
+      assert.deepEqual(firefoxApp.run.firstCall.args[1].binaryArgs,
+                       expectedBinaryArgs);
+    });
+  });
+
+  it('passes multiple url parameters to Firefox when specified', () => {
+    const cmd = prepareRun();
+    const {firefoxApp} = cmd.options;
+    const expectedBinaryArgs = [
+      '--url', 'www.one.com', '--url', 'www.two.com', '--url', 'www.three.com',
+    ];
+
+    return cmd.run({startUrl: [
+      'www.one.com', 'www.two.com', 'www.three.com',
+    ]}).then(() => {
+      assert.ok(firefoxApp.run.called);
+      assert.deepEqual(firefoxApp.run.firstCall.args[1].binaryArgs,
+                       expectedBinaryArgs);
+    });
+  });
+
   it('passes -jsconsole when --browser-console is specified', () => {
     const cmd = prepareRun();
     const {firefoxApp} = cmd.options;

tests/unit/test.program.js

@@ -368,6 +368,20 @@ describe('program.main', () => {
       });
   });
 
+  it('passes the url of a firefox binary when specified', () => {
+    const fakeCommands = fake(commands, {
+      run: () => Promise.resolve(),
+    });
+    return execProgram(
+      ['run', '--start-url', 'www.example.com'],
+      {commands: fakeCommands})
+      .then(() => {
+        assert.equal(fakeCommands.run.called, true);
+        assert.equal(fakeCommands.run.firstCall.args[0].startUrl,
+                     'www.example.com');
+      });
+  });
+
   it('opens browser console when --browser-console is specified', () => {
     const fakeCommands = fake(commands, {
       run: () => Promise.resolve(),
@@ -396,10 +410,8 @@ describe('program.main', () => {
         assert.equal(customPrefs.prop2, 'value2');
       });
   });
-
 });
 
-
 describe('program.defaultVersionGetter', () => {
   const root = path.join(__dirname, '..', '..');