feat: npm stop by win32 support

lib/cmd/stop.js

@@ -24,23 +24,30 @@ class StopCommand extends Command {
 
   * run(context) {
     /* istanbul ignore next */
-    if (process.platform === 'win32') {
-      this.logger.warn('Windows is not supported, try to kill master process which command contains `start-cluster` or `--type=egg-server` yourself, good luck.');
-      process.exit(0);
-    }
+    // if (process.platform === 'win32') {
+    //   this.logger.warn('Windows is not supported, try to kill master process which command contains `start-cluster` or `--type=egg-server` yourself, good luck.');
+    //   process.exit(0);
+    // }
 
     const { argv } = context;
 
     this.logger.info(`stopping egg application ${argv.title ? `with --title=${argv.title}` : ''}`);
 
-    // node /Users/tz/Workspaces/eggjs/egg-scripts/lib/start-cluster {"title":"egg-server","workers":4,"port":7001,"baseDir":"/Users/tz/Workspaces/eggjs/test/showcase","framework":"/Users/tz/Workspaces/eggjs/test/showcase/node_modules/egg"}
-    let processList = yield this.helper.findNodeProcess(item => {
-      const cmd = item.cmd;
-      return argv.title ?
-        cmd.includes('start-cluster') && cmd.includes(`"title":"${argv.title}"`) :
-        cmd.includes('start-cluster');
-    });
-    let pids = processList.map(x => x.pid);
+    let pids = [];
+
+    if (process.platform !== 'win32') {
+      // node /Users/tz/Workspaces/eggjs/egg-scripts/lib/start-cluster {"title":"egg-server","workers":4,"port":7001,"baseDir":"/Users/tz/Workspaces/eggjs/test/showcase","framework":"/Users/tz/Workspaces/eggjs/test/showcase/node_modules/egg"}
+      const processList = yield this.helper.findNodeProcess(item => {
+        const cmd = item.cmd;
+        return argv.title ?
+          cmd.includes('start-cluster') && cmd.includes(`"title":"${argv.title}"`) :
+          cmd.includes('start-cluster');
+      });
+
+      pids = processList.map(x => x.pid);
+    } else {
+      pids = yield this.helper.findfindNodeProcessWin(argv);
+    }
 
     if (pids.length) {
       this.logger.info('got master pid %j', pids);
@@ -49,18 +56,23 @@ class StopCommand extends Command {
       this.logger.warn('can\'t detect any running egg process');
     }
 
-    // wait for 5s to confirm whether any worker process did not kill by master
+    // wait for 5s to confirm whether every worker process killed by master or not
     yield sleep('5s');
 
     // node --debug-port=5856 /Users/tz/Workspaces/eggjs/test/showcase/node_modules/[email protected]@egg-cluster/lib/agent_worker.js {"framework":"/Users/tz/Workspaces/eggjs/test/showcase/node_modules/egg","baseDir":"/Users/tz/Workspaces/eggjs/test/showcase","port":7001,"workers":2,"plugins":null,"https":false,"key":"","cert":"","title":"egg-server","clusterPort":52406}
     // node /Users/tz/Workspaces/eggjs/test/showcase/node_modules/[email protected]@egg-cluster/lib/app_worker.js {"framework":"/Users/tz/Workspaces/eggjs/test/showcase/node_modules/egg","baseDir":"/Users/tz/Workspaces/eggjs/test/showcase","port":7001,"workers":2,"plugins":null,"https":false,"key":"","cert":"","title":"egg-server","clusterPort":52406}
-    processList = yield this.helper.findNodeProcess(item => {
-      const cmd = item.cmd;
-      return argv.title ?
-        (cmd.includes('egg-cluster/lib/app_worker.js') || cmd.includes('egg-cluster/lib/agent_worker.js')) && cmd.includes(`"title":"${argv.title}"`) :
-        (cmd.includes('egg-cluster/lib/app_worker.js') || cmd.includes('egg-cluster/lib/agent_worker.js'));
-    });
-    pids = processList.map(x => x.pid);
+
+    if (process.platform !== 'win32') {
+      const processList = yield this.helper.findNodeProcess(item => {
+        const cmd = item.cmd;
+        return argv.title ?
+          (cmd.includes('egg-cluster/lib/app_worker.js') || cmd.includes('egg-cluster/lib/agent_worker.js')) && cmd.includes(`"title":"${argv.title}"`) :
+          (cmd.includes('egg-cluster/lib/app_worker.js') || cmd.includes('egg-cluster/lib/agent_worker.js'));
+      });
+      pids = processList.map(x => x.pid);
+    } else {
+      pids = yield this.helper.findfindNodeProcessWin(argv);
+    }
 
     if (pids.length) {
       this.logger.info('got worker/agent pids %j that is not killed by master', pids);

lib/helper.js

@@ -2,6 +2,7 @@
 
 const runScript = require('runscript');
 const REGEX = /^\s*(\d+)\s+(.*)/;
+const regexDim = /\\+/g;
 
 exports.findNodeProcess = function* (filterFn) {
   const command = 'ps -eo "pid,command"';
@@ -34,3 +35,285 @@ exports.kill = function(pids, signal) {
     }
   });
 };
+
+
+/* ------- below for win32 ------ */
+
+/**
+ * retrieve master pid by worker's pid via ppid for win32
+ * Minimum supported client: Vista
+ * Minimum supported server: Server 2008
+ *
+ * @param {object} argv - context
+ * @return {number[]} - array pids of master and app/agent worker
+ */
+exports.findfindNodeProcessWin = function* (argv) {
+  const port = argv.port || (process.env && process.env.PORT);
+  const keyStr = argv.title ? argv.title : argv.baseDir;
+  let masterPids = [];
+  let workerPids = [];
+
+  if (keyStr) { // title match first
+    const mPidSet = new Set(); // master pid
+    workerPids = yield findWorkerPidsWin(keyStr); // order or pid random
+
+    for (const workerPid of workerPids) {
+      const ppid = yield findMasterPidByWorker(workerPid);
+      ppid > 0 && mPidSet.add(ppid);
+    }
+    if (mPidSet.size > 1) {
+      throw new Error('number of master pid should be One via title, but got:' + mPidSet.size);
+    }
+    masterPids = Array.from(mPidSet);
+  } else if (port) {
+    masterPids = yield findMasterPidsByPort(port);
+    if (masterPids.length > 1) {
+      throw new Error('number of master pid should be One via port, but got:' + masterPids.length);
+    }
+    workerPids = yield findWorkerPidsByMaster(masterPids[0]); // [agentPid, ...workerPids]
+  }
+
+  return masterPids.concat(workerPids); // master first
+};
+
+function parseKeyStr(str) {
+  const ret = str && typeof str === 'string' ? str : '';
+  return ret.replace(regexDim, '/');
+}
+
+/**
+ * retrieve master pid by worker's pid via ppid for win32
+ * Minimum supported client: Vista
+ * Minimum supported server: Server 2008
+ *
+ * @param {number} pid - process id
+ * @return {number} - pid of master
+ */
+function* findMasterPidByWorker(pid) {
+  const where = `process where processid="${pid}"`;
+  const str = yield retrieveProcessInfo(pid, where);
+  const info = parseProcessInfo(str);
+  const row = info && info.length === 1 && info[0];
+
+  return row && row.pid && row.ppid && row.pid === pid
+    ? row.ppid
+    : 0;
+}
+
+/**
+ * retrieve master pid by worker's pid via ppid for win32
+ * Minimum supported client: Vista
+ * Minimum supported server: Server 2008
+ *
+ * @param {number} pid - master process id
+ * @return {number[]} - array pids of app/agent work, order: [agentPid, ...appPids]
+ */
+function* findWorkerPidsByMaster(pid) {
+  const where = `process where ParentProcessId="${pid}"`;
+  const str = yield retrieveProcessInfo(pid, where);
+  const info = parseProcessInfo(str);
+  const ret = [];
+
+  for (const row of info) {
+    if (row && row.ppid && row.ppid === pid) {
+      if (row.cmd.includes('agent_worker')) { // agent at first
+        ret.unshift(row.pid);
+      } else {
+        ret.push(row.pid);
+      }
+    }
+  }
+
+  return ret;
+}
+
+/**
+ * find master pids by listining port
+ * @param {number} port - port number of master listening
+ * @return {number[]} - array of pid
+ */
+function* findMasterPidsByPort(port) {
+  port = +port;
+  if (!Number.isSafeInteger(port)) {
+    return [];
+  }
+  const command = `netstat -aon|findstr ":${port}"`;
+  let stdio;
+
+  try {
+    stdio = yield runScript(command, { stdio: 'pipe' });
+  } catch (ex) {
+    return [];
+  }
+  const list = new Set();
+  const arr = stdio.stdout && stdio.stdout.toString().split('\n') || [];
+
+  arr.length && arr.forEach(line => {
+    if (line) {
+      //  [ '', 'TCP', '0.0.0.0:7001', '0.0.0.0:0', 'LISTENING', '4580', '' ]
+      //  [ '', 'TCP', '[::]:7001', '0.0.0.0:0', 'LISTENING', '4580', '' ]
+      const lineArr = line.split(/\s+/);
+
+      if (!lineArr[0] && lineArr[1] === 'TCP' && lineArr[2] && lineArr[5]) {
+        const pid = +lineArr[5];
+        const ipArr = lineArr[2].split(':');
+
+        if (!Number.isSafeInteger(pid) && list.has(pid)) {
+          return;
+        }
+
+        if (ipArr && ipArr.length >= 2) {
+          if (+ipArr[ipArr.length - 1] === port) { // ipv4/v6
+            list.add(pid);
+          }
+        }
+      }
+    }
+  });
+
+  return [ ...list ];
+}
+
+function* findWorkerPidsWin(str) {
+  const keyStr = parseKeyStr(str);
+  const command = `tasklist /NH /FI "WINDOWTITLE eq ${keyStr}"`;
+
+  if (!keyStr) {
+    return [];
+  }
+
+  let stdio;
+  try {
+    stdio = yield runScript(command, { stdio: 'pipe' });
+  } catch (ex) {
+    return [];
+  }
+  const list = new Set();
+  const arr = stdio.stdout && stdio.stdout.toString().split('\n') || [];
+
+  arr.length && arr.forEach(line => {
+    if (line && line.includes('node.exe')) {
+      // image name   PID  session name  session#   memory
+      // node.exe     1704 Console       1          31,540 K
+      // node.exe     6096 Console       1          33,380 K
+      const [ , id ] = line.split(/\s+/);
+      const pid = parseInt(id, 10);
+
+      if (typeof pid === 'number' && Number.isSafeInteger(pid)) {
+        if (list.has(pid)) {
+          return;
+        }
+        list.add(pid);
+      }
+    }
+  });
+
+  return [ ...list ];
+}
+
+/**
+ * retrieve process info by pid via wmic
+ * Minimum supported client: Vista
+ * Minimum supported server: Server 2008
+ *
+ * @param {number} processId - process id
+ * @param {string} where - wmic query string
+ * @return {Promise<string>} - raw data
+ */
+function* retrieveProcessInfo(processId, where) {
+  // invalid result of runScript(), so run by spawn
+  const spawn = require('child_process').spawn;
+
+  return new Promise((resolve, reject) => {
+    const pid = +processId;
+
+    if (Number.isNaN(pid) || !Number.isSafeInteger(pid)) {
+      return resolve('');
+    }
+    const wmic = spawn('wmic', []);
+    const stdout = [];
+
+    wmic.stdout.on('data', buf => {
+      stdout.push(buf.toString('utf8'));
+    });
+    wmic.stdout.on('error', err => {
+      reject(err);
+    });
+    wmic.on('close', () => {
+      resolve(stdout.join(''));
+    });
+
+    wmic.stdin.end(where + ' get CommandLine, Name, ParentProcessId, ProcessId');
+  });
+}
+
+/**
+ * parse process info for win32
+ *
+ * @param {string} data - data from retrieveProcessInfo()
+ * @return {processInfo[]} - <code>
+ * interface ProcessInfo {
+ *   shell: string  // 'D:/.../node.exe'
+ *   cmd: string    // 'E:/.../node_modules/egg-cluster/lib/(agent_worker|app_worker).js'
+ *   options: ClusterOptions
+ *   ppid: number
+ *   pid: number
+ * }
+ * interface ClusterOptions {
+ *   framework: string  // delimite '\' be replaced to '/' -> 'E:/.../app/node_modules/yadan-ts'
+ *   baseDir: string    // delimite '\' be replaced to '/' -> 'E:/.../app'
+ *   plugins: object | null
+ *   workers: number
+ *   port: number
+ *   https: boolean
+ *   key: string
+ *   cert: string
+ *   typescript: boolean
+ *   title?: string
+ *   [prop: string]: any
+ * }
+ * </code>
+ */
+function parseProcessInfo(data) {
+  const ret = [];
+
+  data && typeof data === 'string' && data.split('\n').forEach(line => {
+    if (!line) {
+      return;
+    }
+    // sh, cmd, optstr, imageName, ppid, pid
+    const arr = line.trim().split(/\s+/);
+
+    if (!arr[3] || !arr[3].includes('node')) { // node.exe
+      return;
+    }
+    let [ sh, cmd, optstr, , ppid, pid ] = arr;
+
+    if (typeof +ppid === 'number' && typeof +pid === 'number') {
+      optstr = optstr.trim().slice(1, -1).replace(/\\"/g, '"');
+
+      try {
+        const options = JSON.parse(optstr);
+
+        if (options.framework) {
+          options.framework = options.framework.trim().replace(regexDim, '/');
+        }
+        if (options.baseDir) {
+          options.baseDir = options.baseDir.trim().replace(regexDim, '/');
+        }
+
+        ret.push({
+          shell: sh && sh.trim().replace(regexDim, '/') || '',
+          cmd: cmd && cmd.trim().replace(regexDim, '/') || '',
+          options,
+          ppid: +ppid,
+          pid: +pid,
+        });
+      } catch (ex) {
+        return;
+      }
+    }
+  });
+
+  return ret;
+}