feat: mock and action config

code-by-ai · code-by-ai · commit 3b39f75e2911 · 2024-10-06T13:46:58.000+08:00
diff --git a/README.md b/README.md
@@ -6,17 +6,23 @@
 - 安装和启动方便
 
 待办：
-- [待确认]支持版本：node>=14
-- 发布启动的配置信息汇总，提示产品使用文档：CLI使用说明，配置说明mock.config.json
-- 同时只能支持一个风格，当风格切换时，检测到有mock文件夹，则提示清空
+- [已完成]支持版本：node>=18
+- [已完成]发布启动的配置信息汇总，提示产品使用文档：CLI使用说明，配置说明mock.config.json，提示当前运行的action风格还是restful风格
+- [已完成]读取配置文件，全局使用处理，并确认默认文件的优先级：命令行 > 配置文件 > 默认配置
+- [已完成]如何remote api,网络不通，进行告警，并不再转发
 - TODO: restful: 读取swagger，生成json，处理中，晚上CLI的文档，用来测试
-- TODO: 读取配置文件，全局使用处理
-- TODO: .js默认加载
-- TODO: mock能力细节处理
-- 安装则生成mock.config.json
+  - ACL文档的返回值
+- 上传npm的时候，指定文件
 - 生成单元测试
+- CLI使用文档
 - 录制演示视频
 - 优化打印日志，全部英文显示
+- 配置npm可以发布的文件
+- 支持自动生成mock.config.json
+- 同时只能支持一个风格，当风格切换时，检测到有mock文件夹，则提示清空
+  - 当用户之前用restful风格，后面切换成了action后，在代码里面兼容，如果读取格式不对，就报错
+- TODO: .js默认加载
+- TODO: mock能力细节处理，支持不走本地的local json
 
 ### 二、启动一个Mock-API服务
 
diff --git a/bin/config.js b/bin/config.js
@@ -8,27 +8,47 @@ export const commandOptions = [
       type: {
         alias: 't',
         type: 'string',
-        default: 'restful',
         describe: '选择API类型',
         choices: ['restful', 'action']
       },
       port: {
-        alias: 'P',
+        alias: 'p',
         type: 'number',
-        default: 9000,
         describe: '选择启动的端口号'
-      },
-      create: {
-        alias: 'c',
-        type: 'boolean',
-        default: false,
-        describe: '如果mock目录不存在是否自动创建，默认不自动创建'
       }
+      // create: {
+      //   alias: 'c',
+      //   type: 'boolean',
+      //   default: false,
+      //   describe: '如果mock目录不存在是否自动创建，默认不自动创建'
+      // }
     },
     callback: async argv => {
       mock({
         ...argv
       });
     }
+  },
+  {
+    command: 'config',
+    descriptions: '【开发中】自动在根目录下生成mock.config.json',
+    options: {
+      type: {
+        alias: 't',
+        type: 'string',
+        describe: '选择API类型',
+        default: 'restful',
+        choices: ['restful', 'action']
+      },
+      port: {
+        alias: 'p',
+        type: 'number',
+        default: 9000,
+        describe: '选择启动的端口号'
+      }
+    },
+    callback: async argv => {
+      console.log("【开发中】自动在根目录下生成mock.config.json", argv)
+    }
   }
 ];
diff --git a/command/action.js b/command/action.js
@@ -2,13 +2,12 @@ import fs from 'fs';
 import { createProxyMiddleware } from 'http-proxy-middleware';
 import { ResponseExample } from './response.js';
 import { getAllAction } from '../utils/index.js';
-import { getConfig } from '../utils/config.js';
 import { generateApi, createAPIFile, fetchAndCreateRoutes } from './localAction.js';
 
 
