From 7db370fb877bfaa7bc7cd57764895fb4ab6d493c Mon Sep 17 00:00:00 2001
From: Kristóf Marussy <kristof@marussy.com>
Date: Thu, 30 Dec 2021 02:37:44 +0100
Subject: refactor: Improve logging

---
 packages/main/src/controllers/config.ts | 32 +++++++++++---------------------
 1 file changed, 11 insertions(+), 21 deletions(-)

(limited to 'packages/main/src/controllers/config.ts')

diff --git a/packages/main/src/controllers/config.ts b/packages/main/src/controllers/config.ts
index f2467c7..600a142 100644
--- a/packages/main/src/controllers/config.ts
+++ b/packages/main/src/controllers/config.ts
@@ -28,17 +28,16 @@ import { Disposer, getLogger } from '../utils';
 
 const DEFAULT_CONFIG_DEBOUNCE_TIME = ms('1s');
 
-const logger = getLogger('controller:config');
+const log = getLogger('config');
 
 export async function initConfig(
   config: Config,
   persistenceService: ConfigPersistenceService,
   debounceTime: number = DEFAULT_CONFIG_DEBOUNCE_TIME,
 ): Promise<Disposer> {
-  logger.debug('Initializing controller');
+  log.trace('Initializing config controller');
 
   let lastSnapshotOnDisk: ConfigSnapshotOut | null = null;
-  let writingConfig: boolean = false;
 
   async function readConfig(): Promise<boolean> {
     const result = await persistenceService.readConfig();
@@ -46,9 +45,8 @@ export async function initConfig(
       try {
         applySnapshot(config, result.data);
         lastSnapshotOnDisk = getSnapshot(config);
-        logger.debug('Loaded config');
       } catch (err) {
-        logger.error('Failed to read config', result.data, err);
+        log.error('Failed to apply config snapshot', result.data, err);
       }
     }
     return result.found;
@@ -56,23 +54,17 @@ export async function initConfig(
 
   async function writeConfig(): Promise<void> {
     const snapshot = getSnapshot(config);
-    writingConfig = true;
-    try {
-      await persistenceService.writeConfig(snapshot);
-      lastSnapshotOnDisk = snapshot;
-      logger.debug('Wrote config');
-    } finally {
-      writingConfig = false;
-    }
+    await persistenceService.writeConfig(snapshot);
+    lastSnapshotOnDisk = snapshot;
   }
 
   if (!await readConfig()) {
-    logger.info('Config file was not found');
+    log.info('Config file was not found');
     try {
       await writeConfig();
-      logger.info('Created config file');
+      log.info('Created config file');
     } catch (err) {
-      logger.error('Failed to initialize config');
+      log.error('Failed to initialize config', err);
     }
   }
 
@@ -80,19 +72,17 @@ export async function initConfig(
     // We can compare snapshots by reference, since it is only recreated on store changes.
     if (lastSnapshotOnDisk !== snapshot) {
       writeConfig().catch((err) => {
-        logger.error('Failed to write config on config change', err);
+        log.error('Failed to write config on config change', err);
       })
     }
   }, debounceTime));
 
   const disposeWatcher = persistenceService.watchConfig(async () => {
-    if (!writingConfig) {
-      await readConfig();
-    }
+    await readConfig();
   }, debounceTime);
 
   return () => {
-    logger.debug('Disposing controller');
+    log.trace('Disposing config controller');
     disposeWatcher();
     disposeOnSnapshot();
   };
-- 
cgit v1.2.3-54-g00ecf