From 0bdac639536cfd43716fa0e58e716ec9207e6909 Mon Sep 17 00:00:00 2001
From: Pavel Djundik <xPaw@users.noreply.github.com>
Date: Thu, 2 Jan 2020 12:54:47 +0200
Subject: [PATCH 1/5] Check for TL updates on server start

---
 client/components/VersionChecker.vue    |  9 ++-------
 client/components/Windows/Changelog.vue |  2 +-
 client/js/socket-events/changelog.js    |  8 +++++++-
 src/plugins/changelog.js                | 17 ++++++++---------
 src/server.js                           | 12 ++++++++++++
 5 files changed, 30 insertions(+), 18 deletions(-)

diff --git a/client/components/VersionChecker.vue b/client/components/VersionChecker.vue
index d9c390f1..f2dbc684 100644
--- a/client/components/VersionChecker.vue
+++ b/client/components/VersionChecker.vue
@@ -1,7 +1,7 @@
 <template>
 	<div id="version-checker" :class="[$store.state.versionStatus]">
 		<p v-if="$store.state.versionStatus === 'loading'">
-			Checking for updates...
+			Checking for updates…
 		</p>
 		<p v-if="$store.state.versionStatus === 'new-version'">
 			The Lounge <b>{{ $store.state.versionData.latest.version }}</b>
@@ -35,7 +35,7 @@
 		</template>
 		<template v-if="$store.state.versionStatus === 'error'">
 			<p>
-				Information about latest releases could not be retrieved.
+				Information about latest release could not be retrieved.
 			</p>
 
 			<button id="check-now" class="btn btn-small" @click="checkNow">Try again</button>