-const action = async ({ app, filePath }) => {
+const action = async ({ app, filePath, config }) => {
   // TODO: 配置信息需要统一处理，作为全局使用，type的每个优先级需要确认和逻辑开发
-  const { proxyApiUrl, swaggerApiJSON=[] } = await getConfig();
+  const { proxyApiUrl, swaggerApi=[] } = config;
   
   // 如果 mock 文件夹不存在，自动创建它
   if (!fs.existsSync(filePath)) {
@@ -22,26 +21,14 @@ const action = async ({ app, filePath }) => {
     return;
   }
   
-  // Step 1: 中间件来拦截请求并动态修改 URL
-  // app.use('/', (req, res, next) => {
-  //   const { Action } = req.body;
-  //   if (!Action) {
-  //     // 如果请求体中没有 Action，返回 400 错误
-  //     return res.status(400).send({ error: 'Action field is required' });
-  //   }
-  //   // 动态修改请求的 URL，将它转发到 /{Action} 路径
-  //   req.url = `/${Action}`;
-  //   next();  // 继续处理下一个中间件
-  // });
-
-  // Step2: 为每个 action 注册对应的路由
+  // Step1: 为每个 action 注册对应的路由
   generateApi(app, filePath, allActions);
   
-  // Step3: 获取swagger api json的数据，注册接口
+  // Step2: 获取swagger api json的数据，注册接口
   // 调用 fetchAndCreateRoutes 函数
-  await fetchAndCreateRoutes({app, swaggerApiJSON});
+  await fetchAndCreateRoutes({app, swaggerApi});
   
-  // Step4: 获取代理配置并设置代理
+  // Step3: 获取代理配置并设置代理
   if (proxyApiUrl) {
     app.use('*', createProxyMiddleware({
         target: proxyApiUrl,
diff --git a/command/localAction.js b/command/localAction.js
@@ -75,8 +75,8 @@ export const createRoutes = ({ app, data }) => {
   };
   
   // Step3: 获取swagger api json的数据，注册接口
-export const fetchAndCreateRoutes = async ({ app, swaggerApiJSON }) => {
-    const routePromises = swaggerApiJSON.map(async (item) => {
+export const fetchAndCreateRoutes = async ({ app, swaggerApi }) => {
+    const routePromises = swaggerApi.map(async (item) => {
       const { type, url } = item;
       if (type === 'action') {
         try {
diff --git a/command/middleware.js b/command/middleware.js
@@ -1,4 +1,4 @@
-import { defaultConfig } from '../utils/default.config.js';
+import defaultConfig from '../utils/defaultConfig.js';
 import { setHeader } from '../utils/index.js';
 export const cors = (req, res, next) => {
   res.header('Access-Control-Allow-Origin', '*'); //访问控制允许来源：所有
@@ -33,7 +33,6 @@ export const headerSetting = (req, res, next) => {
 // action中间件的转化
 export const actionTransfer = (req, res, next) => {
   const { Action } = req.body;
-  console.log('actionTransfer', Action);
   if (!Action) {
     // 如果请求体中没有 Action，返回 400 错误
     return res.status(400).send({ error: 'Action field is required' });
diff --git a/command/restful.js b/command/restful.js
@@ -1,10 +1,9 @@
 import { createProxyMiddleware } from 'http-proxy-middleware';
-import { getConfig } from '../utils/config.js';
 import { getAllAPIPath } from '../utils/index.js';
 import { checkFileExist, checkFileExistsAndRespond } from './localRestful.js';
 
-
-const restful = async ({ app, filePath }) => {
+const restful = async ({ app, filePath, config }) => {
+  const { proxyApiUrl } = config;
   // 如果没有文件，新建example
   checkFileExist(filePath, true)
   console.log(filePath)
@@ -15,7 +14,6 @@ const restful = async ({ app, filePath }) => {
     checkFileExistsAndRespond(url, filePath, req, res);
   });
   // 没有本地mock，则读取远程接口
-  const { proxyApiUrl } = await getConfig();
   if (proxyApiUrl) {
     const proxyMiddleware = createProxyMiddleware({
       target: proxyApiUrl,
diff --git a/index.js b/index.js
@@ -1,85 +1,11 @@
-import express from 'express';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import logger from './utils/logger.js';
-import { cors, timeoutSetting, actionTransfer } from './command/middleware.js';
-import restful from './command/restful.js';
-import action from './command/action.js';
-import { ConfirmPort } from './utils/prompt.js';
-import { getIdlePort } from './utils/index.js';
-
-// 获取当前文件路径（解决 ESM 模块路径问题）
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-// 静态资源路径
-const staticPath = path.join(__dirname, 'public');
-
-// 表单提交处理函数
-const handleFormSubmission = (req, res) => {
-  const { name, email } = req.body;
-  console.log(`Received form submission: Name=${name}, Email=${email}`);
-  res.send(`<h2>Thank you, ${name}! Your email is ${email}</h2>`);
-  process.exit(0); // 停止 CLI 工具
-};
-
-// 服务器启动日志
-const logServerStart = (port, type) => {
-  const examples = {
-    action: `curl --location --request POST 'http://localhost:${port}' --header 'Content-Type: application/json' --data-raw '{ "Action": "Query" }'`,
-    restful: `curl --location --request GET 'http://localhost:${port}/v1/user' --header 'Content-Type: application/json'`,
-  };
-  logger.success(`Mock API listening on port ${port}!`);
-  logger.success(`example: ${examples[type]}`);
-};
-
-// 启动服务器
-const startServer = (app, port, type) => {
-  app.listen(port, () => logServerStart(port, type));
-};
-
-// 模拟服务器
-const mock = async ({ port, type }) => {
-  // open port
-  const newPort = await getIdlePort(port);
-  let confirmPortResult = true;
-  if (port !== newPort) {
-    confirmPortResult = await ConfirmPort(port, newPort);
-    if (confirmPortResult) {
-      port = newPort;
-    } else {
-      logger.output.error(
-        `The current port is occupied and the service cannot be started. Please close the current port and try again.`,
-      );
-      process.exit(0);
-    }
-  }
-  
-  // 启动express
-  const app = express();
-  const filePath = path.join(process.cwd(), './mock');
-
-  app.use(express.urlencoded({ extended: true }));
-  app.use(express.json({ limit: '50mb' }));
-  app.use(express.static(staticPath));
-
-  // 渲染 HTML 表单页面
-  app.get('/monto/docs', (req, res) => res.sendFile(path.join(staticPath, 'index.html')));
-  
-  // 处理表单提交
-  app.post('/submit', handleFormSubmission);
-
-  // 通用中间件
-  app.all('*', cors);
-  app.all('*', timeoutSetting);
-  if (type === 'action') {
-    app.all("*", actionTransfer)
-  }
-
-  // 根据类型加载相应模块
-  const loadModule = type === 'action' ? action : restful;
-  loadModule({ app, filePath });
-
-  startServer(app, port, type);
-};
+import MockServer from './server.js';
+import ConfigManager from './utils/config.js';
+
+const mock = async (commandArgs) => {
+  const GlobalConfig = new ConfigManager();
+  const config = await GlobalConfig.getConfig(commandArgs);
+  const mockServer = new MockServer(config);
+  mockServer.start();
+}
 
 export default mock;
diff --git a/package.json b/package.json
@@ -3,6 +3,16 @@
   "version": "0.0.3",
   "description": "a react-cli and create react app",
   "main": "index.js",
+  "files": [
+    "bin",
+		"command",
+    "public",
+    "utils",
+		"index.js",
+    "package.json",
+		"server.js",
+		"README.md"
+	],
   "type": "module",
   "bin": {
     "dev-mock-cli": "./bin/index.js"
diff --git a/server.js b/server.js
@@ -0,0 +1,63 @@
+import express from 'express';
+import path from 'path';
+
+import { cors, timeoutSetting, actionTransfer } from './command/middleware.js';
+import restful from './command/restful.js';
+import action from './command/action.js';
+import { ConfirmPort } from './utils/prompt.js';
+import { getIdlePort } from './utils/index.js';
+import { logServerStart, handleFormSubmission } from './utils/serverUtils.js';
+
+class MockServer {
+  constructor(config) {
+    this.config = config;
+    this.port = config.port;
+    this.type = config.type;
+    this.staticPath = path.join(process.cwd(), 'public');
+    this.filePath = path.join(process.cwd(), './mock');
+  }
+
+  // 启动服务器
+  async start() {
+    const newPort = await getIdlePort(this.port);
+    let confirmPortResult = true;
+
+    if (this.port !== newPort) {
+      confirmPortResult = await ConfirmPort(this.port, newPort);
+      if (confirmPortResult) {
+        this.port = newPort;
+      } else {
+        console.error('The current port is occupied and the service cannot be started.');
+        process.exit(0);
+      }
+    }
+
+    const app = express();
+    app.use(express.urlencoded({ extended: true }));
+    app.use(express.json({ limit: '50mb' }));
+    app.use(express.static(this.staticPath));
+
+    app.get('/monto/docs', (req, res) => res.sendFile(path.join(this.staticPath, 'index.html')));
+    app.post('/submit', handleFormSubmission);
+
+    // 通用中间件
+    app.all('*', cors);
+    app.all('*', timeoutSetting);
+    if (this.type === 'action') {
+      app.all('*', actionTransfer);
+    }
+
+    // 根据类型加载模块
+    const loadModule = this.type === 'action' ? action : restful;
+    loadModule({ app, filePath: this.filePath, config: this.config });
+
+    this.startServer(app);
+  }
+
+  // 启动Express服务器并打印启动日志
+  startServer(app) {
+    app.listen(this.port, () => logServerStart(this.port, this.type));
+  }
+}
+
+export default MockServer;
diff --git a/utils/config.js b/utils/config.js
diff --git a/utils/defaultConfig.js b/utils/defaultConfig.js
diff --git a/utils/serverUtils.js b/utils/serverUtils.js
