Ability to set log level from UI. Fixes #448 (#458)

* Checkpoint

* Set logging level from frontend

server/package.json

@@ -44,6 +44,7 @@
     "axios": "^1.6.0",
     "better-sqlite3": "^9.1.1",
     "chalk": "^5.3.0",
+    "chokidar": "^3.6.0",
     "cors": "^2.8.5",
     "dayjs": "^1.11.10",
     "fast-json-stringify": "^5.9.1",

server/src/api/index.ts

@@ -27,6 +27,7 @@ import { hdhrSettingsRouter } from './hdhrSettingsApi.js';
 import { plexServersRouter } from './plexServersApi.js';
 import { plexSettingsRouter } from './plexSettingsApi.js';
 import { xmlTvSettingsRouter } from './xmltvSettingsApi.js';
+import { systemSettingsRouter } from './systemSettingsApi.js';
 
 export const apiRouter: RouterPluginAsyncCallback = async (fastify) => {
   const logger = LoggerFactory.child({ caller: import.meta });
@@ -53,6 +54,7 @@ export const apiRouter: RouterPluginAsyncCallback = async (fastify) => {
     .register(plexSettingsRouter)
     .register(xmlTvSettingsRouter)
     .register(hdhrSettingsRouter)
+    .register(systemSettingsRouter)
     .register(guideRouter);
 
   fastify.get(

server/src/api/systemSettingsApi.ts

@@ -0,0 +1,70 @@
+import {
+  SystemSettingsResponseSchema,
+  UpdateSystemSettingsRequestSchema,
+} from '@tunarr/types/api';
+import { RouterPluginAsyncCallback } from '../types/serverType';
+import {
+  getDefaultLogLevel,
+  getEnvironmentLogLevel,
+} from '../util/logging/LoggerFactory';
+import { SystemSettings } from '@tunarr/types';
+
+export const systemSettingsRouter: RouterPluginAsyncCallback = async (
+  fastify,
+  // eslint-disable-next-line @typescript-eslint/require-await
+) => {
+  fastify.get(
+    '/system/settings',
+    {
+      schema: {
+        response: {
+          200: SystemSettingsResponseSchema,
+        },
+      },
+    },
+    async (req, res) => {
+      const settings = req.serverCtx.settings.systemSettings();
+      return res.send(getSystemSettingsResponse(settings));
+    },
+  );
+
+  fastify.put(
+    '/system/settings',
+    {
+      schema: {
+        body: UpdateSystemSettingsRequestSchema,
+        response: {
+          200: SystemSettingsResponseSchema,
+        },
+      },
+    },
+    async (req, res) => {
+      await req.serverCtx.settings.directUpdate((file) => {
+        const { system } = file;
+        system.logging.useEnvVarLevel = req.body.useEnvVarLevel ?? true;
+        if (system.logging.useEnvVarLevel) {
+          system.logging.logLevel = getDefaultLogLevel(false);
+        } else {
+          system.logging.logLevel =
+            req.body.logLevel ?? getDefaultLogLevel(false);
+        }
+        return file;
+      });
+
+      return res.send(
+        getSystemSettingsResponse(req.serverCtx.settings.systemSettings()),
+      );
+    },
+  );
+
+  function getSystemSettingsResponse(settings: SystemSettings) {
+    const envLogLevel = getEnvironmentLogLevel();
+    return {
+      ...settings,
+      logging: {
+        ...settings.logging,
+        environmentLogLevel: envLogLevel,
+      },
+    };
+  }
+};

server/src/dao/settings.ts

@@ -1,7 +1,10 @@
 import {
   FfmpegSettings,
   HdhrSettings,
+  LoggingSettingsSchema,
   PlexStreamSettings,
+  SystemSettings,
+  SystemSettingsSchema,
   XmlTvSettings,
   defaultFfmpegSettings,
   defaultHdhrSettings,
@@ -11,7 +14,7 @@ import {
 import { isUndefined, merge, once } from 'lodash-es';
 import { Low, LowSync } from 'lowdb';
 import path from 'path';
-import fs from 'node:fs/promises';
+import chokidar from 'chokidar';
 import { DeepReadonly } from 'ts-essentials';
 import { v4 as uuidv4 } from 'uuid';
 import { globalOptions } from '../globals.js';
@@ -42,28 +45,6 @@ export const defaultXmlTvSettings = (dbBasePath: string): XmlTvSettings => ({
   outputPath: path.resolve(dbBasePath, 'xmltv.xml'),
 });
 
-const LoggingSettingsSchema = z.object({
-  logLevel: z
-    .union([
-      z.literal('silent'),
-      z.literal('fatal'),
-      z.literal('error'),
-      z.literal('warn'),
-      z.literal('info'),
-      z.literal('http'),
-      z.literal('debug'),
-      z.literal('trace'),
-    ])
-    .default(() => (isProduction ? 'info' : 'debug')),
-  logsDirectory: z.string(),
-});
-
-const SystemSettingsSchema = z.object({
-  logging: LoggingSettingsSchema,
-});
-
-type SystemSettings = z.infer<typeof SystemSettingsSchema>;
-
 export const SettingsSchema = z.object({
   clientId: z.string(),
   hdhr: HdhrSettingsSchema,
@@ -82,7 +63,13 @@ export const SettingsFileSchema = z.object({
   version: z.number(),
   migration: MigrationStateSchema,
   settings: SettingsSchema,
-  system: SystemSettingsSchema,
+  system: SystemSettingsSchema.extend({
+    logging: LoggingSettingsSchema.extend({
+      logLevel: SystemSettingsSchema.shape.logging.shape.logLevel.default(() =>
+        isProduction ? 'info' : 'debug',
+      ),
+    }),
+  }),
 });
 
 export type SettingsFile = z.infer<typeof SettingsFileSchema>;
@@ -103,6 +90,7 @@ export const defaultSchema = (dbBasePath: string): SettingsFile => ({
     logging: {
       logLevel: getDefaultLogLevel(),
       logsDirectory: getDefaultLogDirectory(),
+      useEnvVarLevel: true,
     },
   },
 });
@@ -116,12 +104,11 @@ abstract class ITypedEventEmitter extends (events.EventEmitter as new () => Type
 export class SettingsDB extends ITypedEventEmitter {
   private logger: Logger;
   private db: Low<SettingsFile>;
-  private watcherController = new AbortController();
 
   constructor(dbPath: string, db: Low<SettingsFile>) {
     super();
     this.db = db;
-    this.handleFileChanges(dbPath).catch(console.error);
+    this.handleFileChanges(dbPath);
     setImmediate(() => {
       this.logger = LoggerFactory.child(import.meta);
     });
@@ -184,15 +171,22 @@ export class SettingsDB extends ITypedEventEmitter {
     return this.db.write();
   }
 
-  private async handleFileChanges(path: string) {
-    const watcher = fs.watch(path, { signal: this.watcherController.signal });
-    for await (const event of watcher) {
-      if (event.eventType === 'change') {
-        this.logger.debug('detected settings DB change on disk, reloading.');
-        await this.db.read();
-        this.emit('change');
-      }
-    }
+  private handleFileChanges(path: string) {
+    const watcher = chokidar.watch(path, {
+      persistent: false,
+      awaitWriteFinish: true,
+    });
+
+    watcher.on('change', () => {
+      this.logger.debug(
+        'Detected change to settings DB file %s on disk. Reloading.',
+        path,
+      );
+      this.db
+        .read()
+        .then(() => this.emit('change'))
+        .catch(console.error);
+    });
   }
 }
 

server/src/server.ts

@@ -269,7 +269,6 @@ export async function initServer(opts: ServerOptions) {
         decorateReply: false,
         serve: false, // Use the interceptor
       });
-      // f.addHook('onRequest', async (req, res) => ctx.cacheImageService.routerInterceptor(req, res));
       f.get<{ Params: { hash: string } }>(
         '/cache/images/:hash',
         {

server/src/util/index.ts

@@ -410,7 +410,6 @@ export function flipMap<K extends string | number, V extends string | number>(
 }
 
 export const filename = (path: string) => fileURLToPath(path);
-// const dirname = (path: string) => dirname(filename(path));
 
 export const currentEnv = once(() => {
   const env = process.env['NODE_ENV'];