mock-service-cli 3.3.1 → 3.3.2

package/lib/manageMockFiles.js

@@ -2,13 +2,13 @@
  * @description: 生成Mock文件、获取mock数据统计
  * @Date: 2021-12-22 16:57:08
  * @LastEditors: chendq
- * @LastEditTime: 2022-01-06 13:41:12
+ * @LastEditTime: 2025-06-15 22:25:45
  * @Author: chendq
  */
 const fsa = require('fs-extra'),
   fs = require('fs'),
   path = require('path'),
-  _ = require('lodash'),
+  isEqual = require('lodash/isEqual'),
   colors = require('colors/safe');
 const {
   getFileLatestContent,
@@ -96,7 +96,7 @@ const genMockFiles = async function ({ url: apiUrl, method, data: resJsonData, d
   if (fsa.pathExistsSync(mockFilePath)) {
     const mockFileContent = getFileLatestContent(mockFilePath);
     // 内容一样不作修改
-    if (mockFileContent.hasOwnProperty(method) && _.isEqual(mockFileContent[method], resJsonData)) {
+    if (mockFileContent.hasOwnProperty(method) && isEqual(mockFileContent[method], resJsonData)) {
       // log.assert(
       //   !_.isEqual(mockFileContent[method], resJsonData),
       //   colors.bgYellow(`${method} ${apiUrl}, Mock data is same`)

package/lib/mockServer.js

@@ -27,13 +27,14 @@ const argv = JSON.parse(process.env.ARGV);
 let socketServer = null; // Socket server instance
 const AsyncTaskQueue = require('./asyncTaskQueue');
 const saveDataAsyncTask = new AsyncTaskQueue();
+let corsOrigin = [],
+  corsHeaders = '';
 
 const httpsRE = /^https:\/\//;
 let count = 0,
   fileCount = 0, // 记录mock api个数,mock file个数
   mockDirStat = {}, // 缓存mock目录的统计信息
   mockFileStat = {}; // 缓存mock文件的统计信息
-let done = false;
 if (!process.env.PORT) {
   portfinder.basePort = 8090;
   portfinder.getPort(function (err, port) {
@@ -41,53 +42,68 @@ if (!process.env.PORT) {
       throw err;
     }
     process.env.PORT = port;
-    done = true;
+    init();
   });
 } else {
-  done = true;
+  init();
 }
-// 将异步函数转换为同步代码代码执行
-require('deasync').loopWhile(function () {
-  return !done;
-});
-let corsOrigin = [],
-  corsHeaders = '';
-if (process.env.CORS_ORIGIN) {
-  process.env.CORS_ORIGIN.split(/\s*,\s*/).forEach(function (h) {
-    corsOrigin.push(h);
-  }, this);
 
-  corsHeaders = DefaultHeaders;
-}
-if (process.env.CORS_HEADERS) {
-  process.env.CORS_HEADERS.split(/\s*,\s*/).forEach(function (h) {
-    corsHeaders += corsHeaders ? ', ' + h : h;
-  }, this);
+/**
+ * Init mock server
+ */
+function init() {
+  if (process.env.CORS_ORIGIN) {
+    process.env.CORS_ORIGIN.split(/\s*,\s*/).forEach(function (h) {
+      corsOrigin.push(h);
+    }, this);
+
+    corsHeaders = DefaultHeaders;
+  }
+  if (process.env.CORS_HEADERS) {
+    process.env.CORS_HEADERS.split(/\s*,\s*/).forEach(function (h) {
+      corsHeaders += corsHeaders ? ', ' + h : h;
+    }, this);
+  }
+
+  app.use(crossDomain()); // 允许跨域
+  app.use(bodyParser.json()); // 解析body
+
+  if (process.env.SPECIFIED_FILE) {
+    composeRouteFromJsFile(process.env.SPECIFIED_FILE);
+  } else {
+    parseMockFiles(process.env.SPECIFIED_DIR);
+  }
+  argv.a && log.info(colors.yellow(`${fileCount} mock file are parsed in total.`));
+
+  startServer();
 }
+
 /**
  * @description: 跨域设置
  * @param {*}
  * @return {*}
  */
-const crossDomain = () => (req, res, next) => {
-  // 设置withCredentials: true时,需设置以下两项
-  res.header('Access-Control-Allow-Credentials', true);
-  // withCredentials, must be specified value instead of *
-  res.header('Access-Control-Allow-Origin', corsOrigin.includes(req.headers.origin) ? req.headers.origin : '*');
-  // res.header('Access-Control-Allow-Origin', '*');
-  res.header('Access-Control-Allow-Methods', SupportMethods.join(','));
-  res.header('Access-Control-Allow-Headers', corsHeaders ? corsHeaders : '*');
-  // res.header('Access-Control-Allow-Headers', '*');
-  if (req.method === 'OPTIONS') res.status(200); // 让OPTIONS快速返回
-  next();
-};
+function crossDomain() {
+  return (req, res, next) => {
+    // 设置withCredentials: true时,需设置以下两项
+    res.header('Access-Control-Allow-Credentials', true);
+    // withCredentials, must be specified value instead of *
+    res.header('Access-Control-Allow-Origin', corsOrigin.includes(req.headers.origin) ? req.headers.origin : '*');
+    // res.header('Access-Control-Allow-Origin', '*');
+    res.header('Access-Control-Allow-Methods', SupportMethods.join(','));
+    res.header('Access-Control-Allow-Headers', corsHeaders ? corsHeaders : '*');
+    // res.header('Access-Control-Allow-Headers', '*');
+    if (req.method === 'OPTIONS') res.status(200); // 让OPTIONS快速返回
+    next();
+  };
+}
 
 /**
  * @description: 构建本地服务的路由请求
  * @param {*} file
  * @returns {*}
  */
-const composeRouteFromJsFile = function (file) {
+function composeRouteFromJsFile(file) {
   // 先删除require之前导入的缓存文件,否则获取到的文件内容还是旧内容
   const fileObject = getFileLatestContent(file);
 
@@ -121,13 +137,13 @@ const composeRouteFromJsFile = function (file) {
       });
     }
   });
-};
+}
 /**
  * @description: 解析mock目录下的js文件，为构建路由请求做准备
  * @param {string} specialDir 目录路径
  * @return {void}
  */
-const parseMockFiles = function (specialDir = '../mock') {
+function parseMockFiles(specialDir = '../mock') {
   const files = fs.readdirSync(path.resolve(process.cwd(), specialDir), { withFileTypes: true });
   const curFilesSize = files.length;
   for (let index = 0; index < curFilesSize; index++) {
@@ -171,66 +187,60 @@ const parseMockFiles = function (specialDir = '../mock') {
     }
     composeRouteFromJsFile(filePath);
   }
-};
-
-app.use(crossDomain()); // 允许跨域
-app.use(bodyParser.json()); // 解析body
-
-if (process.env.SPECIFIED_FILE) {
-  composeRouteFromJsFile(process.env.SPECIFIED_FILE);
-} else {
-  parseMockFiles(process.env.SPECIFIED_DIR);
 }
-argv.a && log.info(colors.yellow(`${fileCount} mock file are parsed in total.`));
 
-let webApp = null,
-  webPublicPath = '/',
-  proxyTable = {};
-// Enable Web Server
-if (process.env.WEB_ROOT) {
-  webApp = express();
-  // Enable web proxy
-  if (process.env.PROXY_OPTIONS) {
-    try {
-      const options = JSON.parse(process.env.PROXY_OPTIONS);
-      Object.keys(options).forEach(function (prefix) {
-        proxyTable[prefix] = options[prefix];
-        const opts = {
-          target: options[prefix],
-          changeOrigin: true,
-          ws: true
-        };
-        if (httpsRE.test(options[prefix])) {
-          // https is require secure=false
-          opts.secure = false;
-        }
-        if (process.env.PREFIX_REWRITE) {
-          opts.pathRewrite = path => path.replace(new RegExp(`^${prefix}`), '');
-        }
-        // 接口代理
-        // https://github.com/http-party/node-http-proxy#options
-        webApp.use(prefix, createProxyMiddleware(opts));
-      }, this);
-    } catch (error) {
-      console.warn(colors.yellow('\nEnable web proxy Failed:', error));
+/**
+ * Start web server、socket server
+ */
+function startServer() {
+  let webApp = null,
+    webPublicPath = '/',
+    proxyTable = {};
+  // Enable Web Server
+  if (process.env.WEB_ROOT) {
+    webApp = express();
+    // Enable web proxy
+    if (process.env.PROXY_OPTIONS) {
+      try {
+        const options = JSON.parse(process.env.PROXY_OPTIONS);
+        Object.keys(options).forEach(function (prefix) {
+          proxyTable[prefix] = options[prefix];
+          const opts = {
+            target: options[prefix],
+            changeOrigin: true,
+            ws: true
+          };
+          if (httpsRE.test(options[prefix])) {
+            // https is require secure=false
+            opts.secure = false;
+          }
+          if (process.env.PREFIX_REWRITE) {
+            opts.pathRewrite = path => path.replace(new RegExp(`^${prefix}`), '');
+          }
+          // 接口代理
+          // https://github.com/http-party/node-http-proxy#options
+          webApp.use(prefix, createProxyMiddleware(opts));
+        }, this);
+      } catch (error) {
+        console.warn(colors.yellow('\nEnable web proxy Failed:', error));
+      }
     }
-  }
-  // console.log(process.env.WEB_PUBLIC_PATH, process.env.WEB_ROOT);
-  if (process.env.WEB_PUBLIC_PATH) {
-    webPublicPath = process.env.WEB_PUBLIC_PATH;
-  }
-  webApp.use(webPublicPath, express.static(process.env.WEB_ROOT)); // 将dist目录下所有文件作为静态文件来管理
-  const defaultStaticEntry = `${process.env.WEB_ROOT}/index.html`;
-  if (fs.existsSync(defaultStaticEntry)) {
-    // Used as static HTTP server for SPA
-    webApp.get('*', (req, res) => {
-      res.sendFile(defaultStaticEntry);
-    });
-  } else {
-    // Used as api server for test on browser console or api request tools
-    webApp.use(webPublicPath, (req, res) => {
-      res.status(200)
-        .send(`Hi, welcome to web server entrance ui, you can test http proxy on browser console or api request tools. Examples as follows:<br />
+    // console.log(process.env.WEB_PUBLIC_PATH, process.env.WEB_ROOT);
+    if (process.env.WEB_PUBLIC_PATH) {
+      webPublicPath = process.env.WEB_PUBLIC_PATH;
+    }
+    webApp.use(webPublicPath, express.static(process.env.WEB_ROOT)); // 将dist目录下所有文件作为静态文件来管理
+    const defaultStaticEntry = `${process.env.WEB_ROOT}/index.html`;
+    if (fs.existsSync(defaultStaticEntry)) {
+      // Used as static HTTP server for SPA
+      webApp.get('*', (req, res) => {
+        res.sendFile(defaultStaticEntry);
+      });
+    } else {
+      // Used as api server for test on browser console or api request tools
+      webApp.use(webPublicPath, (req, res) => {
+        res.status(200)
+          .send(`Hi, welcome to web server entrance ui, you can test http proxy on browser console or api request tools. Examples as follows:<br />
         fetch("http://localhost:${process.env.WEB_PORT}/api/permission/auth/login", {
           method: 'post',
           headers: {
@@ -240,101 +250,104 @@ if (process.env.WEB_ROOT) {
           body:JSON.stringify({"loginName":"admin","password":"admin"})
         })
       `);
-    });
+      });
+    }
   }
-}
-const http = require('http').createServer(app);
-if (process.env.SOCKET_SERVER) {
-  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) {
-    const { headers, address } = socket.handshake;
-    const clientIp = headers.hasOwnProperty('x-forwarded-for') ? headers['x-forwarded-for'] : address;
-    log.info(
-      colors.green(`Socket client ${clientIp} has connected.     --- ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`)
-    );
-    socket.on('mock-dir-stat', function (dir) {
-      socket.emit('mock-dir-stat', isEmptyObj(mockDirStat) ? (mockDirStat = getMockStatFromDir(dir)) : mockDirStat);
-    });
-    socket.on('mock-file-stat', function (filePath) {
-      socket.emit(
-        'mock-file-stat',
-        isEmptyObj(mockFileStat) ? (mockFileStat = getMockStatFromFile(filePath)) : mockFileStat
+  const http = require('http').createServer(app);
+  if (process.env.SOCKET_SERVER) {
+    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) {
+      const { headers, address } = socket.handshake;
+      const clientIp = headers.hasOwnProperty('x-forwarded-for') ? headers['x-forwarded-for'] : address;
+      log.info(
+        colors.green(
+          `Socket client ${clientIp} has connected.     --- ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`
+        )
       );
-    });
-    const async = args => {
-      return async next => {
-        await genMockFiles(args);
-        next();
+      socket.on('mock-dir-stat', function (dir) {
+        socket.emit('mock-dir-stat', isEmptyObj(mockDirStat) ? (mockDirStat = getMockStatFromDir(dir)) : mockDirStat);
+      });
+      socket.on('mock-file-stat', function (filePath) {
+        socket.emit(
+          'mock-file-stat',
+          isEmptyObj(mockFileStat) ? (mockFileStat = getMockStatFromFile(filePath)) : mockFileStat
+        );
+      });
+      const async = args => {
+        return async next => {
+          await genMockFiles(args);
+          next();
+        };
       };
-    };
-    socket.on('save-data', function (data) {
-      // console.log('lis save-data:', data);
-      saveDataAsyncTask.add(async(data));
+      socket.on('save-data', function (data) {
+        // console.log('lis save-data:', data);
+        saveDataAsyncTask.add(async(data));
 
-      if (saveDataAsyncTask.list.length === 1) {
-        saveDataAsyncTask.run();
-      } else {
-        saveDataAsyncTask.next();
-      }
-      // await genMockFiles(data);
-    });
+        if (saveDataAsyncTask.list.length === 1) {
+          saveDataAsyncTask.run();
+        } else {
+          saveDataAsyncTask.next();
+        }
+        // await genMockFiles(data);
+      });
 
-    socket.on('disconnect', function () {
-      log.info(
-        colors.gray(
-          `Socket client ${clientIp} has disconnected.     --- ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`
-        )
-      );
+      socket.on('disconnect', function () {
+        log.info(
+          colors.gray(
+            `Socket client ${clientIp} has disconnected.     --- ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`
+          )
+        );
+      });
     });
-  });
-}
+  }
 
-http.listen(Number.parseInt(process.env.PORT, 10), () => {
-  console.info(colors.red('\n Mock File仅支持commonjs规范的js、cjs文件，不支持ES Module'));
+  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);
-    Object.keys(ifaces).forEach(function (dev) {
-      ifaces[dev].forEach(function (details) {
-        if (details.family === 'IPv4') {
-          console.info('    http://' + details.address + ':' + colors.green(process.env.WEB_PORT) + webPublicPath);
-        }
+  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);
+      Object.keys(ifaces).forEach(function (dev) {
+        ifaces[dev].forEach(function (details) {
+          if (details.family === 'IPv4') {
+            console.info('    http://' + details.address + ':' + colors.green(process.env.WEB_PORT) + webPublicPath);
+          }
+        });
       });
+      if (!isEmptyObj(proxyTable)) {
+        console.info(colors.yellow(`\n Enable proxy at web server on:`));
+        Object.keys(proxyTable).forEach(prefix => {
+          console.info(`    ${prefix}   ->  ${proxyTable[prefix]}`);
+        });
+      }
     });
-    if (!isEmptyObj(proxyTable)) {
-      console.info(colors.yellow(`\n Enable proxy at web server on:`));
-      Object.keys(proxyTable).forEach(prefix => {
-        console.info(`    ${prefix}   ->  ${proxyTable[prefix]}`);
-      });
-    }
-  });
+  }
 }
 
 if (process.platform === 'win32') {

package/lib/staticServer.js

@@ -2,7 +2,7 @@
  * Static Server
  * @Date: 2023-12-03 18:02:24
  * @LastEditors: chendq
- * @LastEditTime: 2023-12-03 18:44:33
+ * @LastEditTime: 2025-06-15 22:16:36
  * @Author      : chendq
  */
 const express = require('express'), // 引入express
@@ -13,7 +13,6 @@ const { dateFormat, logger } = require('./utils');
 const ifaces = os.networkInterfaces();
 const log = logger(process.env.SILENT);
 
-let done = false;
 if (!process.env.PORT) {
   portfinder.basePort = 8090;
   portfinder.getPort(function (err, port) {
@@ -21,38 +20,40 @@ if (!process.env.PORT) {
       throw err;
     }
     process.env.PORT = port;
-    done = true;
+    startServer();
   });
 } else {
-  done = true;
+  startServer();
 }
-// 将异步函数转换为同步代码代码执行
-require('deasync').loopWhile(function () {
-  return !done;
-});
-const app = express();
 
-app.use(express.static(process.env.STATIC_DIRECTORY)); // 将dist目录下所有文件作为静态文件来管理
+/**
+ * Start server
+ */
+function startServer() {
+  const app = express();
+
+  app.use(express.static(process.env.STATIC_DIRECTORY)); // 将dist目录下所有文件作为静态文件来管理
 
-app.listen(Number.parseInt(process.env.PORT, 10), () => {
-  console.info(
-    [
-      colors.yellow(`\nStarting up Static Server, serving `),
-      colors.cyan(process.env.STATIC_DIRECTORY),
-      colors.yellow(`  ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`)
-    ].join('')
-  );
+  app.listen(Number.parseInt(process.env.PORT, 10), () => {
+    console.info(
+      [
+        colors.yellow(`\nStarting up Static Server, serving `),
+        colors.cyan(process.env.STATIC_DIRECTORY),
+        colors.yellow(`  ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`)
+      ].join('')
+    );
 
-  console.info(colors.yellow(`\n Static 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));
-      }
+    console.info(colors.yellow(`\n Static 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.platform === 'win32') {
   require('readline')

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mock-service-cli",
-  "version": "3.3.1",
-  "description": "🦅 Local mock server",
+  "version": "3.3.2",
+  "description": "🦅 Local mock server, Static server, SPA server, Http?s request proxy",
   "main": "./lib/mockServer.js",
   "bin": {
     "mock-service-cli": "bin/mock-service-cli"
@@ -10,7 +10,6 @@
     "start": "node ./bin/mock-service-cli",
     "test:unit": "tap --reporter=spec test/*.test.js",
     "test": "tap --cov --coverage-report=lcov --reporter=spec test/*.test.js ",
-    "coverage": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls -v",
     "test-watch": "tap --reporter=spec --watch test/*.test.js",
     "fix": "eslint --ext .js,.vue,.css --fix",
     "prettier": "prettier -c --write \"**/*.{ts,js,jsx,css,less,scss,json}\"",
@@ -31,14 +30,12 @@
   "author": "chendq <deqiaochen@gmail.com>",
   "packageManager": "yarn@1.22.19",
   "keywords": [
-    "MIT-licensed",
     "Static Server",
-    "Mock",
+    "Web Server",
+    "Mock Server CLI",
     "MockServer",
     "mock-service-cli",
-    "CLI",
-    "Socket server",
-    "socket.io"
+    "Socket server"
   ],
   "repository": {
     "type": "git",
@@ -49,7 +46,6 @@
   "dependencies": {
     "body-parser": "^1.20.2",
     "colors": "^1.4.0",
-    "deasync": "^0.1.23",
     "express": "^4.17.1",
     "fs-extra": "^10.0.0",
     "http-proxy-middleware": "^2.0.6",