mock-service-cli 2.0.2 → 2.1.0

package/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.1.0](https://github.com/chandq/mock-service-cli/compare/v2.0.5...v2.1.0) (2021-12-30)
+
+
+### Features
+
+* 根据命令行参数决定是否 打印api统计信息 ([0e838db](https://github.com/chandq/mock-service-cli/commit/0e838db7820fd096163d14eb87abbd9b852b6a0e))
+* add arguments description ([097b373](https://github.com/chandq/mock-service-cli/commit/097b3733a1da0b43dae6b50080d270323b92f0d2))
+
+
+### Bug Fixes
+
+* issue of comment typo ([85297a5](https://github.com/chandq/mock-service-cli/commit/85297a5895fd7c0446ee8b90a58ebed90a02e9e7))
+* issue of maybe write content to file failed ([8ed910b](https://github.com/chandq/mock-service-cli/commit/8ed910b1e9687cae46ad6bdab641db0c305c83fb))
+* socket connection show datetime ([c6db3b4](https://github.com/chandq/mock-service-cli/commit/c6db3b47a2370dc1c9aba5495dbb6606c20eb0c9))
+
+### [2.0.5](https://github.com/chandq/mock-service-cli/compare/v2.0.4...v2.0.5) (2021-12-28)
+
+
+### Bug Fixes
+
+* validate func parameter to avoid exception ([32e4d28](https://github.com/chandq/mock-service-cli/commit/32e4d28114a4907352491e16829d37345fbab9d9))
+
+### [2.0.4](https://github.com/chandq/mock-service-cli/compare/v2.0.3...v2.0.4) (2021-12-27)
+
+
+### Bug Fixes
+
+* get valid api url for route ([8770751](https://github.com/chandq/mock-service-cli/commit/877075107ea60244a52e345f37b7df855752d5f6))
+
+### [2.0.3](https://github.com/chandq/mock-service-cli/compare/v2.0.2...v2.0.3) (2021-12-27)
+
+
+### Bug Fixes
+
+* convert windows file path to api url ([1f15b33](https://github.com/chandq/mock-service-cli/commit/1f15b334ab5374bc102e5e11fbfaae994569bca5))
+
 ### [2.0.2](https://github.com/chandq/mock-service-cli/compare/v2.0.1...v2.0.2) (2021-12-27)
 
 

package/README.md

@@ -45,15 +45,16 @@ This will install `mock-service-cli` globally so that it may be run from the com
 
 `[path]` defaults to `./mock` .
 
-| Command             | Description                                                                                                    | Defaults |
-| ------------------- | -------------------------------------------------------------------------------------------------------------- | -------- |
-| `-p` or `--port`    | Port to use. Use `-p 0` to look for an open port, starting at 8090. It will also read from `process.env.PORT`. | 8090     |
-| `-d`                | Specify mock directory                                                                                         | ./mock   |
-| `-f`                | Specify mock file                                                                                              |          |
-| `-s` or `--silent`  | Suppress log messages from output                                                                              |          |
-| `-h` or `--help`    | Print this list and exit.                                                                                      |          |
-| `-v` or `--version` | Print the version and exit.                                                                                    |          |
-| `--ss`              | Start socket server which used to save api response data for future mock.                                      | false    |
+| Command                   | Description                                                                                                    | Defaults |
+| ------------------------- | -------------------------------------------------------------------------------------------------------------- | -------- |
+| `-p` or `--port`          | Port to use. Use `-p 0` to look for an open port, starting at 8090. It will also read from `process.env.PORT`. | 8090     |
+| `-d`                      | Specify mock directory                                                                                         | ./mock   |
+| `-f`                      | Specify mock file                                                                                              |          |
+| `-s` or `--silent`        | Suppress log messages from output                                                                              |          |
+| `-h` or `--help`          | Print this list and exit.                                                                                      |          |
+| `-v` or `--version`       | Print the version and exit.                                                                                    |          |
+| `-S` or `--socket-server` | Start socket server which used to save api response data for future mock.                                      | false    |
+| `-a` or `--api-stat`      | Whether print api url and file path info or not, default false.                                                | false    |
 
 ## Example
 
@@ -71,7 +72,7 @@ This will install `mock-service-cli` globally so that it may be run from the com
 
 4. Start socket server for used to save api response data.
 
-`mock-service-cli --ss`
+`mock-service-cli -S`
 
 ### 编写 Mock 文件
 
@@ -124,6 +125,8 @@ module.exports = {
 
 ### 借助 socket.io 保留接口数据
 
+> `save-data` 和 `mock-dir-stat` 事件会自动生成 `mock-list.json` 文件（维护接口`<url, [method]>`的关系映射），方便查阅接口统计信息
+
 ```js
 // 连接SocketServer
 import { io } from 'socket.io-client';

package/bin/mock-service-cli

@@ -20,7 +20,8 @@ if (argv.h || argv.help) {
       '  -f --file     Specify the input data source, support javascript ',
       '                     The priority is over the directory watches',
       '  -s --silent  Suppress log messages from output',
-      '  --ss  Whether start socket server or not, default false.',
+      '  -S --socket-server  Whether start socket server or not, default false.',
+      '  -a --api-stat  Whether print api url and file path or not, default false.',
       '',
       '  -h --help          Print this list and exit.',
       '  -v --version       Print the version and exit.'
@@ -29,11 +30,14 @@ if (argv.h || argv.help) {
   process.exit();
 }
 
+// 保留命令行参数
+process.env.ARGV = JSON.stringify(argv);
+
 var port = argv.p || argv.port,
   watchDir = argv.d,
   specifiedFile = argv.f || argv.file,
   version = argv.v || argv.version,
-  isStartSocketServer = argv.ss || false,
+  isStartSocketServer = argv.S || false,
   log = null;
 
 if (!argv.s && !argv.silent) {
@@ -44,7 +48,7 @@ if (!argv.s && !argv.silent) {
 }
 
 if (isStartSocketServer) {
-  process.env.SOCKETSERVER = true;
+  process.env.SOCKET_SERVER = true;
 }
 
 if (version) {

package/lib/manageMockFiles.js

@@ -2,7 +2,7 @@
  * @description: 生成Mock文件、获取mock数据统计
  * @Date: 2021-12-22 16:57:08
  * @LastEditors: chendq
- * @LastEditTime: 2021-12-27 10:15:01
+ * @LastEditTime: 2021-12-30 13:29:00
  * @Author: chendq
  */
 const fsa = require('fs-extra'),
@@ -10,12 +10,12 @@ const fsa = require('fs-extra'),
   path = require('path'),
   _ = require('lodash'),
   colors = require('colors/safe');
-const { getFileLatestContent, SupportMethods, logger } = require('./utils');
+const { getFileLatestContent, SupportMethods, filePath2ApiUrl, logger, getDataType } = require('./utils');
 const log = logger(process.env.SILENT);
 
 const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
 /**
- * @description: 生成mock文件
+ * @description: 生成mock文件（自动生成mock-list.json文件，并维护<url, [method]>的关系映射）
  * @param {string} apiUrl 请求url
  * @param {string} method 请求方法
  * @param {object} resJsonData 响应数据
@@ -24,9 +24,21 @@ const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
  *
  */
 const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mockDir }) {
-  const normalizeUrl = path.normalize(apiUrl);
+  if (!apiUrl || !method || !resJsonData || !mockDir) {
+    log.info(
+      colors.red(
+        [`参数: apiUrl: ${apiUrl}, method: ${method}, mockDir: ${mockDir}, resJsonData: `, `必须是有效值`].join(',')
+      )
+    );
+    return;
+  } else if (!['object', 'array'].includes(getDataType(resJsonData))) {
+    log.info(resJsonData, colors.red('参数resJsonData要求是数组或对象'));
+    return;
+  }
+  apiUrl = apiUrl.trim().split('?')[0];
+  const normalizeApiUrl = filePath2ApiUrl(path.normalize(apiUrl));
   const mockListFilePath = path.resolve(process.cwd(), `${mockDir}/mock-list.json`);
-  const mockFilePath = path.resolve(process.cwd(), `${mockDir}/${encodeURIComponent(normalizeUrl)}.json`);
+  const mockFilePath = path.resolve(process.cwd(), `${mockDir}/${encodeURIComponent(path.normalize(apiUrl))}.json`);
   let newMockListContent = {},
     oldMockListContent = null;
   if (fsa.pathExistsSync(mockListFilePath)) {
@@ -37,13 +49,14 @@ const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mo
   }
 
   // update mock-list.json file
-  if (!newMockListContent.hasOwnProperty(normalizeUrl)) {
-    newMockListContent[normalizeUrl] = [method];
-  } else if (!newMockListContent[normalizeUrl].includes(method)) {
-    newMockListContent[normalizeUrl].push(method);
+  if (!newMockListContent.hasOwnProperty(normalizeApiUrl)) {
+    newMockListContent[normalizeApiUrl] = [method];
+  } else if (!newMockListContent[normalizeApiUrl].includes(method)) {
+    newMockListContent[normalizeApiUrl].push(method);
   }
   if (!oldMockListContent || !_.isEqual(oldMockListContent, newMockListContent)) {
-    fsa.writeFileSync(mockListFilePath, JSON.stringify(newMockListContent, null, 2));
+    Object.keys(newMockListContent).length > 0 &&
+      fs.writeFileSync(mockListFilePath, JSON.stringify(newMockListContent, null, 2));
   }
 
   // mock文件存在
@@ -57,17 +70,19 @@ const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mo
       // );
       return;
     }
-    mockFileContent[method] = resJsonData ? resJsonData : {};
-    fsa.writeFileSync(mockFilePath, JSON.stringify(mockFileContent, null, 2));
+    mockFileContent[method] = resJsonData;
+    Object.keys(mockFileContent).length > 0 &&
+      fsa.writeFileSync(mockFilePath, JSON.stringify(mockFileContent, null, 2));
   } else {
     // fsa.ensureFileSync(mockFilePath);
-    fsa.writeFileSync(mockFilePath, JSON.stringify({ [method]: resJsonData ? resJsonData : {} }, null, 2));
+    Object.keys(mockFilePath).length > 0 &&
+      fsa.writeFileSync(mockFilePath, JSON.stringify({ [method]: resJsonData }, null, 2));
   }
-  // console.debug('file::', `${mockDir}/${normalizeUrl}`, newMockListContent);
+  // console.debug('file::', `${mockDir}/${apiUrl}`, newMockListContent);
 };
 /**
  * @description: 从js文件中收集mock数据
- * @param {map} mockDataMap
+ * @param {object} mockDataMap
  * @param {string} filePath
  * @return {*} void
  */
@@ -93,7 +108,7 @@ const collectMockDataFromJsFile = function (mockDataMap, filePath) {
 
 /**
  * @description: 递归收集mock数据
- * @param {map} mockDataMap mock数据集
+ * @param {object} mockDataMap mock数据集
  * @param {string} specialDir 目录
  * @return {*} void
  */
@@ -126,22 +141,48 @@ const deepCollectMockData = function (mockDataMap, specialDir = '../mock') {
   }
 };
 /**
- * @description: 从文件目录中获取mock数据统计
+ * @description: 从文件目录中获取mock数据统计（若mock-list.json文件不存在则自动生成）
  * @param {string} dirPath
- * @return {map} mock数据统计
+ * @return {object} mock数据统计
  */
 const getMockStatFromDir = dirPath => {
+  if (!fsa.pathExistsSync(dirPath)) {
+    throw new Error(`入参无效，${dirPath} 目录不存在`);
+  }
   const mockDataMap = {};
   deepCollectMockData(mockDataMap, dirPath);
+
+  const mockListFilePath = path.resolve(process.cwd(), `${dirPath}/mock-list.json`);
+  // 若不存在mock-list.json文件，则根据现有mock文件重新生成<api, [method]>映射关系
+  if (Object.keys(mockDataMap).length > 0 && !fsa.pathExistsSync(mockListFilePath)) {
+    fsa.ensureFileSync(mockListFilePath);
+    const reverseMockList = {};
+    Object.keys(mockDataMap).forEach(it => {
+      if (methodRegExp.exec(it)) {
+        const [, method, url] = methodRegExp.exec(it);
+        if (url.trim() && method.trim()) {
+          if (reverseMockList.hasOwnProperty(url)) {
+            reverseMockList[url].push(method);
+          } else {
+            reverseMockList[url] = [method];
+          }
+        }
+      }
+    });
+    fs.writeFileSync(mockListFilePath, JSON.stringify(reverseMockList, null, 2));
+  }
   return mockDataMap;
 };
 
 /**
  * @description: 从js文件中获取mock数据统计
  * @param {string} filePath
- * @return {map}  mock数据统计
+ * @return {object}  mock数据统计
  */
 const getMockStatFromFile = filePath => {
+  if (!fsa.pathExistsSync(filePath)) {
+    throw new Error(`入参无效，${filePath} 文件不存在`);
+  }
   const mockDataMap = {};
   collectMockDataFromJsFile(mockDataMap, filePath);
   return mockDataMap;
@@ -154,8 +195,8 @@ const getMockStatFromFile = filePath => {
  * @return {boolean}
  */
 const hasMockApi = function (mockDataMap, apiUrl, method) {
-  if (!mockDataMap || !(mockDataMap instanceof Object)) {
-    throw new Error(`如参无效，${mockDataMap} 必须是 mock数据的Object对象`);
+  if (!apiUrl || !method || !mockDataMap || !(mockDataMap instanceof Object)) {
+    throw new Error(`入参无效，${mockDataMap} 必须是 mock数据的Object对象`);
   }
   return mockDataMap.hasOwnProperty(`${method.toLocaleLowerCase()} ${path.normalize(apiUrl)}`);
 };

package/lib/mockServer.js

@@ -7,13 +7,14 @@ const express = require('express'), // 引入express
   chalk = require('chalk');
 const ifaces = os.networkInterfaces();
 const { Server } = require('socket.io');
-const { dateFormat, logger, SupportMethods, getFileLatestContent } = require('./utils');
+const { dateFormat, logger, SupportMethods, getFileLatestContent, filePath2ApiUrl } = require('./utils');
 const { genMockFiles, getMockStatFromDir, getMockStatFromFile } = require('./manageMockFiles');
 
 const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
 
 const app = express();
 const log = logger(process.env.SILENT);
+const argv = JSON.parse(process.env.ARGV);
 let socketServer = null; // Socket server instance
 
 let count = 0,
@@ -60,11 +61,11 @@ const crossDomain = () => (req, res, next) => {
  * @param {*} file
  * @returns {*}
  */
-const composeRoute = function (file) {
+const composeRouteFromJsFile = function (file) {
   // 先删除require之前导入的缓存文件,否则获取到的文件内容还是旧内容
   const fileObject = getFileLatestContent(file);
 
-  log.info(colors.green(`Mockfile ${++fileCount}: `), file, colors.yellow('all API URL is follows: '));
+  argv.a && log.info(colors.green(`Mockfile ${++fileCount}: `), file, colors.yellow('all API URL is follows: '));
   Object.keys(fileObject).forEach(item => {
     let reqMethod = 'get',
       reqUrl = item;
@@ -74,7 +75,7 @@ const composeRoute = function (file) {
       reqMethod = method.toLowerCase();
       reqUrl = url;
     }
-    log.info(colors.yellow(`path ${++count}: `), item, colors.blue(typeof fileObject[item]));
+    argv.a && log.info(colors.yellow(`path ${++count}: `), item, colors.blue(typeof fileObject[item]));
     log.assert(typeof app[reqMethod] === 'function', colors.red(`${file}, ${reqMethod}`));
     if (typeof fileObject[item] === 'function') {
       app[reqMethod](reqUrl, fileObject[item]);
@@ -103,12 +104,14 @@ const parseMockFiles = function (specialDir = '../mock') {
 
     // 处理存放mock数据的json文件
     if (el.name.endsWith('.json') && el.name !== 'mock-list.json') {
-      log.info(colors.green(`Mockfile ${++fileCount}: `), filePath, colors.yellow('all API URL is follows: '));
+      argv.a &&
+        log.info(colors.green(`Mockfile ${++fileCount}: `), filePath, colors.yellow('all API URL is follows: '));
       const fileObject = getFileLatestContent(filePath);
       // eslint-disable-next-line no-loop-func
       Object.keys(fileObject).forEach(method => {
-        const apiUrl = decodeURIComponent(el.name.split('.')[0]);
-        log.info(colors.yellow(`path ${++count}: `), `${method} ${apiUrl}`, colors.blue(typeof fileObject[method]));
+        const apiUrl = filePath2ApiUrl(decodeURIComponent(el.name.split('.')[0]));
+        argv.a &&
+          log.info(colors.yellow(`path ${++count}: `), `${method} ${apiUrl}`, colors.blue(typeof fileObject[method]));
         log.assert(typeof app[method] === 'function', colors.red(`${filePath}, ${method}`));
         app[method](apiUrl, function (req, res) {
           res.json(fileObject[method]);
@@ -121,24 +124,26 @@ const parseMockFiles = function (specialDir = '../mock') {
     if (!el.name.endsWith('.js')) {
       continue;
     }
-    composeRoute(filePath);
+    composeRouteFromJsFile(filePath);
   }
 };
 app.use(crossDomain());
 if (process.env.SPECIFIED_FILE) {
-  composeRoute(process.env.SPECIFIED_FILE);
+  composeRouteFromJsFile(process.env.SPECIFIED_FILE);
 } else {
   parseMockFiles(process.env.SPECIFIED_DIR);
 }
-log.info(chalk.hex('#ce5b34bd')(`${fileCount} mock file are parsed in total.`));
+argv.a && log.info(chalk.hex('#ce5b34bd')(`${fileCount} mock file are parsed in total.`));
 const http = require('http').createServer(app);
-if (process.env.SOCKETSERVER) {
+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.`));
+    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', getMockStatFromDir(dir));
     });
@@ -151,7 +156,11 @@ if (process.env.SOCKETSERVER) {
     });
 
     socket.on('disconnect', function () {
-      log.info(colors.gray(`Socket client ${clientIp} has disconnected.`));
+      log.info(
+        colors.gray(
+          `Socket client ${clientIp} has disconnected.     --- ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`
+        )
+      );
     });
   });
 }
@@ -201,6 +210,6 @@ process.on('SIGTERM', function () {
 });
 
 module.exports = {
-  composeRoute,
+  composeRouteFromJsFile,
   parseMockFiles
 };

package/lib/utils.js

@@ -1,3 +1,10 @@
+/*
+ * @description:
+ * @Date: 2021-12-25 17:52:48
+ * @LastEditors: chendq
+ * @LastEditTime: 2021-12-30 13:17:12
+ * @Author: chendq
+ */
 /**
  * @description: 输出和错误输出写入不同文件
  * @param {*}
@@ -78,5 +85,30 @@ const getFileLatestContent = function (filePath) {
   delete require.cache[require.resolve(filePath)];
   return require(path.resolve(process.cwd(), filePath));
 };
+/**
+ * @description: 文件路径转成API的url
+ * @param {string} filePath
+ * @return {string} apiUrl
+ */
+const filePath2ApiUrl = function (filePath) {
+  return filePath.split(path.sep).join('/');
+};
+/**
+ * @description: 获取数据类型
+ * @param {any} data 数据值
+ * @return {string} 数据类型
+ */
+const getDataType = function (data) {
+  return Object.prototype.toString.call(data).slice(8, -1).toLowerCase();
+};
 
-module.exports = { getLogger, dateFormat, logger, SupportMethods, isValidMethod, getFileLatestContent };
+module.exports = {
+  getLogger,
+  dateFormat,
+  logger,
+  SupportMethods,
+  isValidMethod,
+  getFileLatestContent,
+  filePath2ApiUrl,
+  getDataType
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mock-service-cli",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "🦅 Local mock server",
   "main": "./lib/mockServer.js",
   "bin": {