Improve auto updater

.gitignore

@@ -8,3 +8,4 @@ release/
 *.tgz
 .idea
 .DS_Store
+dev-app-update.yml

desktop/updater/auto-updater/index.js

@@ -5,58 +5,68 @@
  */
 const EventEmitter = require('events').EventEmitter;
 const util = require('util');
-const electron = require( 'electron' );
-const autoUpdater = electron.autoUpdater;
-const dialog = electron.dialog;
+const { dialog } = require('electron');
+const { autoUpdater } = require('electron-updater');
+const sanitizeHtml = require('sanitize-html');
+const TurndownService = require('turndown');
+
+const config = require('../../config');
 
 /**
  * Internal dependencies
  */
-const AppQuit = require( '../..//app-quit' );
-
-function AutoUpdater( url ) {
-	this.hasPrompted = false;
-	this.url = url;
+const AppQuit = require('../../app-quit');
 
-	autoUpdater.on( 'error', () => this.emit( 'end' ) );
-	autoUpdater.on( 'update-not-available', () => this.emit( 'end' ) );
-	autoUpdater.on( 'update-downloaded', this.onDownloaded.bind( this ) );
+function AutoUpdater() {
+  this.hasPrompted = false;
 
-	try {
-		autoUpdater.setFeedURL( url );
-	} catch (e) {
-		console.log( e.message );
-	}
+  autoUpdater.on('error', () => this.emit('end'));
+  autoUpdater.on('update-not-available', () => this.emit('end'));
+  autoUpdater.on('update-downloaded', this.onDownloaded.bind(this));
 }
 
 util.inherits(AutoUpdater, EventEmitter);
 
 AutoUpdater.prototype.ping = function() {
-	autoUpdater.checkForUpdates();
+  autoUpdater.checkForUpdates();
+};
+
+AutoUpdater.prototype.onDownloaded = function(info) {
+  const releaseNotes = this.formatGithubReleaseNotes(info.releaseNotes);
+
+  const updateDialogOptions = {
+    buttons: ['Update & Restart', 'Cancel'],
+    title: 'Update Available',
+    message: `${config.name} ${info.releaseName}`,
+    detail: releaseNotes,
+  };
+
+  if (this.hasPrompted === false) {
+    this.hasPrompted = true;
+
+    dialog.showMessageBox(updateDialogOptions, button => {
+      this.hasPrompted = false;
+
+      if (button === 0) {
+        AppQuit.allowQuit();
+        autoUpdater.quitAndInstall();
+      } else {
+        this.emit('end');
+      }
+    });
+  }
 };
 
-AutoUpdater.prototype.onDownloaded = function( event, releaseNotes, releaseName, releaseDate, updateUrl, quitAndUpdate ) {
-	const updateDialogOptions = {
-		buttons: [ 'Update & Restart', 'Cancel' ],
-		title: 'Update Available',
-		message: releaseName,
-		detail: releaseNotes
-	};
-
-	if ( this.hasPrompted === false ) {
-		this.hasPrompted = true;
-
-		dialog.showMessageBox( updateDialogOptions, button => {
-			this.hasPrompted = false;
-
-			if ( button === 0 ) {
-				AppQuit.allowQuit();
-				quitAndUpdate();
-			} else {
-				this.emit( 'end' );
-			}
-		} );
-	}
+AutoUpdater.prototype.formatGithubReleaseNotes = function(releaseNotes) {
+  const turndownService = new TurndownService();
+
+  let sanitizedHtml = releaseNotes;
+  sanitizedHtml = sanitizeHtml(releaseNotes, {
+    allowedTags: ['p', 'ul', 'ol', 'li'],
+    allowedAttributes: [],
+  }).replace(/\(@(.*)\)/g, ''); // remove user mentions
+
+  return turndownService.turndown(sanitizedHtml);
 };
 
 module.exports = AutoUpdater;

desktop/updater/index.js

@@ -3,9 +3,7 @@
 /**
  * External Dependencies
  */
-const electron = require('electron');
-const app = electron.app;
-const dialog = electron.dialog;
+const { app } = require('electron');
 
 /**
  * Internal dependencies
@@ -18,13 +16,7 @@ const ManualUpdater = require('./manual-updater');
 let updater = false;
 
 function urlBuilder(version) {
-  let platformString = 'osx';
-
-  if (platform.isWindows()) {
-    platformString = 'windows';
-  } else if (platform.isLinux()) {
-    platformString = 'linux';
-  }
+  const platformString = 'linux';
 
   if (config.forceUpdate) {
     version = '0.0.1';
@@ -37,11 +29,11 @@ function urlBuilder(version) {
 
 module.exports = function() {
   app.on('will-finish-launching', function() {
-    let url = urlBuilder(app.getVersion());
-
-    if (platform.isOSX()) {
-      updater = new AutoUpdater(url);
+    // TODO:@adlk: `electron-updater` supports AppImage as well
+    if (platform.isOSX() || platform.isWindows()) {
+      updater = new AutoUpdater();
     } else {
+      const url = urlBuilder(app.getVersion());
       updater = new ManualUpdater(url);
     }