@@ -48,11 +48,6 @@ import socket from "../js/socket";
 
 export default {
 	name: "VersionChecker",
-	data() {
-		return {
-			status: "loading",
-		};
-	},
 	mounted() {
 		if (!this.$store.state.versionData) {
 			this.checkNow();
diff --git a/client/components/Windows/Changelog.vue b/client/components/Windows/Changelog.vue
index a516934b..55961d11 100644
--- a/client/components/Windows/Changelog.vue
+++ b/client/components/Windows/Changelog.vue
@@ -26,7 +26,7 @@
 					></div>
 				</template>
 				<template v-else>
-					<p>Unable to retrieve releases from GitHub.</p>
+					<p>Unable to retrieve changelog for current release from GitHub.</p>
 					<p>
 						<a
 							:href="
diff --git a/client/js/socket-events/changelog.js b/client/js/socket-events/changelog.js
index f840e575..d647d16e 100644
--- a/client/js/socket-events/changelog.js
+++ b/client/js/socket-events/changelog.js
@@ -24,6 +24,12 @@ socket.on("changelog", function(data) {
 	// When there is a button to refresh the checker available, display it when
 	// data is expired. Before that, server would return same information anyway.
 	if (data.expiresAt) {
-		setTimeout(() => store.commit("versionDataExpired", true), data.expiresAt - Date.now());
+		const expires = data.expiresAt - Date.now();
+
+		if (expires > 0) {
+			setTimeout(() => store.commit("versionDataExpired", true), expires);
+		} else {
+			store.commit("versionDataExpired", true);
+		}
 	}
 });
diff --git a/src/plugins/changelog.js b/src/plugins/changelog.js
index 0ae90222..df474365 100644
--- a/src/plugins/changelog.js
+++ b/src/plugins/changelog.js
@@ -7,6 +7,7 @@ const pkg = require("../../package.json");
 const TIME_TO_LIVE = 15 * 60 * 1000; // 15 minutes, in milliseconds
 
 module.exports = {
+	isUpdateAvailable: false,
 	fetch,
 };
 
@@ -17,8 +18,10 @@ const versions = {
 };
 
 async function fetch() {
+	const time = Date.now();
+
 	// Serving information from cache
-	if (versions.current.changelog) {
+	if (versions.expiresAt > time) {
 		return versions;
 	}
 
@@ -36,11 +39,8 @@ async function fetch() {
 
 		updateVersions(response);
 
-		// Emptying cached information after reaching said expiration date
-		setTimeout(() => {
-			delete versions.current.changelog;
-			delete versions.latest;
-		}, TIME_TO_LIVE);
+		// Add expiration date to the data to send to the client for later refresh
+		versions.expiresAt = time + TIME_TO_LIVE;
 	} catch (error) {
 		log.error(`Failed to fetch changelog: ${error}`);
 	}
@@ -74,6 +74,8 @@ function updateVersions(response) {
 
 			// Find latest release or pre-release if current version is also a pre-release
 			if (!release.prerelease || release.prerelease === prerelease) {
+				module.exports.isUpdateAvailable = true;
+
 				versions.latest = {
 					prerelease: release.prerelease,
 					version: release.tag_name,
@@ -84,7 +86,4 @@ function updateVersions(response) {
 			}
 		}
 	}
-
-	// Add expiration date to the data to send to the client for later refresh
-	versions.expiresAt = Date.now() + TIME_TO_LIVE;
 }
diff --git a/src/server.js b/src/server.js
index da3248eb..0d907079 100644
--- a/src/server.js
+++ b/src/server.js
@@ -241,6 +241,18 @@ module.exports = function(options = {}) {
 		}
 	});
 
+	changelog.fetch().then((versionData) => {
+		if (!versionData.latest) {
+			return;
+		}
+
+		log.info(
+			`The Lounge ${colors.green(
+				versionData.latest.version
+			)} is available. Read more on GitHub: ${versionData.latest.url}`
+		);
+	});
+
 	return server;
 };
 

From efc421c0a695971ad4cb66079123ca11032fc30c Mon Sep 17 00:00:00 2001
From: Pavel Djundik <xPaw@users.noreply.github.com>
Date: Thu, 2 Jan 2020 12:55:02 +0200
Subject: [PATCH 2/5] Display icon in footer when an update is available

---
 client/components/Sidebar.vue | 14 ++++++++++++--
 client/css/style.css          | 12 ++++++++++++
 src/server.js                 |  1 +
 3 files changed, 25 insertions(+), 2 deletions(-)

diff --git a/client/components/Sidebar.vue b/client/components/Sidebar.vue
index 742c2d33..724dac00 100644
--- a/client/components/Sidebar.vue
+++ b/client/components/Sidebar.vue
@@ -52,12 +52,22 @@
 					aria-controls="settings"
 					:aria-selected="$route.name === 'Settings'"
 			/></span>
-			<span class="tooltipped tooltipped-n tooltipped-no-touch" aria-label="Help"
+			<span
+				class="tooltipped tooltipped-n tooltipped-no-touch"
+				:aria-label="
+					$store.state.serverConfiguration.isUpdateAvailable
+						? 'Help\n(update available)'
+						: 'Help'
+				"
 				><router-link
 					to="/help"
 					tag="button"
 					active-class="active"
-					:class="['icon', 'help']"
+					:class="[
+						'icon',
+						'help',
+						{notified: $store.state.serverConfiguration.isUpdateAvailable},
+					]"
 					aria-label="Help"
 					role="tab"
 					aria-controls="help"
diff --git a/client/css/style.css b/client/css/style.css
index b5f427d0..e88b85c0 100644
--- a/client/css/style.css
+++ b/client/css/style.css
@@ -906,6 +906,18 @@ background on hover (unless active) */
 	border-radius: 5px;
 }
 
+#footer .help.notified::after {
+	content: "\f021";
+	position: absolute;
+	bottom: 10px;
+	right: 7px;
+	padding: 2px;
+	font-size: 10px;
+	border-radius: 50%;
+	color: var(--link-color);
+	background: var(--body-bg-color);
+}
+
 .window li,
 .window p,
 .window label,
diff --git a/src/server.js b/src/server.js
index 0d907079..904a0995 100644
--- a/src/server.js
+++ b/src/server.js
@@ -715,6 +715,7 @@ function getClientConfiguration() {
 		]);
 	}
 
