RoccoC / webpack-build-notifier / 86

pending completion

Build # 86

Build Type

push

travis-ci-com

Committed by

RoccoC

Commit Message

<a href="https://github.com/RoccoC/webpack-build-notifier/commit/<a class=hub.com/RoccoC/webpack-build-notifier/commit/c10e84a59ff8509aa8106ed0d70de9021ad6ad0d">c10e84a59<a href="https://github.com/RoccoC/webpack-build-notifier/commit/c10e84a59ff8509aa8106ed0d70de9021ad6ad0d">&quot;&gt;Revert &amp;quot;Fixed #51.&quot;

This reverts commit </a><a class="double-link" href="https://github.com/RoccoC/webpack-build-notifier/commit/<a class="double-link" href="https://github.com/RoccoC/webpack-build-notifier/commit/c59f530c70e06224b7dbfd8ffe0087622db78b86">c59f530c7</a>">c59f530c7</a><a href="https://github.com/RoccoC/webpack-build-notifier/commit/c10e84a59ff8509aa8106ed0d70de9021ad6ad0d">.

Run Details

49 of 57 branches covered (85.96%)

Branch coverage included in aggregate %.

46 of 46 new or added lines in 1 file covered. (100.0%)

111 of 115 relevant lines covered (96.52%)

11.64 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.02

/src/index.ts

/**
 * @class WebpackBuildNotifierPlugin
 * @extends Object
 * A Webpack plugin that generates OS notifications for build steps using node-notifier.
 */
import path from 'path';
import process from 'process';
import os from 'os';
import notifier from 'node-notifier';
import stripAnsi from 'strip-ansi';
import { exec, execFileSync } from 'child_process';
import { Notification } from 'node-notifier/notifiers/notificationcenter';
import { CompilationResult, Config, CompilationStatus } from './types';
import webpack from 'webpack';

const DEFAULT_ICON_PATH = path.resolve(__dirname, 'icons');

export default class WebpackBuildNotifierPlugin {
  private appName: string | undefined = undefined;
  private buildSuccessful: boolean = false;
  private hasRun: boolean = false;

  // config options
  private title: string = 'Webpack Build';
  private logo?: string;
  private sound: string = 'Submarine';
  private successSound: string = this.sound;
  private warningSound: string = this.sound;
  private failureSound: string = this.sound;
  private compilationSound: string = this.sound;
  private suppressSuccess: boolean | 'always' | 'initial' = false;
  private suppressWarning: boolean = false;
  private suppressCompileStart: boolean = true;
  private activateTerminalOnError: boolean = false;
  private showDuration: boolean = false;
  private successIcon: string = path.join(DEFAULT_ICON_PATH, 'success.png');
  private warningIcon: string = path.join(DEFAULT_ICON_PATH, 'warning.png');
  private failureIcon: string = path.join(DEFAULT_ICON_PATH, 'failure.png');
  private compileIcon: string = path.join(DEFAULT_ICON_PATH, 'compile.png');
  private onCompileStart?: (compilation: webpack.compiler.Compiler) => void;
  private onComplete?: (compilation: webpack.compilation.Compilation, status: CompilationStatus) => void;
  private onClick: (notifier: notifier.NodeNotifier, options: Notification) => void = () => this.activateTerminalWindow;
  private onTimeout?: (notifier: notifier.NodeNotifier, options: Notification) => void;
  private messageFormatter?: (error: CompilationResult, filepath: string) => string;
  private notifyOptions?: Notification;

  constructor(cfg?: Config) {
    Object.assign(this, cfg);

    this.registerSnoreToast();

    notifier.on('click', this.onClick);
    /* istanbul ignore else */
    if (this.onTimeout) {
      notifier.on('timeout', this.onTimeout);
    }
  }

