mock-service-cli 3.3.2 → 3.3.3

package/README.md

@@ -24,6 +24,8 @@
 
 #### Mock Server - 本地 Mock 服务器
 
+**支持热更新，即 Mock 文件改动后自动重启服务**
+
 > Mock File 仅支持 commonjs 规范的 js、cjs 文件，不支持 ES Module
 
 支持以下常见业务场景：

package/bin/mock-service-cli

@@ -9,6 +9,7 @@ const argv = require('minimist')(process.argv.slice(2));
 const { logger } = require('../lib/utils');
 const spawn = require('child_process').spawn;
 const node = process.execPath;
+
 process.title = 'mock-service-cli';
 
 if (argv.h || argv.help) {
@@ -113,6 +114,7 @@ if (proxyArg) {
   }
   process.env.PROXY_OPTIONS = JSON.stringify(proxyTable);
 }
+// whether to start Web server or not
 if (argv.D || argv['web-dir']) {
   // 解析SPA应用参数：SPA Web目录
   process.env.WEB_ROOT = resolve(process.cwd(), argv.D || argv['web-dir']);
@@ -122,24 +124,38 @@ if (argv.D || argv['web-dir']) {
   }
   // Web Server port
   portfinder.basePort = argv.P || argv['web-port'] || 9090;
+  portfinder.getPort(function (err, webPort) {
+    if (err) {
+      throw err;
+    }
+    process.env.WEB_PORT = webPort;
+    // Mock Server port
+    portfinder.basePort = port || 8090;
+    portfinder.getPort(function (err, port) {
+      if (err) {
+        throw err;
+      }
+      process.env.PORT = port;
+      initServe();
+    });
+  });
+} else {
+  // Mock Server port
+  portfinder.basePort = port || 8090;
   portfinder.getPort(function (err, port) {
     if (err) {
       throw err;
     }
-    process.env.WEB_PORT = port;
+    process.env.PORT = port;
+    initServe();
   });
 }
 
