mock-service-cli 2.3.1 → 2.4.2

package/CHANGELOG.md

@@ -2,6 +2,34 @@
 
 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.4.2](https://github.com/chandq/mock-service-cli/compare/v2.4.1...v2.4.2) (2022-01-07)
+
+
+### Features
+
+* 缓存mock统计信息 ([1ee87cd](https://github.com/chandq/mock-service-cli/commit/1ee87cd041e68b9f17b64e9e3cb906681cb855fc))
+
+### [2.4.1](https://github.com/chandq/mock-service-cli/compare/v2.4.0...v2.4.1) (2022-01-06)
+
+
+### Bug Fixes
+
+* 修复无法同时保留相同url不同请求类型的响应数据 ([90326dc](https://github.com/chandq/mock-service-cli/commit/90326dc556760eb81efadd76b031366452c95d2b))
+
+## [2.4.0](https://github.com/chandq/mock-service-cli/compare/v2.3.2...v2.4.0) (2022-01-05)
+
+
+### Features
+
+* 增加异步任务队列，移出不必要模块 ([c7f3608](https://github.com/chandq/mock-service-cli/commit/c7f3608e4d0185434154d6f8d84889f281147022))
+
+### [2.3.2](https://github.com/chandq/mock-service-cli/compare/v2.3.1...v2.3.2) (2022-01-02)
+
+
+### Bug Fixes
+
+* be sure to write file successfully ([55415e3](https://github.com/chandq/mock-service-cli/commit/55415e387af4d8232db2bede0a51dad1dca474b3))
+
 ### [2.3.1](https://github.com/chandq/mock-service-cli/compare/v2.2.0...v2.3.1) (2022-01-01)
 
 

package/README.md

@@ -162,7 +162,7 @@ const socket = io.connect('http://192.168.31.54:8090/mock-data', {
   }
 });
 
-socket.emit('mock-dir-stat', '/home/chen/projects/isc-twin-model-ui/mock');
+socket.emit('mock-dir-stat', '/home/chen/projects/model-ui/mock');
 socket.on('mock-dir-stat', function (data) {
   console.debug('mock-dir-stat:', data);
 });

package/lib/asyncTaskQueue.js

@@ -0,0 +1,74 @@
+/*
+ * @description: 异步任务队列
+ * @Date: 2022-01-04 10:46:20
+ * @LastEditors: chendq
+ * @LastEditTime: 2022-01-06 13:17:21
+ * @Author: chendq
+ */
+// const { getDataType } = require('./utils');
+class AsyncTaskQueue {
+  constructor(isSaveItem = false) {
+    this.list = [];
+    this.index = 0;
+    this.isStop = false;
+    this.isParallel = false;
+    this.isSaveItem = isSaveItem; // 执行完成后的数据是否保留
+  }
+
+  next() {
+    // 加限制
+    if (this.index >= this.list.length - 1 || this.isStop) return;
+    if (!this.isSaveItem) {
+      this.list.splice(this.index, 1, '');
+    }
+    const cur = this.list[++this.index];
+    cur(this.next.bind(this));
+  }
+  /**
+   * @description: 增加异步任务
+   * @param {array} fn
+   */
+  add(...fn) {
+    this.list.push(...fn);
+  }
+  /**
+   * @description: 按序执行异步任务
+   */
+  run() {
+    const cur = this.list[this.index];
+    typeof cur === 'function' && cur(this.next.bind(this));
+  }
+
+  /**
+   * @description: 并发执行异步任务
+   */
+  parallelRun() {
+    this.isParallel = true;
+    for (const fn of this.list) {
+      fn(this.next.bind(this));
+    }
+  }
+
+  /**
+   * @description: 暂停执行异步任务
+   */
+  stop() {
+    this.isStop = true;
+  }
+
+  /**
+   * @description: 重试执行异步任务
+   */
+  retry() {
+    this.isStop = false;
+    run();
+  }
+  /**
+   * @description: 继续执行下一个异步任务
+   */
+  goOn() {
+    this.isStop = false;
+    this.next();
+  }
+}
+module.exports = AsyncTaskQueue;

package/lib/manageMockFiles.js

@@ -2,7 +2,7 @@
  * @description: 生成Mock文件、获取mock数据统计
  * @Date: 2021-12-22 16:57:08
  * @LastEditors: chendq
- * @LastEditTime: 2022-01-01 10:51:12
+ * @LastEditTime: 2022-01-06 13:41:12
  * @Author: chendq
  */
 const fsa = require('fs-extra'),
@@ -21,9 +21,23 @@ const {
 } = require('./utils');
 const log = logger(process.env.SILENT);
 const processArgv = process.env.ARGV ? JSON.parse(process.env.ARGV) : {};
-let LOGGER = getLogger();
 
 const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
+/**
+ * @description: 记录日志文件函数
+ * @param {boolean} isWriteLogFile 是否写入日志文件
+ * @param {string} mockDir 存放日志文件的目录
+ * @return {object}
+ */
+const logFile = (isWriteLogFile = false, mockDir) => {
+  if (isWriteLogFile) {
+    return getLogger(mockDir);
+  }
+  return {
+    log: function () {},
+    error: function () {}
+  };
+};
 /**
  * @description: 生成mock文件（自动生成mock-list.json文件，并维护<url, [method]>的关系映射）
  * @param {string} apiUrl 请求url
@@ -33,7 +47,7 @@ const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
  * @return {*} void
  *
  */
-const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mockDir }) {
+const genMockFiles = async function ({ url: apiUrl, method, data: resJsonData, dir: mockDir }) {
   const type = getDataType(resJsonData);
   if (!apiUrl || !method || !resJsonData || !mockDir) {
     log.info(
@@ -53,28 +67,29 @@ const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mo
     return;
   }
   apiUrl = apiUrl.trim().split('?')[0];
-  LOGGER = getLogger(mockDir);
+  const LOGGER = logFile(processArgv.l || processArgv.log, mockDir);
   const normalizeApiUrl = filePath2ApiUrl(path.normalize(apiUrl));
   const mockListFilePath = path.resolve(process.cwd(), `${mockDir}/mock-list.json`);
   const mockFilePath = path.resolve(process.cwd(), `${mockDir}/${encodeURIComponent(path.normalize(apiUrl))}.json`);
-  let newMockListContent = {},
-    oldMockListContent = null;
+  let newMockListContent = {};
   if (fsa.pathExistsSync(mockListFilePath)) {
-    oldMockListContent = getFileLatestContent(mockListFilePath);
-    newMockListContent = _.cloneDeep(oldMockListContent);
+    newMockListContent = getFileLatestContent(mockListFilePath);
   } else {
     fsa.ensureFileSync(mockListFilePath);
   }
 
+  let isChange = false;
   // update mock-list.json file
   if (!newMockListContent.hasOwnProperty(normalizeApiUrl)) {
     newMockListContent[normalizeApiUrl] = [method];
+    isChange = true;
   } else if (!newMockListContent[normalizeApiUrl].includes(method)) {
     newMockListContent[normalizeApiUrl].push(method);
+    isChange = true;
   }
-  if (!oldMockListContent || !_.isEqual(oldMockListContent, newMockListContent)) {
+  if (isChange) {
     Object.keys(newMockListContent).length > 0 &&
-      writeStream(mockListFilePath, JSON.stringify(newMockListContent, null, 2));
+      fs.writeFileSync(mockListFilePath, JSON.stringify(newMockListContent, null, 2));
   }
 
   // mock文件存在
@@ -89,17 +104,19 @@ const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mo
       return;
     }
     mockFileContent[method] = resJsonData;
-    writeStream(mockFilePath, JSON.stringify(mockFileContent, null, 2));
-    if (processArgv.l || processArgv.log) {
-      LOGGER.log(`Update file:  ${method} ${apiUrl}  ${mockFilePath}`);
+    try {
+      await writeStream(mockFilePath, JSON.stringify(mockFileContent, null, 2));
+    } catch (error) {
+      LOGGER.error(`Update file:  ${method} ${apiUrl}  ${mockFilePath}`);
     }
+    LOGGER.log(`Update file:  ${method} ${apiUrl}  ${mockFilePath}`);
   } else {
-    // fsa.ensureFileSync(mockFilePath);
-
-    writeStream(mockFilePath, JSON.stringify({ [method]: resJsonData }, null, 2));
-    if (processArgv.l || processArgv.log) {
-      LOGGER.log(`Write new file:  ${method} ${apiUrl}  ${mockFilePath}`);
+    try {
+      await writeStream(mockFilePath, JSON.stringify({ [method]: resJsonData }, null, 2));
+    } catch (error) {
+      LOGGER.error(`New    file:  ${method} ${apiUrl}  ${mockFilePath}`);
     }
+    LOGGER.log(`New    file:  ${method} ${apiUrl}  ${mockFilePath}`);
   }
   // console.debug('file::', `${mockDir}/${apiUrl}`, newMockListContent);
 };
@@ -170,7 +187,8 @@ const deepCollectMockData = function (mockDataMap, specialDir = '../mock') {
  */
 const getMockStatFromDir = dirPath => {
   if (!fsa.pathExistsSync(dirPath)) {
-    throw new Error(`入参无效，${dirPath} 目录不存在`);
+    getLogger(path.resolve(process.cwd())).error(`入参无效，${dirPath} 目录不存在`);
+    return;
   }
   const mockDataMap = {};
   deepCollectMockData(mockDataMap, dirPath);
@@ -204,7 +222,8 @@ const getMockStatFromDir = dirPath => {
  */
 const getMockStatFromFile = filePath => {
   if (!fsa.pathExistsSync(filePath)) {
-    throw new Error(`入参无效，${filePath} 文件不存在`);
+    getLogger(path.resolve(process.cwd())).error(`入参无效，${filePath} 文件不存在`);
+    return;
   }
   const mockDataMap = {};
   collectMockDataFromJsFile(mockDataMap, filePath);
@@ -219,7 +238,8 @@ const getMockStatFromFile = filePath => {
  */
 const hasMockApi = function (mockDataMap, apiUrl, method) {
   if (!apiUrl || !method || !mockDataMap || !(mockDataMap instanceof Object)) {
-    throw new Error(`入参无效，${mockDataMap} 必须是 mock数据的Object对象`);
+    getLogger(path.resolve(process.cwd())).error(`入参无效，${mockDataMap} 必须是 mock数据的Object对象`);
+    return;
   }
   return mockDataMap.hasOwnProperty(`${method.toLocaleLowerCase()} ${path.normalize(apiUrl)}`);
 };

package/lib/mockServer.js

@@ -7,7 +7,7 @@ const express = require('express'), // 引入express
   chalk = require('chalk');
 const ifaces = os.networkInterfaces();
 const { Server } = require('socket.io');
-const { dateFormat, logger, SupportMethods, getFileLatestContent, filePath2ApiUrl } = require('./utils');
+const { dateFormat, logger, SupportMethods, getFileLatestContent, filePath2ApiUrl, isEmptyObj } = require('./utils');
 const { genMockFiles, getMockStatFromDir, getMockStatFromFile } = require('./manageMockFiles');
 
 const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
@@ -16,9 +16,13 @@ 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 count = 0,
-  fileCount = 0; // 记录mock api个数,mock file个数
+  fileCount = 0, // 记录mock api个数,mock file个数
+  mockDirStat = {}, // 缓存mock目录的统计信息
+  mockFileStat = {}; // 缓存mock文件的统计信息
 let done = false;
 if (!process.env.PORT) {
   portfinder.basePort = 8090;
@@ -145,14 +149,27 @@ if (process.env.SOCKET_SERVER) {
       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));
+      socket.emit('mock-dir-stat', isEmptyObj(mockDirStat) ? mockDirStat =  getMockStatFromDir(dir) : mockDirStat);
     });
     socket.on('mock-file-stat', function (filePath) {
-      socket.emit('mock-file-stat', getMockStatFromFile(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);
-      genMockFiles(data);
+      saveDataAsyncTask.add(async(data));
+
+      if (saveDataAsyncTask.list.length === 1) {
+        saveDataAsyncTask.run();
+      } else {
+        saveDataAsyncTask.next();
+      }
+      // await genMockFiles(data);
     });
 
     socket.on('disconnect', function () {

package/lib/utils.js

@@ -2,11 +2,12 @@
  * @description: 工具函数库
  * @Date: 2021-12-25 17:52:48
  * @LastEditors: chendq
- * @LastEditTime: 2021-12-31 23:10:02
+ * @LastEditTime: 2022-01-05 20:21:07
  * @Author: chendq
  */
 const fs = require('fs');
 const path = require('path');
+// const JSONStream = require('JSONStream');
 /**
  * @description: 输出和错误输出写入不同文件
  * @param {string} logFileDirPath
@@ -18,11 +19,11 @@ const getLogger = function (logFileDirPath) {
     encoding: 'utf8' // utf8编码
   };
   const output = fs.createWriteStream(
-    path.resolve(logFileDirPath ? logFileDirPath : process.cwd(), './stdout.log'),
+    path.resolve(logFileDirPath ? logFileDirPath : path.resolve(process.cwd()), './stdout.log'),
     options
   );
   const errorOutput = fs.createWriteStream(
-    path.resolve(logFileDirPath ? logFileDirPath : process.cwd(), './stderr.log'),
+    path.resolve(logFileDirPath ? logFileDirPath : path.resolve(process.cwd()), './stderr.log'),
     options
   );
   // 自定义日志打印
@@ -38,9 +39,9 @@ const getLogger = function (logFileDirPath) {
 };
 /**
  * @description: 格式化时间日期
- * @param {*} fmt
- * @param {*} date
- * @returns {*}
+ * @param {string} fmt 时间日期字符串格式化模板
+ * @param {date} date 时间日期Date
+ * @returns {string}
  */
 function dateFormat(fmt, date = new Date()) {
   let ret;
@@ -65,8 +66,8 @@ function dateFormat(fmt, date = new Date()) {
 }
 /**
  * @description: 控制是否写日志
- * @param {*} isSilent
- * @return {*}
+ * @param {boolean} isSilent 是否静默
+ * @return {object}
  */
 function logger(isSilent = false) {
   let logObj = null;
@@ -96,8 +97,12 @@ const isValidMethod = function (m) {
  * @return {object} 文件内容
  */
 const getFileLatestContent = function (filePath) {
-  delete require.cache[require.resolve(filePath)];
-  return require(path.resolve(process.cwd(), filePath));
+  try {
+    delete require.cache[require.resolve(filePath)];
+    return require(path.resolve(process.cwd(), filePath));
+  } catch (error) {
+    getLogger(path.resolve(process.cwd())).error(filePath, require.cache[require.resolve(filePath)], error);
+  }
 };
 /**
  * @description: 文件路径转成API的url
@@ -115,24 +120,39 @@ const filePath2ApiUrl = function (filePath) {
 const getDataType = function (data) {
   return Object.prototype.toString.call(data).slice(8, -1).toLowerCase();
 };
+/**
+ * @description: 判断对象是否为空
+ * @param {object} obj
+ * @return {boolean}
+ */
+const isEmptyObj = function (obj) {
+  return getDataType(obj) === 'object' && Object.keys(obj).length === 0;
+};
 /**
  * @description: 流方式写文件（适合写超大文件）
  * @param {string} filePath
  * @param {object} data
- * @return {*}
+ * @return {promise}
  */
 const writeStream = function (filePath, data) {
   // 创建一个可写流   也会创建一个test1.txt文件
-  const writerStream = fs.createWriteStream(filePath);
-  // 将数据写入流
-  writerStream.write(data, 'utf-8');
-  // 标记文件的结束
-  writerStream.end();
-  writerStream.on('finish', () => {
-    // console.log('写入完成');
-  });
-  writerStream.on('error', () => {
-    console.error(`${filePath} 写入失败`);
+  return new Promise((resolve, reject) => {
+    const writerStream = fs.createWriteStream(filePath);
+    // 将数据写入流
+    writerStream.write(data, 'utf-8');
+    // 标记文件的结束
+    writerStream.end();
+    writerStream.on('finish', () => {});
+    writerStream.on('close', () => {
+      setTimeout(() => {
+        resolve(data);
+      });
+    });
+
+    writerStream.on('error', err => {
+      getLogger(path.resolve(process.cwd())).error(filePath, require.cache[require.resolve(filePath)], err);
+      reject(err);
+    });
   });
 };
 /**
@@ -140,7 +160,7 @@ const writeStream = function (filePath, data) {
  * @param {string} filePath
  * @return {*}
  */
-const readeStream = function (filePath) {
+const readStream = function (filePath) {
   let data = '';
   // 创建可读流
   return new Promise((resovle, reject) => {
@@ -161,6 +181,99 @@ const readeStream = function (filePath) {
   });
 };
 
+/**
+ * 防抖函数
+ * 当函数被连续调用时，该函数并不执行，只有当其全部停止调用超过一定时间后才执行1次。
+ * 例如：上电梯的时候，大家陆陆续续进来，电梯的门不会关上，只有当一段时间都没有人上来，电梯才会关门。
+ * @param {F} func
+ * @param {number} wait
+ * @returns {DebounceFunc<F>}
+ */
+const debounce = (func, wait) => {
+  let timeout;
+  let canceled = false;
+  const f = function (...args) {
+    if (canceled) return;
+    clearTimeout(timeout);
+    timeout = setTimeout(() => {
+      func.call(this, ...args);
+    }, wait);
+  };
+  f.cancel = () => {
+    clearTimeout(timeout);
+    canceled = true;
+  };
+  return f;
+};
+/**
+ * 节流函数
+ * 节流就是节约流量，将连续触发的事件稀释成预设评率。 比如每间隔1秒执行一次函数，无论这期间触发多少次事件。
+ * 这有点像公交车，无论在站点等车的人多不多，公交车只会按时来一班，不会来一个人就来一辆公交车。
+ * @param {F} func
+ * @param {number} wait
+ * @param {boolean} immediate
+ * @returns {ThrottleFunc<F>}
+ */
+const throttle = (func, wait, immediate) => {
+  let timeout;
+  let canceled = false;
+  let lastCalledTime = 0;
+  const f = function (...args) {
+    if (canceled) return;
+    const now = Date.now();
+    const call = () => {
+      lastCalledTime = now;
+      func.call(this, ...args);
+    };
+    // 第一次执行
+    if (lastCalledTime === 0) {
+      if (immediate) {
+        return call();
+      }
+
+      lastCalledTime = now;
+      return;
+    }
+    const remain = lastCalledTime + wait - now;
+    if (remain > 0) {
+      clearTimeout(timeout);
+      timeout = setTimeout(() => call(), wait);
+    } else {
+      call();
+    }
+  };
+  f.cancel = () => {
+    clearTimeout(timeout);
+    canceled = true;
+  };
+  return f;
+};
+// /**
+//  * @description: 带模糊搜索的分块读取大JSON文件
+//  * @param {string} filePath
+//  * @return {*}
+//  */
+// const readBigJson = function (filePath) {
+//   return new Promise((resolve, reject) => {
+//     let res = '';
+//     const readable = fs.createReadStream(filePath, {
+//       encoding: 'utf8',
+//       highWaterMark: 10
+//     });
+//     const parser = JSONStream.parse('*');
+//     readable.pipe(parser);
+//     parser.on('end', function () {
+//       // I know it ends here,
+//       console.log('end::', res);
+//       resolve(res);
+//     });
+//     parser.on('data', function (data) {
+//       res += data;
+//       console.log('yy::', data);
+//     });
+//   });
+// };
+
 module.exports = {
   getLogger,
   dateFormat,
@@ -170,6 +283,9 @@ module.exports = {
   getFileLatestContent,
   filePath2ApiUrl,
   getDataType,
+  isEmptyObj,
   writeStream,
-  readeStream
+  readStream,
+  debounce,
+  throttle
 };

package/package.json

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