feat(GUI): add metadata and icon to notifications (#1455)

We add the image filename, its destination drive, and application icon
to the notifications.

See: https://github.com/resin-io/etcher/issues/1443
Changelog-Entry: Add image name, drive name, and icon to notifications.
This commit is contained in:
Benedict Aas 2017-05-22 20:06:32 +01:00 committed by Juan Cruz Viotti
parent 8e681b5534
commit 3df6cd07d0
3 changed files with 32 additions and 10 deletions

View File

@ -29,20 +29,23 @@ const electron = require('electron');
* http://electron.atom.io/docs/v0.37.5/tutorial/desktop-environment-integration/ * http://electron.atom.io/docs/v0.37.5/tutorial/desktop-environment-integration/
* *
* @param {String} title - notification title * @param {String} title - notification title
* @param {String} body - notification body * @param {Object} options - options object
* @param {String} options.body - notification body
* @param {String} options.icon - supported icon path
* @returns {Object} HTML5 notification instance * @returns {Object} HTML5 notification instance
* *
* @example * @example
* notification.send('Hello', 'Foo Bar Bar'); * notification.send('Hello', {
* body: 'Foo Bar Bar',
* icon: 'icon.png'
* });
*/ */
exports.send = (title, body) => { exports.send = (title, options) => {
// `app.dock` is only defined in OS X // `app.dock` is only defined in OS X
if (electron.remote.app.dock) { if (electron.remote.app.dock) {
electron.remote.app.dock.bounce(); electron.remote.app.dock.bounce();
} }
return new Notification(title, { return new Notification(title, options);
body
});
}; };

View File

@ -21,6 +21,7 @@ const settings = require('../../../models/settings');
const flashState = require('../../../models/flash-state'); const flashState = require('../../../models/flash-state');
const utils = require('../../../../shared/utils'); const utils = require('../../../../shared/utils');
const notification = require('../../../os/notification'); const notification = require('../../../os/notification');
const path = require('path');
module.exports = function( module.exports = function(
$state, $state,
@ -61,12 +62,24 @@ module.exports = function(
ImageWriterService.flash(image.path, drive).then(() => { ImageWriterService.flash(image.path, drive).then(() => {
if (!flashState.wasLastFlashCancelled()) { if (!flashState.wasLastFlashCancelled()) {
notification.send('Success!', messages.info.flashComplete()); notification.send('Success!', {
body: messages.info.flashComplete({
imageBasename: path.basename(image.path),
drive
}),
icon: '../../../../../assets/icon.png'
});
$state.go('success'); $state.go('success');
} }
}) })
.catch((error) => { .catch((error) => {
notification.send('Oops!', messages.error.flashFailure()); notification.send('Oops! Looks like the flash failed.', {
body: messages.error.flashFailure({
imageBasename: path.basename(image.path),
drive
}),
icon: '../../../../../assets/icon.png'
});
// TODO: All these error codes to messages translations // TODO: All these error codes to messages translations
// should go away if the writer emitted user friendly // should go away if the writer emitted user friendly

View File

@ -32,7 +32,10 @@ module.exports = {
*/ */
info: { info: {
flashComplete: _.template('Your flash is complete!') flashComplete: _.template([
'<%= imageBasename %> was successfully written to',
'<%= drive.description %> (<%= drive.name %>)'
].join(' '))
}, },
@ -86,7 +89,10 @@ module.exports = {
elevationRequired: _.template('This should should be run with root/administrator permissions.'), elevationRequired: _.template('This should should be run with root/administrator permissions.'),
flashFailure: _.template('Looks like your flash has failed!'), flashFailure: _.template([
'Something went wrong while writing <%= imageBasename %>',
'to <%= drive.description %> (<%= drive.name %>)'
].join(' ')),
driveUnplugged: _.template([ driveUnplugged: _.template([
'Looks like Etcher lost access to the drive.', 'Looks like Etcher lost access to the drive.',