refactor: Improve logging

1 files changed, 33 insertions, 6 deletions

diff --git a/packages/main/src/services/ConfigPersistenceService.ts b/packages/main/src/services/ConfigPersistenceService.ts
index ee5eb9f..b2109f6 100644
--- a/packages/main/src/services/ConfigPersistenceService.ts
+++ b/packages/main/src/services/ConfigPersistenceService.ts
@@ -24,13 +24,17 @@ import throttle from 'lodash-es/throttle';
 import { join } from 'path';
 
 import type { ConfigSnapshotOut } from  '../stores/Config';
-import { Disposer } from '../utils';
+import { Disposer, getLogger } from '../utils';
+
+const log = getLogger('configPersistence');
 
 export type ReadConfigResult = { found: true; data: unknown; } | { found: false; };
 
 export class ConfigPersistenceService {
   private readonly configFilePath: string;
 
+  private writingConfig = false;
+
   private timeLastWritten: Date | null = null;
 
   constructor(
@@ -47,10 +51,12 @@ export class ConfigPersistenceService {
       configStr = await readFile(this.configFilePath, 'utf8');
     } catch (err) {
       if ((err as NodeJS.ErrnoException).code === 'ENOENT') {
+        log.debug('Config file', this.configFilePath, 'was not found');
         return { found: false };
       }
       throw err;
     }
+    log.info('Read config file', this.configFilePath);
     return {
       found: true,
       data: JSON5.parse(configStr),
@@ -61,24 +67,42 @@ export class ConfigPersistenceService {
     const configJson = JSON5.stringify(configSnapshot, {
       space: 2,
     });
-    await writeFile(this.configFilePath, configJson, 'utf8');
-    const stats = await stat(this.configFilePath);
-    this.timeLastWritten = stats.mtime;
+    this.writingConfig = true;
+    try {
+      await writeFile(this.configFilePath, configJson, 'utf8');
+      const { mtime } = await stat(this.configFilePath);
+      log.trace('Config file', this.configFilePath, 'last written at', mtime);
+      this.timeLastWritten = mtime;
+    } finally {
+      this.writingConfig = false;
+    }
+    log.info('Wrote config file', this.configFilePath);
   }
 
   watchConfig(callback: () => Promise<void>, throttleMs: number): Disposer {
+    log.debug('Installing watcher for', this.userDataDir);
+
     const configChanged = throttle(async () => {
       let mtime: Date;
       try {
         const stats = await stat(this.configFilePath);
         mtime = stats.mtime;
+        log.trace('Config file last modified at', mtime);
       } catch (err) {
         if ((err as NodeJS.ErrnoException).code === 'ENOENT') {
+          log.debug('Config file', this.configFilePath, 'was deleted after being changed');
           return;
         }
         throw err;
       }
-      if (this.timeLastWritten === null || mtime > this.timeLastWritten) {
+      if (!this.writingConfig
+        && (this.timeLastWritten === null || mtime > this.timeLastWritten)) {
+        log.debug(
+          'Found a config file modified at',
+          mtime,
+          'whish is newer than last written',
+          this.timeLastWritten,
+        );
         return callback();
       }
     }, throttleMs);
@@ -96,6 +120,9 @@ export class ConfigPersistenceService {
       }
     });
 
-    return () => watcher.close();
+    return () => {
+      log.trace('Removing watcher for', this.configFilePath);
+      watcher.close();
+    };
   }
 }