update electron-builder to v13.0.0

🎉 switched to NSIS + autoupdates

.travis.yml

@@ -1,12 +1,13 @@
-language: node_js
+sudo: required
+dist: trusty
 
 os:
 - osx
 - linux
-sudo: required
 
+language: node_js
 node_js:
-  - 'node'
+- '6'
 
 before_install:
 - npm install -g gulp
@@ -14,7 +15,10 @@ before_install:
 
 cache:
   directories:
-    - node_modules
+  - node_modules
+  - app/node_modules
+  - $HOME/.electron
+  - $HOME/.cache
 
 script:
 - npm run travis

README.md

@@ -11,6 +11,15 @@ The goal is to achieve feature-compatibility with the old desktop app
 and then start adding cool features like easy support for
 multi-account, auto-updates etc.
 
+## Prerequisites
+* node >= v6.3.1
+* npm >= 3.10.3
+* python (v2.7.x recommended)
+* If you're on Debian or Ubuntu, you'll need to install following packages:
+```sh
+$ sudo apt-get install nodejs-legacy build-essential libxext-dev libxtst-dev libxkbfile-dev
+```
+
 ## Installation
 
 Clone the source locally:
@@ -19,14 +28,6 @@ Clone the source locally:
 $ git clone https://github.com/zulip/zulip-electron
 $ cd zulip-electron
 ```
-If you're on Debian or Ubuntu, you'll also need to install
-`nodejs-legacy`:
-
-Use your package manager to install `npm`.
-
-```sh
-$ sudo apt-get install npm nodejs-legacy
-```
 
 Install project dependencies:
 
@@ -59,6 +60,8 @@ You can create Windows installer only when running on Windows, the same is true
 
 - [x] Native Notifications
 - [x] SpellChecker
+- [x] OSX/Win/Linux installer
+- [x] Automatic Updates (macOS/Windows)
 - [x] Keyboard shortcuts
 
 Description            | Keys
@@ -68,9 +71,6 @@ Change Zulip Server    | <kbd>Cmd/Ctrl</kbd> <kbd>,</kbd>
 Back                   | <kbd>Cmd/Ctrl</kbd> <kbd>[</kbd>
 Forward                | <kbd>Cmd/Ctrl</kbd> <kbd>]</kbd>
 
-- [x] OSX/Win/Linux installer
-- [ ] Launch on OS startup
-- [ ] Automatic Updates
 
 ## Contribute
 

app/main/autoupdater.js

@@ -0,0 +1,56 @@
+'use strict';
+// const os = require('os');
+const {app, dialog} = require('electron');
+const {autoUpdater} = require('electron-updater');
+
+// We don't need to call all of these since it's automatically handled by electron-updater
+// const version = app.getVersion();
+// const platform = os.platform() + '_' + os.arch();  // usually returns darwin_64
+// const updaterFeedURL = 'http://zulipdesktop.herokuapp.com/update/' + platform + '/' + version;
+
+function appUpdater() {
+	// autoUpdater.setFeedURL(updaterFeedURL);
+
+	// Log whats happening
+	const log = require('electron-log');
+	log.transports.file.level = 'info';
+	autoUpdater.logger = log;
+	// TODO send autoUpdater events to renderer so that we could
+	// it could console log in developer tools
+	/*
+	autoUpdater.on('error', err => console.log(err));
+	autoUpdater.on('checking-for-update', () => console.log('checking-for-update'));
+	autoUpdater.on('update-available', () => console.log('update-available'));
+	autoUpdater.on('update-not-available', () => console.log('update-not-available'));
+	*/
+
+	// Ask the user if update is available
+	autoUpdater.on('update-downloaded', (event, info) => {
+		// let message = app.getName() + ' ' + info.releaseName + ' is now available. It will be installed the next time you restart the application.';
+		// if (info.releaseNotes) {
+			// const splitNotes = info.releaseNotes.split(/[^\r]\n/);
+			// message += '\n\nRelease notes:\n';
+			// splitNotes.forEach(notes => {
+				// message += notes + '\n\n';
+			// });
+		// }
+		// Ask user to update the app
+		dialog.showMessageBox({
+			type: 'question',
+			buttons: ['Install and Relaunch', 'Later'],
+			defaultId: 0,
+			message: 'A new version of ' + app.getName() + ' has been downloaded',
+			detail: 'It will be installed the next time you restart the application'
+		}, response => {
+			if (response === 0) {
+				setTimeout(() => autoUpdater.quitAndInstall(), 1);
+			}
+		});
+	});
+	// init for updates
+	autoUpdater.checkForUpdates();
+}
+
+exports = module.exports = {
+	appUpdater
+};

app/main/domain.js

@@ -1,7 +1,7 @@
-const JsonDB = require('node-json-db');
 const {app} = require('electron').remote;
-const request = require('request');
 const ipcRenderer = require('electron').ipcRenderer;
+const JsonDB = require('node-json-db');
+const request = require('request');
 
 const db = new JsonDB(app.getPath('userData') + '/domain.json', true, true);
 const data = db.getData('/');
@@ -29,7 +29,7 @@ window.addDomain = function () {
 			ipcRenderer.send('new-domain', domain);
 		} else {
 			document.getElementById('main').innerHTML = 'Connect';
-			document.getElementById('server-status').innerHTML = 'Not a vaild Zulip Server.';
+			document.getElementById('server-status').innerHTML = 'Not a valid Zulip Server.';
 		}
 	});
 };

app/main/index.js

@@ -3,23 +3,30 @@ const path = require('path');
 const fs = require('fs');
 const electron = require('electron');
 const {app} = require('electron');
-const electronLocalshortcut = require('electron-localshortcut');
 const ipc = require('electron').ipcMain;
+const electronLocalshortcut = require('electron-localshortcut');
 const Configstore = require('configstore');
 const JsonDB = require('node-json-db');
+const isDev = require('electron-is-dev');
 const tray = require('./tray');
 const appMenu = require('./menu');
 const {linkIsInternal, skipImages} = require('./link-helper');
+const {appUpdater} = require('./autoupdater');
 
 const db = new JsonDB(app.getPath('userData') + '/domain.json', true, true);
 const data = db.getData('/');
 
+/* Handling squirrel.windows events on windows
+Update - Not needed for NSIS
+if (require('electron-squirrel-startup')) {
+	app.quit();
+} */
+
 // adds debug features like hotkeys for triggering dev tools and reload
 require('electron-debug')();
 
 const conf = new Configstore('Zulip-Desktop');
 
-
 // prevent window being garbage collected
 let mainWindow;
 let targetLink;
@@ -30,9 +37,8 @@ const staticURL = 'file://' + path.join(__dirname, '../renderer', 'index.html');
 const targetURL = function () {
 	if (data.domain === undefined) {
 		return staticURL;
-	} else {
-		return data.domain;
 	}
+	return data.domain;
 };
 
 const isAlreadyRunning = app.makeSingleInstance(() => {
@@ -56,6 +62,10 @@ function checkWindowURL() {
 	return targetLink;
 }
 
+function isWindowsOrmacOS() {
+	return process.platform === 'darwin' || process.platform === 'win32';
+}
+
 const APP_ICON = path.join(__dirname, '../resources', 'Icon');
 
 const iconPath = () => {
@@ -150,6 +160,8 @@ function createMainWindow() {
 app.commandLine.appendSwitch('ignore-certificate-errors', 'true');
 
 app.on('window-all-closed', () => {
+	// unregister all the shortcuts so that they don't interfare with other apps
+	electronLocalshortcut.unregisterAll(mainWindow);
 	if (process.platform !== 'darwin') {
 		app.quit();
 	}
@@ -198,6 +210,19 @@ app.on('ready', () => {
 		event.preventDefault();
 		electron.shell.openExternal(url);
 	});
+
+	page.once('did-frame-finish-load', () => {
+		const checkOS = isWindowsOrmacOS();
+		if (checkOS && !isDev) {
+			// Initate auto-updates on macOs and windows
+			appUpdater();
+		}
+	});
+});
+
+app.on('will-quit', () => {
+	// unregister all the shortcuts so that they don't interfare with other apps
+	electronLocalshortcut.unregisterAll(mainWindow);
 });
 
 ipc.on('new-domain', (e, domain) => {

app/main/macos-swipe-navigation.js

@@ -0,0 +1,69 @@
+// Adopted from
+// https://github.com/wozaki/twitter-js-apps/blob/9bc00eafd575fd180dc7a450e1b1daf425e67b80/redux/src/main/renderer/registries/electron/swipeNavigatorImpl.js
+
+'use strict'
+const {remote} = require('electron');
+
+const THRESHOLD_DELTA_X = 70;
+const THRESHOLD_LIMIT_DELTA_Y = 50;
+const THRESHOLD_TIME = 50;
+
+// TODO avoid module global state
+let tracking = false;
+let deltaX = 0;
+let deltaY = 0;
+let startTime = 0;
+let time = 0;
+
+module.exports.register = function register() {
+  remote.getCurrentWindow()
+    .on('scroll-touch-begin', onScrollBegin)
+    .on('scroll-touch-end', onScrollEnd)
+    .on('swipe', onSwipe)
+
+  window.addEventListener('wheel', onMouseWheel, {passive: true});
+  window.addEventListener('beforeunload', remove);
+}
+
+const remove = module.exports.remove = function remove() {
+  remote.getCurrentWindow()
+    .removeListener('scroll-touch-begin', onScrollBegin)
+    .removeListener('scroll-touch-end', onScrollEnd)
+    .removeListener('swipe', onSwipe)
+
+  window.removeEventListener('mousewheel', onMouseWheel);
+  window.removeEventListener('beforeunload', remove);
+}
+
+function onSwipe(e, direction) {
+  if (direction === 'left')
+    remote.getCurrentWebContents().goBack()
+  else if (direction === 'right')
+    remote.getCurrentWebContents().goForward()
+}
+
+function onMouseWheel(e) {
+  if (tracking) {
+    deltaX = deltaX + e.deltaX
+    deltaY = deltaY + e.deltaY
+    time   = (new Date()).getTime() - startTime
+  }
+}
+
+function onScrollBegin() {
+  tracking  = true
+  startTime = (new Date()).getTime()
+}
+
+function onScrollEnd() {
+  if (time > THRESHOLD_TIME && tracking && Math.abs(deltaY) < THRESHOLD_LIMIT_DELTA_Y)
+    if (deltaX > THRESHOLD_DELTA_X)
+      remote.getCurrentWebContents().goForward()
+    else if (deltaX < -THRESHOLD_DELTA_X)
+      remote.getCurrentWebContents().goBack()
+
+  tracking = false
+  deltaX = 0
+  deltaY = 0
+  startTime = 0
+}

app/main/menu.js

@@ -2,6 +2,8 @@
 const os = require('os');
 const electron = require('electron');
 
+const {dialog} = require('electron');
+
 const app = electron.app;
 const BrowserWindow = electron.BrowserWindow;
 const shell = electron.shell;
@@ -19,10 +21,17 @@ function sendAction(action) {
 	win.webContents.send(action);
 }
 
+function clearCache() {
+	const win = BrowserWindow.getAllWindows()[0];
+	const ses = win.webContents.session;
+	ses.clearCache(() => {
+		dialog.showMessageBox({type: 'info', buttons: [], message: 'Cache cleared!'});
+	});
+}
+
 const viewSubmenu = [
 	{
 		label: 'Reload',
-		accelerator: 'CmdOrCtrl+R',
 		click(item, focusedWindow) {
 			if (focusedWindow) {
 				focusedWindow.reload();
@@ -135,8 +144,15 @@ const darwinTpl = [
 			{
 				type: 'separator'
 			},
+			{
+				label: 'Clear Cache',
+				click() {
+					clearCache();
+				}
+			},
 			{
 				label: 'Log Out',
+				accelerator: 'Cmd+L',
 				click(item, focusedWindow) {
 					if (focusedWindow) {
 						sendAction('log-out');
@@ -264,8 +280,15 @@ const otherTpl = [
 			{
 				type: 'separator'
 			},
+			{
+				label: 'Clear Cache',
+				click() {
+					clearCache();
+				}
+			},
 			{
 				label: 'Log Out',
+				accelerator: 'Ctrl+L',
 				click(item, focusedWindow) {
 					if (focusedWindow) {
 						sendAction('log-out');
@@ -313,7 +336,6 @@ const otherTpl = [
 			{
 				role: 'selectall'
 			}
-
 		]
 	},
 	{

app/main/preload.js

@@ -1,8 +1,15 @@
 'use strict';
 const ipcRenderer = require('electron').ipcRenderer;
+const {webFrame} = require('electron');
+const {spellChecker} = require('./spellchecker');
 
-// Handle zooming functionality
+// enable swipe back/forward navigation on macOS
+require('./macos-swipe-navigation.js').register();
 
+// eslint-disable-next-line import/no-unassigned-import
+require('./domain');
+
+// handle zooming functionality
 const zoomIn = () => {
 	webFrame.setZoomFactor(webFrame.getZoomFactor() + 0.1);
 };
@@ -15,7 +22,7 @@ const zoomActualSize = () => {
 	webFrame.setZoomFactor(1);
 };
 
-// Get zooming actions from main process
+// get zooming actions from main process
 ipcRenderer.on('zoomIn', () => {
 	zoomIn();
 });
@@ -44,9 +51,8 @@ ipcRenderer.on('shortcut', () => {
 	nodes[nodes.length - 1].click();
 });
 
-require('./domain');
-
 // To prevent failing this script on linux we need to load it after the document loaded
-document.addEventListener('DOMContentLoaded', function () {
-	require('./spellchecker');
+document.addEventListener('DOMContentLoaded', () => {
+	// init spellchecker
+	spellChecker();
 });

app/main/spellchecker.js

@@ -1,14 +1,27 @@
 const {SpellCheckHandler, ContextMenuListener, ContextMenuBuilder} = require('electron-spellchecker');
 
-// Implement spellcheck using electron api
+function spellChecker() {
+	// Implement spellcheck using electron api
+	window.spellCheckHandler = new SpellCheckHandler();
+	window.spellCheckHandler.attachToInput();
 
-window.spellCheckHandler = new SpellCheckHandler();
-window.spellCheckHandler.attachToInput();
+	// Start off as US English
+	window.spellCheckHandler.switchLanguage('en-US');
 
-// Start off as US English
-window.spellCheckHandler.switchLanguage('en-US');
+	const contextMenuBuilder = new ContextMenuBuilder(window.spellCheckHandler);
+	const contextMenuListener = new ContextMenuListener(info => {
+		contextMenuBuilder.showPopupMenu(info);
+	});
 
-let contextMenuBuilder = new ContextMenuBuilder(window.spellCheckHandler);
-let contextMenuListener = new ContextMenuListener((info) => {
-  contextMenuBuilder.showPopupMenu(info);
-});
+	// Clean up events after you navigate away from this page;
+	// otherwise, you may experience errors
+	window.addEventListener('beforeunload', () => {
+	// eslint-disable-next-line no-undef
+		spellCheckHandler.unsubscribe();
+		contextMenuListener.unsubscribe();
+	});
+}
+
+exports = module.exports = {
+	spellChecker
+};

app/main/tray.js

@@ -6,10 +6,13 @@ const {addDomain, about} = require('./windowmanager');
 
 let tray = null;
 
-const APP_ICON = path.join(__dirname, '../resources', 'Icon');
+const APP_ICON = path.join(__dirname, '../resources/tray', 'tray');
 
 const iconPath = () => {
-	return APP_ICON + (process.platform === 'win32' ? '.ico' : '.png');
+	if (process.platform === 'linux') {
+		return APP_ICON + 'linux.png';
+	}
+	return APP_ICON + (process.platform === 'win32' ? 'win.ico' : 'osx.png');
 };
 
 exports.create = () => {

app/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zulip",
   "productName": "Zulip",
-  "version": "0.5.1",
+  "version": "0.5.6",
   "description": "Zulip Desktop App",
   "license": "Apache-2.0",
   "email":"<svnitakash@gmail.com>",
@@ -27,15 +27,16 @@
     "InstantMessaging"
   ],
   "dependencies": {
-    "configstore": "^2.0.0",
+    "electron-is-dev": "0.1.2",
+    "electron-updater": "1.4.1",
+    "electron-log": "1.3.0",
+    "configstore": "2.1.0",
     "dialogs": "1.1.14",
-    "electron-context-menu": "0.4.0",
-    "electron-debug": "^1.0.0",
-    "electron-dl": "^0.2.0",
-    "electron-localshortcut": "^0.6.1",
-    "node-json-db": "^0.7.2",
-    "request": "^2.74.0",
-    "electron-spellchecker": "^0.5.12",
-    "wurl": "^2.1.0"
+    "electron-debug": "1.1.0",
+    "electron-localshortcut": "0.6.1",
+    "node-json-db": "0.7.3",
+    "request": "2.79.0",
+    "electron-spellchecker": "1.0.0",
+    "wurl": "2.1.0"
   }
 }

app/renderer/index.html

@@ -23,7 +23,7 @@
               <fieldset>
                 <div class="control-group control-required">
                   <div class="control-field">
-                    <input type="text" id="url"  autofocus="autofocus" spellcheck="false" placeholder="zulip.tabbott.net">
+                    <input type="text" id="url"  autofocus="autofocus" spellcheck="false" placeholder="chat.zulip.org">
                   </div>
                 </div>
                 <div class="control-group">

app/renderer/js/pref.js

@@ -1,4 +1,5 @@
 'use strict';
+// eslint-disable-next-line import/no-extraneous-dependencies
 const {remote} = require('electron');
 
 const prefWindow = remote.getCurrentWindow();
@@ -15,8 +16,10 @@ document.addEventListener('keydown', event => {
 // eslint-disable-next-line no-unused-vars
 function addDomain() {
 	const request = require('request');
+	// eslint-disable-next-line import/no-extraneous-dependencies
 	const ipcRenderer = require('electron').ipcRenderer;
 	const JsonDB = require('node-json-db');
+	// eslint-disable-next-line import/no-extraneous-dependencies
 	const {app} = require('electron').remote;
 
 	const db = new JsonDB(app.getPath('userData') + '/domain.json', true, true);
@@ -39,7 +42,7 @@ function addDomain() {
 		} else {
 			document.getElementById('pic').style.display = 'none';
 			document.getElementById('main').innerHTML = 'Switch';
-			document.getElementById('urladded').innerHTML = 'Not a vaild Zulip Server.';
+			document.getElementById('urladded').innerHTML = 'Not a valid Zulip Server.';
 		}
 	});
 }

app/renderer/pref.html

@@ -10,7 +10,7 @@
 		<div class="close" id="close-button">Close</div>
 		<div class="form">
 			<form onsubmit="addDomain(); return false">
-				<input id="url" type="text" placeholder="zulip.example.com">
+				<input id="url" type="text" placeholder="chat.zulip.org">
 				<button type="submit" id="main" value="Submit" onclick="addDomain();">
 				Switch</button>
 				<img id="pic" src="img/loader.gif" />
@@ -19,4 +19,4 @@
 			</div>
 			<script src="js/pref.js"></script>
 		</body>
-	</html>
+	</html>

package.json

@@ -1,7 +1,7 @@
 {
   "name": "zulip",
   "productName": "Zulip",
-  "version": "0.5.1",
+  "version": "0.5.6",
   "description": "Zulip Desktop App",
   "license": "Apache-2.0",
   "email":"<svnitakash@gmail.com>",
@@ -40,10 +40,10 @@
     "linux" : {
       "synopsis": "Zulip Desktop App",
       "category": "",
-      "packageCategory": "",
+      "packageCategory": "GNOME;GTK;Network;InstantMessaging",
       "description": "Zulip Desktop Client for Linux",
       "target" : ["deb", "AppImage"],
-      "version" : "0.5.1",
+      "version" : "0.5.6",
       "title" : "Zulip",
       "license": "Apache-2.0",
       "maintainer": "Akash Nimare <svnitakash@gmail.com>"
@@ -68,7 +68,12 @@
     },
     "win": {
       "target": "nsis",
-      "icon": "build/icon.ico"
+      "icon": "build/icon.ico",
+      "iconUrl": "https://raw.githubusercontent.com/zulip/zulip-electron/master/build/icon.ico"
+    },
+    "nsis": {
+      "perMachine": true,
+      "oneClick": false
     }
   },
   "keywords": [
@@ -82,7 +87,7 @@
   "devDependencies": {
     "assert": "^1.4.1",
     "devtron": "^1.1.0",
-    "electron-builder": "*",
+    "electron-builder": "13.0.0",
     "electron": "1.4.7",
     "electron-connect": "^0.4.6",
     "gulp": "^3.9.1",
@@ -98,15 +103,18 @@
         "rules": {
           "max-lines": [
             "warn",
-            350
+            500
           ],
           "no-warning-comments": 0,
-          "no-else-return": 0
+          "no-else-return": 0,
+          "import/no-unresolved": 0,
+          "import/no-extraneous-dependencies":0
         }
       }
     ],
     "ignore": [
-      "tests/*.js"
+      "tests/*.js",
+      "app/main/macos-swipe-navigation.js"
     ],
     "envs": [
       "node",

scripts/travis-build-test.sh

@@ -1,7 +1,8 @@
 #!/usr/bin/env bash
 
 if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
-  export DISPLAY=:99.0
+  export {no_proxy,NO_PROXY}="127.0.0.1,localhost"
+	export DISPLAY=:99.0
   sh -e /etc/init.d/xvfb start
   sleep 3
 fi

tests/index.js

@@ -2,7 +2,7 @@ const assert = require('assert')
 const Application = require('spectron').Application
 
 describe('application launch', function () {
-  this.timeout(10000)
+  this.timeout(15000)
 
   beforeEach(function () {
     this.app = new Application({

zulip-electron-launcher.sh

@@ -74,11 +74,11 @@ gitCheckout()
 }
 
 # }}}
-# {{{ npmUpgradeStart()
+# {{{ npmInstallStart()
 
-npmUpgradeStart()
+npmInstallStart()
 {
-	npm upgrade
+	npm install
 	npm start &
 }
 
@@ -105,5 +105,5 @@ cleanUp()
 
 envSetup $*
 gitCheckout
-npmUpgradeStart
-cleanUp
+npmInstallStart
+cleanUp