🔨 Raise minimum auto refresh interval to 30 min

Author: devmount

src/composables/useOptionsData.js

@@ -1,7 +1,7 @@
 // Thunderbird messenger.* data engine for the options page.
 // Call exactly once, from Options.vue - this composable owns all its state internally.
 import { ref, computed, watch } from 'vue';
-import { defaultColors, defaultOptions } from '@/definitions.js';
+import { defaultColors, defaultOptions, minAutoRefreshInterval } from '@/definitions.js';
 import { formatBytes, setTheme } from '@/utils.js';
 
 export function useOptionsData() {
@@ -87,17 +87,17 @@ export function useOptionsData() {
 		options.value.autoRefreshInterval++;
 	};
 
-	// decreases auto refresh interval down to limit 5
+	// decreases auto refresh interval down to minimum limit
 	const decrementAutoRefreshInterval = () => {
-		if (options.value.autoRefreshInterval > 5) {
+		if (options.value.autoRefreshInterval > minAutoRefreshInterval) {
 			options.value.autoRefreshInterval--;
 		}
 	};
 
 	// check auto refresh number input to stay in allowed range
 	const checkAutoRefreshInterval = () => {
-		if (options.value.autoRefreshInterval < 5) {
-			options.value.autoRefreshInterval = 5;
+		if (options.value.autoRefreshInterval < minAutoRefreshInterval) {
+			options.value.autoRefreshInterval = minAutoRefreshInterval;
 		}
 	};
 

src/definitions.js

@@ -25,6 +25,9 @@ const defaultOptions = {
 	debug: false,
 };
 
+// lower limit in minutes for the automatic background processing interval
+const minAutoRefreshInterval = 30;
+
 // tab navigation for stats page
 const tabsNumbers = {
 	years: 1,
@@ -73,6 +76,7 @@ export {
 	accentColors,
 	defaultColors,
 	defaultOptions,
+	minAutoRefreshInterval,
 	tabsActivity,
 	tabsFolders,
 	tabsLeader,

src/engines/backgroundEngine.js

@@ -1,5 +1,5 @@
 // background-script: schedules periodic stats reprocessing via messenger.alarms independent from other pages
-import { defaultOptions } from '@/definitions.js';
+import { defaultOptions, minAutoRefreshInterval } from '@/definitions.js';
 import { filterActiveAccounts } from '@/utils.js';
 import {
 	buildAllIdentities,
@@ -60,7 +60,10 @@ export const syncAlarm = async () => {
 	const options = await getOptions();
 	await messenger.alarms.clear(ALARM_NAME);
 	if (options.autoRefresh) {
-		messenger.alarms.create(ALARM_NAME, { periodInMinutes: Number(options.autoRefreshInterval) });
+		// enforce the minimum also for intervals stored before it was raised
+		messenger.alarms.create(ALARM_NAME, {
+			periodInMinutes: Math.max(minAutoRefreshInterval, Number(options.autoRefreshInterval)),
+		});
 	}
 };
 

src/options/AutoRefreshOption.vue

@@ -25,7 +25,7 @@
 						type="number"
 						v-model="options.autoRefreshInterval"
 						placeholder="360"
-						min="5"
+						:min="minAutoRefreshInterval"
 						@change="checkAutoRefreshInterval()"
 					/>
 				</div>
@@ -49,6 +49,7 @@
 <script setup>
 import { inject } from 'vue';
 import { useI18n } from 'vue-i18n';
+import { minAutoRefreshInterval } from '@/definitions.js';
 
 const { options, incrementAutoRefreshInterval, decrementAutoRefreshInterval, checkAutoRefreshInterval } =
 	inject('engine');

test/composables/useOptionsData.spec.js

@@ -1,6 +1,6 @@
 import { describe, expect, it, vi } from 'vitest';
 import { useOptionsData } from '@/composables/useOptionsData.js';
-import { defaultOptions } from '@/definitions.js';
+import { defaultOptions, minAutoRefreshInterval } from '@/definitions.js';
 import { createMockMessenger } from '../helpers/messenger.js';
 
 // the composable's internal deep watch on `options` fires (asynchronously, via Vue's
@@ -92,23 +92,23 @@ describe('autoRefreshInterval increment/decrement/check', () => {
 		expect(options.value.autoRefreshInterval).toBe(1000);
 	});
 
-	it('decrements down to but not below the 5-minute floor', () => {
+	it('decrements down to but not below the minimum', () => {
 		const { options, decrementAutoRefreshInterval } = useOptionsData();
-		options.value.autoRefreshInterval = 6;
+		options.value.autoRefreshInterval = minAutoRefreshInterval + 1;
 		decrementAutoRefreshInterval();
-		expect(options.value.autoRefreshInterval).toBe(5);
+		expect(options.value.autoRefreshInterval).toBe(minAutoRefreshInterval);
 		decrementAutoRefreshInterval();
-		expect(options.value.autoRefreshInterval).toBe(5);
+		expect(options.value.autoRefreshInterval).toBe(minAutoRefreshInterval);
 	});
 
-	it('clamps a sub-5 value up to 5, leaves a valid value untouched', () => {
+	it('clamps a value below the minimum up to it, leaves a valid value untouched', () => {
 		const { options, checkAutoRefreshInterval } = useOptionsData();
-		options.value.autoRefreshInterval = 2;
+		options.value.autoRefreshInterval = minAutoRefreshInterval - 1;
 		checkAutoRefreshInterval();
-		expect(options.value.autoRefreshInterval).toBe(5);
-		options.value.autoRefreshInterval = 30;
+		expect(options.value.autoRefreshInterval).toBe(minAutoRefreshInterval);
+		options.value.autoRefreshInterval = minAutoRefreshInterval + 15;
 		checkAutoRefreshInterval();
-		expect(options.value.autoRefreshInterval).toBe(30);
+		expect(options.value.autoRefreshInterval).toBe(minAutoRefreshInterval + 15);
 	});
 });
 

test/engines/backgroundEngine.spec.js

@@ -1,6 +1,6 @@
 import { afterEach, describe, expect, it, vi } from 'vitest';
 import { ALARM_NAME, initBackground, runScheduledRefresh, syncAlarm } from '@/engines/backgroundEngine.js';
-import { defaultOptions } from '@/definitions.js';
+import { defaultOptions, minAutoRefreshInterval } from '@/definitions.js';
 import { PAGE_PROCESSING_STORAGE_KEY, PROCESSING_STORAGE_KEY } from '@/engines/statsEngine.js';
 import { statsCacheKey } from '@/utils.js';
 import { createMockMessenger } from '../helpers/messenger.js';
@@ -65,6 +65,16 @@ describe('syncAlarm', () => {
 		expect(messenger.alarms.create).toHaveBeenCalledWith(ALARM_NAME, { periodInMinutes: 45 });
 	});
 
+	it('raises a stored interval below the minimum to the minimum', async () => {
+		const messenger = setupMessenger();
+		vi.stubGlobal('messenger', messenger);
+		await messenger.storage.local.set({ options: { ...defaultOptions, autoRefresh: true, autoRefreshInterval: 10 } });
+
+		await syncAlarm();
+
+		expect(messenger.alarms.create).toHaveBeenCalledWith(ALARM_NAME, { periodInMinutes: minAutoRefreshInterval });
+	});
+
 	it('only clears, never creates, when autoRefresh is disabled', async () => {
 		const messenger = setupMessenger();
 		vi.stubGlobal('messenger', messenger);
@@ -113,10 +123,10 @@ describe('initBackground', () => {
 		await vi.waitFor(() => expect(messenger.alarms.clear).toHaveBeenCalledWith(ALARM_NAME));
 		messenger.alarms.clear.mockClear();
 
-		await messenger.storage.local.set({ options: { ...defaultOptions, autoRefresh: true, autoRefreshInterval: 10 } });
+		await messenger.storage.local.set({ options: { ...defaultOptions, autoRefresh: true, autoRefreshInterval: 60 } });
 
 		await vi.waitFor(() => expect(messenger.alarms.clear).toHaveBeenCalledWith(ALARM_NAME));
-		expect(messenger.alarms.create).toHaveBeenCalledWith(ALARM_NAME, { periodInMinutes: 10 });
+		expect(messenger.alarms.create).toHaveBeenCalledWith(ALARM_NAME, { periodInMinutes: 60 });
 	});
 
 	it('ignores storage changes to keys other than "options"', async () => {