feat: web-ext run now shows a desktop notification if auto-reloading results in an error (#674)

Author: saintsebastian

package.json

@@ -58,6 +58,7 @@
     "minimatch": "3.0.3",
     "mz": "2.6.0",
     "node-firefox-connect": "1.2.0",
+    "node-notifier": "4.6.1",
     "parse-json": "2.2.0",
     "regenerator-runtime": "0.10.1",
     "sign-addon": "0.2.0",

src/cmd/run.js

@@ -2,6 +2,9 @@
 import type FirefoxProfile from 'firefox-profile';
 import type Watchpack from 'watchpack';
 
+import {
+  showDesktopNotification as defaultDesktopNotifications,
+} from '../util/desktop-notifier';
 import * as defaultFirefoxApp from '../firefox';
 import defaultFirefoxConnector from '../firefox/remote';
 import {
@@ -34,6 +37,7 @@ export type WatcherCreatorParams = {
   sourceDir: string,
   artifactsDir: string,
   onSourceChange?: OnSourceChangeFn,
+  desktopNotifications?: typeof defaultDesktopNotifications,
 };
 
 export type WatcherCreatorFn = (params: WatcherCreatorParams) => Watchpack;
@@ -42,17 +46,23 @@ export function defaultWatcherCreator(
   {
     addonId, client, sourceDir, artifactsDir,
     onSourceChange = defaultSourceWatcher,
+    desktopNotifications = defaultDesktopNotifications,
   }: WatcherCreatorParams
  ): Watchpack {
   return onSourceChange({
     sourceDir,
     artifactsDir,
     onChange: () => {
       log.debug(`Reloading add-on ID ${addonId}`);
+
       return client.reloadAddon(addonId)
         .catch((error) => {
           log.error('\n');
           log.error(error.stack);
+          desktopNotifications({
+            title: 'web-ext run: error occured',
+            message: error.message,
+          });
           throw error;
         });
     },

src/util/desktop-notifier.js

@@ -0,0 +1,41 @@
+/* @flow */
+import defaultNotifier from 'node-notifier';
+
+import {createLogger} from './logger';
+import type {Logger} from './logger';
+
+const defaultLog = createLogger(__filename);
+
+type desktopNotificationsParams = {
+  title: string,
+  message: string,
+  icon?: string,
+};
+
+export type desktopNotificationsOptions = {
+  notifier?: typeof defaultNotifier,
+  log?: Logger,
+};
+
+export function showDesktopNotification(
+  {
+    title, message, icon,
+  }: desktopNotificationsParams,
+  {
+    notifier = defaultNotifier,
+    log = defaultLog,
+  }: desktopNotificationsOptions = {}
+): Promise<void> {
+
+  return new Promise((resolve, reject) => {
+    notifier.notify({title, message, icon}, (err, res) => {
+      if (err) {
+        log.debug(`Desktop notifier error: ${err.message},` +
+                 ` response: ${res}`);
+        reject(err);
+      } else {
+        resolve();
+      }
+    });
+  });
+}

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

@@ -280,6 +280,7 @@ describe('run', () => {
         sourceDir: '/path/to/extension/source/',
         artifactsDir: '/path/to/web-ext-artifacts',
         onSourceChange: sinon.spy(() => {}),
+        desktopNotifications: sinon.spy(() => Promise.resolve()),
       };
       return {
         config,
@@ -322,6 +323,24 @@ describe('run', () => {
         });
     });
 
+    it('notifies user on error from source change handler', () => {
+      const {config, createWatcher} = prepare();
+      config.client.reloadAddon = () => Promise.reject(new Error('an error'));
+      createWatcher();
+
+      assert.equal(config.onSourceChange.called, true);
+      // Simulate executing the handler when a source file changes.
+      return config.onSourceChange.firstCall.args[0].onChange()
+        .then(makeSureItFails())
+        .catch((error) => {
+          assert.equal(config.desktopNotifications.called, true);
+          assert.equal(
+            config.desktopNotifications.lastCall.args[0].message,
+            error.message
+          );
+        });
+    });
+
     it('throws errors from source change handler', () => {
       const {createWatcher, config} = prepare();
       config.client.reloadAddon = () => Promise.reject(new Error('an error'));

tests/unit/test-util/test.desktop-notifier.js

@@ -0,0 +1,59 @@
+/* @flow */
+import {it, describe} from 'mocha';
+import {assert} from 'chai';
+import sinon from 'sinon';
+
+import {showDesktopNotification} from '../../../src/util/desktop-notifier';
+import {createLogger} from '../../../src/util/logger';
+import {makeSureItFails} from '../helpers';
+
+describe('util/desktop-notifier', () => {
+  describe('desktopNotifications()', () => {
+    const expectedNotification = {
+      title: 'web-ext run: title',
+      message: 'message',
+    };
+
+    it('is called and creates a message with correct parameters', () => {
+      const fakeNotifier = {
+        notify: sinon.spy((options, callback) => callback()),
+      };
+      return showDesktopNotification(expectedNotification, {
+        notifier: fakeNotifier,
+      })
+        .then(() => {
+          assert.ok(fakeNotifier.notify.called);
+          assert.equal(
+            fakeNotifier.notify.firstCall.args[0].title,
+            'web-ext run: title',
+          );
+          assert.equal(fakeNotifier.notify.firstCall.args[0].message,
+                      'message');
+        });
+    });
+
+    it('logs error when notifier fails', () => {
+      const expectedError = new Error('an error');
+      const fakeLog = createLogger(__filename);
+      sinon.spy(fakeLog, 'debug');
+      const fakeNotifier = {
+        notify: (obj, callback) => {
+          callback(expectedError, 'response');
+        },
+      };
+
+      return showDesktopNotification(expectedNotification, {
+        notifier: fakeNotifier,
+        log: fakeLog,
+      })
+        .then(makeSureItFails())
+        .catch(() => {
+          assert.ok(fakeLog.debug.called);
+          assert.equal(fakeLog.debug.firstCall.args[0],
+                      `Desktop notifier error: ${expectedError.message}, ` +
+                      'response: response');
+        });
+    });
+
+  });
+});