Add setting for sync timeout

The setting is a string that can be formatted as anything that [moment.duration](https://momentjs.com/docs/#/durations/creating/) can parse: * 'hh:mm:ss' * 'PT1M' (ISO 8601) Any invalid setting or setting to less than a second will lead to the calendar updates being disabled. The setting is not exposed in the UI. It's meant to be configured by server admins to be able to adjust the timeout and prevent an overly high load. Signed-off-by: Azul <[email protected]>
nextcloud · Feb 28, 2021 · 56fc034 · 56fc034
1 parent a566196
commit 56fc034
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 13 deletions.
diff --git a/lib/Controller/PublicViewController.php b/lib/Controller/PublicViewController.php
@@ -120,6 +120,7 @@ private function publicIndex(string $token,
 		$defaultSkipPopover = $this->config->getAppValue($this->appName, 'skipPopover', 'yes');
 		$defaultTimezone = $this->config->getAppValue($this->appName, 'timezone', 'automatic');
 		$defaultSlotDuration = $this->config->getAppValue($this->appName, 'slotDuration', '00:30:00');
+		$defaultSyncTimeout = $this->config->getAppValue($this->appName, 'syncTimeout', 'PT1M');
 		$defaultShowTasks = $this->config->getAppValue($this->appName, 'showTasks', 'yes');
 
 		$appVersion = $this->config->getAppValue($this->appName, 'installed_version', null);
@@ -135,6 +136,7 @@ private function publicIndex(string $token,
 		$this->initialStateService->provideInitialState($this->appName, 'timezone', $defaultTimezone);
 		$this->initialStateService->provideInitialState($this->appName, 'slot_duration', $defaultSlotDuration);
 		$this->initialStateService->provideInitialState($this->appName, 'show_tasks', $defaultShowTasks === 'yes');
+		$this->initialStateService->provideInitialState($this->appName, 'sync_timeout', $defaultSyncTimeout);
 		$this->initialStateService->provideInitialState($this->appName, 'tasks_enabled', false);
 
 		return new TemplateResponse($this->appName, 'main', [

diff --git a/lib/Controller/ViewController.php b/lib/Controller/ViewController.php
@@ -106,6 +106,7 @@ public function index():TemplateResponse {
 		$timezone = $this->config->getUserValue($this->userId, $this->appName, 'timezone', $defaultTimezone);
 		$slotDuration = $this->config->getUserValue($this->userId, $this->appName, 'slotDuration', $defaultSlotDuration);
 		$showTasks = $this->config->getUserValue($this->userId, $this->appName, 'showTasks', $defaultShowTasks) === 'yes';
+		$syncTimeout = $this->config->getAppValue($this->appName, 'syncTimeout', 'PT1M');
 
 		$talkEnabled = $this->appManager->isEnabledForUser('spreed');
 		$tasksEnabled = $this->appManager->isEnabledForUser('tasks');
@@ -121,6 +122,7 @@ public function index():TemplateResponse {
 		$this->initialStateService->provideInitialState($this->appName, 'timezone', $timezone);
 		$this->initialStateService->provideInitialState($this->appName, 'slot_duration', $slotDuration);
 		$this->initialStateService->provideInitialState($this->appName, 'show_tasks', $showTasks);
+		$this->initialStateService->provideInitialState($this->appName, 'sync_timeout', $syncTimeout);
 		$this->initialStateService->provideInitialState($this->appName, 'tasks_enabled', $tasksEnabled);
 
 		return new TemplateResponse($this->appName, 'main');

diff --git a/src/store/settings.js b/src/store/settings.js
@@ -25,6 +25,7 @@ import { detectTimezone } from '../services/timezoneDetectionService'
 import { setConfig as setCalendarJsConfig } from 'calendar-js'
 import { setConfig } from '../services/settings.js'
 import { logInfo } from '../utils/logger.js'
+import moment from '@nextcloud/moment'
 
 const state = {
 	// env
@@ -38,6 +39,7 @@ const state = {
 	showWeekNumbers: null,
 	skipPopover: null,
 	slotDuration: null,
+	syncTimeout: null,
 	tasksEnabled: false,
 	timezone: 'automatic',
 	// user-defined Nextcloud settings
@@ -126,11 +128,12 @@ const mutations = {
 	 * @param {Boolean} data.showWeekends Whether or not to display weekends
 	 * @param {Boolean} data.skipPopover Whether or not to skip the simple event popover
 	 * @param {String} data.slotDuration The duration of one slot in the agendaView
+	 * @param {String} data.syncTimeout The timeout between fetching updates from the server
 	 * @param {Boolean} data.talkEnabled Whether or not the talk app is enabled
 	 * @param {Boolean} data.tasksEnabled Whether ot not the tasks app is enabled
 	 * @param {String} data.timezone The timezone to view the calendar in. Either an Olsen timezone or "automatic"
 	 */
-	loadSettingsFromServer(state, { appVersion, eventLimit, firstRun, showWeekNumbers, showTasks, showWeekends, skipPopover, slotDuration, talkEnabled, tasksEnabled, timezone }) {
+	loadSettingsFromServer(state, { appVersion, eventLimit, firstRun, showWeekNumbers, showTasks, showWeekends, skipPopover, slotDuration, syncTimeout, talkEnabled, tasksEnabled, timezone }) {
 		logInfo(`
 Initial settings:
 	- AppVersion: ${appVersion}
@@ -141,6 +144,7 @@ Initial settings:
 	- ShowWeekends: ${showWeekends}
 	- SkipPopover: ${skipPopover}
 	- SlotDuration: ${slotDuration}
+	- SyncTimeout: ${syncTimeout}
 	- TalkEnabled: ${talkEnabled}
 	- TasksEnabled: ${tasksEnabled}
 	- Timezone: ${timezone}
@@ -154,6 +158,7 @@ Initial settings:
 		state.showWeekends = showWeekends
 		state.skipPopover = skipPopover
 		state.slotDuration = slotDuration
+		state.syncTimeout = syncTimeout
 		state.talkEnabled = talkEnabled
 		state.tasksEnabled = tasksEnabled
 		state.timezone = timezone
@@ -186,6 +191,14 @@ const getters = {
 	getResolvedTimezone: (state) => state.timezone === 'automatic'
 		? detectTimezone()
 		: state.timezone,
+
+	/**
+	 * Gets the sync timeout in milliseconds.
+	 *
+	 * @param {Object} state The Vuex state
+	 * @returns {Integer}
+	 */
+	getSyncTimeout: (state) => moment.duration(state.syncTimeout).asMilliseconds(),
 }
 
 const actions = {

diff --git a/src/views/Calendar.vue b/src/views/Calendar.vue
@@ -184,15 +184,6 @@ export default {
 				})
 			}
 		}, 1000 * 60)
-		this.checkForUpdatesJob = setInterval(async() => {
-			if (this.$route.name.startsWith('Public') || this.$route.name.startsWith('Embed')) {
-				const tokens = this.$route.params.tokens.split('-')
-				await this.$store.dispatch('syncPublicCalendars', { tokens })
-			} else {
-				await this.$store.dispatch('syncCalendars')
-			}
-		}, 1000 * 20)
-
 	},
 	destroy() {
 		clearInterval(this.timeFrameCacheExpiryJob)
@@ -211,6 +202,7 @@ export default {
 			tasksEnabled: loadState('calendar', 'tasks_enabled'),
 			timezone: loadState('calendar', 'timezone'),
 			showTasks: loadState('calendar', 'show_tasks'),
+			syncTimeout: loadState('calendar', 'sync_timeout'),
 		})
 		this.$store.dispatch('initializeCalendarJsConfig')
 
@@ -255,6 +247,16 @@ export default {
 
 			this.loadingCalendars = false
 		}
+		if (this.$store.getters.getSyncTimeout > 1000) {
+			this.checkForUpdatesJob = setInterval(async() => {
+				if (this.$route.name.startsWith('Public') || this.$route.name.startsWith('Embed')) {
+					const tokens = this.$route.params.tokens.split('-')
+					await this.$store.dispatch('syncPublicCalendars', { tokens })
+				} else {
+					await this.$store.dispatch('syncCalendars')
+				}
+			}, this.$store.getters.getSyncTimeout)
+		}
 	},
 	async mounted() {
 		if (this.timezone === 'automatic' && this.timezoneId === 'UTC') {

diff --git a/tests/javascript/unit/store/settings.test.js b/tests/javascript/unit/store/settings.test.js
@@ -56,6 +56,7 @@ describe('store/settings test suite', () => {
 			showWeekNumbers: null,
 			skipPopover: null,
 			slotDuration: null,
+			syncTimeout: null,
 			tasksEnabled: false,
 			timezone: 'automatic',
 			momentLocale: 'en',
@@ -151,6 +152,7 @@ describe('store/settings test suite', () => {
 			showWeekNumbers: null,
 			skipPopover: null,
 			slotDuration: null,
+			syncTimeout: null,
 			tasksEnabled: false,
 			timezone: 'automatic',
 			momentLocale: 'en',
@@ -166,6 +168,7 @@ describe('store/settings test suite', () => {
 			showWeekends: true,
 			skipPopover: true,
 			slotDuration: '00:30:00',
+			syncTimeout: 'PT1M',
 			talkEnabled: false,
 			tasksEnabled: true,
 			timezone: 'Europe/Berlin',
@@ -185,6 +188,7 @@ Initial settings:
 	- ShowWeekends: true
 	- SkipPopover: true
 	- SlotDuration: 00:30:00
+	- SyncTimeout: PT1M
 	- TalkEnabled: false
 	- TasksEnabled: true
 	- Timezone: Europe/Berlin
@@ -198,6 +202,7 @@ Initial settings:
 			showWeekends: true,
 			skipPopover: true,
 			slotDuration: '00:30:00',
+			syncTimeout: 'PT1M',
 			talkEnabled: false,
 			tasksEnabled: true,
 			timezone: 'Europe/Berlin',
@@ -217,6 +222,7 @@ Initial settings:
 			showWeekNumbers: null,
 			skipPopover: null,
 			slotDuration: null,
+			syncTimeout: null,
 			tasksEnabled: false,
 			timezone: 'automatic',
 			momentLocale: 'en',
@@ -237,6 +243,7 @@ Initial settings:
 			showWeekNumbers: null,
 			skipPopover: null,
 			slotDuration: null,
+			syncTimeout: null,
 			tasksEnabled: false,
 			timezone: 'automatic',
 			momentLocale: 'de',
@@ -267,6 +274,31 @@ Initial settings:
 		expect(detectTimezone).toHaveBeenCalledTimes(0)
 	})
 
+	it('should provide a getter for the sync timeout in milliseconds', () => {
+		const state = {
+			syncTimeout: '00:01:00'
+		}
+
+		expect(settingsStore.getters.getSyncTimeout(state)).toEqual(60 * 1000)
+	})
+
+	it('can parse sync timeouts in ISO 8601 format', () => {
+		const state = {
+			syncTimeout: 'PT1M'
+		}
+
+		expect(settingsStore.getters.getSyncTimeout(state)).toEqual(60 * 1000)
+	})
+
+	it('should handle invalid sync timeout gracefully', () => {
+		const state = {
+			syncTimeout: 'not a timeout at all'
+		}
+
+		// Check from Calendar.vue which will disable the updates:
+		expect(settingsStore.getters.getSyncTimeout(state) > 1000).toBeFalsy()
+	})
+
 	it('should provide an action to toggle the birthday calendar - enabled to disabled', async () => {
 		expect.assertions(3)
 

diff --git a/tests/php/unit/Controller/PublicViewControllerTest.php b/tests/php/unit/Controller/PublicViewControllerTest.php
@@ -63,7 +63,7 @@ protected function setUp():void {
 	}
 
 	public function testPublicIndexWithBranding():void {
-		$this->config->expects(self::exactly(9))
+		$this->config->expects(self::exactly(10))
 			->method('getAppValue')
 			->willReturnMap([
 				['calendar', 'eventLimit', 'yes', 'no'],
@@ -74,6 +74,7 @@ public function testPublicIndexWithBranding():void {
 				['calendar', 'timezone', 'automatic', 'defaultTimezone'],
 				['calendar', 'slotDuration', '00:30:00', 'defaultSlotDuration'],
 				['calendar', 'showTasks', 'yes', 'yes'],
+				['calendar', 'syncTimeout', 'PT1M', 'defaultSyncTimeout'],
 				['calendar', 'installed_version', null, '1.0.0']
 			]);
 
@@ -99,7 +100,7 @@ public function testPublicIndexWithBranding():void {
 			->with('imagePath456')
 			->willReturn('absoluteImagePath456');
 
-		$this->initialStateService->expects(self::exactly(12))
+		$this->initialStateService->expects(self::exactly(13))
 			->method('provideInitialState')
 			->withConsecutive(
 				['calendar', 'app_version', '1.0.0'],
@@ -113,6 +114,7 @@ public function testPublicIndexWithBranding():void {
 				['calendar', 'timezone', 'defaultTimezone'],
 				['calendar', 'slot_duration', 'defaultSlotDuration'],
 				['calendar', 'show_tasks', true],
+				['calendar', 'sync_timeout', 'defaultSyncTimeout'],
 				['calendar', 'tasks_enabled', false]
 			);
 
@@ -139,6 +141,7 @@ public function testPublicIndexForEmbedding():void {
 				['calendar', 'timezone', 'automatic', 'defaultTimezone'],
 				['calendar', 'slotDuration', '00:30:00', 'defaultSlotDuration'],
 				['calendar', 'showTasks', 'yes', 'defaultShowTasks'],
+				['calendar', 'syncTimeout', 'PT1M', 'defaultSyncTimeout'],
 				['calendar', 'installed_version', null, '1.0.0']
 			]);
 		$this->request->expects(self::once())
@@ -163,7 +166,7 @@ public function testPublicIndexForEmbedding():void {
 			->with('imagePath456')
 			->willReturn('absoluteImagePath456');
 
-		$this->initialStateService->expects(self::exactly(12))
+		$this->initialStateService->expects(self::exactly(13))
 			->method('provideInitialState')
 			->withConsecutive(
 				['calendar', 'app_version', '1.0.0'],
@@ -177,6 +180,7 @@ public function testPublicIndexForEmbedding():void {
 				['calendar', 'timezone', 'defaultTimezone'],
 				['calendar', 'slot_duration', 'defaultSlotDuration'],
 				['calendar', 'show_tasks', false],
+				['calendar', 'sync_timeout', 'defaultSyncTimeout'],
 				['calendar', 'tasks_enabled', false]
 			);
 

diff --git a/tests/php/unit/Controller/ViewControllerTest.php b/tests/php/unit/Controller/ViewControllerTest.php
@@ -79,6 +79,7 @@ public function testIndex(): void {
 				['calendar', 'timezone', 'automatic', 'defaultTimezone'],
 				['calendar', 'slotDuration', '00:30:00', 'defaultSlotDuration'],
 				['calendar', 'showTasks', 'yes', 'defaultShowTasks'],
+				['calendar', 'syncTimeout', 'PT1M', 'PT1M'],
 				['calendar', 'installed_version', null, '1.0.0'],
 			]);
 		$this->config
@@ -115,6 +116,7 @@ public function testIndex(): void {
 				['calendar', 'timezone', 'Europe/Berlin'],
 				['calendar', 'slot_duration', '00:15:00'],
 				['calendar', 'show_tasks', false],
+				['calendar', 'sync_timeout', 'PT1M'],
 				['calendar', 'tasks_enabled', true]
 			);
 
@@ -144,6 +146,7 @@ public function testIndexViewFix(string $savedView, string $expectedView): void
 				['calendar', 'timezone', 'automatic', 'defaultTimezone'],
 				['calendar', 'slotDuration', '00:30:00', 'defaultSlotDuration'],
 				['calendar', 'showTasks', 'yes', 'defaultShowTasks'],
+				['calendar', 'syncTimeout', 'PT1M', 'PT1M'],
 				['calendar', 'installed_version', null, '1.0.0'],
 			]);
 		$this->config
@@ -180,6 +183,7 @@ public function testIndexViewFix(string $savedView, string $expectedView): void
 				['calendar', 'timezone', 'Europe/Berlin'],
 				['calendar', 'slot_duration', '00:15:00'],
 				['calendar', 'show_tasks', false],
+				['calendar', 'sync_timeout', 'PT1M'],
 				['calendar', 'tasks_enabled', false]
 			);