feat: http-server 支持外部传入 logger, electron 实现 logger

packages/electron/package.json

@@ -62,7 +62,8 @@
     "@autorecord/shared": "workspace:^",
     "concurrently": "^7.4.0",
     "env-paths": "^2.0.0",
-    "ffmpeg-static": "^5.0.2"
+    "ffmpeg-static": "^5.0.2",
+    "winston": "^3.8.2"
   },
   "devDependencies": {
     "electron": "^20.1.1",

packages/electron/src/index.ts

@@ -1,3 +1,4 @@
+import { logger } from './logger'
 import { dirname, join } from 'path'
 import { app, screen, shell, BrowserWindow, Menu, Tray } from 'electron'
 import { startServer } from '@autorecord/http-server'
@@ -47,6 +48,7 @@ function initApp() {
   startServer({
     getSettings: async () => getSettings(),
     setSettings: async (newSettings) => setSettings(newSettings),
+    logger,
     // electron 在 asar 模式下对于一些文件相关的 api 有限制，而 fluent-ffmpeg 使用的 spawn
     // 则在限制范围中，所以需要解包后的路径（解包是由 electron-builder 内部 hard code 实现的）。
     // https://www.electronjs.org/fr/docs/latest/tutorial/asar-archives#executing-binaries-inside-asar-archive

packages/electron/src/logger.ts

@@ -0,0 +1,44 @@
+import path from 'path'
+import { createLogger, format, transports } from 'winston'
+import { paths } from './env'
+
+export const logger = createLogger({
+  level: 'debug',
+  format: format.combine(
+    format.label({ label: 'default' }),
+    format.timestamp(),
+    format.json()
+  ),
+  transports: [
+    new transports.File({
+      filename: path.join(paths.log, 'client-error.log'),
+      level: 'error',
+    }),
+    new transports.File({
+      filename: path.join(paths.log, 'client-combined.log'),
+    }),
+  ],
+})
+
+// winston 的 rejectionHandlers / exceptionHandlers 实现有 bug，配置后在遇到
+// unhandledRejection 时会导致 logger 的 stream 永久 pause，所以这里手动写日志。
+process.on('unhandledRejection', (error) => {
+  logger.error('unhandledRejection', error)
+})
+process.on('unhandleExceptions', (error) => {
+  logger.error('unhandleExceptions', error)
+})
+
+if (process.env.NODE_ENV !== 'production') {
+  logger.add(
+    new transports.Console({
+      format: format.combine(
+        format.colorize(),
+        format.align(),
+        format.printf(({ level, message, label, timestamp }) => {
+          return `${timestamp} [${label}] ${level}: ${message}`
+        })
+      ),
+    })
+  )
+}

packages/http-server/src/index.ts

@@ -1,4 +1,3 @@
-import './prepare'
 import path from 'path'
 import express from 'express'
 import morgan from 'morgan'
@@ -11,18 +10,20 @@ import { Settings } from '@autorecord/shared'
 import { paths } from './env'
 import { PickPartial, readJSONFile, writeJSONFile } from './utils'
 import { ServerOpts } from './types'
-import { logger } from './logger'
+import { createLogger } from './logger'
 
 export * from './routes/api_types'
 
 export async function startServer(
-  opts: PickPartial<ServerOpts, 'getSettings' | 'setSettings'> = {}
+  opts: PickPartial<ServerOpts, 'getSettings' | 'setSettings' | 'logger'> = {}
 ) {
   const serverOpts: ServerOpts = {
     ...opts,
     getSettings: opts.getSettings ?? defaultGetSettings,
     setSettings: opts.setSettings ?? defaultSetSettings,
+    logger: opts.logger ?? console,
   }
+  const { logger } = serverOpts
 
   logger.info('initializing db')
   await initDB()
@@ -31,7 +32,7 @@ export async function startServer(
   if (opts.ffmpegPath != null) {
     setFFMPEGPath(opts.ffmpegPath)
   }
-  await initRecorderManager()
+  await initRecorderManager(serverOpts)
 
   logger.info('HTTP server starting')
   const app = express()
@@ -68,5 +69,15 @@ async function defaultSetSettings(newSettings: Settings) {
 
 const isDirectlyRun = require.main === module
 if (isDirectlyRun) {
-  void startServer()
+  const logger = createLogger()
+  // winston 的 rejectionHandlers / exceptionHandlers 实现有 bug，配置后在遇到
+  // unhandledRejection 时会导致 logger 的 stream 永久 pause，所以这里手动写日志。
+  process.on('unhandledRejection', (error) => {
+    logger.error('unhandledRejection', error)
+  })
+  process.on('unhandleExceptions', (error) => {
+    logger.error('unhandleExceptions', error)
+  })
+
+  void startServer({ logger })
 }

packages/http-server/src/logger.ts

@@ -1,42 +1,49 @@
 import path from 'path'
-import { createLogger, format, transports } from 'winston'
+import {
+  createLogger as createWinstonLogger,
+  format,
+  transports,
+} from 'winston'
 import { paths } from './env'
 
-export const logger = createLogger({
-  level: 'debug',
-  format: format.combine(
-    format.label({ label: 'default' }),
-    format.timestamp(),
-    format.json()
-  ),
-  transports: [
-    new transports.File({
-      filename: path.join(paths.log, 'error.log'),
-      level: 'error',
-    }),
-    new transports.File({ filename: path.join(paths.log, 'combined.log') }),
-  ],
-})
+export function createLogger() {
+  const logger = createWinstonLogger({
+    levels: {
+      error: 3,
+      warn: 4,
+      info: 6,
+      debug: 7,
+    },
+    level: 'debug',
+    format: format.combine(
+      format.label({ label: 'default' }),
+      format.timestamp(),
+      format.json()
+    ),
+    transports: [
+      new transports.File({
+        filename: path.join(paths.log, 'server-error.log'),
+        level: 'error',
+      }),
+      new transports.File({
+        filename: path.join(paths.log, 'server-combined.log'),
+      }),
+    ],
+  })
 
-// winston 的 rejectionHandlers / exceptionHandlers 实现有 bug，配置后在遇到
-// unhandledRejection 时会导致 logger 的 stream 永久 pause，所以这里手动写日志。
-process.on('unhandledRejection', (error) => {
-  logger.error('unhandledRejection', error)
-})
-process.on('unhandleExceptions', (error) => {
-  logger.error('unhandleExceptions', error)
-})
+  if (process.env.NODE_ENV !== 'production') {
+    logger.add(
+      new transports.Console({
+        format: format.combine(
+          format.colorize(),
+          format.align(),
+          format.printf(({ level, message, label, timestamp }) => {
+            return `${timestamp} [${label}] ${level}: ${message}`
+          })
+        ),
+      })
+    )
+  }
 
-if (process.env.NODE_ENV !== 'production') {
-  logger.add(
-    new transports.Console({
-      format: format.combine(
-        format.colorize(),
-        format.align(),
-        format.printf(({ level, message, label, timestamp }) => {
-          return `${timestamp} [${label}] ${level}: ${message}`
-        })
-      ),
-    })
-  )
+  return logger
 }

packages/http-server/src/manager.ts

@@ -5,7 +5,7 @@ import { provider as providerForBilibili } from '@autorecord/bilibili-recorder'
 import { isDebugMode, paths } from './env'
 import { asyncDebounce, readJSONFile, writeJSONFile } from './utils'
 import { insertRecord, updateRecordStopTime } from './db'
-import { logger } from './logger'
+import { ServerOpts } from './types'
 
 const recordersConfigPath = path.join(paths.config, 'recorders.json')
 const managerConfigPath = path.join(paths.config, 'manager.json')
@@ -18,7 +18,11 @@ export const recorderManager = createRecorderManager<RecorderExtra>({
   providers: [providerForDouYu, providerForBilibili],
 })
 
-export async function initRecorderManager(): Promise<void> {
+export async function initRecorderManager(
+  serverOpts: ServerOpts
+): Promise<void> {
+  const { logger } = serverOpts
+
   const managerConfig = await readJSONFile<ManagerConfig>(managerConfigPath, {
     savePathRule: path.join(
       paths.data,

packages/http-server/src/routes/index.ts

@@ -5,10 +5,10 @@ import { router as managerRoutes } from './manager'
 import { router as eventRoutes } from './event'
 import { createRouter as createSettingRouter } from './setting'
 import { ServerOpts } from '../types'
-import { logger } from '../logger'
 // import { respond } from './utils'
 
 export function createRouter(serverOpts: ServerOpts) {
+  const { logger } = serverOpts
   const router = Router()
 
   router.use(recorderRoutes)

packages/http-server/src/types.ts

@@ -1,7 +1,15 @@
 import { Settings } from '@autorecord/shared'
 
+export type LogFn = (data: unknown) => void
+
 export interface ServerOpts {
   getSettings: () => Promise<Settings>
   setSettings: (newSettings: Settings) => Promise<Settings>
+  logger: {
+    error: LogFn
+    warn: LogFn
+    info: LogFn
+    debug: LogFn
+  }
   ffmpegPath?: string
 }

yarn.lock

@@ -67,6 +67,7 @@ __metadata:
     electron-vite: ^1.0.14
     env-paths: ^2.0.0
     ffmpeg-static: ^5.0.2
+    winston: ^3.8.2
   languageName: unknown
   linkType: soft