🐛 Fix: the issue of lost logs

Author: Molunerfinn

src/core/PicGo.ts

@@ -43,6 +43,7 @@ class PicGo extends EventEmitter {
       beforeUploadPlugins: new LifecyclePlugins('beforeUploadPlugins'),
       afterUploadPlugins: new LifecyclePlugins('afterUploadPlugins')
     }
+    this.initConfigPath()
     this.log = new Logger(this)
     this.cmd = new Commander(this)
     this.pluginHandler = new PluginHandler(this)
@@ -54,29 +55,31 @@ class PicGo extends EventEmitter {
     LifecyclePlugins.currentPlugin = name
   }
 
-  initConfig (): void {
+  private initConfigPath (): void {
     if (this.configPath === '') {
       this.configPath = homedir() + '/.picgo/config.json'
     }
     if (path.extname(this.configPath).toUpperCase() !== '.JSON') {
       this.configPath = ''
-      this.log.error('The configuration file only supports JSON format.')
-      return
+      throw Error('The configuration file only supports JSON format.')
     }
     this.baseDir = path.dirname(this.configPath)
     const exist = fs.pathExistsSync(this.configPath)
     if (!exist) {
       fs.ensureFileSync(`${this.configPath}`)
     }
+  }
+
+  private initConfig (): void {
     this.db = new DB(this)
     this.config = this.db.read().value()
   }
 
-  init (): any {
+  private init (): void {
     try {
-      // load self plugins
       this.Request = new Request(this)
       this.pluginLoader = new PluginLoader(this)
+      // load self plugins
       this.setCurrentPluginName('picgo')
       uploaders(this)
       transformers(this)

src/lib/Logger.ts

@@ -4,51 +4,67 @@ import dayjs from 'dayjs'
 import fs from 'fs-extra'
 import path from 'path'
 import util from 'util'
+import { ILogType } from '../utils/enum'
+import {
+  ILogArgvType,
+  ILogArgvTypeWithError
+} from '../utils/interfaces'
 
 class Logger {
-  level: {
-    [propName: string]: string
+  private level = {
+    [ILogType.success]: 'green',
+    [ILogType.info]: 'blue',
+    [ILogType.warn]: 'yellow',
+    [ILogType.error]: 'red'
   }
-  ctx: PicGo
+  private ctx: PicGo
+  // private logger: Console
+  private logLevel: string
+  private logPath: string
   constructor (ctx: PicGo) {
-    this.level = {
-      success: 'green',
-      info: 'blue',
-      warn: 'yellow',
-      error: 'red'
-    }
     this.ctx = ctx
   }
-  protected handleLog (type: string, msg: string | Error): string | Error | undefined {
+  private handleLog (type: ILogType, ...msg: ILogArgvTypeWithError[]): void {
     // if configPath is invalid then this.ctx.config === undefined
     // if not then check config.silent
     if (this.ctx.getConfig() === undefined || !this.ctx.getConfig('silent')) {
       let log = chalk[this.level[type]](`[PicGo ${type.toUpperCase()}]: `)
-      log += msg
-      console.log(log)
-      process.nextTick(() => {
-        this.handleWriteLog(type, msg, this.ctx)
-      })
-      return msg
+      console.log(log, ...msg)
+      this.logLevel = this.ctx.getConfig('settings.logLevel')
+      const logPath = this.checkLogPathChange()
+      setTimeout(() => {
+        // The incoming logPath is a value
+        // lock the path with a closure
+        this.handleWriteLog(logPath, type, ...msg)
+      }, 0)
     } else {
       return
     }
   }
 
-  protected handleWriteLog (type: string, msg: string | Error, ctx: PicGo): void {
+  private checkLogPathChange (): string {
+    const logPath = this.ctx.getConfig('settings.logPath') || path.join(this.ctx.baseDir, './picgo.log')
+    if (logPath !== this.logPath) {
+      this.logPath = logPath
+    }
+    return logPath
+  }
+
+  protected handleWriteLog (logPath: string, type: string, ...msg: ILogArgvTypeWithError[]): void {
     try {
-      const logLevel = this.ctx.getConfig('settings.logLevel')
-      const logPath = this.ctx.getConfig('settings.logPath') || path.join(ctx.baseDir, './picgo.log')
-      if (this.checkLogLevel(type, logLevel)) {
-        const picgoLog = fs.createWriteStream(logPath, { flags: 'a', encoding: 'utf8' })
-        let log = `${dayjs().format('YYYY-MM-DD HH:mm:ss')} [PicGo ${type.toUpperCase()}] ${msg}`
-        let logger = new console.Console(picgoLog)
-        if (typeof msg === 'object' && type === 'error') {
-          log += `\n------Error Stack Begin------\n${util.format(msg.stack)}\n-------Error Stack End-------`
-        }
-        logger.log(log)
-        picgoLog.destroy()
-        logger = null
+      if (this.checkLogLevel(type, this.logLevel)) {
+        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 {
+            log += `${item} `
+          }
+        })
+        log += '\n'
+        fs.appendFile(logPath, log, (err: Error) => {
+          if (err) console.log(err)
+        })
       }
     } catch (e) {
       console.log(e)
@@ -66,20 +82,20 @@ class Logger {
     }
   }
 
-  success (msg: string | Error): string | Error | undefined {
-    return this.handleLog('success', msg)
+  success (...msg: ILogArgvType[]): void {
+    return this.handleLog(ILogType.success, ...msg)
   }
 
-  info (msg: string | Error): string | Error | undefined {
-    return this.handleLog('info', msg)
+  info (...msg: ILogArgvType[]): void {
+    return this.handleLog(ILogType.info, ...msg)
   }
 
-  error (msg: string | Error): string | Error | undefined {
-    return this.handleLog('error', msg)
+  error (...msg: ILogArgvTypeWithError[]): void {
+    return this.handleLog(ILogType.error, ...msg)
   }
 
-  warn (msg: string | Error): string | Error | undefined {
-    return this.handleLog('warn', msg)
+  warn (...msg: ILogArgvType[]): void {
+    return this.handleLog(ILogType.warn, ...msg)
   }
 }
 

src/lib/PluginHandler.ts

@@ -61,7 +61,7 @@ class PluginHandler {
         body: plugins
       })
     } else {
-      const err = `插件更新失败，失败码为${result.code}，错误日志为${result.data}`
+      const err = `插件更新失败，失败码为${result.code}，错误日志为 \n ${result.data}`
       this.ctx.log.error(err)
       this.ctx.emit('updateFailed', {
         title: '插件更新失败',
@@ -71,7 +71,7 @@ class PluginHandler {
   }
   execCommand (cmd: string, modules: string[], where: string, proxy: string = '', env: ProcessEnv = {}): Promise<Result> {
     const registry = this.ctx.getConfig('registry')
-    return new Promise((resolve: any, reject: any): void => {
+    return new Promise((resolve: any): void => {
       let args = [cmd].concat(modules).concat('--color=always').concat('--save')
       if (registry) {
         args = args.concat(`--registry=${registry}`)
@@ -95,7 +95,7 @@ class PluginHandler {
           if (!code) {
             resolve({ code: 0, data: output })
           } else {
-            reject({ code: code, data: output })
+            resolve({ code: code, data: output })
           }
         })
         // for users who haven't installed node.js

src/utils/enum.ts

@@ -0,0 +1,6 @@
+export enum ILogType {
+  success = 'success',
+  info = 'info',
+  warn = 'warn',
+  error = 'error'
+}

src/utils/getClipboardImage.ts

@@ -46,9 +46,9 @@ const getClipboardImage = (ctx: PicGo): Promise<ClipboardImage> => {
         '-nologo',
         '-sta',
         '-executionpolicy', 'unrestricted',
-        // fix windows 10 native cmd crash bug when "picgo upload"
-        // https://github.com/PicGo/PicGo-Core/issues/32
-        // '-windowstyle', 'hidden',
+        // fix windows 10 native cmd crash bug when "picgo upload"
+        // https://github.com/PicGo/PicGo-Core/issues/32
+        // '-windowstyle','hidden',
         // '-noexit',
         '-file', scriptPath,
         imagePath

src/utils/interfaces.ts

@@ -4,7 +4,7 @@ import LifecyclePlugins from '../lib/LifecyclePlugins'
 /**
  * for plugin config
  */
-interface PluginConfig {
+export interface PluginConfig {
   name: string
   type: string
   required: boolean
@@ -15,7 +15,7 @@ interface PluginConfig {
 /**
  * for lifecycle plugins
  */
-interface Helper {
+export interface Helper {
   transformer: LifecyclePlugins
   uploader: LifecyclePlugins
   beforeTransformPlugins: LifecyclePlugins
@@ -26,7 +26,7 @@ interface Helper {
 /**
  * for uploading image info
  */
-interface ImgInfo {
+export interface ImgInfo {
   buffer?: Buffer
   base64Image?: string
   fileName?: string
@@ -36,45 +36,45 @@ interface ImgInfo {
   [propName: string]: any
 }
 
-interface IPathTransformedImgInfo extends ImgInfo {
+export interface IPathTransformedImgInfo extends ImgInfo {
   success: boolean
 }
 
 /**
  * for config options
  */
-interface Config {
+export interface Config {
   [propName: string]: any
 }
 
 /**
  * for plugin
  */
-interface Plugin {
+export interface Plugin {
   handle (ctx: PicGo): void | Promise<any>
   [propName: string]: any
 }
 
 /**
  * for spawn output
  */
-interface Result {
+export interface Result {
   code: string | number
   data: string
 }
 
 /**
  * for transformer - path
  */
-interface ImgSize {
+export interface ImgSize {
   width: number
   height: number
 }
 
 /**
  * for initUtils
  */
-interface Options {
+export interface Options {
   template: string // template name
   dest: string // destination for template to generate
   hasSlash: boolean // check if is officail template
@@ -88,27 +88,18 @@ interface Options {
 /**
  * for clipboard image
  */
-interface ClipboardImage {
+export interface ClipboardImage {
   imgPath: string
   isExistFile: boolean
 }
 
 /**
  * for install command environment variable
  */
-interface ProcessEnv {
+export interface ProcessEnv {
   [propName: string]: string | undefined
 }
-export {
-  PluginConfig,
-  ImgInfo,
-  Config,
-  Helper,
-  Plugin,
-  Result,
-  ImgSize,
-  Options,
-  ClipboardImage,
-  ProcessEnv,
-  IPathTransformedImgInfo
-}
+
+export type ILogArgvType = string | number
+
+export type ILogArgvTypeWithError = ILogArgvType | Error