  public apply(compiler: webpack.Compiler): void {
    if (compiler.hooks && compiler.hooks.watchRun && compiler.hooks.done) {
      // for webpack >= 4
      /* istanbul ignore else */
      if (!this.suppressCompileStart) {
        compiler.hooks.watchRun.tapAsync('webpack-build-notifier', this.onCompilationWatchRun);
      }
      compiler.hooks.done.tap('webpack-build-notifier', this.onCompilationDone);
    } else {
      // for webpack < 4
      /* istanbul ignore else */
      if (!this.suppressCompileStart) {
        compiler.plugin('watch-run', this.onCompilationWatchRun);
      }
      compiler.plugin('done', this.onCompilationDone);
    }
  }

  private readonly activateTerminalWindow = (): void => {
    if (process.platform === 'darwin') {
      // TODO: is there a way to translate $TERM_PROGRAM into the application name
      // to make this more flexible?
      exec('TERM="$TERM_PROGRAM"; ' +
        '[[ "$TERM" == "Apple_Terminal" ]] && TERM="Terminal"; ' +
        '[[ "$TERM" == "vscode" ]] && TERM="Visual Studio Code"; ' +
        'osascript -e "tell application \\"$TERM\\" to activate"');
    } else if (process.platform === 'win32') {
      // TODO: Windows platform
    }
  };

  private readonly formatMessage = (
    error: CompilationResult,
    filepath: string
  ): string => {
    let message: string | undefined = undefined;
    if (this.messageFormatter) {
      message = this.messageFormatter(error, filepath);
    } else {
      message = (error.message || error.details);
      if (message && error.module && error.module.resource) {
        message = `${filepath}${os.EOL}${message!.replace(error.module.resource, '')}`;
      }
    }

    if (message === undefined) {
      return 'Unknown';
    } else if (typeof message === 'string') {
      return message.substr(0, 256); // limit message length to 256 characters, fixes #20
    } else {
      throw `Invalid message type '${typeof message}'; messageFormatter must return a string.`;
    }
  };

  private readonly onCompilationDone = (results: webpack.Stats): void => {
    let notify: boolean = false;
    let title = `${this.title} - `;
    let msg = 'Build successful!';
    let icon = this.successIcon;
    let sound = this.successSound;
    let compilationStatus = CompilationStatus.SUCCESS;

    if (results.hasErrors()) {
      const error = results.compilation.errors[0];
      const errorFilePath = error.module && error.module.rawRequest ? error.module.rawRequest : '';
      notify = true;
      compilationStatus = CompilationStatus.ERROR;
      title += 'Error';
      msg = this.formatMessage(error, errorFilePath);
      icon = this.failureIcon;
      sound = this.failureSound;
      this.buildSuccessful = false;
    } else if (!this.suppressWarning && results.hasWarnings()) {
      const warning = results.compilation.warnings[0];
      const warningFilePath = warning.module && warning.module.rawRequest ? warning.module.rawRequest : '';
      notify = true;
      compilationStatus = CompilationStatus.WARNING;
      title += 'Warning';
      msg = this.formatMessage(warning, warningFilePath);
      icon = this.warningIcon;
      sound = this.warningSound;
      this.buildSuccessful = false;
    } else {
      title += 'Success';
      if (this.showDuration) {
        msg += ` [${results.endTime! - results.startTime!} ms]`;
      }
      /* istanbul ignore else */
      if (this.suppressSuccess === 'always' || (this.suppressSuccess === 'initial' && !this.hasRun)) {
        notify = false;
      } else if (this.suppressSuccess === false || !this.buildSuccessful) {
        notify = true; // previous build failed, let's show a notification even if success notifications are suppressed
      }
      this.buildSuccessful = true;
    }

    /* istanbul ignore else */
    if (notify) {
      notifier.notify(
        Object.assign(this.notifyOptions || {}, {
          title,
          sound,
          icon,
          appName: this.appName,
          message: stripAnsi(msg),
          contentImage: this.logo,
          wait: !this.buildSuccessful
        })
      );
      /* istanbul ignore else */
      if (this.onComplete) {
        this.onComplete(results.compilation, compilationStatus);
      }
    }

    /* istanbul ignore else */
    if (this.activateTerminalOnError && !this.buildSuccessful) {
      this.activateTerminalWindow();
    }

    this.hasRun = true;
  };

