Update:Log uncaught exceptions to crash_logs.txt #706 & cleanup logger

server/managers/LogManager.js

@@ -1,19 +1,34 @@
 const Path = require('path')
 const fs = require('../libs/fsExtra')
 
+const Logger = require('../Logger')
 const DailyLog = require('../objects/DailyLog')
 
-const Logger = require('../Logger')
+const { LogLevel } = require('../utils/constants')
 
 const TAG = '[LogManager]'
 
+/**
+ * @typedef LogObject
+ * @property {string} timestamp
+ * @property {string} source
+ * @property {string} message
+ * @property {string} levelName
+ * @property {number} level
+ */
+
 class LogManager {
   constructor() {
     this.DailyLogPath = Path.posix.join(global.MetadataPath, 'logs', 'daily')
     this.ScanLogPath = Path.posix.join(global.MetadataPath, 'logs', 'scans')
 
+    /** @type {DailyLog} */
     this.currentDailyLog = null
+
+    /** @type {LogObject[]} */
     this.dailyLogBuffer = []
+
+    /** @type {string[]} */
     this.dailyLogFiles = []
   }
 
@@ -26,12 +41,12 @@ class LogManager {
     await fs.ensureDir(this.ScanLogPath)
   }
 
-  async ensureScanLogDir() {
-    if (!(await fs.pathExists(this.ScanLogPath))) {
-      await fs.mkdir(this.ScanLogPath)
-    }
-  }
-
+  /**
+   * 1. Ensure log directories exist
+   * 2. Load daily log files
+   * 3. Remove old daily log files
+   * 4. Create/set current daily log file
+   */
   async init() {
     await this.ensureLogDirs()
 
@@ -46,11 +61,11 @@ class LogManager {
       }
     }
 
+    // set current daily log file or create if does not exist
     const currentDailyLogFilename = DailyLog.getCurrentDailyLogFilename()
     Logger.info(TAG, `Init current daily log filename: ${currentDailyLogFilename}`)
 
-    this.currentDailyLog = new DailyLog()
-    this.currentDailyLog.setData({ dailyLogDirPath: this.DailyLogPath })
+    this.currentDailyLog = new DailyLog(this.DailyLogPath)
 
     if (this.dailyLogFiles.includes(currentDailyLogFilename)) {
       Logger.debug(TAG, `Daily log file already exists - set in Logger`)
@@ -59,7 +74,7 @@ class LogManager {
       this.dailyLogFiles.push(this.currentDailyLog.filename)
     }
 
-    // Log buffered Logs
+    // Log buffered daily logs
     if (this.dailyLogBuffer.length) {
       this.dailyLogBuffer.forEach((logObj) => {
         this.currentDailyLog.appendLog(logObj)
@@ -68,9 +83,12 @@ class LogManager {
     }
   }
 
+  /**
+   * Load all daily log filenames in /metadata/logs/daily
+   */
   async scanLogFiles() {
     const dailyFiles = await fs.readdir(this.DailyLogPath)
-    if (dailyFiles && dailyFiles.length) {
+    if (dailyFiles?.length) {
       dailyFiles.forEach((logFile) => {
         if (Path.extname(logFile) === '.txt') {
           Logger.debug('Daily Log file found', logFile)
@@ -83,30 +101,38 @@ class LogManager {
     this.dailyLogFiles.sort()
   }
 
-  async removeOldestLog() {
-    if (!this.dailyLogFiles.length) return
-    const oldestLog = this.dailyLogFiles[0]
-    return this.removeLogFile(oldestLog)
-  }
-
+  /**
+   * 
+   * @param {string} filename 
+   */
   async removeLogFile(filename) {
     const fullPath = Path.join(this.DailyLogPath, filename)
     const exists = await fs.pathExists(fullPath)
     if (!exists) {
       Logger.error(TAG, 'Invalid log dne ' + fullPath)
-      this.dailyLogFiles = this.dailyLogFiles.filter(dlf => dlf.filename !== filename)
+      this.dailyLogFiles = this.dailyLogFiles.filter(dlf => dlf !== filename)
     } else {
       try {
         await fs.unlink(fullPath)
         Logger.info(TAG, 'Removed daily log: ' + filename)
-        this.dailyLogFiles = this.dailyLogFiles.filter(dlf => dlf.filename !== filename)
+        this.dailyLogFiles = this.dailyLogFiles.filter(dlf => dlf !== filename)
       } catch (error) {
         Logger.error(TAG, 'Failed to unlink log file ' + fullPath)
       }
     }
   }
 
-  logToFile(logObj) {
+  /**
+   * 
+   * @param {LogObject} logObj 
+   */
+  async logToFile(logObj) {
+    // Fatal crashes get logged to a separate file
+    if (logObj.level === LogLevel.FATAL) {
+      await this.logCrashToFile(logObj)
+    }
+
+    // Buffer when logging before daily logs have been initialized
     if (!this.currentDailyLog) {
       this.dailyLogBuffer.push(logObj)
       return
@@ -114,25 +140,39 @@ class LogManager {
 
     // Check log rolls to next day
     if (this.currentDailyLog.id !== DailyLog.getCurrentDateString()) {
-      const newDailyLog = new DailyLog()
-      newDailyLog.setData({ dailyLogDirPath: this.DailyLogPath })
-      this.currentDailyLog = newDailyLog
+      this.currentDailyLog = new DailyLog(this.DailyLogPath)
       if (this.dailyLogFiles.length > this.loggerDailyLogsToKeep) {
-        this.removeOldestLog()
+        // Remove oldest log
+        this.removeLogFile(this.dailyLogFiles[0])
       }
     }
 
     // Append log line to log file
-    this.currentDailyLog.appendLog(logObj)
+    return this.currentDailyLog.appendLog(logObj)
   }
 
-  socketRequestDailyLogs(socket) {
-    if (!this.currentDailyLog) {
-      return
-    }
+  /**
+   * 
+   * @param {LogObject} logObj 
+   */
+  async logCrashToFile(logObj) {
+    const line = JSON.stringify(logObj) + '\n'
 
-    const lastLogs = this.currentDailyLog.logs.slice(-5000)
-    socket.emit('daily_logs', lastLogs)
+    const logsDir = Path.join(global.MetadataPath, 'logs')
+    await fs.ensureDir(logsDir)
+    const crashLogPath = Path.join(logsDir, 'crash_logs.txt')
+    return fs.writeFile(crashLogPath, line, { flag: "a+" }).catch((error) => {
+      console.log('[LogManager] Appended crash log', error)
+    })
+  }
+
+  /**
+   * Most recent 5000 daily logs
+   * 
+   * @returns {string}
+   */
+  getMostRecentCurrentDailyLogs() {
+    return this.currentDailyLog?.logs.slice(-5000) || ''
   }
 }
 module.exports = LogManager