+	config.isUpdateAvailable = changelog.isUpdateAvailable;
 	config.applicationServerKey = manager.webPush.vapidKeys.publicKey;
 	config.version = pkg.version;
 	config.gitCommit = Helper.getGitCommit();

From 3f928d8742c83e6fceb102cd83176139a57628bc Mon Sep 17 00:00:00 2001
From: Pavel Djundik <xPaw@users.noreply.github.com>
Date: Fri, 17 Jan 2020 12:09:42 +0200
Subject: [PATCH 3/5] Check for updates every day

---
 src/plugins/changelog.js | 21 +++++++++++++++++++++
 src/server.js            | 12 +-----------
 2 files changed, 22 insertions(+), 11 deletions(-)

diff --git a/src/plugins/changelog.js b/src/plugins/changelog.js
index df474365..9c717430 100644
--- a/src/plugins/changelog.js
+++ b/src/plugins/changelog.js
@@ -1,6 +1,7 @@
 "use strict";
 
 const got = require("got");
+const colors = require("chalk");
 const log = require("../log");
 const pkg = require("../../package.json");
 
@@ -9,6 +10,7 @@ const TIME_TO_LIVE = 15 * 60 * 1000; // 15 minutes, in milliseconds
 module.exports = {
 	isUpdateAvailable: false,
 	fetch,
+	checkForUpdates,
 };
 
 const versions = {
@@ -87,3 +89,22 @@ function updateVersions(response) {
 		}
 	}
 }
+
+function checkForUpdates() {
+	fetch().then((versionData) => {
+		if (!module.exports.isUpdateAvailable) {
+			// Check for updates every 24 hours + random jitter of <3 hours
+			setTimeout(checkForUpdates, 24 * 3600 * 1000 + Math.floor(Math.random() * 10000000));
+		}
+
+		if (!versionData.latest) {
+			return;
+		}
+
+		log.info(
+			`The Lounge ${colors.green(
+				versionData.latest.version
+			)} is available. Read more on GitHub: ${versionData.latest.url}`
+		);
+	});
+}
diff --git a/src/server.js b/src/server.js
index 904a0995..4c771f8d 100644
--- a/src/server.js
+++ b/src/server.js
@@ -241,17 +241,7 @@ module.exports = function(options = {}) {
 		}
 	});
 
-	changelog.fetch().then((versionData) => {
-		if (!versionData.latest) {
-			return;
-		}
-
-		log.info(
-			`The Lounge ${colors.green(
-				versionData.latest.version
-			)} is available. Read more on GitHub: ${versionData.latest.url}`
-		);
-	});
+	changelog.checkForUpdates();
 
 	return server;
 };

From d5ac13f91c80384d1b23eb5feb4a6ad0c7994ce2 Mon Sep 17 00:00:00 2001
From: Pavel Djundik <xPaw@users.noreply.github.com>
Date: Fri, 17 Jan 2020 12:17:37 +0200
Subject: [PATCH 4/5] Notify all connected clients when new version is
 available

---
 client/js/socket-events/changelog.js | 4 ++++
 src/plugins/changelog.js             | 5 ++++-
 src/server.js                        | 4 ++--
 3 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/client/js/socket-events/changelog.js b/client/js/socket-events/changelog.js
index d647d16e..a952d3ed 100644
--- a/client/js/socket-events/changelog.js
+++ b/client/js/socket-events/changelog.js
@@ -33,3 +33,7 @@ socket.on("changelog", function(data) {
 		}
 	}
 });
+
+socket.on("changelog:newversion", () => {
+	store.state.serverConfiguration.isUpdateAvailable = true;
+});
diff --git a/src/plugins/changelog.js b/src/plugins/changelog.js
index 9c717430..5a64c704 100644
--- a/src/plugins/changelog.js
+++ b/src/plugins/changelog.js
@@ -90,7 +90,7 @@ function updateVersions(response) {
 	}
 }
 
