✨ Feature: add logFileSizeLimit for log file

ISSUES CLOSED: #935, #945

src/main/apis/app/uploader/index.ts

@@ -19,6 +19,8 @@ import { T } from '~/universal/i18n'
 import fse from 'fs-extra'
 import path from 'path'
 import { privacyManager } from '~/main/utils/privacyManager'
+import writeFile from 'write-file-atomic'
+import { CLIPBOARD_IMAGE_FOLDER } from '~/universal/utils/static'
 
 const waitForShow = (webcontent: WebContents) => {
   return new Promise<void>((resolve) => {
@@ -126,8 +128,8 @@ class Uploader {
       const buffer = nativeImage.toPNG()
       const baseDir = picgo.baseDir
       const fileName = `${dayjs().format('YYYYMMDDHHmmSSS')}.png`
-      filePath = path.join(baseDir, fileName)
-      await fse.writeFile(filePath, buffer)
+      filePath = path.join(baseDir, CLIPBOARD_IMAGE_FOLDER, fileName)
+      await writeFile(filePath, buffer)
       return await this.upload([filePath])
     } catch (e: any) {
       logger.error(e)

src/main/apis/core/datastore/dbChecker.ts

@@ -1,4 +1,5 @@
 import fs from 'fs-extra'
+import writeFile from 'write-file-atomic'
 import path from 'path'
 import { app as APP } from 'electron'
 import { getLogger } from '@core/utils/localLogger'
@@ -50,7 +51,7 @@ function dbChecker () {
         try {
           configFile = fs.readFileSync(configFileBackupPath, { encoding: 'utf-8' })
           JSON.parse(configFile)
-          fs.writeFileSync(configFilePath, configFile, { encoding: 'utf-8' })
+          writeFile.sync(configFilePath, configFile, { encoding: 'utf-8' })
           const stats = fs.statSync(configFileBackupPath)
           optionsTpl.body = `${errorMsg.brokenButBackup}\n${T('TIPS_PICGO_BACKUP_FILE_VERSION', {
             v: dayjs(stats.mtime).format('YYYY-MM-DD HH:mm:ss')
@@ -67,7 +68,7 @@ function dbChecker () {
       global.notificationList?.push(optionsTpl)
       return
     }
-    fs.writeFileSync(configFileBackupPath, configFile, { encoding: 'utf-8' })
+    writeFile.sync(configFileBackupPath, configFile, { encoding: 'utf-8' })
   }
 }
 
@@ -97,7 +98,7 @@ function dbPathChecker (): string {
     }
     return _configFilePath
   } catch (e) {
-    const picgoLogPath = path.join(STORE_PATH, 'picgo.log')
+    const picgoLogPath = path.join(STORE_PATH, 'picgo-gui-local.log')
     const logger = getLogger(picgoLogPath)
     if (!hasCheckPath) {
       const optionsTpl = {
@@ -108,7 +109,6 @@ function dbPathChecker (): string {
       hasCheckPath = true
     }
     logger('error', e)
-    console.error(e)
     _configFilePath = defaultConfigPath
     return _configFilePath
   }

src/main/apis/core/utils/localLogger.ts

@@ -2,6 +2,32 @@ import fs from 'fs-extra'
 import dayjs from 'dayjs'
 import util from 'util'
 
+const checkLogFileIsLarge = (logPath: string): {
+  isLarge: boolean
+  logFileSize?: number
+  logFileSizeLimit?: number
+} => {
+  if (fs.existsSync(logPath)) {
+    const logFileSize = fs.statSync(logPath).size
+    const logFileSizeLimit = 10 * 1024 * 1024 // 10 MB default
+    return {
+      isLarge: logFileSize > logFileSizeLimit,
+      logFileSize,
+      logFileSizeLimit
+    }
+  }
+  return {
+    isLarge: false
+  }
+}
+
+const recreateLogFile = (logPath: string): void => {
+  if (fs.existsSync(logPath)) {
+    fs.unlinkSync(logPath)
+    fs.createFileSync(logPath)
+  }
+}
+
 /**
  * for local log before picgo inited
  */
@@ -9,21 +35,29 @@ const getLogger = (logPath: string) => {
   if (!fs.existsSync(logPath)) {
     fs.ensureFileSync(logPath)
   }
+  if (checkLogFileIsLarge(logPath).isLarge) {
+    recreateLogFile(logPath)
+  }
   return (type: string, ...msg: any[]) => {
-    let log = `${dayjs().format('YYYY-MM-DD HH:mm:ss')} [PicGo ${type.toUpperCase()}] `
-    msg.forEach((item: ILogArgvTypeWithError) => {
-      if (typeof item === 'object' && type === 'error') {
-        log += `\n------Error Stack Begin------\n${util.format(item.stack)}\n-------Error Stack End------- `
-      } else {
-        if (typeof item === 'object') {
-          item = JSON.stringify(item)
+    try {
+      let log = `${dayjs().format('YYYY-MM-DD HH:mm:ss')} [PicGo ${type.toUpperCase()}] `
+      msg.forEach((item: ILogArgvTypeWithError) => {
+        if (typeof item === 'object' && type === 'error') {
+          log += `\n------Error Stack Begin------\n${util.format(item.stack)}\n-------Error Stack End------- `
+        } else {
+          if (typeof item === 'object') {
+            item = JSON.stringify(item)
+          }
+          log += `${item} `
         }
-        log += `${item} `
-      }
-    })
-    log += '\n'
-    // A synchronized approach to avoid log msg sequence errors
-    fs.appendFileSync(logPath, log)
+      })
+      log += '\n'
+      console.log(log)
+      // A synchronized approach to avoid log msg sequence errors
+      fs.appendFileSync(logPath, log)
+    } catch (e) {
+      console.error(e)
+    }
   }
 }
 

src/main/lifeCycle/errorHandler.ts

@@ -1,36 +1,17 @@
-import fse from 'fs-extra'
 import path from 'path'
-import dayjs from 'dayjs'
-import util from 'util'
 import { dbPathDir } from 'apis/core/datastore/dbChecker'
+import { getLogger } from 'apis/core/utils/localLogger'
 const STORE_PATH = dbPathDir()
-const LOG_PATH = path.join(STORE_PATH, '/picgo.log')
+const LOG_PATH = path.join(STORE_PATH, 'picgo-gui-local.log')
+
+const logger = getLogger(LOG_PATH)
 
 // since the error may occur in picgo-core
 // so we can't use the log from picgo
-export const loggerWriter = (error: Error) => {
-  try {
-    const time = dayjs().format('YYYY-MM-DD HH:mm:ss')
-    let log = `${time} [PicGo ERROR] process error begin`
-    if (error?.stack) {
-      log += `\n------Error Stack Begin------\n${util.format(error.stack)}\n-------Error Stack End-------\n`
-    } else {
-      const msg = JSON.stringify(error)
-      log += `${msg}\n`
-    }
-    log += `${time} [PicGo ERROR] process error end`
-    if (!fse.existsSync(LOG_PATH)) {
-      fse.ensureFileSync(LOG_PATH)
-    }
-    fse.appendFileSync(LOG_PATH, log)
-  } catch (e) {
-    console.error(e)
-  }
-}
 
 const handleProcessError = (error: Error) => {
   console.error(error)
-  loggerWriter(error)
+  logger('error', error)
 }
 
 process.on('uncaughtException', error => {