Feature: set log level via settings UI

R0Wi · R0Wi · commit 90cf2edaa085 · 2023-10-23T19:31:49.000+02:00
Signed-off-by: Robin Windey &lt;ro.windey@gmail.com&gt;
diff --git a/css/logreader-index.css b/css/logreader-index.css
diff --git a/js/logreader-main.mjs b/js/logreader-main.mjs
diff --git a/js/logreader-main.mjs.map b/js/logreader-main.mjs.map
diff --git a/lib/Constants.php b/lib/Constants.php
@@ -32,11 +32,13 @@ class Constants {
 	 * Used AppConfig Keys
 	 */
 	public const CONFIG_KEY_SHOWNLEVELS = 'shownLevels';
+	public const CONFIG_KEY_LOGLEVEL = 'logLevel';
 	public const CONFIG_KEY_DATETIMEFORMAT = 'dateTimeFormat';
 	public const CONFIG_KEY_RELATIVEDATES = 'relativedates';
 	public const CONFIG_KEY_LIVELOG = 'liveLog';
 	public const CONFIG_KEYS = [
 		self::CONFIG_KEY_SHOWNLEVELS,
+		self::CONFIG_KEY_LOGLEVEL,
 		self::CONFIG_KEY_DATETIMEFORMAT,
 		self::CONFIG_KEY_RELATIVEDATES,
 		self::CONFIG_KEY_LIVELOG
diff --git a/lib/Controller/SettingsController.php b/lib/Controller/SettingsController.php
@@ -92,8 +92,13 @@ public function updateAppConfig(string $settingsKey, $settingsValue): JSONRespon
 			}
 		}
 
-		// Set on DB
-		$this->config->setAppValue($this->appName, $settingsKey, json_encode($settingsValue));
+		if ($settingsKey === Constants::CONFIG_KEY_LOGLEVEL) {
+			// Set backend loglevel directly via system value
+			$this->config->setSystemValue('loglevel', $settingsValue);
+		} else {
+			// Set on DB
+			$this->config->setAppValue($this->appName, $settingsKey, json_encode($settingsValue));
+		}
 
 		return new JSONResponse();
 	}