  private readonly onCompilationWatchRun = (
    compiler: webpack.compiler.Compiler,
    callback: Function
  ): void => {
    notifier.notify({
      appName: this.appName,
      title: this.title,
      message: 'Compilation started...',
      contentImage: this.logo,
      icon: this.compileIcon,
      sound: this.compilationSound
    } as Notification);
    /* istanbul ignore else */
    if (this.onCompileStart) {
      this.onCompileStart(compiler);
    }
    callback();
  };

  private readonly registerSnoreToast = (): void => {
    // ensure the SnoreToast appId is registered, which is needed for Windows Toast notifications
    // this is necessary in Windows 8 and above, (Windows 10 post build 1709), where all notifications must be generated
    // by a valid application.
    // see: https://github.com/KDE/snoretoast, https://github.com/RoccoC/webpack-build-notifier/issues/20
    /* istanbul ignore else */
    if (process.platform === 'win32') {
      const versionParts = os.release().split('.');
      const winVer = +(`${versionParts[0]}.${versionParts[1]}`);
      /* istanbul ignore else */
      if (winVer >= 6.2) {
        // Windows version >= 8
        const snoreToast = path.join(
          require.resolve('node-notifier'),
          '../vendor/snoreToast',
          `snoretoast-${process.arch === 'x64' ? 'x64' : 'x86'}.exe`
        );
        try {
          execFileSync(
            snoreToast,
            [
              '-appID',
              'Snore.DesktopToasts',
              '-install',
              'SnoreToast.lnk',
              snoreToast,
              'Snore.DesktopToasts'
            ]
          );
          this.appName = 'Snore.DesktopToasts';
        } catch (e) {
          console.error('An error occurred while attempting to install the SnoreToast AppID!', e);
        }
      }
    }
  };
}

module.exports = WebpackBuildNotifierPlugin;

