feat: 使用 pm2 管理进程

Author: wll8

doc/dev/realize.md

@@ -76,7 +76,7 @@ mockm 是一个基于 Node.js 和 Express 的 API 模拟和调试工具，集成
 
 ### 进程管理架构
 
-mockm 采用多进程架构，通过 `@wll8/process-manager` 管理进程生命周期：
+mockm 采用多进程架构，通过 `pm2` 管理进程生命周期：
 
 1. **主进程 (run.js)**: 负责配置解析、进程管理、文件监听
 2. **服务进程 (server.js)**: 负责启动各种服务器和业务逻辑

server/package.json

@@ -17,7 +17,6 @@
     "@wll8/better-mock": "^0.3.3-alpha",
     "@wll8/express-ws": "^1.0.6",
     "@wll8/json-server": "^0.17.5-alpha.1",
-    "@wll8/process-manager": "^1.0.4",
     "address": "^1.2.2",
     "axios": "^0.30.0",
     "body-parser": "^1.20.3",
@@ -36,6 +35,7 @@
     "morgan": "^1.10.0",
     "node-http-proxy-json": "^0.1.9",
     "path-to-regexp": "0.1.12",
+    "pm2": "^6.0.8",
     "postinstall-postinstall": "^2.1.0",
     "vm2": "^3.9.19",
     "whatnpm": "^1.0.0"

server/pnpm-lock.yaml

@@ -13,13 +13,27 @@ process.argv.includes(`--log-line`) && logHelper()
 
 const fs = require(`fs`)
 const path = require(`path`)
+const util = require('util')
 const { tool, business } = require(`${__dirname}/util/index.js`)
 const lib = require(`${__dirname}/util/lib.js`)
 const packageJson = require(`${__dirname}/package.json`)
 const cli = tool.cli
 const cliArg = cli.parseArgv()
 const serverPath = path.normalize(`${__dirname}/server.js`) // 转换为跨平台的路径
