chore(backend): improve logging structure for error handling

Author: Lasim

services/backend/src/plugin-system/plugin-manager.ts

@@ -118,7 +118,7 @@ export class PluginManager {
         this.logger?.debug(`Trying to import as module: ${pluginPath}`);
         pluginPackage = await import(pluginPath);
       } catch (err) {
-        this.logger?.debug(`Module import failed, trying require: ${pluginPath}`, err);
+        this.logger?.debug({ error: err }, `Module import failed, trying require: ${pluginPath}`);
         // Using dynamic import with a constructed path to avoid require()
         // This is a workaround for the ESLint rule @typescript-eslint/no-require-imports
         pluginPackage = await import(`${pluginPath}`);
@@ -153,7 +153,7 @@ export class PluginManager {
       if (error instanceof PluginDuplicateError) {
         throw error;
       }
-      this.logger?.error(`Error loading plugin from ${pluginPath}:`, error);
+      this.logger?.error({ error }, `Error loading plugin from ${pluginPath}:`);
       throw new PluginLoadError(path.basename(pluginPath), error);
     }
   }
@@ -210,7 +210,7 @@ export class PluginManager {
                   this.logger?.debug(`Found main file: ${mainPath}`);
                   await this.loadPlugin(mainPath);
                 } catch (accessErr) {
-                  this.logger?.debug(`Main file not found: ${mainPath}, error:`, accessErr);
+                  this.logger?.debug({ error: accessErr }, `Main file not found: ${mainPath}, error:`);
 
                   // If preferred file not found, try alternative
                   const altExtension = pluginExtension === 'ts' ? 'js' : 'ts';
@@ -236,7 +236,7 @@ export class PluginManager {
           await this.loadPlugin(pluginPath);
         }
       } catch (error) {
-        this.logger?.error(`Error discovering plugins at ${pluginPath}:`, error);
+        this.logger?.error({ error }, `Error discovering plugins at ${pluginPath}:`);
       }
     }
 
@@ -331,7 +331,7 @@ export class PluginManager {
           this.logger?.warn(`Global setting group ID '${group.id}' already exists (Existing Name: "${existingGroup.name}"). Plugin's attempt to define a group with this ID (Plugin's proposed Name: "${group.name}") will use the existing group. Plugin-specific metadata for this group ID (name, description, icon, sort_order) is ignored.`);
         }
       } catch (error) {
-        this.logger?.error(`Error processing plugin-defined group '${group.id}' (Plugin's proposed Name: "${group.name}"):`, error);
+        this.logger?.error({ error }, `Error processing plugin-defined group '${group.id}' (Plugin's proposed Name: "${group.name}"):`);
       }
     }
 
@@ -342,7 +342,7 @@ export class PluginManager {
       const coreSettings = await GlobalSettingsService.getAll();
       coreSettings.forEach(cs => initializedKeys.add(cs.key));
     } catch (error) {
-      this.logger?.error('Failed to get all core settings for precedence check:', error);
+      this.logger?.error({ error }, 'Failed to get all core settings for precedence check:');
       // If this fails, we might risk overwriting, but proceed with caution.
     }
 
@@ -362,7 +362,7 @@ export class PluginManager {
         initializedKeys.add(definition.key); // Add to set after successful initialization
         this.logger?.info(`Initialized global setting '${definition.key}' from plugin '${pluginId}'.`);
       } catch (error) {
-        this.logger?.error(`Failed to initialize global setting '${definition.key}' from plugin '${pluginId}':`, error);
+        this.logger?.error({ error }, `Failed to initialize global setting '${definition.key}' from plugin '${pluginId}':`);
       }
     }
     this.logger?.info('Plugin global settings initialization complete.');
@@ -402,7 +402,7 @@ export class PluginManager {
       } catch (error) {
         // Log individual plugin initialization errors but continue with others.
         const typedError = error as Error;
-        this.logger?.error(`Failed to initialize plugin ${plugin.meta.id}: ${typedError.message}`, typedError.stack);
+        this.logger?.error({ error: typedError, stack: typedError.stack }, `Failed to initialize plugin ${plugin.meta.id}: ${typedError.message}`);
         // Optionally, re-throw: throw new PluginInitializeError(plugin.meta.id, error);
       }
     }
@@ -440,7 +440,7 @@ export class PluginManager {
         }
       } catch (error) {
         const typedError = error as Error;
-        this.logger?.error(`Failed to re-initialize plugin ${plugin.meta.id}: ${typedError.message}`, typedError.stack);
+        this.logger?.error({ error: typedError, stack: typedError.stack }, `Failed to re-initialize plugin ${plugin.meta.id}: ${typedError.message}`);
         // Continue with other plugins even if one fails
       }
     }
@@ -459,7 +459,7 @@ export class PluginManager {
           const pluginLogger = this.logger?.child({ pluginId: plugin.meta.id }) || this.app!.log.child({ pluginId: plugin.meta.id });
           await plugin.shutdown(pluginLogger);
         } catch (error) {
-          this.logger?.error(`Error shutting down plugin ${plugin.meta.id}:`, error);
+          this.logger?.error({ error }, `Error shutting down plugin ${plugin.meta.id}:`);
         }
       }
     }

services/backend/src/routes/auth/changePassword.ts

