feat(logging): Wave 2 - integrate logging throughout application

This commit integrates the logging infrastructure across the entire application: IPC Layer: - Add logger-handler.ts with centralized IPC logging channels - Integrate audit logging into auth, cleaner, extractor handlers - Add structured logging for IPC operations and data flow Service Layer: - Add logger integration to ERP services (extractor, cleaner) - Integrate logging into excel-parser and user DAO - Add operation tracking and error logging Renderer Layer: - Add useLogger hook for component-level logging - Update App.tsx with session and user activity logging - Enable frontend audit trail for critical actions Testing: - Add comprehensive IPC logging integration tests - Enhance unit test coverage for logger and audit-logger - Add end-to-end logging flow validation Types: - Update preload type definitions for logging APIs Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-03-08 15:07:03 +08:00
parent 5e6898fb40
commit 6df16898da
20 changed files with 1653 additions and 305 deletions
--- a/src/main/ipc/auth-handler.ts
+++ b/src/main/ipc/auth-handler.ts
@@ -13,6 +13,7 @@
 import { ipcMain } from 'electron'
 import { SessionManager } from '../services/user/session-manager'
 import { createLogger } from '../services/logger'
+import { logAudit } from '../services/logger/audit-logger'
 import type { UserInfo } from '../types/user.types'
 import { IPC_CHANNELS } from '../../shared/ipc-channels'
 import { ValidationError } from '../types/errors'