1	/**
2	* @class WebpackBuildNotifierPlugin
3	* @extends Object
4	* A Webpack plugin that generates OS notifications for build steps using node-notifier.
5	*/
6	import path from 'path';	1✔
7	import process from 'process';	1✔
8	import os from 'os';	1✔
9	import notifier from 'node-notifier';	1✔
10	import stripAnsi from 'strip-ansi';	1✔
11	import { exec, execFileSync } from 'child_process';	1✔
12	import { Notification } from 'node-notifier/notifiers/notificationcenter';
13	import { CompilationResult, Config, CompilationStatus } from './types';	1✔
14	import webpack from 'webpack';
15
16	const DEFAULT_ICON_PATH = path.resolve(__dirname, 'icons');	1✔
17
18	export default class WebpackBuildNotifierPlugin {	1✔
19	private appName: string \| undefined = undefined;	22✔
20	private buildSuccessful: boolean = false;	22✔
21	private hasRun: boolean = false;	22✔
22
23	// config options
24	private title: string = 'Webpack Build';	22✔
25	private logo?: string;
26	private sound: string = 'Submarine';	22✔
27	private successSound: string = this.sound;	22✔
28	private warningSound: string = this.sound;	22✔
29	private failureSound: string = this.sound;	22✔
30	private compilationSound: string = this.sound;	22✔
31	private suppressSuccess: boolean \| 'always' \| 'initial' = false;	22✔
32	private suppressWarning: boolean = false;	22✔
33	private suppressCompileStart: boolean = true;	22✔
34	private activateTerminalOnError: boolean = false;	22✔
35	private showDuration: boolean = false;	22✔
36	private successIcon: string = path.join(DEFAULT_ICON_PATH, 'success.png');	22✔
37	private warningIcon: string = path.join(DEFAULT_ICON_PATH, 'warning.png');	22✔
38	private failureIcon: string = path.join(DEFAULT_ICON_PATH, 'failure.png');	22✔
39	private compileIcon: string = path.join(DEFAULT_ICON_PATH, 'compile.png');	22✔
40	private onCompileStart?: (compilation: webpack.compiler.Compiler) => void;
41	private onComplete?: (compilation: webpack.compilation.Compilation, status: CompilationStatus) => void;
42	private onClick: (notifier: notifier.NodeNotifier, options: Notification) => void = () => this.activateTerminalWindow;	22✔
43	private onTimeout?: (notifier: notifier.NodeNotifier, options: Notification) => void;
44	private messageFormatter?: (error: CompilationResult, filepath: string) => string;
45	private notifyOptions?: Notification;
46
47	constructor(cfg?: Config) {	22✔
48	Object.assign(this, cfg);	22✔
49
50	this.registerSnoreToast();	22✔
51
52	notifier.on('click', this.onClick);	22✔
53	/* istanbul ignore else */
54	if (this.onTimeout) {	22✔
55	notifier.on('timeout', this.onTimeout);	1✔
56	}
57	}
58
59	public apply(compiler: webpack.Compiler): void {	1✔
60	if (compiler.hooks && compiler.hooks.watchRun && compiler.hooks.done) {	20!
61	// for webpack >= 4
62	/* istanbul ignore else */
63	if (!this.suppressCompileStart) {	20✔
64	compiler.hooks.watchRun.tapAsync('webpack-build-notifier', this.onCompilationWatchRun);	20✔
65	}
66	compiler.hooks.done.tap('webpack-build-notifier', this.onCompilationDone);	20✔
67	} else {
68	// for webpack < 4
69	/* istanbul ignore else */
70	if (!this.suppressCompileStart) {	×
71	compiler.plugin('watch-run', this.onCompilationWatchRun);	×
72	}
73	compiler.plugin('done', this.onCompilationDone);	×
74	}
75	}
76
77	private readonly activateTerminalWindow = (): void => {	22✔
78	if (process.platform === 'darwin') {	2✔
79	// TODO: is there a way to translate $TERM_PROGRAM into the application name
80	// to make this more flexible?
81	exec('TERM="$TERM_PROGRAM"; ' +	1✔
82	'[[ "$TERM" == "Apple_Terminal" ]] && TERM="Terminal"; ' +
83	'[[ "$TERM" == "vscode" ]] && TERM="Visual Studio Code"; ' +
84	'osascript -e "tell application \\"$TERM\\" to activate"');
85	} else if (process.platform === 'win32') {	1!
86	// TODO: Windows platform
87	}
88	};
89
90	private readonly formatMessage = (	22✔
91	error: CompilationResult,
92	filepath: string
93	): string => {
94	let message: string \| undefined = undefined;	12✔
95	if (this.messageFormatter) {	12✔
96	message = this.messageFormatter(error, filepath);	6✔
97	} else {
98	message = (error.message \|\| error.details);	6!
99	if (message && error.module && error.module.resource) {	6✔
100	message = `${filepath}${os.EOL}${message!.replace(error.module.resource, '')}`;	4✔
101	}
102	}
103
104	if (message === undefined) {	12✔
105	return 'Unknown';	2✔
106	} else if (typeof message === 'string') {	10✔
107	return message.substr(0, 256); // limit message length to 256 characters, fixes #20	8✔
108	} else {
109	throw `Invalid message type '${typeof message}'; messageFormatter must return a string.`;	2✔
110	}
111	};
112
113	private readonly onCompilationDone = (results: webpack.Stats): void => {	22✔
114	let notify: boolean = false;	22✔
115	let title = `${this.title} - `;	22✔
116	let msg = 'Build successful!';	22✔
117	let icon = this.successIcon;	22✔
118	let sound = this.successSound;	22✔
119	let compilationStatus = CompilationStatus.SUCCESS;	22✔
120
121	if (results.hasErrors()) {	22✔
122	const error = results.compilation.errors[0];	10✔
123	const errorFilePath = error.module && error.module.rawRequest ? error.module.rawRequest : '';	10!
124	notify = true;	10✔
125	compilationStatus = CompilationStatus.ERROR;	10✔
126	title += 'Error';	10✔
127	msg = this.formatMessage(error, errorFilePath);	10✔
128	icon = this.failureIcon;	8✔
129	sound = this.failureSound;	8✔
130	this.buildSuccessful = false;	8✔
131	} else if (!this.suppressWarning && results.hasWarnings()) {	12✔
132	const warning = results.compilation.warnings[0];	2✔
133	const warningFilePath = warning.module && warning.module.rawRequest ? warning.module.rawRequest : '';	2!
134	notify = true;	2✔
135	compilationStatus = CompilationStatus.WARNING;	2✔
136	title += 'Warning';	2✔
137	msg = this.formatMessage(warning, warningFilePath);	2✔
138	icon = this.warningIcon;	2✔
139	sound = this.warningSound;	2✔
140	this.buildSuccessful = false;	2✔
141	} else {
142	title += 'Success';	10✔
143	if (this.showDuration) {	10✔
144	msg += ` [${results.endTime! - results.startTime!} ms]`;	2✔
145	}
146	/* istanbul ignore else */
147	if (this.suppressSuccess === 'always' \|\| (this.suppressSuccess === 'initial' && !this.hasRun)) {	10✔
148	notify = false;	2✔
149	} else if (this.suppressSuccess === false \|\| !this.buildSuccessful) {
150	notify = true; // previous build failed, let's show a notification even if success notifications are suppressed
151	}
152	this.buildSuccessful = true;	10✔
153	}
154
155	/* istanbul ignore else */
156	if (notify) {	20✔
157	notifier.notify(	18✔
158	Object.assign(this.notifyOptions \|\| {}, {	36✔
159	title,
160	sound,
161	icon,
162	appName: this.appName,
163	message: stripAnsi(msg),
164	contentImage: this.logo,
165	wait: !this.buildSuccessful
166	})
167	);
168	/* istanbul ignore else */
169	if (this.onComplete) {	18✔
170	this.onComplete(results.compilation, compilationStatus);	6✔
171	}
172	}
173
174	/* istanbul ignore else */
175	if (this.activateTerminalOnError && !this.buildSuccessful) {	20✔
176	this.activateTerminalWindow();	2✔
177	}
178
179	this.hasRun = true;	20✔
180	};
181
182	private readonly onCompilationWatchRun = (	22✔
183	compiler: webpack.compiler.Compiler,
184	callback: Function
185	): void => {
186	notifier.notify({	4✔
187	appName: this.appName,
188	title: this.title,
189	message: 'Compilation started...',
190	contentImage: this.logo,
191	icon: this.compileIcon,
192	sound: this.compilationSound
193	} as Notification);
194	/* istanbul ignore else */
195	if (this.onCompileStart) {	4✔
196	this.onCompileStart(compiler);	4✔
197	}
198	callback();	4✔
199	};
200
201	private readonly registerSnoreToast = (): void => {	22✔
202	// ensure the SnoreToast appId is registered, which is needed for Windows Toast notifications
203	// this is necessary in Windows 8 and above, (Windows 10 post build 1709), where all notifications must be generated
204	// by a valid application.
205	// see: https://github.com/KDE/snoretoast, https://github.com/RoccoC/webpack-build-notifier/issues/20
206	/* istanbul ignore else */
207	if (process.platform === 'win32') {	22✔
208	const versionParts = os.release().split('.');	10✔
209	const winVer = +(`${versionParts[0]}.${versionParts[1]}`);	10✔
210	/* istanbul ignore else */
211	if (winVer >= 6.2) {	10✔
212	// Windows version >= 8
213	const snoreToast = path.join(	10✔
214	require.resolve('node-notifier'),
215	'../vendor/snoreToast',
216	`snoretoast-${process.arch === 'x64' ? 'x64' : 'x86'}.exe`	10!
217	);
218	try {	10✔
219	execFileSync(	10✔
220	snoreToast,
221	[
222	'-appID',
223	'Snore.DesktopToasts',
224	'-install',
225	'SnoreToast.lnk',
226	snoreToast,
227	'Snore.DesktopToasts'
228	]
229	);
230	this.appName = 'Snore.DesktopToasts';	10✔
231	} catch (e) {
232	console.error('An error occurred while attempting to install the SnoreToast AppID!', e);	×
233	}
234	}
235	}
236	};
237	}	1✔
238
239	module.exports = WebpackBuildNotifierPlugin;	1✔

RoccoC / webpack-build-notifier / 86

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous