vite-plugin-mock-dev-server 0.4.2 → 0.4.3

package/README.md

@@ -433,7 +433,22 @@ export default defineMock({
 })
 ```
 
-#### Example 8：
+#### Example 8:
+Dynamic route matching
+```ts
+export default defineMock({
+  url: '/api/user/:userId',
+  body({ params }) {
+    return {
+      userId: params.userId,
+    }
+  }
+})
+```
+
+The `userId` in the route will be resolved into the `request.params` object.
+
+#### Example 9：
 Use `mockjs`:
 ```ts
 import Mock from 'mockjs'
@@ -448,7 +463,7 @@ export default defineMock({
 ```
 You need installed `mockjs`
 
-### Example 9：
+### Example 10：
 Use `response` to customize the response
 ```ts
 export default defineMock({
@@ -468,7 +483,7 @@ export default defineMock({
 })
 ```
 
-### Example 10：
+### Example 11：
 Use json / json5
 ```json
 {
@@ -480,7 +495,7 @@ Use json / json5
 }
 ```
 
-### Example 11:
+### Example 12:
 
 multipart, upload file.
 

package/README.zh-CN.md

@@ -436,7 +436,22 @@ export default defineMock({
 })
 ```
 
-#### 示例8：
+#### 示例8:
+动态路由匹配
+```ts
+export default defineMock({
+  url: '/api/user/:userId',
+  body({ params }) {
+    return {
+      userId: params.userId,
+    }
+  }
+})
+```
+
+路由中的 `userId`将会解析到 `request.params` 对象中.
+
+#### 示例9：
 使用 `mockjs` 生成响应数据:
 ```ts
 import Mock from 'mockjs'
@@ -451,7 +466,7 @@ export default defineMock({
 ```
 请先安装 `mockjs`
 
-### 示例9：
+### 示例10：
 使用 `response` 自定义响应
 ```ts
 export default defineMock({
@@ -471,7 +486,7 @@ export default defineMock({
 })
 ```
 
-### 示例10：
+### 示例11：
 使用 json / json5
 ```json
 {
@@ -483,7 +498,7 @@ export default defineMock({
 }
 ```
 
-### Example 11:
+### Example 12:
 
 multipart, 文件上传.
 

package/dist/index.cjs

@@ -52,7 +52,7 @@ var import_vite = require("vite");
 
 // package.json
 var name = "vite-plugin-mock-dev-server";
-var version = "0.4.2";
+var version = "0.4.3";
 
 // src/esbuildPlugin.ts
 var import_promises = __toESM(require("fs/promises"), 1);
@@ -100,6 +100,7 @@ var import_node_fs = __toESM(require("fs"), 1);
 var import_node_path2 = __toESM(require("path"), 1);
 var import_node_url = require("url");
 var import_debug = __toESM(require("debug"), 1);
+var import_picocolors = __toESM(require("picocolors"), 1);
 var isArray = (val) => Array.isArray(val);
 var isFunction = (val) => typeof val === "function";
 function sleep(timeout) {
@@ -116,6 +117,14 @@ var ensureArray = (thing) => {
     return [];
   return [thing];
 };
+var log = {
+  info(...args) {
+    console.info(import_picocolors.default.cyan("mock-dev-server: "), ...args);
+  },
+  error(...args) {
+    console.error("\n", import_picocolors.default.cyan("mock-dev-server: "), ...args, "\n");
+  }
+};
 function lookupFile(dir, formats, options) {
   for (const format of formats) {
     const fullPath = import_node_path2.default.join(dir, format);
@@ -319,6 +328,7 @@ async function buildMockEntry(inputFile, define) {
 var import_node_url2 = require("url");
 var import_http_status = __toESM(require("http-status"), 1);
 var import_path_to_regexp = require("path-to-regexp");
+var import_picocolors2 = __toESM(require("picocolors"), 1);
 
 // src/parseReqBody.ts
 var import_co_body = __toESM(require("co-body"), 1);
@@ -404,7 +414,7 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
           pathname
         ) || { params: {} };
         const params2 = urlMatch2.params || {};
-        const request = {
+        const request2 = {
           query,
           refererQuery,
           params: params2,
@@ -412,9 +422,9 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
           headers: req.headers
         };
         if (isFunction(mock.validator)) {
-          return mock.validator(request);
+          return mock.validator(request2);
         } else {
-          return validate(request, mock.validator);
+          return validate(request2, mock.validator);
         }
       }
       return hasMock;
@@ -431,47 +441,53 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
       pathname
     ) || { params: {} };
     const params = urlMatch.params || {};
-    req.body = reqBody;
-    req.query = query;
-    req.refererQuery = refererQuery;
-    req.params = params;
+    const request = req;
+    request.body = reqBody;
+    request.query = query;
+    request.refererQuery = refererQuery;
+    request.params = params;
     res.setHeader("Content-Type", "application/json");
     res.setHeader("Cache-Control", "no-cache,max-age=0");
-    res.setHeader("X-Mock", "generate by vite:mock-dev-server");
+    res.setHeader("X-Mock", "generate by vite:plugin-mock-dev-server");
     if (currentMock.headers) {
-      const headers = isFunction(currentMock.headers) ? await currentMock.headers({
-        query,
-        refererQuery,
-        body: reqBody,
-        params,
-        headers: req.headers
-      }) : currentMock.headers;
-      Object.keys(headers).forEach((key) => {
-        res.setHeader(key, headers[key]);
-      });
+      try {
+        const headers = isFunction(currentMock.headers) ? await currentMock.headers(request) : currentMock.headers;
+        Object.keys(headers).forEach((key) => {
+          res.setHeader(key, headers[key]);
+        });
+      } catch (e) {
+        log.error(`${import_picocolors2.default.red("[headers error]")} ${req.url} 
+`, e);
+      }
     }
     if (currentMock.body) {
-      let body;
-      if (isFunction(currentMock.body)) {
-        body = await currentMock.body({
-          query,
-          refererQuery,
-          body: reqBody,
-          params,
-          headers: req.headers
-        });
-      } else {
-        body = currentMock.body;
+      try {
+        let body;
+        if (isFunction(currentMock.body)) {
+          body = await currentMock.body(request);
+        } else {
+          body = currentMock.body;
+        }
+        res.end(JSON.stringify(body));
+      } catch (e) {
+        log.error(`${import_picocolors2.default.red("[body error]")} ${req.url} 
+`, e);
+        res.statusCode = 500;
+        res.statusMessage = getHTTPStatusText(res.statusCode);
+        res.end("");
       }
-      res.end(JSON.stringify(body));
       return;
     }
     if (currentMock.response) {
-      await currentMock.response(
-        req,
-        res,
-        next
-      );
+      try {
+        await currentMock.response(request, res, next);
+      } catch (e) {
+        log.error(`${import_picocolors2.default.red("[response error]")} ${req.url} 
+`, e);
+        res.statusCode = 500;
+        res.statusMessage = getHTTPStatusText(res.statusCode);
+        res.end("");
+      }
       return;
     }
     res.end("");

package/dist/index.d.ts

@@ -50,8 +50,9 @@ interface ServerBuildOption {
     dist?: string;
 }
 type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'TRACE' | 'OPTIONS';
+type Headers = http.IncomingHttpHeaders;
 type ResponseBody = Record<string, any> | any[] | string | number | null;
-interface ResponseReq {
+interface ExtraRequest {
     /**
      * 请求地址中位于 `?` 后面的 queryString，已解析为 json
      */
@@ -69,17 +70,13 @@ interface ResponseReq {
      */
     params: Record<string, any>;
     /**
-     * 请求 中的 headers
+     * 请求体中 headers
      */
-    headers: Record<string, any>;
+    headers: Headers;
 }
-interface ResponseBodyFn {
-    (request: ResponseReq): ResponseBody | Promise<ResponseBody>;
-}
-interface ResponseHeaderFn {
-    (request: ResponseReq): Headers | Promise<Headers>;
-}
-type Headers = Record<string, any>;
+type MockRequest = ExtraRequest & http.IncomingMessage;
+type ResponseBodyFn = (request: MockRequest) => ResponseBody | Promise<ResponseBody>;
+type ResponseHeaderFn = (request: MockRequest) => Headers | Promise<Headers>;
 interface MockOptionsItem {
     /**
      * 需要做mock的接口地址，
@@ -136,7 +133,7 @@ interface MockOptionsItem {
      *
      * 在 req 中，还可以拿到 query、params、body等已解析的请求信息
      */
-    response?: (req: Connect.IncomingMessage & ResponseReq, res: http.ServerResponse<http.IncomingMessage>, next: Connect.NextFunction) => void | Promise<void>;
+    response?: (req: MockRequest, res: http.ServerResponse<http.IncomingMessage>, next: Connect.NextFunction) => void | Promise<void>;
     /**
      * 请求验证器
      *
@@ -144,7 +141,7 @@ interface MockOptionsItem {
      * 但全部都在单个 mock中的 body或者 response 中写，内容会很庞杂，不好管理，
      * 验证器的功能，允许你同时配置多条相同url的mock，通过验证器来判断使哪个mock生效。
      */
-    validator?: Partial<ResponseReq> | ((request: ResponseReq) => boolean);
+    validator?: Partial<ExtraRequest> | ((request: ExtraRequest) => boolean);
 }
 type MockOptions = MockOptionsItem[];
 type FormidableFile = formidable.File | formidable.File[];

package/dist/index.js

@@ -9,7 +9,7 @@ import { createFilter } from "vite";
 
 // package.json
 var name = "vite-plugin-mock-dev-server";
-var version = "0.4.2";
+var version = "0.4.3";
 
 // src/esbuildPlugin.ts
 import fsp from "fs/promises";
@@ -57,6 +57,7 @@ import fs from "fs";
 import path2 from "path";
 import { fileURLToPath } from "url";
 import Debug from "debug";
+import colors from "picocolors";
 var isArray = (val) => Array.isArray(val);
 var isFunction = (val) => typeof val === "function";
 function sleep(timeout) {
@@ -73,6 +74,14 @@ var ensureArray = (thing) => {
     return [];
   return [thing];
 };
+var log = {
+  info(...args) {
+    console.info(colors.cyan("mock-dev-server: "), ...args);
+  },
+  error(...args) {
+    console.error("\n", colors.cyan("mock-dev-server: "), ...args, "\n");
+  }
+};
 function lookupFile(dir, formats, options) {
   for (const format of formats) {
     const fullPath = path2.join(dir, format);
@@ -276,6 +285,7 @@ async function buildMockEntry(inputFile, define) {
 import { parse as urlParse } from "url";
 import HTTP_STATUS from "http-status";
 import { match, pathToRegexp } from "path-to-regexp";
+import colors2 from "picocolors";
 
 // src/parseReqBody.ts
 import bodyParser from "co-body";
@@ -361,7 +371,7 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
           pathname
         ) || { params: {} };
         const params2 = urlMatch2.params || {};
-        const request = {
+        const request2 = {
           query,
           refererQuery,
           params: params2,
@@ -369,9 +379,9 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
           headers: req.headers
         };
         if (isFunction(mock.validator)) {
-          return mock.validator(request);
+          return mock.validator(request2);
         } else {
-          return validate(request, mock.validator);
+          return validate(request2, mock.validator);
         }
       }
       return hasMock;
@@ -388,47 +398,53 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
       pathname
     ) || { params: {} };
     const params = urlMatch.params || {};
-    req.body = reqBody;
-    req.query = query;
-    req.refererQuery = refererQuery;
-    req.params = params;
+    const request = req;
+    request.body = reqBody;
+    request.query = query;
+    request.refererQuery = refererQuery;
+    request.params = params;
     res.setHeader("Content-Type", "application/json");
     res.setHeader("Cache-Control", "no-cache,max-age=0");
-    res.setHeader("X-Mock", "generate by vite:mock-dev-server");
+    res.setHeader("X-Mock", "generate by vite:plugin-mock-dev-server");
     if (currentMock.headers) {
-      const headers = isFunction(currentMock.headers) ? await currentMock.headers({
-        query,
-        refererQuery,
-        body: reqBody,
-        params,
-        headers: req.headers
-      }) : currentMock.headers;
-      Object.keys(headers).forEach((key) => {
-        res.setHeader(key, headers[key]);
-      });
+      try {
+        const headers = isFunction(currentMock.headers) ? await currentMock.headers(request) : currentMock.headers;
+        Object.keys(headers).forEach((key) => {
+          res.setHeader(key, headers[key]);
+        });
+      } catch (e) {
+        log.error(`${colors2.red("[headers error]")} ${req.url} 
+`, e);
+      }
     }
     if (currentMock.body) {
-      let body;
-      if (isFunction(currentMock.body)) {
-        body = await currentMock.body({
-          query,
-          refererQuery,
-          body: reqBody,
-          params,
-          headers: req.headers
-        });
-      } else {
-        body = currentMock.body;
+      try {
+        let body;
+        if (isFunction(currentMock.body)) {
+          body = await currentMock.body(request);
+        } else {
+          body = currentMock.body;
+        }
+        res.end(JSON.stringify(body));
+      } catch (e) {
+        log.error(`${colors2.red("[body error]")} ${req.url} 
+`, e);
+        res.statusCode = 500;
+        res.statusMessage = getHTTPStatusText(res.statusCode);
+        res.end("");
       }
-      res.end(JSON.stringify(body));
       return;
     }
     if (currentMock.response) {
-      await currentMock.response(
-        req,
-        res,
-        next
-      );
+      try {
+        await currentMock.response(request, res, next);
+      } catch (e) {
+        log.error(`${colors2.red("[response error]")} ${req.url} 
+`, e);
+        res.statusCode = 500;
+        res.statusMessage = getHTTPStatusText(res.statusCode);
+        res.end("");
+      }
       return;
     }
     res.end("");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-mock-dev-server",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "keywords": [
     "vite",
     "plugin",
@@ -39,7 +39,8 @@
     "http-status": "^1.6.2",
     "is-core-module": "^2.11.0",
     "json5": "^2.2.3",
-    "path-to-regexp": "^6.2.1"
+    "path-to-regexp": "^6.2.1",
+    "picocolors": "^1.0.0"
   },
   "devDependencies": {
     "@pengzhanbo/eslint-config-ts": "^0.3.2",