-function checkForUpdates() {
+function checkForUpdates(manager) {
 	fetch().then((versionData) => {
 		if (!module.exports.isUpdateAvailable) {
 			// Check for updates every 24 hours + random jitter of <3 hours
@@ -106,5 +106,8 @@ function checkForUpdates() {
 				versionData.latest.version
 			)} is available. Read more on GitHub: ${versionData.latest.url}`
 		);
+
+		// Notify all connected clients about the new version
+		manager.clients.forEach((client) => client.emit("changelog:newversion"));
 	});
 }
diff --git a/src/server.js b/src/server.js
index 4c771f8d..0ae0334f 100644
--- a/src/server.js
+++ b/src/server.js
@@ -239,9 +239,9 @@ module.exports = function(options = {}) {
 		if (Helper.config.prefetchStorage) {
 			require("./plugins/storage").emptyDir();
 		}
-	});
 
-	changelog.checkForUpdates();
+		changelog.checkForUpdates(manager);
+	});
 
 	return server;
 };

From 26bf0850d7ba5de2133336ea46508aa73996be2f Mon Sep 17 00:00:00 2001
From: Pavel Djundik <xPaw@users.noreply.github.com>
Date: Sun, 19 Jan 2020 01:14:52 +0200
Subject: [PATCH 5/5] Stub checkForUpdates in tests

---
 test/plugins/auth/ldap.js |  7 ++-----
 test/server.js            | 12 ++++++------
 test/tests/mergeConfig.js |  6 ++----
 3 files changed, 10 insertions(+), 15 deletions(-)

diff --git a/test/plugins/auth/ldap.js b/test/plugins/auth/ldap.js
index 46703de6..d3adfe91 100644
--- a/test/plugins/auth/ldap.js
+++ b/test/plugins/auth/ldap.js
@@ -129,12 +129,9 @@ describe("LDAP authentication plugin", function() {
 	this.slow(200);
 
 	let server;
-	let originalLogInfo;
 
 	before(function(done) {
-		originalLogInfo = log.info;
-
-		log.info = () => {};
+		stub(log, "info");
 
 		server = startLdapServer(done);
 	});
@@ -142,7 +139,7 @@ describe("LDAP authentication plugin", function() {
 	after(function() {
 		server.close();
 
-		log.info = originalLogInfo;
+		log.info.restore();
 	});
 
 	beforeEach(function() {
diff --git a/test/server.js b/test/server.js
index cf6ebbe3..c33c9ae2 100644
--- a/test/server.js
+++ b/test/server.js
@@ -3,28 +3,28 @@
 const log = require("../src/log");
 const Helper = require("../src/helper");
 const expect = require("chai").expect;
+const stub = require("sinon").stub;
 const got = require("got");
 const io = require("socket.io-client");
+const changelog = require("../src/plugins/changelog");
 
 describe("Server", function() {
 	// Increase timeout due to unpredictable I/O on CI services
 	this.timeout(process.env.CI ? 25000 : 5000);
 
 	let server;
-	let originalLogInfo;
 
 	before(function() {
-		originalLogInfo = log.info;
-
-		log.info = () => {};
+		stub(log, "info");
+		stub(changelog, "checkForUpdates");
 
 		server = require("../src/server")();
 	});
 
 	after(function(done) {
 		server.close(done);
-
-		log.info = originalLogInfo;
+		log.info.restore();
+		changelog.checkForUpdates.restore();
 	});
 
 	const webURL = `http://${Helper.config.host}:${Helper.config.port}/`;
diff --git a/test/tests/mergeConfig.js b/test/tests/mergeConfig.js
index d14b1200..f2ddb449 100644
--- a/test/tests/mergeConfig.js
+++ b/test/tests/mergeConfig.js
@@ -248,9 +248,7 @@ describe("mergeConfig", function() {
 	});
 
 	it("should only merge same type", function() {
-		const originalLog = log.info;
-
-		log.warn = () => {};
+		stub(log, "warn");
 
 		expect(
 			mergeConfig(
@@ -282,6 +280,6 @@ describe("mergeConfig", function() {
 			shouldBeString: "string",
 		});
 
-		log.warn = originalLog;
+		log.warn.restore();
 	});
 });