@qse/edu-scripts 1.13.10 → 1.13.12

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # 更新日志
 
+## 1.13.12 (2023-08-24)
+
+- fix: 降低级 prettier
+
+## 1.13.11 (2023-08-10)
+
+- feat: mock 支持 `path-to-regexp` 规则
+- fix: 修复 mock 导致 proxy 失效
+
 ## 1.13.10 (2023-08-10)
 
 - fix: 清理 mock 的 console.log，优化提示效果

package/lib/config/plugins/mock-server/index.js

@@ -3,10 +3,13 @@ var paths = require("../../paths");
 var globby = require("globby");
 var chokidar = require("chokidar");
 var debounce = require("lodash/debounce");
+var memoize = require("lodash/memoize");
 var chalk = require("chalk");
 var fs = require("fs-extra");
 var express = require("express");
 var cookieParser = require("cookie-parser");
+var multer = require("multer");
+var { pathToRegexp } = require("path-to-regexp");
 var mockCache = {};
 var isSetup = false;
 var setupMock = debounce(function setupMock2() {
@@ -22,26 +25,80 @@ var setupMock = debounce(function setupMock2() {
     try {
       let mock = require(file);
       mock = mock.default || mock;
-      mockCache = { ...mockCache, ...mock };
+      for (const key in mock) {
+        const [method, path] = key.split(" ");
+        mockCache[key] = { method, path, handler: mock[key] };
+      }
     } catch (e) {
       console.error(chalk.red(`Mock file ${file} error: ${e.message}`));
     }
   }
 }, 100);
+var getPathReAndKeys = memoize((path) => {
+  const keys = [];
+  const re = pathToRegexp(path, keys);
+  return { re, keys };
+});
+function decodeParam(val) {
+  if (typeof val !== "string" || val.length === 0) {
+    return val;
+  }
+  try {
+    return decodeURIComponent(val);
+  } catch (err) {
+    if (err instanceof URIError) {
+      err.message = `Failed to decode param ' ${val} '`;
+      err.status = 400;
+      err.statusCode = 400;
+    }
+    throw err;
+  }
+}
 function mockMiddlewave(req, res, next) {
   const { method, path } = req;
-  const key = `${method.toUpperCase()} ${path}`;
-  const mock = mockCache[key];
-  if (mock) {
-    console.log(chalk.green(`Mock: ${key}`));
-    if (typeof mock === "function") {
-      mock(req, res, next);
-    } else {
-      res.json(mock);
+  for (const key in mockCache) {
+    const mock = mockCache[key];
+    if (mock.method !== method)
+      continue;
+    const { keys, re } = getPathReAndKeys(mock.path);
+    const m = re.exec(path);
+    if (m) {
+      console.log(chalk.green(`Mock: ${key}`));
+      res.setHeader("X-Mock", key);
+      if (typeof mock.handler === "function") {
+        const params = {};
+        for (let i = 1; i < m.length; i += 1) {
+          const key2 = keys[i - 1];
+          const prop = key2.name;
+          const val = decodeParam(m[i]);
+          if (val !== void 0) {
+            params[prop] = val;
+          }
+        }
+        req.params = params;
+        const middelwaves = [
+          express.urlencoded({ limit: "5mb", extended: true }),
+          express.json({ limit: "5mb", strict: false }),
+          multer().any(),
+          cookieParser(),
+          mock.handler
+        ];
+        const throwNext = () => {
+          console.log(chalk.red(`Mock: ${key} don't use next()`));
+          res.sendStatus(500);
+        };
+        const mwNext = () => {
+          const middelwave = middelwaves.shift();
+          middelwave(req, res, middelwaves.length ? mwNext : throwNext);
+        };
+        mwNext();
+      } else {
+        res.json(mock.handler);
+      }
+      return;
     }
-  } else {
-    next();
   }
+  next();
 }
 function setupMockServer(middelwaves, devServer) {
   if (!fs.existsSync(paths.mock))
@@ -52,9 +109,6 @@ function setupMockServer(middelwaves, devServer) {
     only: [/\/mock\//, /\/src\//],
     extensions: [".js", ".ts"]
   });
-  devServer.app.use(express.urlencoded({ extended: false }));
-  devServer.app.use(express.json());
-  devServer.app.use(cookieParser());
   middelwaves.unshift({
     name: "edu-scripts-mock-middelwave",
     middleware: mockMiddlewave

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qse/edu-scripts",
-  "version": "1.13.10",
+  "version": "1.13.12",
   "author": "Kinoko",
   "license": "MIT",
   "description": "教育工程化基础框架",
@@ -53,6 +53,7 @@
     "cookie-parser": "^1.4.6",
     "css-loader": "^6.8.1",
     "cssnano": "^6.0.1",
+    "debug": "^4.3.4",
     "esbuild-loader": "^2.21.0",
     "express": "^4.18.2",
     "filesize": "^8.0.7",
@@ -64,14 +65,16 @@
     "less": "^3.13.1",
     "less-loader": "^10.2.0",
     "lodash": "^4.17.21",
+    "multer": "^1.4.5-lts.1",
     "open": "^8.4.2",
+    "path-to-regexp": "^6.2.1",
     "postcss": "^8.4.27",
     "postcss-flexbugs-fixes": "^5.0.2",
     "postcss-loader": "^7.3.3",
     "postcss-momentum-scrolling": "^3.14.22",
     "postcss-normalize": "^8.0.1",
     "postcss-preset-env": "^9.1.0",
-    "prettier": "^3.0.0",
+    "prettier": "^2.8.8",
     "prettier-plugin-tailwindcss": "^0.4.1",
     "react-refresh": "^0.14.0",
     "recursive-readdir": "^2.2.3",

package/src/config/plugins/mock-server/index.js

@@ -2,10 +2,17 @@ const paths = require('../../paths')
 const globby = require('globby')
 const chokidar = require('chokidar')
 const debounce = require('lodash/debounce')
+const memoize = require('lodash/memoize')
 const chalk = require('chalk')
 const fs = require('fs-extra')
 const express = require('express')
 const cookieParser = require('cookie-parser')
+const multer = require('multer')
+const { pathToRegexp } = require('path-to-regexp')
+
+/**
+ * @type {Record<string,{handler:any;method:string;path:string}>}
+ */
 let mockCache = {}
 let isSetup = false
 
@@ -30,30 +37,92 @@ const setupMock = debounce(function setupMock() {
     try {
       let mock = require(file)
       mock = mock.default || mock
-      mockCache = { ...mockCache, ...mock }
+
+      for (const key in mock) {
+        const [method, path] = key.split(' ')
+        mockCache[key] = { method, path, handler: mock[key] }
+      }
     } catch (e) {
       console.error(chalk.red(`Mock file ${file} error: ${e.message}`))
     }
   }
 }, 100)
 
+const getPathReAndKeys = memoize((path) => {
+  const keys = []
+  const re = pathToRegexp(path, keys)
+  return { re, keys }
+})
+
+function decodeParam(val) {
+  if (typeof val !== 'string' || val.length === 0) {
+    return val
+  }
+  try {
+    return decodeURIComponent(val)
+  } catch (err) {
+    if (err instanceof URIError) {
+      err.message = `Failed to decode param ' ${val} '`
+      // @ts-ignore
+      err.status = 400
+      // @ts-ignore
+      err.statusCode = 400
+    }
+    throw err
+  }
+}
+
 /**
  * @type {import('express').RequestHandler}
  */
 function mockMiddlewave(req, res, next) {
   const { method, path } = req
-  const key = `${method.toUpperCase()} ${path}`
-  const mock = mockCache[key]
-  if (mock) {
-    console.log(chalk.green(`Mock: ${key}`))
-    if (typeof mock === 'function') {
-      mock(req, res, next)
-    } else {
-      res.json(mock)
+  for (const key in mockCache) {
+    const mock = mockCache[key]
+    if (mock.method !== method) continue
+    const { keys, re } = getPathReAndKeys(mock.path)
+    const m = re.exec(path)
+    if (m) {
+      console.log(chalk.green(`Mock: ${key}`))
+      res.setHeader('X-Mock', key)
+
+      if (typeof mock.handler === 'function') {
+        const params = {}
+        for (let i = 1; i < m.length; i += 1) {
+          const key = keys[i - 1]
+          const prop = key.name
+          const val = decodeParam(m[i])
+          if (val !== undefined) {
+            params[prop] = val
+          }
+        }
+        req.params = params
+
+        const middelwaves = [
+          express.urlencoded({ limit: '5mb', extended: true }),
+          express.json({ limit: '5mb', strict: false }),
+          multer().any(),
+          cookieParser(),
+          mock.handler,
+        ]
+
+        const throwNext = () => {
+          console.log(chalk.red(`Mock: ${key} don't use next()`))
+          res.sendStatus(500)
+        }
+
+        const mwNext = () => {
+          const middelwave = middelwaves.shift()
+          middelwave(req, res, middelwaves.length ? mwNext : throwNext)
+        }
+        mwNext()
+      } else {
+        res.json(mock.handler)
+      }
+      return
     }
-  } else {
-    next()
   }
+  next()
 }
 
 /**
@@ -70,10 +139,6 @@ function setupMockServer(middelwaves, devServer) {
     extensions: ['.js', '.ts'],
   })
 
-  devServer.app.use(express.urlencoded({ extended: false }))
-  devServer.app.use(express.json())
-  devServer.app.use(cookieParser())
-
   middelwaves.unshift({
     name: 'edu-scripts-mock-middelwave',
     middleware: mockMiddlewave,

package/src/utils/defineConfig.ts

@@ -9,7 +9,7 @@ export type BabelImportPlugin = [
     camel2DashComponentName?: boolean
     style?: boolean | 'css' | ((name: string) => string)
   },
-  string,
+  string
 ]
 export type BabelConfig = {
   presets: any[]