Merge pull request #4176 from vector-im/t3chguy/updating_stuff

improve update polling electron and provide a manual check for updates button

src/vector/index.js

@@ -59,7 +59,6 @@ var sdk = require("matrix-react-sdk");
 const PlatformPeg = require("matrix-react-sdk/lib/PlatformPeg");
 sdk.loadSkin(require('../component-index'));
 var VectorConferenceHandler = require('../VectorConferenceHandler');
-var UpdateChecker = require("./updater");
 var q = require('q');
 var request = require('browser-request');
 import * as UserSettingsStore from 'matrix-react-sdk/lib/UserSettingsStore';
@@ -275,7 +274,9 @@ async function loadApp() {
             Unable to load config file: please refresh the page to try again.
         </div>, document.getElementById('matrixchat'));
     } else if (validBrowser) {
-        UpdateChecker.start();
+        const platform = PlatformPeg.get();
+        platform.startUpdater();
+
         const MatrixChat = sdk.getComponent('structures.MatrixChat');
         window.matrixChat = ReactDOM.render(
             <MatrixChat
@@ -288,7 +289,7 @@ async function loadApp() {
                 enableGuest={true}
                 onTokenLoginCompleted={onTokenLoginCompleted}
                 initialScreenAfterLogin={getScreenFromLocation(window.location)}
-                defaultDeviceDisplayName={PlatformPeg.get().getDefaultDeviceDisplayName()}
+                defaultDeviceDisplayName={platform.getDefaultDeviceDisplayName()}
             />,
             document.getElementById('matrixchat')
         );

src/vector/platform/ElectronPlatform.js

@@ -17,11 +17,11 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import VectorBasePlatform from './VectorBasePlatform';
+import VectorBasePlatform, {updateCheckStatusEnum} from './VectorBasePlatform';
 import dis from 'matrix-react-sdk/lib/dispatcher';
 import { _t } from 'matrix-react-sdk/lib/languageHandler';
 import q from 'q';
-import electron, {remote, ipcRenderer} from 'electron';
+import {remote, ipcRenderer} from 'electron';
 
 remote.autoUpdater.on('update-downloaded', onUpdateDownloaded);
 
@@ -62,10 +62,42 @@ function _onAction(payload: Object) {
     }
 }
 
+function getUpdateCheckStatus(status) {
+    if (status === true) {
+        return { status: updateCheckStatusEnum.DOWNLOADING };
+    } else if (status === false) {
+        return { status: updateCheckStatusEnum.NOTAVAILABLE };
+    } else {
+        return {
+            status: updateCheckStatusEnum.ERROR,
+            detail: status,
+        };
+    }
+}
+
 export default class ElectronPlatform extends VectorBasePlatform {
     constructor() {
         super();
         dis.register(_onAction);
+        this.updatable = Boolean(remote.autoUpdater.getFeedURL());
+
+        /*
+            IPC Call `check_updates` returns:
+            true if there is an update available
+            false if there is not
+            or the error if one is encountered
+         */
+        ipcRenderer.on('check_updates', (event, status) => {
+            if (!this.showUpdateCheck) return;
+            dis.dispatch({
+                action: 'check_updates',
+                value: getUpdateCheckStatus(status),
+            });
+            this.showUpdateCheck = false;
+        });
+
+        this.startUpdateCheck = this.startUpdateCheck.bind(this);
+        this.stopUpdateCheck = this.stopUpdateCheck.bind(this);
     }
 
     getHumanReadableName(): string {
@@ -137,17 +169,18 @@ export default class ElectronPlatform extends VectorBasePlatform {
         return q(remote.app.getVersion());
     }
 
-    pollForUpdate() {
-        // In electron we control the update process ourselves, since
-        // it needs to run in the main process, so we just run the timer
-        // loop in the main electron process instead.
+    startUpdateCheck() {
+        if (this.showUpdateCheck) return;
+        super.startUpdateCheck();
+
+        ipcRenderer.send('check_updates');
     }
 
     installUpdate() {
         // IPC to the main process to install the update, since quitAndInstall
         // doesn't fire the before-quit event so the main process needs to know
         // it should exit.
-        electron.ipcRenderer.send('install_update');
+        ipcRenderer.send('install_update');
     }
 
     getDefaultDeviceDisplayName(): string {

src/vector/platform/VectorBasePlatform.js

@@ -19,9 +19,18 @@ limitations under the License.
 
 import BasePlatform from 'matrix-react-sdk/lib/BasePlatform';
 import { _t } from 'matrix-react-sdk/lib/languageHandler';
+import dis from 'matrix-react-sdk/lib/dispatcher';
 
 import Favico from 'favico.js';
 
+export const updateCheckStatusEnum = {
+    CHECKING: 'CHECKING',
+    ERROR: 'ERROR',
+    NOTAVAILABLE: 'NOTAVAILABLE',
+    DOWNLOADING: 'DOWNLOADING',
+    READY: 'READY',
+};
+
 /**
  * Vector-specific extensions to the BasePlatform template
  */
@@ -34,7 +43,12 @@ export default class VectorBasePlatform extends BasePlatform {
         // and we set the state each time, even if the value hasn't changed,
         // so we'd need to fix that if enabling the animation.
         this.favicon = new Favico({animation: 'none'});
+        this.showUpdateCheck = false;
         this._updateFavicon();
+        this.updatable = true;
+
+        this.startUpdateCheck = this.startUpdateCheck.bind(this);
+        this.stopUpdateCheck = this.stopUpdateCheck.bind(this);
     }
 
     getHumanReadableName(): string {
@@ -75,12 +89,32 @@ export default class VectorBasePlatform extends BasePlatform {
     }
 
     /**
-     * Check for the availability of an update to the version of the
-     * app that's currently running.
-     * If an update is available, this function should dispatch the
-     * 'new_version' action.
+     * Begin update polling, if applicable
      */
-    pollForUpdate() {
+    startUpdater() {
+    }
+
+    /**
+     * Whether we can call checkForUpdate on this platform build
+     */
+    canSelfUpdate(): boolean {
+        return this.updatable;
+    }
+
+    startUpdateCheck() {
+        this.showUpdateCheck = true;
+        dis.dispatch({
+            action: 'check_updates',
+            value: { status: updateCheckStatusEnum.CHECKING },
+        });
+    }
+
+    stopUpdateCheck() {
+        this.showUpdateCheck = false;
+        dis.dispatch({
+            action: 'check_updates',
+            value: false,
+        })
     }
 
     /**

src/vector/platform/WebPlatform.js

@@ -17,7 +17,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import VectorBasePlatform from './VectorBasePlatform';
+import VectorBasePlatform, {updateCheckStatusEnum} from './VectorBasePlatform';
 import request from 'browser-request';
 import dis from 'matrix-react-sdk/lib/dispatcher.js';
 import { _t } from 'matrix-react-sdk/lib/languageHandler';
@@ -26,10 +26,15 @@ import q from 'q';
 import url from 'url';
 import UAParser from 'ua-parser-js';
 
+var POKE_RATE_MS = 10 * 60 * 1000; // 10 min
+
 export default class WebPlatform extends VectorBasePlatform {
     constructor() {
         super();
         this.runningVersion = null;
+
+        this.startUpdateCheck = this.startUpdateCheck.bind(this);
+        this.stopUpdateCheck = this.stopUpdateCheck.bind(this);
     }
 
     getHumanReadableName(): string {
@@ -132,8 +137,13 @@ export default class WebPlatform extends VectorBasePlatform {
         return this._getVersion();
     }
 
+    startUpdater() {
+        this.pollForUpdate();
+        setInterval(this.pollForUpdate.bind(this), POKE_RATE_MS);
+    }
+
     pollForUpdate() {
-        this._getVersion().done((ver) => {
+        return this._getVersion().then((ver) => {
             if (this.runningVersion === null) {
                 this.runningVersion = ver;
             } else if (this.runningVersion !== ver) {
@@ -142,9 +152,29 @@ export default class WebPlatform extends VectorBasePlatform {
                     currentVersion: this.runningVersion,
                     newVersion: ver,
                 });
+                // Return to skip a MatrixChat state update
+                return;
             }
+            return { status: updateCheckStatusEnum.NOTAVAILABLE };
         }, (err) => {
             console.error("Failed to poll for update", err);
+            return {
+                status: updateCheckStatusEnum.ERROR,
+                detail: err.message || err.status ? err.status.toString() : 'Unknown Error',
+            };
+        });
+    }
+
+    startUpdateCheck() {
+        if (this.showUpdateCheck) return;
+        super.startUpdateCheck();
+        this.pollForUpdate().then((updateState) => {
+            if (!this.showUpdateCheck) return;
+            if (!updateState) return;
+            dis.dispatch({
+                action: 'check_updates',
+                value: updateState,
+            });
         });
     }
 

src/vector/updater.js

@@ -1,30 +0,0 @@
-/*
-Copyright 2016 OpenMarket Ltd
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-import PlatformPeg from 'matrix-react-sdk/lib/PlatformPeg';
-
-var POKE_RATE_MS = 10 * 60 * 1000; // 10 min
-
-module.exports = {
-    start: function() {
-        module.exports.poll();
-        setInterval(module.exports.poll, POKE_RATE_MS);
-    },
-
-    poll: function() {
-        PlatformPeg.get().pollForUpdate();
-    }
-};