@@ -83,32 +84,45 @@ export function registerAuthHandlers(): void {
  /**
   * Silent login by computer name
   */
-  ipcMain.handle(IPC_CHANNELS.AUTH_SILENT_LOGIN, async (): Promise<IpcResult<SilentLoginResponse>> => {
-    return withErrorHandling(async () => {
-      log.info('Attempting silent login')
-      const success = await sessionManager.loginByComputerName()
-      const userInfo = sessionManager.getUserInfo()
+  ipcMain.handle(
+    IPC_CHANNELS.AUTH_SILENT_LOGIN,
+    async (): Promise<IpcResult<SilentLoginResponse>> => {
+      return withErrorHandling(async () => {
+        log.info('Attempting silent login')
+        const success = await sessionManager.loginByComputerName()
+        const userInfo = sessionManager.getUserInfo()

-      if (success && userInfo) {
-        // Check if admin needs user selection
-        const requiresUserSelection = userInfo.userType === 'Admin'
+        if (success && userInfo) {
+          // Check if admin needs user selection
+          const requiresUserSelection = userInfo.userType === 'Admin'

-        log.info('Silent login successful', {
-          username: userInfo.username,
-          userType: userInfo.userType,
-          requiresUserSelection
-        })
+          log.info('Silent login successful', {
+            username: userInfo.username,
+            userType: userInfo.userType,
+            requiresUserSelection
+          })

-        return {
-          success: true,
-          userInfo,
-          requiresUserSelection
+          // Audit log: LOGIN success (non-blocking)
+          const os = await import('os')
+          logAudit('LOGIN', String(userInfo.id), {
+            username: userInfo.username,
+            computerName: os.hostname(),
+            resource: 'ERP_SYSTEM',
+            status: 'success',
+            metadata: { loginType: 'silent', userType: userInfo.userType }
+          }).catch((err) => log.warn('Failed to write audit log', { err }))
+
+          return {
+            success: true,
+            userInfo,
+            requiresUserSelection
+          }
        }
-      }

-      throw new ValidationError('无感登录失败：未找到匹配用户', 'VAL_INVALID_INPUT')
-    }, 'auth:silentLogin')
-  })
+        throw new ValidationError('无感登录失败：未找到匹配用户', 'VAL_INVALID_INPUT')
+      }, 'auth:silentLogin')
+    }
+  )

  /**
   * Login with username and password
@@ -117,27 +131,48 @@ export function registerAuthHandlers(): void {
    IPC_CHANNELS.AUTH_LOGIN,
    async (_event, request: LoginRequest): Promise<IpcResult<LoginResponse>> => {
      return withErrorHandling(async () => {
-      const { username, password } = request
+        const { username, password } = request

-      if (!username || !password) {
-        log.warn('Login attempt with missing credentials')
-        throw new ValidationError('请输入用户名和密码', 'VAL_MISSING_REQUIRED')
-      }
-
-      log.info('Login attempt', { username })
-      const success = await sessionManager.login(username, password)
-      const userInfo = sessionManager.getUserInfo()
-
-      if (success && userInfo) {
-        log.info('Login successful', { username, userType: userInfo.userType })
-        return {
-          success: true,
-          userInfo
+        if (!username || !password) {
+          log.warn('Login attempt with missing credentials')
+          throw new ValidationError('请输入用户名和密码', 'VAL_MISSING_REQUIRED')
        }
-      }

-      log.warn('Login failed - invalid credentials', { username })
-      throw new ValidationError('用户名或密码错误', 'VAL_INVALID_INPUT')
+        log.info('Login attempt', { username })
+        const success = await sessionManager.login(username, password)
+        const userInfo = sessionManager.getUserInfo()
+
+        if (success && userInfo) {
+          log.info('Login successful', { username, userType: userInfo.userType })
+
+          // Audit log: LOGIN success (non-blocking)
+          const os = await import('os')
+          logAudit('LOGIN', String(userInfo.id), {
+            username: userInfo.username,
+            computerName: os.hostname(),
+            resource: 'ERP_SYSTEM',
+            status: 'success',
+            metadata: { loginType: 'credentials', userType: userInfo.userType }
+          }).catch((err) => log.warn('Failed to write audit log', { err }))
+
+          return {
+            success: true,
+            userInfo
+          }
+        }
+
+        // Audit log: LOGIN failure (non-blocking)
+        const os = await import('os')
+        logAudit('LOGIN', '0', {
+          username,
+          computerName: os.hostname(),
+          resource: 'ERP_SYSTEM',
+          status: 'failure',
+          metadata: { loginType: 'credentials', reason: 'invalid_credentials' }
+        }).catch((err) => log.warn('Failed to write audit log', { err }))
+
+        log.warn('Login failed - invalid credentials', { username })
+        throw new ValidationError('用户名或密码错误', 'VAL_INVALID_INPUT')
      }, 'auth:login')
    }
  )
@@ -149,6 +184,19 @@ export function registerAuthHandlers(): void {
    return withErrorHandling(async () => {
      const userInfo = sessionManager.getUserInfo()
      log.info('User logout', { username: userInfo?.username })
+
+      // Audit log: LOGOUT (non-blocking)
+      if (userInfo) {
+        const os = await import('os')
+        logAudit('LOGOUT', String(userInfo.id), {
+          username: userInfo.username,
+          computerName: os.hostname(),
+          resource: 'ERP_SYSTEM',
+          status: 'success',
+          metadata: { userType: userInfo.userType }
+        }).catch((err) => log.warn('Failed to write audit log', { err }))
+      }
+
      sessionManager.logout()
    }, 'auth:logout')
  })
@@ -156,16 +204,19 @@ export function registerAuthHandlers(): void {
  /**
   * Get current user
   */
-  ipcMain.handle(IPC_CHANNELS.AUTH_GET_CURRENT_USER, async (): Promise<IpcResult<CurrentUserResponse>> => {
-    return withErrorHandling(async () => {
-      const isAuthenticated = sessionManager.isAuthenticated()
-      const userInfo = sessionManager.getUserInfo()
-      return {
-        isAuthenticated,
-        userInfo: userInfo ?? undefined
-      }
-    }, 'auth:getCurrentUser')
-  })
+  ipcMain.handle(
+    IPC_CHANNELS.AUTH_GET_CURRENT_USER,
+    async (): Promise<IpcResult<CurrentUserResponse>> => {
+      return withErrorHandling(async () => {
+        const isAuthenticated = sessionManager.isAuthenticated()
+        const userInfo = sessionManager.getUserInfo()
+        return {
+          isAuthenticated,
+          userInfo: userInfo ?? undefined
+        }
+      }, 'auth:getCurrentUser')
+    }
+  )

  /**
   * Get all users (for admin user selection)
@@ -209,4 +260,3 @@ export function registerAuthHandlers(): void {
    return withErrorHandling(async () => sessionManager.isAdmin(), 'auth:isAdmin')
  })
 }
-
--- a/src/main/ipc/cleaner-handler.ts
+++ b/src/main/ipc/cleaner-handler.ts
@@ -9,6 +9,7 @@ import { ResultExporter } from '../services/excel/result-exporter'
 import { CleanerReportGenerator } from '../services/report/cleaner-report-generator'
 import { SessionManager } from '../services/user/session-manager'
 import { createLogger } from '../services/logger'
+import { logAudit } from '../services/logger/audit-logger'
 import { withErrorHandling, type IpcResult } from './index'
 import { ErpConnectionError, ValidationError, DatabaseQueryError } from '../types/errors'
 import type {
@@ -230,6 +231,31 @@ export function registerCleanerHandlers(): void {
            errorCount: result.errors.length
          })

+          // Audit log: CLEAN (non-blocking)
+          const os = await import('os')
+          const currentUser = SessionManager.getInstance().getUserInfo()
+          if (currentUser) {
+            const status: 'success' | 'failure' | 'partial' =
+              result.errors.length > 0 && result.materialsDeleted > 0
+                ? 'partial'
+                : result.errors.length > 0
+                  ? 'failure'
+                  : 'success'
+            logAudit('CLEAN', String(currentUser.id), {
+              username: currentUser.username,
+              computerName: os.hostname(),
+              resource: 'MATERIAL_PLAN',
+              status,
+              metadata: {
+                orderCount: validOrderNumbers.length,
+                dryRun: input.dryRun ?? false,
+                materialsDeleted: result.materialsDeleted,
+                materialsSkipped: result.materialsSkipped,
+                errorCount: result.errors.length
+              }
+            }).catch((err) => log.warn('Failed to write audit log', { err }))
+          }
+
          // Generate report (silent, user unaware)
          try {
            const endTime = Date.now()
--- a/src/main/ipc/extractor-handler.ts
+++ b/src/main/ipc/extractor-handler.ts
@@ -4,6 +4,8 @@ import { ExtractorService } from '../services/erp/extractor'
 import { OrderNumberResolver } from '../services/erp/order-resolver'
 import { create, type IDatabaseService } from '../services/database'
 import { createLogger } from '../services/logger'
+import { logAudit } from '../services/logger/audit-logger'
+import { SessionManager } from '../services/user/session-manager'
 import { withErrorHandling, type IpcResult } from './index'
 import { ErpConnectionError, ValidationError, DatabaseQueryError } from '../types/errors'
 import type { ExtractorInput, ExtractorResult, ExtractionProgress } from '../types/extractor.types'
@@ -202,6 +204,29 @@ export function registerExtractorHandlers(): void {
            })
          }

+          // Audit log: EXTRACT (non-blocking)
+          const os = await import('os')
+          const currentUser = SessionManager.getInstance().getUserInfo()
+          if (currentUser) {
+            const status: 'success' | 'failure' | 'partial' =
+              result.errors.length > 0 && result.recordCount > 0
+                ? 'partial'
+                : result.errors.length > 0
+                  ? 'failure'
+                  : 'success'
+            logAudit('EXTRACT', String(currentUser.id), {
+              username: currentUser.username,
+              computerName: os.hostname(),
+              resource: 'MATERIAL_PLAN',
+              status,
+              metadata: {
+                orderCount: validOrderNumbers.length,
+                recordCount: result.recordCount,
+                errorCount: result.errors.length
+              }
+            }).catch((err) => log.warn('Failed to write audit log', { err }))
+          }
+
          return result
        } finally {
          // Clean up: close browser
--- a/src/main/ipc/index.ts
+++ b/src/main/ipc/index.ts
@@ -13,6 +13,7 @@ import { registerValidationHandlers } from './validation-handler'
 import { registerSettingsHandlers } from './settings-handler'
 import { registerMaterialTypeHandlers } from './material-type-handler'
 import { registerUserErpConfigHandlers } from './user-erp-config-handler'
+import { registerLoggerHandlers } from './logger-handler'
 import { createLogger } from '../services/logger'
 import { getErrorMessage, getErrorCode, isBaseError } from '../types/errors'

@@ -85,5 +86,6 @@ export function registerIpcHandlers(): void {
  registerSettingsHandlers()
  registerMaterialTypeHandlers()
  registerUserErpConfigHandlers()
+  registerLoggerHandlers()
  log.info('All IPC handlers registered')
 }
--- a/src/main/ipc/logger-handler.ts
+++ b/src/main/ipc/logger-handler.ts
@@ -0,0 +1,229 @@
+/**
+ * IPC Logger Handler with Batching
+ * Receives logs from renderer process and forwards to Winston
+ *
+ * Features:
+ * - 100ms debounce for batch processing
+ * - Maximum 50 messages per batch
+ * - Circuit breaker: discards new logs when buffer > 500
+ * - Error-level logs bypass circuit breaker
+ */
+
+import { ipcMain } from 'electron'
+import { createLogger } from '../services/logger'
+import { IPC_CHANNELS, type LogLevel } from '../../shared/ipc-channels'
+
+const log = createLogger('LoggerHandler')
+
+/**
+ * Log entry from renderer process
+ */
+interface LogEntry {
+  level: LogLevel
+  message: string
+  context?: Record<string, unknown>
+  timestamp: number
+}
+
+/**
+ * Batch processing configuration
+ */
+const BATCH_CONFIG = {
+  DEBOUNCE_MS: 100,
+  MAX_BATCH_SIZE: 50,
+  CIRCUIT_BREAKER_THRESHOLD: 500
+} as const
+
+/**
+ * Logger handler state
+ */
+class LoggerHandlerState {
+  private buffer: LogEntry[] = []
+  private debounceTimer: NodeJS.Timeout | null = null
+  private discardedCount = 0
+
+  /**
+   * Add log entry to buffer
+   * @param entry - Log entry to buffer
+   * @returns true if entry was buffered, false if discarded
+   */
+  addEntry(entry: LogEntry): boolean {
+    // Error-level logs always bypass circuit breaker
+    if (entry.level === 'error') {
+      this.buffer.push(entry)
+      this.flushIfNeeded()
+      return true
+    }
+
+    // Circuit breaker: discard non-error logs when buffer is too large
+    if (this.buffer.length >= BATCH_CONFIG.CIRCUIT_BREAKER_THRESHOLD) {
+      this.discardedCount++
+
+      // Log warning about discarded logs periodically (every 100 discarded)
+      if (this.discardedCount % 100 === 0) {
+        log.warn('Circuit breaker active: discarded logs', {
+          discardedCount: this.discardedCount,
+          bufferSize: this.buffer.length
+        })
+      }
+
+      return false
+    }
+
+    this.buffer.push(entry)
+    this.flushIfNeeded()
+    return true
+  }
+
+  /**
+   * Flush buffer if it reaches max batch size
+   */
+  private flushIfNeeded(): void {
+    if (this.buffer.length >= BATCH_CONFIG.MAX_BATCH_SIZE) {
+      this.flush()
+    } else if (!this.debounceTimer) {
+      // Start debounce timer if not already running
+      this.debounceTimer = setTimeout(() => {
+        this.flush()
+      }, BATCH_CONFIG.DEBOUNCE_MS)
+    }
+  }
+
+  /**
+   * Flush all buffered logs to Winston
+   */
+  flush(): void {
+    if (this.debounceTimer) {
+      clearTimeout(this.debounceTimer)
+      this.debounceTimer = null
+    }
+
+    if (this.buffer.length === 0) {
+      return
+    }
+
+    // Create a copy of the buffer and clear it
+    const batch = [...this.buffer]
+    this.buffer = []
+
+    // Process batch asynchronously (non-blocking)
+    setImmediate(() => {
+      this.processBatch(batch)
+    })
+  }
+
+  /**
+   * Process a batch of log entries
+   * @param batch - Array of log entries to process
+   */
+  private processBatch(batch: LogEntry[]): void {
+    try {
+      for (const entry of batch) {
+        this.forwardToWinston(entry)
+      }
+    } catch (error) {
+      // If batch processing fails, log the error but don't rethrow
+      // This ensures logging failures don't crash the app
+      log.error('Failed to process log batch', {
+        error: error instanceof Error ? error.message : String(error),
+        batchSize: batch.length
+      })
+    }
+  }
+
+  /**
+   * Forward a single log entry to Winston logger
+   * @param entry - Log entry to forward
+   */
+  private forwardToWinston(entry: LogEntry): void {
+    const context = (entry.context?.component as string) || 'renderer'
+    const childLogger = log.child({
+      source: 'renderer',
+      component: context
+    })
+
+    const message = entry.context?.message
+      ? `[${entry.context.message}] ${entry.message}`
+      : entry.message
+
+    switch (entry.level) {
+      case 'debug':
+        childLogger.debug(message, entry.context)
+        break
+      case 'warn':
+        childLogger.warn(message, entry.context)
+        break
+      case 'error':
+        childLogger.error(message, entry.context)
+        break
+      case 'info':
+      default:
+        childLogger.info(message, entry.context)
+        break
+    }
+  }
+
+  /**
+   * Get current buffer size (for testing/debugging)
+   */
+  getBufferSize(): number {
+    return this.buffer.length
+  }
+
+  /**
+   * Get discarded log count (for testing/debugging)
+   */
+  getDiscardedCount(): number {
+    return this.discardedCount
+  }
+
+  /**
+   * Reset state (for testing)
+   */
+  reset(): void {
+    if (this.debounceTimer) {
+      clearTimeout(this.debounceTimer)
+      this.debounceTimer = null
+    }
+    this.buffer = []
+    this.discardedCount = 0
+  }
+}
+
+// Singleton state instance
+const state = new LoggerHandlerState()
+
+/**
+ * Register IPC handlers for logger
+ */
+export function registerLoggerHandlers(): void {
+  // Use ipcMain.on with send() - fire-and-forget, non-blocking
+  ipcMain.on(IPC_CHANNELS.LOGGER_FORWARD, (_event, entry: LogEntry) => {
+    // Validate entry
+    if (!entry || typeof entry.level !== 'string' || typeof entry.message !== 'string') {
+      log.warn('Received invalid log entry', { entry })
+      return
+    }
+
+    // Add to buffer for batch processing
+    const buffered = state.addEntry(entry)
+
+    if (!buffered && process.env.NODE_ENV !== 'production') {
+      // In development, log when entries are discarded
+      log.debug('Log entry discarded due to circuit breaker', {
+        level: entry.level,
+        message: entry.message
+      })
+    }
+  })
+
+  log.info('Logger IPC handler registered', {
+    channel: IPC_CHANNELS.LOGGER_FORWARD,
+    debounceMs: BATCH_CONFIG.DEBOUNCE_MS,
+    maxBatchSize: BATCH_CONFIG.MAX_BATCH_SIZE,
+    circuitBreakerThreshold: BATCH_CONFIG.CIRCUIT_BREAKER_THRESHOLD
+  })
+}
+
+// Export for testing
+export { state }
--- a/src/main/ipc/settings-handler.ts
+++ b/src/main/ipc/settings-handler.ts
@@ -5,6 +5,7 @@ import { UserErpConfigService } from '../services/user/user-erp-config-service'
 import { MySqlService } from '../services/database/mysql'
 import { SqlServerService } from '../services/database/sql-server'
 import { createLogger } from '../services/logger'
+import { logAudit } from '../services/logger/audit-logger'
 import type { UserType, ConnectionTestResult, SaveSettingsResult } from '../types/settings.types'
 import { IPC_CHANNELS } from '../../shared/ipc-channels'
 import { ValidationError } from '../types/errors'
@@ -60,6 +61,16 @@ export function registerSettingsHandlers(): void {
            username: settings.erp.username || '',
            password: settings.erp.password || ''
          })
+
+          // Audit log: SETTINGS_CHANGE (non-blocking)
+          const os = await import('os')
+          logAudit('SETTINGS_CHANGE', String(currentUser.id), {
+            username: currentUser.username,
+            computerName: os.hostname(),
+            resource: 'ERP_CONFIG',
+            status: 'success',
+            metadata: { changeType: 'erp_credentials', usernameChanged: !!settings.erp.username }
+          }).catch((err) => log.warn('Failed to write audit log', { err }))
        }

        return { success: true }
@@ -164,4 +175,3 @@ export function registerSettingsHandlers(): void {
    }
  )
 }
-