mock-service-cli 3.1.1 → 3.1.3

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.
 
+### [3.1.3](https://github.com/chandq/mock-service-cli/compare/v3.1.2...v3.1.3) (2022-09-23)
+
+
+### Bug Fixes
+
+* support rewrite proxy request url prefix ([621a2c5](https://github.com/chandq/mock-service-cli/commit/621a2c530f4003d7e29023a69bc22335e76a39c3))
+
+### [3.1.2](https://github.com/chandq/mock-service-cli/compare/v3.1.1...v3.1.2) (2022-08-07)
+
 ### [3.1.1](https://github.com/chandq/mock-service-cli/compare/v3.1.0...v3.1.1) (2022-07-25)
 
 

package/README.md

@@ -10,15 +10,32 @@
 
 ### 简介
 
-内置 Mock Server、Web Server、Http request proxy 等功能集。
+内置 Mock Server、Web Server、Http?s request proxy 等功能集。
 
-**简易轻量**、**B/S 架构**、**0 秒启动**的本地命令行 Mock 服务套件， 支持热更新，对于开发调试 mock 数据很实用，能提高前端开发者的开发效率。支持 `GET`,`POST`,`PUT`,`DELETE`,`PATCH`,`OPTIONS`,`COPY`,`LINK`,`UNLINK`,`PURGE` 等常用请求类型，无需布署后端，可能是本地最好用的 Mock 工具。支持以下常见业务场景：
+**简易轻量**、**B/S 架构**、**0 秒启动**的本地命令行 Mock 服务套件， 支持热更新，对于开发调试 mock 数据很实用，能提高前端开发者的开发效率。支持 `GET`,`POST`,`PUT`,`DELETE`,`PATCH`,`OPTIONS`,`COPY`,`LINK`,`UNLINK`,`PURGE` 等常用请求类型，无需布署后端，可能是本地最好用的 Mock 工具之一。
+
+#### Mock Server - 本地 Mock 服务器
+
+支持以下常见业务场景：
 
 - [x] 无服务端演示项目的数据 Mock
 - [x] 业务开发接口联调前的数据 Mock
 - [x] 保留业务项目的所有或部分接口的响应数据(写入文件)
 - [x] 保障前端开发调试不受后端服务影响(当后端服务挂掉或部分接口响应异常时启用 Mock)
 
+#### Web Server - SPA Web 服务器
+
+对 React、Vue 等单页应用项目构建生成的 dist 目录，启动本地 web 服务器（相当于使用本地安装的 nginx 服务）来模拟运行生产环境下的 web 服务
+
+#### Http request proxy - 基于浏览器的本地代理服务
+
+实现了本地接口代理的能力，一般接口测试工具无法查看到 request 和 response 中 headers 的更多详情，这里实现了接口代理功能，在 Network 中可查看接口调用的详细信息。
+
+> 两种应用场景
+
+- 项目 dev 模式下的接口代理请求
+- Chrome 的 Console 执行 fetch 请求（用于接口测试）
+
 ## Installation:
 
 #### Running on-demand:

package/bin/mock-service-cli

@@ -32,6 +32,7 @@ if (argv.h || argv.help) {
       '  -H --cors-headers   Optionally provide CORS headers list separated by commas. default *',
       '',
       '  -O --proxy-options          Optionally provide proxy options list separated by commas.',
+      '  -r --rewrite          rewrite http or https request url prefix of proxy, default false.',
       '  -P --web-port                 Web server port to use. If 0, look for open port. [9090]',
       '  -D --web-dir        Enable web server, specify web directory, default [./dist] directory',
       '  -b --web-baseurl    Specify website public path when enabled web server.',
@@ -51,6 +52,7 @@ var port = argv.p || argv.port,
   specifiedFile = argv.f || argv.file,
   version = argv.v || argv.version,
   isStartSocketServer = argv.S || false,
+  rewrite = argv.r || argv.rewrite || false,
   log = null;
 
 if (!argv.s && !argv.silent) {
@@ -74,7 +76,7 @@ if (version) {
   log.info('v' + require('../package.json').version);
   process.exit();
 }
-
+injectEnvVariable('PREFIX_REWRITE', rewrite);
 injectEnvVariable('CORS_ORIGIN', argv.o || argv['cors-origin']);
 injectEnvVariable('CORS_HEADERS', argv.H || argv['cors-headers']);
 

package/lib/mockServer.js

@@ -27,6 +27,7 @@ let socketServer = null; // Socket server instance
 const AsyncTaskQueue = require('./asyncTaskQueue');
 const saveDataAsyncTask = new AsyncTaskQueue();
 
+const httpsRE = /^https:\/\//;
 let count = 0,
   fileCount = 0, // 记录mock api个数,mock file个数
   mockDirStat = {}, // 缓存mock目录的统计信息
@@ -172,10 +173,23 @@ if (process.env.WEB_ROOT) {
   if (process.env.PROXY_OPTIONS) {
     try {
       const options = JSON.parse(process.env.PROXY_OPTIONS);
-      Object.keys(options).forEach(function (origin) {
-        proxyTable[origin] = options[origin];
+      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}`), '');
+        }
         // 接口代理
-        webApp.use(origin, createProxyMiddleware({ target: options[origin], changeOrigin: true, ws: true }));
+        // 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));
@@ -291,8 +305,8 @@ if (webApp && !process.env.RESTARTED) {
     });
     if (!isEmptyObj(proxyTable)) {
       console.info(colors.yellow(`\n Enable proxy at web server on:`));
-      Object.keys(proxyTable).forEach(origin => {
-        console.info(`    ${origin}   ->  ${proxyTable[origin]}`);
+      Object.keys(proxyTable).forEach(prefix => {
+        console.info(`    ${prefix}   ->  ${proxyTable[prefix]}`);
       });
     }
   });

package/package.json

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