feat: web-ext automatically checks for updates (#676)

Author: shubheksha

package.json

@@ -57,12 +57,13 @@
     "minimatch": "3.0.3",
     "mz": "2.6.0",
     "node-firefox-connect": "1.2.0",
-    "regenerator-runtime": "0.10.1",
     "parse-json": "2.2.0",
+    "regenerator-runtime": "0.10.1",
     "sign-addon": "0.2.0",
     "source-map-support": "0.4.7",
     "stream-to-promise": "2.2.0",
     "tmp": "0.0.30",
+    "update-notifier": "1.0.3",
     "watchpack": "1.1.0",
     "yargs": "6.5.0",
     "zip-dir": "1.0.2"

src/program.js

@@ -9,10 +9,14 @@ import defaultCommands from './cmd';
 import {UsageError} from './errors';
 import {createLogger, consoleStream as defaultLogStream} from './util/logger';
 import {coerceCLICustomPreference} from './firefox/preferences';
+import {checkForUpdates as defaultUpdateChecker} from './util/updates';
 
 const log = createLogger(__filename);
 const envPrefix = 'WEB_EXT';
 
+type ProgramOptions = {|
+  absolutePackageDir?: string,
+|}
 
 /*
  * The command line program.
@@ -24,7 +28,9 @@ export class Program {
 
   constructor(
     argv: ?Array<string>,
-    {absolutePackageDir = process.cwd()}: {absolutePackageDir?: string} = {}
+    {
+      absolutePackageDir = process.cwd(),
+    }: ProgramOptions = {}
   ) {
     // This allows us to override the process argv which is useful for
     // testing.
@@ -84,8 +90,9 @@ export class Program {
   async execute(
     absolutePackageDir: string,
     {
-      systemProcess = process, logStream = defaultLogStream,
-      getVersion = defaultVersionGetter, shouldExitProgram = true,
+      checkForUpdates = defaultUpdateChecker, systemProcess = process,
+      logStream = defaultLogStream, getVersion = defaultVersionGetter,
+      shouldExitProgram = true, globalEnv = WEBEXT_BUILD_ENV,
     }: Object = {}
   ): Promise<void> {
 
@@ -112,7 +119,14 @@ export class Program {
       if (!runCommand) {
         throw new UsageError(`Unknown command: ${cmd}`);
       }
+      if (globalEnv === 'production') {
+        checkForUpdates ({
+          version: getVersion(absolutePackageDir),
+        });
+      }
+
       await runCommand(argv);
+
     } catch (error) {
       const prefix = cmd ? `${cmd}: ` : '';
       if (!(error instanceof UsageError) || argv.verbose) {
@@ -138,14 +152,14 @@ declare var WEBEXT_BUILD_ENV: string;
 
 //A defintion of type of argument for defaultVersionGetter
 type versionGetterOptions = {
-  localEnv?: string,
+  globalEnv?: string,
 };
 
 export function defaultVersionGetter(
   absolutePackageDir: string,
-  {localEnv = WEBEXT_BUILD_ENV}: versionGetterOptions = {}
+  {globalEnv = WEBEXT_BUILD_ENV}: versionGetterOptions = {}
 ): string {
-  if (localEnv === 'production') {
+  if (globalEnv === 'production') {
     log.debug('Getting the version from package.json');
     const packageData: any = readFileSync(
       path.join(absolutePackageDir, 'package.json'));
@@ -164,7 +178,9 @@ export function main(
     runOptions = {},
   }: Object = {}
 ): Promise<any> {
+
   const program = new Program(argv, {absolutePackageDir});
+
   // yargs uses magic camel case expansion to expose options on the
   // final argv object. For example, the 'artifacts-dir' option is alternatively
   // available as argv.artifactsDir.

src/util/updates.js

@@ -0,0 +1,21 @@
+/* @flow */
+import defaultUpdateNotifier from 'update-notifier';
+
+type checkForUpdatesParams = {|
+  version: string,
+  updateNotifier?: typeof defaultUpdateNotifier,
+|};
+
+export function checkForUpdates(
+  {
+    version,
+    updateNotifier = defaultUpdateNotifier,
+  }: checkForUpdatesParams
+) {
+  const pkg = {name: 'web-ext', version};
+
+  updateNotifier({
+    pkg,
+    updateCheckInterval: 1000 * 60 * 60 * 24 * 3, // 3 days,
+  }).notify();
+}

tests/unit/test-util/test.updates.js

@@ -0,0 +1,29 @@
+/* @flow */
+import {it, describe} from 'mocha';
+import {assert} from 'chai';
+import sinon from 'sinon';
+
+import {checkForUpdates} from '../../../src/util/updates';
+
+describe('util/updates', () => {
+  describe('checkForUpdates()', () => {
+    it('calls the notifier with the correct parameters', () => {
+      const updateNotifierStub = sinon.spy(() => {
+        return {
+          notify: sinon.spy(),
+        };
+      });
+
+      checkForUpdates({
+        version: '1.0.0',
+        updateNotifier: updateNotifierStub,
+      });
+      assert.equal(updateNotifierStub.called, true);
+      assert.equal(updateNotifierStub.firstCall.args[0].pkg.name, 'web-ext');
+      assert.equal(updateNotifierStub.firstCall.args[0].pkg.version, '1.0.0');
+      assert.isNumber(updateNotifierStub.firstCall.args[0].updateCheckInterval);
+      assert.equal(updateNotifierStub.firstCall.args[0].updateCheckInterval,
+                   1000 * 60 * 60 * 24 * 3);
+    });
+  });
+});

tests/unit/test.program.js

@@ -21,6 +21,8 @@ describe('program.Program', () => {
     const absolutePackageDir = path.join(__dirname, '..', '..');
     return program.execute(
       absolutePackageDir, {
+        getVersion: () => spy(),
+        checkForUpdates: spy(),
         systemProcess: fakeProcess,
         shouldExitProgram: false,
         ...options,
@@ -176,7 +178,10 @@ describe('program.Program', () => {
     });
     program.command('thing', 'does a thing', () => {});
 
-    return execProgram(program, {getVersion: spy(), logStream})
+    return execProgram(program, {
+      getVersion: spy(),
+      logStream,
+    })
       .then(() => {
         assert.equal(logStream.makeVerbose.called, true);
       });
@@ -241,13 +246,50 @@ describe('program.Program', () => {
       });
   });
 
+  it('checks for updates automatically', () => {
+    const handler = spy();
+    const getVersion = () => 'some-package-version';
+    const checkForUpdates = sinon.stub();
+    const program = new Program(['run'])
+      .command('run', 'some command', handler);
+    return execProgram(program, {
+      checkForUpdates,
+      getVersion,
+      globalEnv: 'production',
+    })
+      .then(() => {
+        assert.equal(checkForUpdates.firstCall.args[0].version,
+                    'some-package-version');
+      });
+  });
+
+  it('does not check for updates during development', () => {
+    const handler = spy();
+    const getVersion = () => 'some-package-version';
+    const checkForUpdates = sinon.stub();
+    const program = new Program(['run'])
+      .command('run', 'some command', handler);
+    return execProgram(program, {
+      checkForUpdates,
+      getVersion,
+      globalEnv: 'development',
+    })
+      .then(() => {
+        assert.equal(checkForUpdates.called, false);
+      });
+  });
 });
 
 
 describe('program.main', () => {
 
   function execProgram(argv, {projectRoot = '', ...mainOptions}: Object = {}) {
-    const runOptions = {shouldExitProgram: false, systemProcess: fake(process)};
+    const runOptions = {
+      getVersion: () => 'not-a-real-version',
+      checkForUpdates: spy(),
+      shouldExitProgram: false,
+      systemProcess: fake(process),
+    };
     return main(projectRoot, {argv, runOptions, ...mainOptions});
   }
 
@@ -351,15 +393,15 @@ describe('program.defaultVersionGetter', () => {
     const pkgFile = path.join(root, 'package.json');
     return fs.readFile(pkgFile)
       .then((pkgData) => {
-        const testBuildEnv = {localEnv: 'production'};
+        const testBuildEnv = {globalEnv: 'production'};
         assert.equal(defaultVersionGetter(root, testBuildEnv),
                    JSON.parse(pkgData).version);
       });
   });
 
   it('returns git commit information in development', () => {
     const commit = `${git.branch()}-${git.long()}`;
-    const testBuildEnv = {localEnv: 'development'};
+    const testBuildEnv = {globalEnv: 'development'};
     assert.equal(defaultVersionGetter(root, testBuildEnv),
                  commit);
   });