mock-service-cli 3.7.0 → 4.0.0

package/lib/mockServer.js

@@ -1,497 +0,0 @@
-const express = require('express'), // 引入express
-  bodyParser = require('body-parser'),
-  { readdirSync, existsSync } = require('fs'),
-  os = require('os'),
-  path = require('path'),
-  colors = require('colors/safe'),
-  portfinder = require('portfinder'),
-  { exec } = require('child_process');
-const { createProxyMiddleware } = require('http-proxy-middleware');
-const ifaces = os.networkInterfaces();
-const { Server } = require('socket.io');
-const {
-  dateFormat,
-  logger,
-  SupportMethods,
-  DefaultHeaders,
-  getFileLatestContent,
-  filePath2ApiUrl,
-  isEmptyObj
-} = require('./utils');
-const { genMockFiles, getMockStatFromDir, getMockStatFromFile } = require('./manageMockFiles');
-const registeredApis = [];
-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 corsOrigin = [],
-  corsHeaders = '';
-
-const httpsRE = /^https:\/\//;
-let count = 0,
-  fileCount = 0, // 记录mock api个数,mock file个数
-  mockDirStat = {}, // 缓存mock目录的统计信息
-  mockFileStat = {}; // 缓存mock文件的统计信息
-
-// whether include web serve or not
-const includesWebServe = process.env.STATIC_DIRECTORY || process.env.WEB_ROOT;
-
-const mockFileOrDir = process.env.SPECIFIED_FILE || process.env.SPECIFIED_DIR;
-
-if (!process.env.PORT) {
-  portfinder.basePort = 8090;
-  portfinder.getPort(function (err, port) {
-    if (err) {
-      throw err;
-    }
-    process.env.PORT = port;
-    init();
-  });
-} else {
-  init();
-}
-
-/**
- * Init mock server
- */
-function init() {
-  if (process.env.CORS_ORIGIN) {
-    process.env.CORS_ORIGIN.split(/\s*,\s*/).forEach(function (h) {
-      corsOrigin.push(h);
-    }, this);
-
-    corsHeaders = DefaultHeaders;
-  }
-  if (process.env.CORS_HEADERS) {
-    process.env.CORS_HEADERS.split(/\s*,\s*/).forEach(function (h) {
-      corsHeaders += corsHeaders ? ', ' + h : h;
-    }, this);
-  }
-
-  app.use(crossDomain()); // 允许跨域
-  app.use(bodyParser.json()); // 解析body
-
-  // API 概览页面路由
-  app.get('/__api-overview', (req, res) => {
-    const htmlPath = path.resolve(__dirname, './api-overview.html');
-    if (existsSync(htmlPath)) {
-      res.sendFile(htmlPath);
-    } else {
-      res.status(404).send('API overview page not found');
-    }
-  });
-
-  // API 数据路由
-  app.get('/__api-data', (req, res) => {
-    // 按目录分组 API
-    const groupedApis = {};
-    registeredApis.forEach(api => {
-      // 从文件路径中提取相对路径作为目录
-      const dirPath = path.dirname(api.file);
-      if (!groupedApis[dirPath]) {
-        groupedApis[dirPath] = [];
-      }
-      groupedApis[dirPath].push(api);
-    });
-
-    res.json({
-      apis: registeredApis,
-      groupedApis: groupedApis,
-      port: process.env.PORT
-    });
-  });
-
-  let requireMockServe = true;
-  if (process.env.SPECIFIED_FILE) {
-    composeRouteFromJsFile(process.env.SPECIFIED_FILE);
-  } else if (includesWebServe && !existsSync(path.resolve(process.cwd(), process.env.SPECIFIED_DIR))) {
-    // 若包含web服务，则允许不启动mock服务
-    requireMockServe = false;
-  } else {
-    parseMockFiles(process.env.SPECIFIED_DIR);
-  }
-  requireMockServe && argv.a && log.info(colors.yellow(`${fileCount} mock file are parsed in total.`));
-  startServer();
-}
-
-/**
- * @description: 跨域设置
- * @param {*}
- * @return {*}
- */
-function crossDomain() {
-  return (req, res, next) => {
-    if (typeof argv.A === 'string') {
-      const resHeaders = {};
-      argv.A.split(/\s*,\s*/).forEach(function (h) {
-        const [key, value] = h.split('=');
-        resHeaders[key] = value;
-      }, this);
-      // 添加自定义响应头
-      for (const key in resHeaders) {
-        if (resHeaders.hasOwnProperty(key)) {
-          res.header(key, resHeaders[key]);
-        }
-      }
-    }
-
-    // 设置withCredentials: true时,需设置以下两项
-    res.header('Access-Control-Allow-Credentials', true);
-    // withCredentials, must be specified value instead of *
-    res.header('Access-Control-Allow-Origin', corsOrigin.includes(req.headers.origin) ? req.headers.origin : '*');
-    // res.header('Access-Control-Allow-Origin', '*');
-    res.header('Access-Control-Allow-Methods', SupportMethods.join(','));
-    res.header('Access-Control-Allow-Headers', corsHeaders ? corsHeaders : '*');
-    // res.header('Access-Control-Allow-Headers', '*');
-    if (req.method === 'OPTIONS') res.status(200); // 让OPTIONS快速返回
-    next();
-  };
-}
-
-/**
- * @description: 构建本地服务的路由请求
- * @param {*} file
- * @returns {*}
- */
-function composeRouteFromJsFile(file) {
-  // 先删除require之前导入的缓存文件,否则获取到的文件内容还是旧内容
-  const fileObject = getFileLatestContent(file);
-
-  argv.a && log.info(colors.green(`Mockfile ${++fileCount}: `), file, colors.yellow('all API URL is follows: '));
-  if (fileObject === 'getFileLatestContent_ERROR') {
-    // console.error(colors.red(`[warning] "${file}" 文件解析失败，请检查并确保文件中的js语法正确`));
-    return;
-  }
-  Object.keys(fileObject).forEach(item => {
-    let reqMethod = 'get',
-      reqUrl = item;
-    // 支持(GET|POST|PUT|DELETE|HEAD|PATCH|OPTIONS|COPY|LINK|UNLINK|PURGE)常用方法, 默认GET请求
-    const [, , method, url] = methodRegExp.exec(item);
-    if (method) {
-      reqMethod = method.toLowerCase();
-    }
-    reqUrl = url;
-    argv.a &&
-      log.info(
-        colors.grey(`path ${String(++count).padStart(3, ' ')}: `),
-        colors.cyan(reqMethod.padEnd(8, ' ')),
-        colors.cyan(reqUrl),
-        colors.grey(typeof fileObject[item])
-      );
-    log.assert(typeof app[reqMethod] === 'function', colors.red(`${file}, ${reqMethod}`));
-    if (typeof fileObject[item] === 'function') {
-      app[reqMethod](reqUrl, fileObject[item]);
-    } else if (typeof fileObject[item] === 'object') {
-      app[reqMethod](reqUrl, function (req, res) {
-        res.json(fileObject[item]);
-      });
-    }
-    // 收集 API 信息
-    registeredApis.push({
-      method: reqMethod.toUpperCase(),
-      url: reqUrl,
-      file: file,
-      data: fileObject[item]
-    });
-  });
-}
-/**
- * @description: 解析mock目录下的js文件，为构建路由请求做准备
- * @param {string} specialDir 目录路径
- * @return {void}
- */
-function parseMockFiles(specialDir = '../mock') {
-  const files = readdirSync(path.resolve(process.cwd(), specialDir), { withFileTypes: true });
-  const curFilesSize = files.length;
-  for (let index = 0; index < curFilesSize; index++) {
-    const el = files[index];
-    const filePath = path.normalize(`${specialDir}/${el.name}`);
-    // 递归目录
-    if (!el.isFile()) {
-      parseMockFiles(filePath);
-    }
-
-    // 处理存放mock数据的json文件
-    if (el.name.endsWith('.json') && el.name !== 'mock-list.json') {
-      argv.a &&
-        log.info(colors.green(`Mockfile ${++fileCount}: `), filePath, colors.yellow('all API URL is follows: '));
-      const fileObject = getFileLatestContent(filePath);
-      if (fileObject === 'getFileLatestContent_ERROR') {
-        // console.error(colors.red(`[warning] "${filePath}" 文件解析失败，请检查并确保文件中的js语法正确`));
-        continue;
-      }
-      // eslint-disable-next-line no-loop-func
-      Object.keys(fileObject).forEach(method => {
-        const apiUrl = filePath2ApiUrl(decodeURIComponent(el.name.split('.')[0]));
-        argv.a &&
-          log.info(
-            colors.grey(`path ${String(++count).padStart(3, ' ')}: `),
-            colors.cyan(method.padEnd(8, ' ')),
-            colors.cyan(apiUrl),
-            colors.grey(typeof fileObject[method])
-          );
-        log.assert(typeof app[method] === 'function', colors.red(`${filePath}, ${method}`));
-        app[method](apiUrl, function (req, res) {
-          res.json(fileObject[method]);
-        });
-        // 收集 API 信息
-        registeredApis.push({
-          method: method.toUpperCase(),
-          url: apiUrl,
-          file: filePath,
-          data: fileObject[method]
-        });
-      });
-      continue;
-    }
-
-    // 非js文件跳过
-    if (!el.name.endsWith('.js') && !el.name.endsWith('.cjs')) {
-      continue;
-    }
-    composeRouteFromJsFile(filePath);
-  }
-}
-
-/**
- * Start web server、socket server
- */
-function startServer() {
-  let webApp = null,
-    webPublicPath = '/',
-    proxyTable = {};
-  // Enable Web Server
-  if (process.env.WEB_ROOT) {
-    webApp = express();
-    // Enable web proxy
-    if (process.env.PROXY_OPTIONS) {
-      try {
-        const options = JSON.parse(process.env.PROXY_OPTIONS);
-        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}`), '');
-          }
-          // 接口代理
-          // 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));
-      }
-    }
-    // 添加自定义响应头
-    if (typeof argv.A === 'string') {
-      webApp.use((req, res, next) => {
-        const resHeaders = {};
-        argv.A.split(/\s*,\s*/).forEach(function (h) {
-          const [key, value] = h.split('=');
-          resHeaders[key] = value;
-        }, this);
-        // 添加自定义响应头
-        for (const key in resHeaders) {
-          if (resHeaders.hasOwnProperty(key)) {
-            res.header(key, resHeaders[key]);
-          }
-        }
-        next();
-      });
-    }
-    // console.log(process.env.WEB_PUBLIC_PATH, process.env.WEB_ROOT);
-    if (process.env.WEB_PUBLIC_PATH) {
-      webPublicPath = process.env.WEB_PUBLIC_PATH;
-    }
-    webApp.use(webPublicPath, express.static(process.env.WEB_ROOT)); // 将dist目录下所有文件作为静态文件来管理
-    const defaultStaticEntry = `${process.env.WEB_ROOT}/index.html`;
-    if (existsSync(defaultStaticEntry)) {
-      // Used as static HTTP server for SPA
-      webApp.get('*', (req, res) => {
-        res.sendFile(defaultStaticEntry);
-      });
-    } else {
-      // Used as api server for test on browser console or api request tools
-      webApp.use(webPublicPath, (req, res) => {
-        res.status(200)
-          .send(`Hi, welcome to web server entrance ui, you can test http proxy on browser console or api request tools. Examples as follows:<br />
-        fetch("http://localhost:${process.env.WEB_PORT}/api/permission/auth/login", {
-          method: 'post',
-          headers: {
-            "accept": "*/*",
-            "Content-type": "application/json; charset=UTF-8",
-          },
-          body:JSON.stringify({"loginName":"admin","password":"admin"})
-        })
-      `);
-      });
-    }
-  }
-  const http = require('http').createServer(app);
-  if (process.env.SOCKET_SERVER) {
-    const AsyncTaskQueue = require('./asyncTaskQueue');
-    const saveDataAsyncTask = new AsyncTaskQueue();
-
-    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.     --- ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`
-        )
-      );
-      socket.on('mock-dir-stat', function (dir) {
-        socket.emit('mock-dir-stat', isEmptyObj(mockDirStat) ? (mockDirStat = getMockStatFromDir(dir)) : mockDirStat);
-      });
-      socket.on('mock-file-stat', function (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);
-        saveDataAsyncTask.add(async(data));
-
-        if (saveDataAsyncTask.list.length === 1) {
-          saveDataAsyncTask.run();
-        } else {
-          saveDataAsyncTask.next();
-        }
-        // await genMockFiles(data);
-      });
-
-      socket.on('disconnect', function () {
-        log.info(
-          colors.gray(
-            `Socket client ${clientIp} has disconnected.     --- ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`
-          )
-        );
-      });
-    });
-  }
-
-  if (existsSync(mockFileOrDir)) {
-    http.listen(Number.parseInt(process.env.PORT, 10), () => {
-      console.info(colors.red('\n Mock File仅支持commonjs规范的js、cjs文件，不支持ES Module'));
-
-      console.info(
-        [
-          colors.yellow(`\n${process.env.RESTARTED ? 'Restarting' : 'Starting'} up mock-server, serving `),
-          colors.cyan(process.env.SPECIFIED_FILE || process.env.SPECIFIED_DIR),
-          colors.yellow(`  ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`)
-        ].join('')
-      );
-      if (!process.env.RESTARTED) {
-        console.info(
-          [colors.yellow('\n🌍  mock-server version: '), colors.cyan(require('../package.json').version), '\n'].join('')
-        );
-        console.info(colors.yellow(`\n Mock server available on:\n`));
-        console.info('    http://localhost:' + colors.green(process.env.PORT));
-        console.info(
-          '    ' +
-            colors.blue('API Overview: ') +
-            'http://localhost:' +
-            colors.green(process.env.PORT) +
-            colors.green('/__api-overview')
-        );
-        Object.keys(ifaces).forEach(function (dev) {
-          ifaces[dev].forEach(function (details) {
-            if (details.family === 'IPv4') {
-              console.info('    http://' + details.address + ':' + colors.green(process.env.PORT));
-            }
-          });
-        });
-      }
-
-      // 自动打开浏览器
-      if (process.env.OPEN_API_OVERVIEW && !process.env.RESTARTED) {
-        const apiOverviewUrl = `http://localhost:${process.env.PORT}/__api-overview`;
-        console.info(colors.yellow(`\nOpening API overview page...`));
-        let openCommand;
-        switch (process.platform) {
-          case 'darwin':
-            openCommand = `open ${apiOverviewUrl}`;
-            break;
-          case 'win32':
-            openCommand = `start ${apiOverviewUrl}`;
-            break;
-          case 'linux':
-            openCommand = `xdg-open ${apiOverviewUrl}`;
-            break;
-          default:
-            console.warn(colors.yellow(`Could not automatically open browser. Please visit: ${apiOverviewUrl}`));
-            return;
-        }
-        exec(openCommand, error => {
-          if (error) {
-            console.warn(colors.yellow(`Could not automatically open browser. Please visit: ${apiOverviewUrl}`));
-          }
-        });
-      }
-    });
-  }
-
-  if (webApp && !process.env.RESTARTED) {
-    webApp.listen(Number.parseInt(process.env.WEB_PORT, 10), () => {
-      console.info(colors.yellow(`\n Web server available on:\n`));
-      console.info('    http://localhost:' + colors.green(process.env.WEB_PORT) + webPublicPath);
-      Object.keys(ifaces).forEach(function (dev) {
-        ifaces[dev].forEach(function (details) {
-          if (details.family === 'IPv4') {
-            console.info('    http://' + details.address + ':' + colors.green(process.env.WEB_PORT) + webPublicPath);
-          }
-        });
-      });
-      if (!isEmptyObj(proxyTable)) {
-        console.info(colors.yellow(`\n Enable proxy at web server on:`));
-        Object.keys(proxyTable).forEach(prefix => {
-          console.info(`    ${prefix}   ->  ${proxyTable[prefix]}`);
-        });
-      }
-    });
-  }
-}
-
-if (process.platform === 'win32') {
-  require('readline')
-    .createInterface({
-      input: process.stdin,
-      output: process.stdout
-    })
-    .on('SIGINT', function () {
-      process.emit('SIGINT');
-    });
-}
-
-process.on('SIGINT', function () {
-  log.info(colors.red('mock-server process stopped.'));
-  process.exit();
-});
-
-process.on('SIGTERM', function () {
-  log.info(colors.red('mock-server process stopped.'));
-  process.exit();
-});
-
-module.exports = {
-  composeRouteFromJsFile,
-  parseMockFiles
-};