diff --git a/lib/Service/SettingsService.php b/lib/Service/SettingsService.php
@@ -65,6 +65,7 @@ public function getLiveLog(): bool {
 	public function getAppSettings(): array {
 		return [
 			Constants::CONFIG_KEY_SHOWNLEVELS => $this->getShownLevels(),
+			Constants::CONFIG_KEY_LOGLEVEL => $this->config->getSystemValueInt('loglevel', 0),
 			Constants::CONFIG_KEY_DATETIMEFORMAT => $this->getDateTimeFormat(),
 			Constants::CONFIG_KEY_RELATIVEDATES => $this->getRelativeDates(),
 			Constants::CONFIG_KEY_LIVELOG => $this->getLiveLog(),
diff --git a/src/components/settings/AppSettingsDialog.vue b/src/components/settings/AppSettingsDialog.vue
@@ -10,6 +10,9 @@
 		<NcAppSettingsSection id="logreader-settings-levels" :name="t('logreader', 'Filter log levels')">
 			<SettingsLogLevels />
 		</NcAppSettingsSection>
+		<NcAppSettingsSection id="logreader-settings-set-level" :name="t('logreader', 'Set log level')">
+			<SettingsSetLogLevel />
+		</NcAppSettingsSection>
 		<NcAppSettingsSection id="logreader-settings-time" :name="t('logreader', 'Time format')">
 			<SettingsDatetimeFormat />
 		</NcAppSettingsSection>
@@ -27,6 +30,7 @@ import { translate as t } from '@nextcloud/l10n'
 import SettingsActions from './SettingsActions.vue'
 import SettingsLiveView from './SettingsLiveView.vue'
 import SettingsLogLevels from './SettingsLogLevels.vue'
+import SettingsSetLogLevel from './SettingsSetLogLevel.vue'
 import SettingsDatetimeFormat from './SettingsDatetimeFormat.vue'
 
 import NcAppSettingsDialog from '@nextcloud/vue/dist/Components/NcAppSettingsDialog.js'
diff --git a/src/components/settings/SettingsSetLogLevel.vue b/src/components/settings/SettingsSetLogLevel.vue
@@ -0,0 +1,59 @@
+<template>
+	<div>
+		<fieldset>
+			<legend>{{ t('logreader', 'Set backend loglevel') }}</legend>
+			<NcCheckboxRadioSwitch v-for="levelName, levelId in LOGGING_LEVEL_NAMES"
+				:checked="logLevel"
+				:value="`${levelId}`"
+				type="radio"
+                name="loglevel"
+                @update:checked="setLogLevel">
+                {{ levelName }}
+			</NcCheckboxRadioSwitch>
+		</fieldset>
+	</div>
+</template>
+
+<script setup lang="ts">
+import type { IAppSettings } from '../../interfaces'
+
+import { computed } from 'vue'
+import { showError } from '@nextcloud/dialogs'
+import { translate as t } from '@nextcloud/l10n'
+import { debounce } from '../../utils/debounce'
+import { useSettingsStore } from '../../store/settings'
+import { LOGGING_LEVEL_NAMES } from '../../constants'
+
+import NcCheckboxRadioSwitch from '@nextcloud/vue/dist/Components/NcCheckboxRadioSwitch.js'
+
+const settingsStore = useSettingsStore()
+
+/**
+ * Get currently set loglevel
+ */
+const logLevel = computed(() => `${settingsStore.logLevel}`)
+
+// /**
+//  * Get shown logging levels (to allow filter levels)
+//  */
+// const shownLevels = computed(() => settingsStore.shownLevels.map(l => `${l}`))
+
+// const setShowLevels = debounce((levels: string[]) => {
+// 	const numericLevels = levels.map(level => parseInt(level)) as IAppSettings['shownLevels']
+
+// 	settingsStore.setSetting('shownLevels', numericLevels)
+// 		.catch(() => showError(t('logreader', 'Could not set logging levels to show')))
+// }, 200)
+
+const setLogLevel = (level: string) => {
+    const numericLevel = parseInt(level) as IAppSettings['logLevel']
+    settingsStore.setSetting('logLevel', numericLevel)
+        .catch(() => showError(t('logreader', 'Could not set logging level')))
+}
+</script>
+
+<style scoped>
+fieldset {
+	padding: 6px;
+}
+</style>
diff --git a/src/interfaces/IAppSettings.ts b/src/interfaces/IAppSettings.ts
@@ -27,4 +27,8 @@ export interface IAppSettings {
 	 * Wether backend is enable = logging is set to file
 	 */
 	enabled: boolean
+	/**
+	 * The loglevel which is currently set on the server
+	 */
+	logLevel: 0 | 1 | 2 | 3 | 4
 }
diff --git a/src/store/settings.ts b/src/store/settings.ts
@@ -24,7 +24,7 @@ export const useSettingsStore = defineStore('logreader-settings', () => {
 	/**
 	 * Saved setting loaded from server
 	 */
-	const _loadedSettings = loadState<SettingsState>('logreader', 'settings', { enabled: false, liveLog: false, dateTimeFormat: 'raw', shownLevels: [] })
+	const _loadedSettings = loadState<SettingsState>('logreader', 'settings', { enabled: false, liveLog: false, dateTimeFormat: 'raw', shownLevels: [], logLevel: 0 })
 
 	/**
 	 * Is file logging enabled on server
@@ -47,6 +47,11 @@ export const useSettingsStore = defineStore('logreader-settings', () => {
 	 */
 	const shownLevels = ref(_loadedSettings.shownLevels)
 
+	/**
+	 * The current log level set on the server
+	 */
+	const logLevel = ref(_loadedSettings.logLevel)
+
 	/**
 	 * The datetime format to used for displaying times
 	 * This is the internal property used for the computed getter
@@ -102,5 +107,5 @@ export const useSettingsStore = defineStore('logreader-settings', () => {
 		return settings.data
 	}
 
-	return { shownLevels, dateTimeFormat, enabled, isEnabled, liveLog, localFile, localFileName, setSetting, getSettings }
+	return { shownLevels, logLevel, dateTimeFormat, enabled, isEnabled, liveLog, localFile, localFileName, setSetting, getSettings }
 })
diff --git a/tests/Unit/Controller/SettingsControllerTest.php b/tests/Unit/Controller/SettingsControllerTest.php
@@ -42,7 +42,7 @@ class SettingsControllerTest extends TestCase {
 	/** @var SettingsController */
 	private $settingsController;
 
-	/** @var SettingsService */
+	/** @var SettingsService|MockObject */
 	private $settingsService;
 
 	/** @var IConfig|MockObject */
@@ -59,6 +59,7 @@ public function setUp(): void {
 
 		$this->settingsService = $this->createMock(SettingsService::class);
 		$this->config = $this->createMock(IConfig::class);
+		/** @var LoggerInterface */
 		$this->logger = $this->getMockBuilder('Psr\Log\LoggerInterface')->getMock();
 		$this->request = $this->createMock(IRequest::class);
 
@@ -76,6 +77,7 @@ public function testGetAppConfig() {
 			->method('getAppSettings')
 			->willReturn([
 				Constants::CONFIG_KEY_SHOWNLEVELS => Constants::LOGGING_LEVELS,
+				Constants::CONFIG_KEY_LOGLEVEL => 4,
 				Constants::CONFIG_KEY_DATETIMEFORMAT => 'local',
 				Constants::CONFIG_KEY_RELATIVEDATES => false,
 				Constants::CONFIG_KEY_LIVELOG => true,
@@ -84,6 +86,7 @@ public function testGetAppConfig() {
 		
 		$this->assertEquals(new JSONResponse([
 			Constants::CONFIG_KEY_SHOWNLEVELS => Constants::LOGGING_LEVELS,
+			Constants::CONFIG_KEY_LOGLEVEL => 4,
 			Constants::CONFIG_KEY_DATETIMEFORMAT => 'local',
 			Constants::CONFIG_KEY_RELATIVEDATES => false,
 			Constants::CONFIG_KEY_LIVELOG => true,
@@ -124,6 +127,7 @@ public function testUpdateAppConfig(string $configKey, $configValue, string $str
 			->method('getAppSettings')
 			->willReturn([
 				Constants::CONFIG_KEY_SHOWNLEVELS => Constants::LOGGING_LEVELS,
+				Constants::CONFIG_KEY_LOGLEVEL => 3,
 				Constants::CONFIG_KEY_DATETIMEFORMAT => 'local',
 				Constants::CONFIG_KEY_RELATIVEDATES => false,
 				Constants::CONFIG_KEY_LIVELOG => true,
@@ -133,6 +137,28 @@ public function testUpdateAppConfig(string $configKey, $configValue, string $str
 		$this->assertEquals(new JSONResponse(), $this->settingsController->updateAppConfig($configKey, $configValue));
 	}
 
+	public function testUpdateAppConfig_logLevel() {
+		$this->logger->expects($this->once())
+			->method('debug');
+		
+		$this->config->expects($this->once())
+			->method('setSystemValue')
+			->with('loglevel', 4);
+
+		$this->settingsService->expects($this->once())
+			->method('getAppSettings')
+			->willReturn([
+				Constants::CONFIG_KEY_SHOWNLEVELS => Constants::LOGGING_LEVELS,
+				Constants::CONFIG_KEY_LOGLEVEL => 3,
+				Constants::CONFIG_KEY_DATETIMEFORMAT => 'local',
+				Constants::CONFIG_KEY_RELATIVEDATES => false,
+				Constants::CONFIG_KEY_LIVELOG => true,
+				'enabled' => true,
+			]);
+
+		$this->assertEquals(new JSONResponse(), $this->settingsController->updateAppConfig(Constants::CONFIG_KEY_LOGLEVEL, 4));
+	}
+
 	public function testUpdateAppConfig_unknownKey() {
 		$this->logger->expects($this->any())
 			->method('debug');
diff --git a/tests/Unit/Service/SettingsServiceTest.php b/tests/Unit/Service/SettingsServiceTest.php
@@ -27,15 +27,15 @@
 use OCA\LogReader\Constants;
 use OCA\LogReader\Service\SettingsService;
 use OCP\IConfig;
-
+use PHPUnit\Framework\MockObject\MockObject;
 use Test\TestCase;
 
 class SettingsServiceTest extends TestCase {
 
 	/** @var SettingsService */
 	private $settingsService;
 
-	/** @var IConfig */
+	/** @var IConfig|MockObject */
 	private $config;
 
 	public function setUp(): void {
@@ -134,6 +134,10 @@ public function testGetAppSettings() {
 			->method('getSystemValueString')
 			->with($this->equalTo('log_type'), $this->anything())
 			->willReturn('file');
+		$this->config->expects($this->once())
+			->method('getSystemValueInt')
+			->with($this->equalTo('loglevel'), 0)
+			->willReturn(4);
 		$this->config->expects($this->any())
 			->method('getAppValue')
 			->willReturnCallback(function ($app, $key, $fallback) {
@@ -142,6 +146,7 @@ public function testGetAppSettings() {
 
 		$this->assertEquals($this->settingsService->getAppSettings(), [
 			Constants::CONFIG_KEY_SHOWNLEVELS => Constants::LOGGING_LEVELS,
+			Constants::CONFIG_KEY_LOGLEVEL => 4,
 			Constants::CONFIG_KEY_DATETIMEFORMAT => 'local',
 			Constants::CONFIG_KEY_RELATIVEDATES => false,
 			Constants::CONFIG_KEY_LIVELOG => true,
@@ -154,6 +159,10 @@ public function testGetAppSettings_nonfile() {
 			->method('getSystemValueString')
 			->with($this->equalTo('log_type'), $this->anything())
 			->willReturn('syslog');
+		$this->config->expects($this->once())
+			->method('getSystemValueInt')
+			->with($this->equalTo('loglevel'), 0)
+			->willReturn(2);
 		$this->config->expects($this->any())
 			->method('getAppValue')
 			->willReturnCallback(function ($app, $key, $fallback) {
@@ -162,6 +171,7 @@ public function testGetAppSettings_nonfile() {
 
 		$this->assertEquals($this->settingsService->getAppSettings(), [
 			Constants::CONFIG_KEY_SHOWNLEVELS => Constants::LOGGING_LEVELS,
+			Constants::CONFIG_KEY_LOGLEVEL => 2,
 			Constants::CONFIG_KEY_DATETIMEFORMAT => 'local',
 			Constants::CONFIG_KEY_RELATIVEDATES => false,
 			Constants::CONFIG_KEY_LIVELOG => true,

Original file line number	Diff line number	Diff line change
`@@ -92,8 +92,13 @@ public function updateAppConfig(string $settingsKey, $settingsValue): JSONRespon`
`92`	`92`	`}`
`93`	`93`	`}`
`94`	`94`
`95`		`- // Set on DB`
`96`		`- $this->config->setAppValue($this->appName, $settingsKey, json_encode($settingsValue));`
	`95`	`+ if ($settingsKey === Constants::CONFIG_KEY_LOGLEVEL) {`
	`96`	`+ // Set backend loglevel directly via system value`
	`97`	`+ $this->config->setSystemValue('loglevel', $settingsValue);`
	`98`	`+ } else {`
	`99`	`+ // Set on DB`
	`100`	`+ $this->config->setAppValue($this->appName, $settingsKey, json_encode($settingsValue));`
	`101`	`+ }`
`97`	`102`
`98`	`103`	`return new JSONResponse();`
`99`	`104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,4 +27,8 @@ export interface IAppSettings {`
`27`	`27`	`* Wether backend is enable = logging is set to file`
`28`	`28`	`*/`
`29`	`29`	`enabled: boolean`
	`30`	`+ /**`
	`31`	`+ * The loglevel which is currently set on the server`
	`32`	`+ */`
	`33`	`+ logLevel: 0 \| 1 \| 2 \| 3 \| 4`
`30`	`34`	`}`