-// Mock Server port
-portfinder.basePort = port || 8090;
-portfinder.getPort(function (err, port) {
-  if (err) {
-    throw err;
-  }
-  process.env.PORT = port;
-});
-
-const watchMockFiles = function (watchDir) {
+/**
+ * Watch change of mock files, restart serve
+ * @param watchDir
+ */
+function watchMockFiles(watchDir) {
   /**
    * script 重启的脚本
    * ext 检测的文件
@@ -164,50 +180,62 @@ const watchMockFiles = function (watchDir) {
         [colors.green('\nnodemon: mockServer restarted due to: '), files, colors.green(' have changed'), '\n'].join('')
       );
     });
-};
+}
 
 // Node子进程启动MockServer
-const startMockServer = function () {
+function startMockServer() {
   spawn(node, [resolve(__dirname, '../lib/mockServer.js')], {
     stdio: 'inherit'
   });
-};
+}
 
 // Node子进程启动StaticServer
-const startStaticServer = function () {
+function startStaticServer() {
   spawn(node, [resolve(__dirname, '../lib/staticServer.js')], {
     stdio: 'inherit'
   });
-};
-
-if (specifiedFile) {
-  // Mock服务器：指定文件
-  process.env.SPECIFIED_FILE = resolve(process.cwd(), specifiedFile);
-  if (isStartSocketServer) {
-    startMockServer();
-  } else {
-    watchMockFiles(process.env.SPECIFIED_FILE);
-  }
-} else if (watchDir) {
-  // Mock服务器：指定目录
-  process.env.SPECIFIED_DIR = resolve(process.cwd(), watchDir);
-  // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
-  if (isStartSocketServer) {
-    startMockServer();
-  } else {
-    watchMockFiles(process.env.SPECIFIED_DIR);
-  }
-} else if (process.env.STATIC_DIRECTORY) {
-  // 静态服务器
-  process.env.STATIC_DIRECTORY = resolve(process.cwd(), process.env.STATIC_DIRECTORY);
-  startStaticServer();
-} else {
-  // Mock服务：使用默认目录
-  watchDir = process.env.SPECIFIED_DIR = resolve(process.cwd(), './mock');
-  // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
-  if (isStartSocketServer) {
-    startMockServer();
+}
+/**
+ * 初始化服务
+ */
+function initServe() {
+  if (specifiedFile) {
+    // Mock服务器：指定文件
+    process.env.SPECIFIED_FILE = resolve(process.cwd(), specifiedFile);
+    if (isStartSocketServer) {
+      startMockServer();
+    } else {
+      watchMockFiles(process.env.SPECIFIED_FILE);
+    }
+  } else if (watchDir) {
+    // Mock服务器：指定目录
+    process.env.SPECIFIED_DIR = resolve(process.cwd(), watchDir);
+    // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
+    if (isStartSocketServer) {
+      startMockServer();
+    } else {
+      watchMockFiles(process.env.SPECIFIED_DIR);
+    }
+  } else if (process.env.STATIC_DIRECTORY) {
+    // 静态服务器
+    process.env.STATIC_DIRECTORY = resolve(process.cwd(), process.env.STATIC_DIRECTORY);
+    startStaticServer();
   } else {
-    watchMockFiles(watchDir);
+    // Mock服务：使用默认目录
+    watchDir = process.env.SPECIFIED_DIR = resolve(process.cwd(), './mock');
+    // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
+    if (isStartSocketServer) {
+      startMockServer();
+    } else {
+      // whether include web serve or not
+      const includesWebServe = process.env.STATIC_DIRECTORY || process.env.WEB_ROOT;
+
+      if (includesWebServe && !existsSync(resolve(process.cwd(), watchDir))) {
+        // 若包含web服务，则允许不启动mock服务
+        startMockServer();
+      } else {
+        watchMockFiles(watchDir);
+      }
+    }
   }
 }

package/lib/mockServer.js

@@ -1,6 +1,6 @@
 const express = require('express'), // 引入express
   bodyParser = require('body-parser'),
-  fs = require('fs'),
+  { readdirSync, existsSync } = require('fs'),
   os = require('os'),
   path = require('path'),
   colors = require('colors/safe'),
@@ -25,8 +25,6 @@ const app = express();
 const log = logger(process.env.SILENT);
 const argv = JSON.parse(process.env.ARGV);
 let socketServer = null; // Socket server instance
-const AsyncTaskQueue = require('./asyncTaskQueue');
-const saveDataAsyncTask = new AsyncTaskQueue();
 let corsOrigin = [],
   corsHeaders = '';
 
@@ -35,6 +33,12 @@ let count = 0,
   fileCount = 0, // 记录mock api个数,mock file个数
   mockDirStat = {}, // 缓存mock目录的统计信息
   mockFileStat = {}; // 缓存mock文件的统计信息
+
+// whether include web serve or not
+const includesWebServe = process.env.STATIC_DIRECTORY || process.env.WEB_ROOT;
+
+const mockFileOrDir = process.env.SPECIFIED_FILE || process.env.SPECIFIED_DIR;
+
 if (!process.env.PORT) {
   portfinder.basePort = 8090;
   portfinder.getPort(function (err, port) {
@@ -68,12 +72,16 @@ function init() {
   app.use(crossDomain()); // 允许跨域
   app.use(bodyParser.json()); // 解析body
 
+  let requireMockServe = true;
   if (process.env.SPECIFIED_FILE) {
     composeRouteFromJsFile(process.env.SPECIFIED_FILE);
+  } else if (includesWebServe && !existsSync(path.resolve(process.cwd(), process.env.SPECIFIED_DIR))) {
+    // 若包含web服务，则允许不启动mock服务
+    requireMockServe = false;
   } else {
     parseMockFiles(process.env.SPECIFIED_DIR);
   }
-  argv.a && log.info(colors.yellow(`${fileCount} mock file are parsed in total.`));
+  requireMockServe && argv.a && log.info(colors.yellow(`${fileCount} mock file are parsed in total.`));
 
   startServer();
 }
@@ -144,7 +152,7 @@ function composeRouteFromJsFile(file) {
  * @return {void}
  */
 function parseMockFiles(specialDir = '../mock') {
-  const files = fs.readdirSync(path.resolve(process.cwd(), specialDir), { withFileTypes: true });
+  const files = readdirSync(path.resolve(process.cwd(), specialDir), { withFileTypes: true });
   const curFilesSize = files.length;
   for (let index = 0; index < curFilesSize; index++) {
     const el = files[index];
@@ -231,7 +239,7 @@ function startServer() {
     }
     webApp.use(webPublicPath, express.static(process.env.WEB_ROOT)); // 将dist目录下所有文件作为静态文件来管理
     const defaultStaticEntry = `${process.env.WEB_ROOT}/index.html`;
-    if (fs.existsSync(defaultStaticEntry)) {
+    if (existsSync(defaultStaticEntry)) {
       // Used as static HTTP server for SPA
       webApp.get('*', (req, res) => {
         res.sendFile(defaultStaticEntry);
@@ -255,6 +263,9 @@ function startServer() {
   }
   const http = require('http').createServer(app);
   if (process.env.SOCKET_SERVER) {
+    const AsyncTaskQueue = require('./asyncTaskQueue');
+    const saveDataAsyncTask = new AsyncTaskQueue();
+
     socketServer = new Server(http, { path: '/ws/mock-service' });
     log.info(colors.bgBlue(`Socket server has started. path: /ws/mock-service, `));
     socketServer.of('/mock-data').on('connection', function (socket) {
@@ -302,34 +313,35 @@ function startServer() {
     });
   }
 
-  http.listen(Number.parseInt(process.env.PORT, 10), () => {
-    console.info(colors.red('\n Mock File仅支持commonjs规范的js、cjs文件，不支持ES Module'));
+  if (existsSync(mockFileOrDir)) {
+    http.listen(Number.parseInt(process.env.PORT, 10), () => {
+      console.info(colors.red('\n Mock File仅支持commonjs规范的js、cjs文件，不支持ES Module'));
 
-    console.info(
-      [
-        colors.yellow(`\n${process.env.RESTARTED ? 'Restarting' : 'Starting'} up mock-server, serving `),
-        colors.cyan(process.env.SPECIFIED_FILE || process.env.SPECIFIED_DIR),
-        colors.yellow(`  ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`)
-      ].join('')
-    );
-    if (!process.env.RESTARTED) {
       console.info(
-        [colors.yellow('\n🌍  mock-server version: '), colors.cyan(require('../package.json').version), '\n'].join('')
+        [
+          colors.yellow(`\n${process.env.RESTARTED ? 'Restarting' : 'Starting'} up mock-server, serving `),
+          colors.cyan(process.env.SPECIFIED_FILE || process.env.SPECIFIED_DIR),
+          colors.yellow(`  ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`)
+        ].join('')
       );
-      console.info(colors.yellow(`\n Mock server available on:\n`));
-      console.info('    http://localhost:' + colors.green(process.env.PORT));
-      Object.keys(ifaces).forEach(function (dev) {
-        ifaces[dev].forEach(function (details) {
-          if (details.family === 'IPv4') {
-            console.info('    http://' + details.address + ':' + colors.green(process.env.PORT));
-          }
+      if (!process.env.RESTARTED) {
+        console.info(
+          [colors.yellow('\n🌍  mock-server version: '), colors.cyan(require('../package.json').version), '\n'].join('')
+        );
+        console.info(colors.yellow(`\n Mock server available on:\n`));
+        console.info('    http://localhost:' + colors.green(process.env.PORT));
+        Object.keys(ifaces).forEach(function (dev) {
+          ifaces[dev].forEach(function (details) {
+            if (details.family === 'IPv4') {
+              console.info('    http://' + details.address + ':' + colors.green(process.env.PORT));
+            }
+          });
         });
-      });
-    }
-  });
+      }
+    });
+  }
 
   if (webApp && !process.env.RESTARTED) {
-    console.info(colors.red('\n Mock File仅支持commonjs规范的js、cjs文件，不支持ES Module'));
     webApp.listen(Number.parseInt(process.env.WEB_PORT, 10), () => {
       console.info(colors.yellow(`\n Web server available on:\n`));
       console.info('    http://localhost:' + colors.green(process.env.WEB_PORT) + webPublicPath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mock-service-cli",
-  "version": "3.3.2",
+  "version": "3.3.3",
   "description": "🦅 Local mock server, Static server, SPA server, Http?s request proxy",
   "main": "./lib/mockServer.js",
   "bin": {
@@ -28,7 +28,6 @@
     "node": ">=12"
   },
   "author": "chendq <deqiaochen@gmail.com>",
-  "packageManager": "yarn@1.22.19",
   "keywords": [
     "Static Server",
     "Web Server",