package/lib/staticServer.js

@@ -1,104 +0,0 @@
-/*
- * Static Server
- * @Date: 2023-12-03 18:02:24
- * @LastEditors: chendq
- * @LastEditTime: 2025-07-29 19:20:21
- * @Author      : chendq
- */
-const express = require('express'), // 引入express
-  os = require('os'),
-  colors = require('colors/safe'),
-  portfinder = require('portfinder');
-const { dateFormat, logger } = require('./utils');
-const ifaces = os.networkInterfaces();
-const log = logger(process.env.SILENT);
-const argv = JSON.parse(process.env.ARGV);
-
-const resHeaders = {};
-
-if (!process.env.PORT) {
-  portfinder.basePort = 8090;
-  portfinder.getPort(function (err, port) {
-    if (err) {
-      throw err;
-    }
-    process.env.PORT = port;
-    startServer();
-  });
-} else {
-  startServer();
-}
-
-/**
- * @description: 添加自定义响应头
- * @param {*}
- * @return {*}
- */
-function appendResHeaders() {
-  return (req, res, next) => {
-    for (const key in resHeaders) {
-      if (resHeaders.hasOwnProperty(key)) {
-        res.header(key, resHeaders[key]);
-      }
-    }
-    next();
-  };
-}
-
-/**
- * Start server
- */
-function startServer() {
-  const app = express();
-
-  if (typeof argv.A === 'string') {
-    argv.A.split(/\s*,\s*/).forEach(function (h) {
-      const [key, value] = h.split('=');
-      resHeaders[key] = value;
-    }, this);
-    app.use(appendResHeaders()); // 添加响应头
-  }
-
-  app.use(express.static(process.env.STATIC_DIRECTORY)); // 将dist目录下所有文件作为静态文件来管理
-
-  app.listen(Number.parseInt(process.env.PORT, 10), () => {
-    console.info(
-      [
-        colors.yellow(`\nStarting up Static Server, serving `),
-        colors.cyan(process.env.STATIC_DIRECTORY),
-        colors.yellow(`  ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`)
-      ].join('')
-    );
-
-    console.info(colors.yellow(`\n Static Server available on:\n`));
-    console.info('    http://localhost:' + colors.green(process.env.PORT));
-    Object.keys(ifaces).forEach(function (dev) {
-      ifaces[dev].forEach(function (details) {
-        if (details.family === 'IPv4') {
-          console.info('    http://' + details.address + ':' + colors.green(process.env.PORT));
-        }
-      });
-    });
-  });
-}
-
-if (process.platform === 'win32') {
-  require('readline')
-    .createInterface({
-      input: process.stdin,
-      output: process.stdout
-    })
-    .on('SIGINT', function () {
-      process.emit('SIGINT');
-    });
-}
-
-process.on('SIGINT', function () {
-  log.info(colors.red('static-server process stopped.'));
-  process.exit();
-});
-
-process.on('SIGTERM', function () {
-  log.info(colors.red('static-server process stopped.'));
-  process.exit();
-});