@@ -219,7 +219,7 @@ export default async function changePasswordRoute(fastify: FastifyInstance) {
           }
         } catch (emailError) {
           // Don't fail the password change if email fails
-          fastify.log.warn('Failed to send password change notification email:', emailError);
+          fastify.log.warn({ error: emailError }, 'Failed to send password change notification email:');
         }
 
         // Optional: Invalidate all other sessions for security

services/backend/src/routes/auth/loginEmail.ts

@@ -303,7 +303,7 @@ export default async function loginEmailRoute(server: FastifyInstance) {
 
         // Send as raw JSON string to bypass any serialization issues
         const jsonString = JSON.stringify(cleanResponse);
-        server.log.info('Sending login response:', jsonString);
+        server.log.info({ response: jsonString }, 'Sending login response:');
         return reply.status(200).type('application/json').send(jsonString);
 
       } catch (error) {

services/backend/src/routes/auth/registerEmail.ts

@@ -380,7 +380,7 @@ export default async function registerEmailRoute(server: FastifyInstance) {
         };
 
         const jsonString = JSON.stringify(successResponse);
-        server.log.info('Sending registration response:', jsonString);
+        server.log.info({ response: jsonString }, 'Sending registration response:');
         return reply.status(201).type('application/json').send(jsonString);
 
       } catch (error) {

services/backend/src/routes/db/setup.ts

@@ -142,7 +142,7 @@ async function setupDbHandler(
       dbConfig = getDatabaseConfig(server.log);
     } catch (error) {
       const typedError = error as Error;
-      server.log.error('Database configuration error:', typedError.message);
+      server.log.error({ error: typedError.message }, 'Database configuration error:');
       return reply.status(400).send({ 
         error: 'Database configuration incomplete. Please check environment variables.',
         details: typedError.message
@@ -191,7 +191,7 @@ async function setupDbHandler(
 
           // Send as raw JSON string to bypass any serialization issues
           const jsonString = JSON.stringify(cleanResponse);
-          server.log.info('Sending clean response:', jsonString);
+          server.log.info({ response: jsonString }, 'Sending clean response:');
           return reply.status(200).type('application/json').send(jsonString);
         } else {
           server.log.warn('Database initialization succeeded but re-initialization failed. Manual restart may be required.');
@@ -200,11 +200,11 @@ async function setupDbHandler(
             restart_required: true,
             database_type: String(dbType)
           };
-          server.log.info('Sending response object:', JSON.stringify(responseObj));
+          server.log.info({ response: JSON.stringify(responseObj) }, 'Sending response object:');
           return reply.status(200).send(responseObj);
         }
       } catch (reinitError) {
-        server.log.error('Error during re-initialization after database setup:', reinitError);
+        server.log.error({ error: reinitError }, 'Error during re-initialization after database setup:');
         return reply.status(200).send({ 
           message: 'Database setup successful, but re-initialization failed. Please restart the server to complete setup.',
           restart_required: true,

services/backend/src/routes/db/status.ts

@@ -40,7 +40,7 @@ async function getDbStatusHandler(
 
     // Send as raw JSON string to bypass any serialization issues
     const jsonString = JSON.stringify(cleanResponse);
-    server.log.info('Sending status response:', jsonString);
+    server.log.info({ response: jsonString }, 'Sending status response:');
     return reply.type('application/json').send(jsonString);
   } catch (error) {
     server.log.error(error, 'Error fetching database status'); // Use server.log

services/backend/src/routes/globalSettings/settings/bulk.ts

@@ -100,7 +100,7 @@ export default async function bulkGlobalSettingsRoute(fastify: FastifyInstance)
           );
           results.push(setting);
         } catch (error) {
-          fastify.log.error(`Error processing setting ${settingData.key}:`, error);
+          fastify.log.error({ error }, `Error processing setting ${settingData.key}:`);
           errors.push({
             key: settingData.key,
             error: error instanceof Error ? error.message : 'Unknown error',

services/backend/src/routes/users/preferences/get.ts

@@ -49,7 +49,7 @@ export default async function getPreferences(server: FastifyInstance) {
       const jsonString = JSON.stringify(successResponse);
       return reply.status(200).type('application/json').send(jsonString);
     } catch (error) {
-      request.log.error('Error getting user preferences:', error);
+      request.log.error({ error }, 'Error getting user preferences:');
 
       const errorResponse: ErrorResponse = {
         success: false,

services/backend/src/routes/users/preferences/getSpecific.ts

@@ -77,7 +77,7 @@ export default async function getSpecificPreference(server: FastifyInstance) {
       const jsonString = JSON.stringify(successResponse);
       return reply.status(200).type('application/json').send(jsonString);
     } catch (error) {
-      request.log.error('Error getting specific preference:', error);
+      request.log.error({ error }, 'Error getting specific preference:');
 
       const errorResponse: ErrorResponse = {
         success: false,

services/backend/src/routes/users/preferences/notifications/acknowledge.ts

@@ -69,7 +69,7 @@ export default async function acknowledgeNotification(server: FastifyInstance) {
       const jsonString = JSON.stringify(successResponse);
       return reply.status(200).type('application/json').send(jsonString);
     } catch (error) {
-      request.log.error('Error acknowledging notification:', error);
+      request.log.error({ error }, 'Error acknowledging notification:');
 
       const errorResponse: ErrorResponse = {
         success: false,