mock-service-cli 2.1.0 → 2.3.2

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.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)
+
+
+### Bug Fixes
+
+* issue of execute unit test case failed ([69f4609](https://github.com/chandq/mock-service-cli/commit/69f46099ed5b26de5d4cca523c56afcbf4db5f2c))
+
+## [2.2.0](https://github.com/chandq/mock-service-cli/compare/v2.1.1...v2.2.0) (2021-12-31)
+
+
+### Features
+
+* 丰富日志工具函数 ([4dcd69c](https://github.com/chandq/mock-service-cli/commit/4dcd69c6400f65aaf77ea4a2923c9900d5954d09))
+* 监听文件变化和写文件互斥执行 ([cfeab8e](https://github.com/chandq/mock-service-cli/commit/cfeab8ede05573974125a9fa91f1db6afa8a898d))
+* record operation log ([42b74d8](https://github.com/chandq/mock-service-cli/commit/42b74d8be0e694600c999490d3fe93bfb3620051))
+
+
+### Bug Fixes
+
+* issue of write large file failed ([d1c470d](https://github.com/chandq/mock-service-cli/commit/d1c470daf9829916016b73993b114fc5ffe3c985))
+
+### [2.1.1](https://github.com/chandq/mock-service-cli/compare/v2.1.0...v2.1.1) (2021-12-30)
+
+
+### Bug Fixes
+
+* issue of  friendly show error tip ([e9822c2](https://github.com/chandq/mock-service-cli/commit/e9822c2038ad411d91a170af33e7541e266ca8e6))
+* issue of empty file content ([3949e00](https://github.com/chandq/mock-service-cli/commit/3949e00a46b4555bc08ec8564221cc230c780dcb))
+
 ## [2.1.0](https://github.com/chandq/mock-service-cli/compare/v2.0.5...v2.1.0) (2021-12-30)
 
 

package/README.md

@@ -55,6 +55,7 @@ This will install `mock-service-cli` globally so that it may be run from the com
 | `-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    |
+| `-l` or `--log`           | Whether record operation info by write file, default false.                                                    | false    |
 
 ## Example
 
@@ -161,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/bin/mock-service-cli

@@ -6,6 +6,8 @@ const colors = require('colors/safe'),
   nodemon = require('nodemon');
 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) {
@@ -22,6 +24,7 @@ if (argv.h || argv.help) {
       '  -s --silent  Suppress log messages from output',
       '  -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.',
+      '  -l --log  Whether record operation info by write file, default false.',
       '',
       '  -h --help          Print this list and exit.',
       '  -v --version       Print the version and exit.'
@@ -94,16 +97,34 @@ const watchMockFiles = function (watchDir) {
       );
     });
 };
+// Node子进程启动MockServer
+const startMockServer = function () {
+  spawn(node, [path.resolve(__dirname, '../lib/mockServer.js')], {
+    stdio: 'inherit'
+  });
+};
 
 if (specifiedFile) {
   process.env.SPECIFIED_FILE = path.resolve(process.cwd(), specifiedFile);
-  watchMockFiles(process.env.SPECIFIED_FILE);
+  if (isStartSocketServer) {
+    startMockServer();
+  } else {
+    watchMockFiles(process.env.SPECIFIED_FILE);
+  }
 } else if (watchDir) {
   process.env.SPECIFIED_DIR = path.resolve(process.cwd(), watchDir);
   // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
-  watchMockFiles(process.env.SPECIFIED_DIR);
+  if (isStartSocketServer) {
+    startMockServer();
+  } else {
+    watchMockFiles(process.env.SPECIFIED_DIR);
+  }
 } else {
   watchDir = process.env.SPECIFIED_DIR = path.resolve(process.cwd(), './mock');
   // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
-  watchMockFiles(watchDir);
+  if (isStartSocketServer) {
+    startMockServer();
+  } else {
+    watchMockFiles(watchDir);
+  }
 }

package/lib/manageMockFiles.js

@@ -2,7 +2,7 @@
  * @description: 生成Mock文件、获取mock数据统计
  * @Date: 2021-12-22 16:57:08
  * @LastEditors: chendq
- * @LastEditTime: 2021-12-30 13:29:00
+ * @LastEditTime: 2022-01-02 12:16:12
  * @Author: chendq
  */
 const fsa = require('fs-extra'),
@@ -10,10 +10,34 @@ const fsa = require('fs-extra'),
   path = require('path'),
   _ = require('lodash'),
   colors = require('colors/safe');
-const { getFileLatestContent, SupportMethods, filePath2ApiUrl, logger, getDataType } = require('./utils');
+const {
+  getFileLatestContent,
+  SupportMethods,
+  filePath2ApiUrl,
+  logger,
+  getDataType,
+  getLogger,
+  writeStream
+} = require('./utils');
 const log = logger(process.env.SILENT);
+const processArgv = process.env.ARGV ? JSON.parse(process.env.ARGV) : {};
 
 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
@@ -23,19 +47,27 @@ 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(
-      colors.red(
-        [`参数: apiUrl: ${apiUrl}, method: ${method}, mockDir: ${mockDir}, resJsonData: `, `必须是有效值`].join(',')
-      )
+      colors.red([`参数: apiUrl: ${apiUrl}, method: ${method}, mockDir: ${mockDir} `, `必须是有效值`].join(','))
     );
     return;
-  } else if (!['object', 'array'].includes(getDataType(resJsonData))) {
-    log.info(resJsonData, colors.red('参数resJsonData要求是数组或对象'));
+  } else if (
+    !['object', 'array'].includes(type) ||
+    (type === 'object' && Object.keys(resJsonData).length === 0) ||
+    (type === 'array' && resJsonData.length === 0)
+  ) {
+    log.info(
+      `参数: apiUrl: ${apiUrl}, method: ${method}, resJsonData:`,
+      resJsonData,
+      colors.red('， 参数字段resJsonData必须是非空的数组或对象！')
+    );
     return;
   }
   apiUrl = apiUrl.trim().split('?')[0];
+  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`);
@@ -71,12 +103,13 @@ const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mo
       return;
     }
     mockFileContent[method] = resJsonData;
-    Object.keys(mockFileContent).length > 0 &&
-      fsa.writeFileSync(mockFilePath, JSON.stringify(mockFileContent, null, 2));
+    await writeStream(mockFilePath, JSON.stringify(mockFileContent, null, 2));
+    LOGGER.log(`Update file:  ${method} ${apiUrl}  ${mockFilePath}`);
   } else {
     // fsa.ensureFileSync(mockFilePath);
-    Object.keys(mockFilePath).length > 0 &&
-      fsa.writeFileSync(mockFilePath, JSON.stringify({ [method]: resJsonData }, null, 2));
+
+    await writeStream(mockFilePath, JSON.stringify({ [method]: resJsonData }, null, 2));
+    LOGGER.log(`Write new file:  ${method} ${apiUrl}  ${mockFilePath}`);
   }
   // console.debug('file::', `${mockDir}/${apiUrl}`, newMockListContent);
 };
@@ -169,7 +202,7 @@ const getMockStatFromDir = dirPath => {
         }
       }
     });
-    fs.writeFileSync(mockListFilePath, JSON.stringify(reverseMockList, null, 2));
+    writeStream(mockListFilePath, JSON.stringify(reverseMockList, null, 2));
   }
   return mockDataMap;
 };

package/lib/mockServer.js

@@ -150,9 +150,9 @@ if (process.env.SOCKET_SERVER) {
     socket.on('mock-file-stat', function (filePath) {
       socket.emit('mock-file-stat', getMockStatFromFile(filePath));
     });
-    socket.on('save-data', function (data) {
+    socket.on('save-data', async function (data) {
       // console.log('lis save-data:', data);
-      genMockFiles(data);
+      await genMockFiles(data);
     });
 
     socket.on('disconnect', function () {

package/lib/utils.js

@@ -1,27 +1,40 @@
 /*
- * @description:
+ * @description: 工具函数库
  * @Date: 2021-12-25 17:52:48
  * @LastEditors: chendq
- * @LastEditTime: 2021-12-30 13:17:12
+ * @LastEditTime: 2022-01-02 12:32:33
  * @Author: chendq
  */
+const fs = require('fs');
+const path = require('path');
 /**
  * @description: 输出和错误输出写入不同文件
- * @param {*}
- * @return {*}
+ * @param {string} logFileDirPath
+ * @return {object}
  */
-const path = require('path');
-const getLogger = function () {
-  const fs = require('fs');
-  const output = fs.createWriteStream('./stdout.log');
-  const errorOutput = fs.createWriteStream('./stderr.log');
+const getLogger = function (logFileDirPath) {
+  const options = {
+    flags: 'a', // append模式
+    encoding: 'utf8' // utf8编码
+  };
+  const output = fs.createWriteStream(
+    path.resolve(logFileDirPath ? logFileDirPath : process.cwd(), './stdout.log'),
+    options
+  );
+  const errorOutput = fs.createWriteStream(
+    path.resolve(logFileDirPath ? logFileDirPath : process.cwd(), './stderr.log'),
+    options
+  );
   // 自定义日志打印
   const logger = new console.Console(output, errorOutput);
 
-  logger.log('向 stdout 中写入数据');
-  logger.error('向 stderr 中写入数据');
+  // logger.log('向 stdout 中写入数据');
+  // logger.error('向 stderr 中写入数据');
 
-  return logger;
+  return {
+    log: (...args) => logger.log.call(null, `[${dateFormat('YYYY-mm-dd HH:MM:SS:fff')}]  - `, ...args),
+    error: (...args) => logger.error.call(null, `[${dateFormat('YYYY-mm-dd HH:MM:SS:fff')}]  - `, ...args)
+  };
 };
 /**
  * @description: 格式化时间日期
@@ -29,7 +42,7 @@ const getLogger = function () {
  * @param {*} date
  * @returns {*}
  */
-function dateFormat(fmt, date) {
+function dateFormat(fmt, date = new Date()) {
   let ret;
   const opt = {
     'Y+': date.getFullYear().toString(), // 年
@@ -37,7 +50,8 @@ function dateFormat(fmt, date) {
     'd+': date.getDate().toString(), // 日
     'H+': date.getHours().toString(), // 时
     'M+': date.getMinutes().toString(), // 分
-    'S+': date.getSeconds().toString() // 秒
+    'S+': date.getSeconds().toString(), // 秒
+    'f+': date.getMilliseconds().toString() // 毫秒
     // 有其他格式化字符需求可以继续添加，必须转化成字符串
   };
   // eslint-disable-next-line guard-for-in
@@ -101,6 +115,56 @@ const filePath2ApiUrl = function (filePath) {
 const getDataType = function (data) {
   return Object.prototype.toString.call(data).slice(8, -1).toLowerCase();
 };
+/**
+ * @description: 流方式写文件（适合写超大文件）
+ * @param {string} filePath
+ * @param {object} data
+ * @return {promise}
+ */
+const writeStream = function (filePath, data) {
+  // 创建一个可写流   也会创建一个test1.txt文件
+  const writerStream = fs.createWriteStream(filePath);
+  return new Promise((resolve, reject) => {
+    // 将数据写入流
+    writerStream.write(data, 'utf-8');
+    // 标记文件的结束
+    writerStream.end();
+    writerStream.on('finish', () => {
+      resolve(data);
+      // console.log('写入完成');
+    });
+
+    writerStream.on('error', err => {
+      reject(err);
+      console.error(`${filePath} 写入失败`);
+    });
+  });
+};
+/**
+ * @description: 流方式读文件（适合写超大文件）
+ * @param {string} filePath
+ * @return {*}
+ */
+const readeStream = function (filePath) {
+  let data = '';
+  // 创建可读流
+  return new Promise((resovle, reject) => {
+    const readerStream = fs.createReadStream(filePath);
+    // 设置编码为 utf8。
+    readerStream.setEncoding('UTF8');
+    // 处理流事件 --> data, end, and error
+    readerStream.on('data', function (chunk) {
+      data += chunk;
+    });
+    readerStream.on('end', function () {
+      resovle(data);
+    });
+    readerStream.on('error', function (err) {
+      reject(err);
+      console.log(err.stack);
+    });
+  });
+};
 
 module.exports = {
   getLogger,
@@ -110,5 +174,7 @@ module.exports = {
   isValidMethod,
   getFileLatestContent,
   filePath2ApiUrl,
-  getDataType
+  getDataType,
+  writeStream,
+  readeStream
 };

package/package.json

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