-const { ProcessManager } = require(`@wll8/process-manager`)
+const pm2 = require('pm2')
+
+// 使用 util.promisify 封装 PM2 的回调方法
+const pm2Async = {
+  connect: util.promisify(pm2.connect.bind(pm2)),
+  start: util.promisify(pm2.start.bind(pm2)),
+  restart: util.promisify(pm2.restart.bind(pm2)),
+  stop: util.promisify(pm2.stop.bind(pm2)),
+  delete: util.promisify(pm2.delete.bind(pm2)),
+  list: util.promisify(pm2.list.bind(pm2)),
+  sendDataToProcessId: util.promisify(pm2.sendDataToProcessId.bind(pm2)),
+  launchBus: util.promisify(pm2.launchBus.bind(pm2)),
+  disconnect: () => pm2.disconnect() // 这个方法不需要 promisify
+}
 
 { // 尽早的, 无依赖的修改 cwd, 避免其他读取到旧值
   const cwd = tool.cli.handlePathArg(
@@ -90,42 +104,109 @@ new Promise( async () => { // 检查更新
 
 new Promise(async () => { // 启动 server.js
   let log = ``
+  let isShuttingDown = false
   const nodeArg = typeof(cliArg[`--node-options`]) === `string` ? cliArg[`--node-options`] : ``
-  const arr = [nodeArg, serverPath, ...process.argv.slice(2), `_base64=${base64config}`, `_share=${sharePath}`].filter(item => item.trim() !== ``)
-  const cp = new ProcessManager(arr)
-  cp.on(`stdout`, (data) => {
-    log = String(data)
-  })
-  cp.on(`stderr`, (data) => {
-    log = String(data)
-  })
-  cp.on(`message`, ({action, data} = {}) => {
-    if(action === `reboot`) {
-      cp.reboot(0)
-    }
-    if(action === `config`) {
-      cp.autoReStart = data.guard
-    }
-  })
-  cp.on(`close`, () => {
-    if(log.match(/killProcess:/)) { // 保存错误日志
-      saveLog({
-        code: ``,
-        logStr: log,
-        logPath: shareConfig._errLog,
-      })
-    }
-  })
+  const processName = `mockm-${process.pid}`
+  
+  // PM2 进程配置
+  const pm2Config = {
+    name: processName,
+    script: serverPath,
+    args: [...process.argv.slice(2), `_base64=${base64config}`, `_share=${sharePath}`],
+    nodeArgs: nodeArg ? nodeArg.split(' ').filter(arg => arg.trim()) : [],
+    cwd: process.cwd(),
+    autorestart: false, // 手动控制重启
+    watch: false, // 关闭 PM2 自带的文件监听，使用自定义监听
+    max_memory_restart: '500M',
+    merge_logs: true,
+    kill_timeout: 5000,
+    namespace: process.env.PM2_NAMESPACE,
+    // 不指定日志文件，让 PM2 使用默认位置，然后我们通过流来转发
+    silent: false
+  }
 
+  // 监听进程消息和日志
+  async function listenToProcessMessages() {
+    const pm2_bus = await pm2Async.launchBus()
+    
+    // 监听日志输出
+    pm2_bus.on('log:out', (packet) => {
+      if (packet.process.name === processName) {
+        process.stdout.write(packet.data)
+        log = String(packet.data)
+      }
+    })
+
+    pm2_bus.on('log:err', (packet) => {
+      if (packet.process.name === processName) {
+        process.stderr.write(packet.data)
+        log = String(packet.data)
+      }
+    })
+
+    pm2_bus.on('process:msg', (packet) => {
+      if (packet.process.name === processName) {
+        const { action, data = {} } = packet.data || {}
+        if (action === 'err-exit') {
+          if(pm2Config.autorestart) {
+            console.log(`[${processName}] Auto restarting process...`)
+          } else {
+            killProcess()
+          }
+        }
+        if (action === 'reboot') {
+          pm2Async.restart(processName)
+        }
+        
+        if (action === 'config') {
+          pm2Config.autorestart = data.guard
+        }
+      }
+    })
+  }
+
+  // 优雅关闭函数
   function killProcess() {
-    cp.kill()
-    process.exit()
+    isShuttingDown = true
+    console.log(`[${processName}] Shutting down...`)
+    pm2Async.delete(processName)
+      .then(() => {
+        pm2Async.disconnect()
+        process.exit(0)
+      })
+      .catch(err => {
+        console.error('Error during shutdown:', err)
+        pm2Async.disconnect()
+        process.exit(1)
+      })
   }
+
+  // 绑定进程信号
   process.on(`SIGTERM`, killProcess)
   process.on(`SIGINT`, killProcess)
   process.on(`uncaughtException`, killProcess)
   process.on(`unhandledRejection`, killProcess)
 
+  try {
+
+    // 启动 PM2 管理的进程
+    await pm2Async.connect()
+    
+    // 先清理可能存在的同名进程
+    await pm2Async.delete(processName).catch(() => {}) // 忽略错误，因为进程可能不存在
+    
+    // 启动新进程
+    await pm2Async.start(pm2Config)
+    
+    // 监听进程消息
+    listenToProcessMessages()
+    
+  } catch (err) {
+    console.error('Failed to start process:', err)
+    pm2Async.disconnect()
+    process.exit(1)
+  }
+
   const {
     showLocalInfo,
     remoteServer,

server/run.js

@@ -9,8 +9,14 @@ const util = require(`./util/index.js`)
 
 new Promise(async () => {
   global.config = await require(`./config.js`)
-  process.send({action: `config`, data: global.config})
-  util.tool.file.fileChange([global.config._configFile, ...global.config.watch], (files) => process.send({action: `reboot`, data: files}))
+  process.send({
+    type: 'process:msg',
+    data: { action: 'config', data: global.config }
+  })
+  util.tool.file.fileChange([global.config._configFile, ...global.config.watch], (files) => process.send({
+    type: 'process:msg',
+    data: { action: 'reboot', data: files }
+  }))
   const {
     tool,
     business,

server/server.js

@@ -1176,8 +1176,15 @@ function tool() { // 与业务没有相关性, 可以脱离业务使用的工具
      */
     function clearProcess({hostname} = {}) {
       function killProcess(...arg) {
-        arg[0] !== `SIGINT` && console.log(`killProcess:`, ...arg) // ctrl+c 不需要显示 err
-        hostname ? sysHost(`remove`, {hostname}).finally(process.exit) : process.exit()
+        if(arg[0] !== `SIGINT`) {
+          process.send({
+            type: 'process:msg',
+            data: { action: 'err-exit', data: [] }
+          })
+        } else {
+          process.exit()
+        }
+        hostname ? sysHost(`remove`, {hostname}).finally(() => {}) : () => {}
       }
       process.on(`SIGTERM`, killProcess)
       process.on(`SIGINT`, killProcess)

server/util/tool.js

@@ -24,5 +24,8 @@
     "mochawesome": "^7.1.3",
     "shelljs": "^0.8.4",
     "ws": "^7.5.3"
+  },
+  "dependencies": {
+    "pm2": "^6.0.8"
   }
 }

test/package.json

@@ -383,24 +383,39 @@ function testCliText({cmd = str, timeout = 30 * 1e3, fn = (str) => str, } = {})
   return new Promise((resolve, reject) => {
     const { spawn } = require('child_process');
     const [bin, ...arg] = cmd.split(/\s+/)
-    const cmdRef = spawn(bin, arg);
+    const cmdRef = spawn(bin, arg, {
+      env: {
+        ...process.env,
+        PM2_NAMESPACE: `MOCKM_TEST`,
+      }
+    });
+    const pm2Kill = async () => {
+      // hack: 由于 kill() 没办法停止 pm2 进程, 所以使用 pm2 进行删除
+      return new Promise(async (ok) => {
+        cmdRef.kill()
+        require(`child_process`).exec(`npx pm2 del mockm-${cmdRef.pid}`, {
+          cwd: `${__dirname}/../server/`,
+          stdio: `inherit`,
+        }, ok)
+      })
+    }
     cmdRef.stdout.on('data', async (data) => {
       const str = String(data)
       if(await fn(str)) {
+        await pm2Kill()
         resolve(str)
-        cmdRef.kill()
       }
     });
     cmdRef.stderr.on('data', async (data) => {
       const str = String(data)
       if(await fn(str)) {
+        await pm2Kill()
         resolve(str)
-        cmdRef.kill()
       }
     });
-    setTimeout(() => {
+    setTimeout(async () => {
+      await pm2Kill()
       reject(false)
-      cmdRef.kill()
     }, timeout);
   })
 }
@@ -441,7 +456,12 @@ function allTestBefore() {
   console.log('备份用户配置')
 }
 
-function allTestAfter() {
+async function allTestAfter() {
+  require(`child_process`).exec(`npx pm2 del MOCKM_TEST`, {
+    cwd: `${__dirname}/../server/`,
+    stdio: `inherit`,
+  }, () => {})
+  await sleep(5000)
   console.log('恢复用户配置')
 }