rspack-plugin-mock 1.3.0 → 2.0.0

package/README.md

@@ -10,18 +10,23 @@ Implement a mock-dev-server in `rspack` and `rsbuild` that is fully consistent w
   <img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/rspack-plugin-mock/peer/@rspack/core?style=flat-square&colorA=564341&colorB=EDED91&label=rspack">
   <img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/rspack-plugin-mock/peer/@rsbuild/core?style=flat-square&colorA=564341&colorB=EDED91&label=rsbuild">
   <img alt="npm" src="https://img.shields.io/npm/dm/rspack-plugin-mock?style=flat-square&colorA=564341&colorB=EDED91">
-  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/pengzhanbo/rspack-plugin-mock/lint.yml?style=flat-square&colorA=564341&colorB=EDED91">
+  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/pengzhanbo/rspack-plugin-mock/release.yaml?style=flat-square&colorA=564341&colorB=EDED91">
 </p>
 
 <p align="center">
 <span>English</span> | <a href="./README.zh-CN.md">简体中文</a>
 </p>
 
+> [!IMPORTANT]
+> Starting from version 2.0 of the plugin, only `rspack@2.x` and `rsbuild@2.x` versions are supported.
+>
+> If you are using `rspack@1.x` or `rsbuild@1.x`, please use version `rspack-plugin-mock@1.x`.
+
 ## Features
 
 - ⚡️ Lightweight, Flexible, Fast.
 - 🧲 Not injection-based, non-intrusive to client code.
-- 💡 ESModule/commonjs.
+- 💡 Pure ESModule
 - 🦾 Typescript.
 - 🔥 HMR
 - 🏷 Support `.[cm]?js`/ `.ts` /`.json` / `.json5`.

package/README.zh-CN.md

@@ -10,18 +10,23 @@
   <img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/rspack-plugin-mock/peer/@rspack/core?style=flat-square&colorA=564341&colorB=EDED91&label=rspack">
   <img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/rspack-plugin-mock/peer/@rsbuild/core?style=flat-square&colorA=564341&colorB=EDED91&label=rsbuild">
   <img alt="npm" src="https://img.shields.io/npm/dm/rspack-plugin-mock?style=flat-square&colorA=564341&colorB=EDED91">
-  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/pengzhanbo/rspack-plugin-mock/lint.yml?style=flat-square&colorA=564341&colorB=EDED91">
+  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/pengzhanbo/rspack-plugin-mock/release.yaml?style=flat-square&colorA=564341&colorB=EDED91">
 </p>
 
 <p align="center">
 <a href="./README.md">English</a> | <span>简体中文</span>
 </p>
 
+> [!IMPORTANT]
+> 从插件 2.0 版本开始，仅支持 `rspack@2.x` 版本 和 `rsbuild@2.x` 版本.
+>
+> 如果您使用的是 `rspack@1.x` 或 `rsbuild@1.x` 版本，请使用 `rspack-plugin-mock@1.x` 版本.
+
 ## 特性
 
 - ⚡️ 轻量，灵活，快速
 - 🧲 非注入式，对客户端代码无侵入
-- 💡 ESModule/commonjs
+- 💡 纯 ESModule
 - 🦾 Typescript
 - 🔥 热更新
 - 🏷 支持 `.[cm]?js`/ `.ts` / `json` / `json5` 编写 mock 数据

package/dist/{helper.d.mts → helper.d.ts}

@@ -1,4 +1,4 @@
-import { _ as WebSocketSetupContext, a as LogType, c as MockMatchPriority, d as MockRequest, f as MockResponse, g as ServerBuildOption, h as ResponseBody, i as LogLevel, l as MockMatchSpecialPriority, m as MockWebsocketItem, n as ExtraRequest, o as Method, p as MockServerPluginOptions, r as FormidableFile, s as MockHttpItem, t as BodyParserOptions, u as MockOptions } from "./types-Bt_OTa7I.mjs";
+import { _ as WebSocketSetupContext, a as LogType, c as MockMatchPriority, d as MockRequest, f as MockResponse, g as ServerBuildOption, h as ResponseBody, i as LogLevel, l as MockMatchSpecialPriority, m as MockWebsocketItem, n as ExtraRequest, o as Method, p as MockServerPluginOptions, r as FormidableFile, s as MockHttpItem, t as BodyParserOptions, u as MockOptions } from "./types-GT6M6WuI.js";
 import { Transform } from "node:stream";
 import { IncomingMessage, OutgoingHttpHeaders, ServerResponse } from "node:http";
 

package/dist/helper.js

@@ -0,0 +1,172 @@
+import { Transform } from "node:stream";
+import { deepClone, deepEqual, isArray, isFunction } from "@pengzhanbo/utils";
+//#region src/helper/createSSEStream.ts
+/**
+* Transforms "messages" to W3C event stream content.
+* See https://html.spec.whatwg.org/multipage/server-sent-events.html
+* A message is an object with one or more of the following properties:
+* - data (String or object, which gets turned into JSON)
+* - event
+* - id
+* - retry
+* - comment
+*
+* If constructed with a HTTP Request, it will optimise the socket for streaming.
+* If this stream is piped to an HTTP Response, it will set appropriate headers.
+*/
+var SSEStream = class extends Transform {
+	constructor(req) {
+		super({ objectMode: true });
+		req.socket.setKeepAlive(true);
+		req.socket.setNoDelay(true);
+		req.socket.setTimeout(0);
+	}
+	pipe(destination, options) {
+		if (destination.writeHead) {
+			destination.writeHead(200, {
+				"Content-Type": "text/event-stream; charset=utf-8",
+				"Transfer-Encoding": "identity",
+				"Cache-Control": "no-cache",
+				"Connection": "keep-alive"
+			});
+			destination.flushHeaders?.();
+		}
+		destination.write(":ok\n\n");
+		return super.pipe(destination, options);
+	}
+	_transform(message, encoding, callback) {
+		if (message.comment) this.push(`: ${message.comment}\n`);
+		if (message.event) this.push(`event: ${message.event}\n`);
+		if (message.id) this.push(`id: ${message.id}\n`);
+		if (message.retry) this.push(`retry: ${message.retry}\n`);
+		if (message.data) this.push(dataString(message.data));
+		this.push("\n");
+		callback();
+	}
+	write(message, ...args) {
+		return super.write(message, ...args);
+	}
+	destroy(error) {
+		if (error) this.write({
+			event: "error",
+			data: error.message
+		});
+		this.end();
+		return this;
+	}
+};
+function dataString(data) {
+	if (typeof data === "object") return dataString(JSON.stringify(data));
+	return data.split(/\r\n|\r|\n/).map((line) => `data: ${line}\n`).join("");
+}
+/**
+* 创建一个 Server-sent events 写入流，用于支持模拟 EventSource
+*
+* @example
+* ```ts
+* import { createSSEStream, defineMock } from 'vite-plugin-mock-dev-server'
+*
+* export default defineMock({
+*   url: '/api',
+*   response: (req, res) => {
+*     const sse = createSSEStream(req, res)
+*     sse.write({ event: 'message', data: { message: 'hello world' } })
+*   }
+* })
+* ```
+*/
+function createSSEStream(req, res) {
+	const sse = new SSEStream(req);
+	sse.pipe(res);
+	return sse;
+}
+//#endregion
+//#region src/helper/defineMock.ts
+function defineMock(config) {
+	return config;
+}
+/**
+* Return a custom defineMock function to support preprocessing of mock config.
+*
+* 返回一个自定义的 defineMock 函数，用于支持对 mock config 的预处理。
+* @param transformer preprocessing function
+* @example
+* ```ts
+* const definePostMock = createDefineMock((mock) => {
+*   mock.url = '/api/post/' + mock.url
+* })
+* export default definePostMock({
+*   url: 'list',
+*   body: [{ title: '1' }, { title: '2' }],
+* })
+* ```
+*/
+function createDefineMock(transformer) {
+	const define = (config) => {
+		if (isArray(config)) config = config.map((item) => transformer(item) || item);
+		else config = transformer(config) || config;
+		return config;
+	};
+	return define;
+}
+//#endregion
+//#region src/helper/defineMockData.ts
+/**
+* 由于插件是 分别独立对 `*.mock.*` 等文件作为单独入口进行编译的，
+* 这导致了 mock 文件编译后的依赖关系不一致，每个 mock 文件拥有独立的作用域，
+* 使得即使多个 `*.mock.*` 虽然引入了同一个 `data.ts` 文件，然而确是完全不同两份 `data`，
+* 使得对 `data` 的操作，在不同的 `*.mock.*` 文件中并不能共享。
+*
+* 为此，插件提供了一种基于 memory 的数据共享机制。
+*/
+const mockDataCache = /* @__PURE__ */ new Map();
+const responseCache = /* @__PURE__ */ new WeakMap();
+const staleInterval = 70;
+var CacheImpl = class {
+	value;
+	#initialValue;
+	#lastUpdate;
+	constructor(value) {
+		this.value = value;
+		this.#initialValue = deepClone(value);
+		this.#lastUpdate = Date.now();
+	}
+	hotUpdate(value) {
+		if (Date.now() - this.#lastUpdate < staleInterval) return;
+		if (!deepEqual(value, this.#initialValue)) {
+			this.value = value;
+			this.#initialValue = deepClone(value);
+			this.#lastUpdate = Date.now();
+		}
+	}
+};
+function defineMockData(key, initialData) {
+	let cache = mockDataCache.get(key);
+	if (!cache) {
+		const newCache = new CacheImpl(initialData);
+		const existing = mockDataCache.get(key);
+		if (existing) cache = existing;
+		else {
+			mockDataCache.set(key, newCache);
+			cache = newCache;
+		}
+	}
+	cache.hotUpdate(initialData);
+	if (responseCache.has(cache)) return responseCache.get(cache);
+	const res = [() => cache.value, (val) => {
+		if (isFunction(val)) val = val(cache.value) ?? cache.value;
+		cache.value = val;
+	}];
+	Object.defineProperty(res, "value", {
+		get() {
+			return cache.value;
+		},
+		set(val) {
+			cache.value = val;
+		}
+	});
+	responseCache.set(cache, res);
+	return res;
+}
+//#endregion
+export { createDefineMock, createSSEStream, defineMock, defineMockData };

package/dist/{index.d.mts → index.d.ts}

@@ -1,6 +1,6 @@
-import { _ as WebSocketSetupContext, a as LogType, c as MockMatchPriority, d as MockRequest, f as MockResponse, g as ServerBuildOption, h as ResponseBody, i as LogLevel, l as MockMatchSpecialPriority, m as MockWebsocketItem, n as ExtraRequest, o as Method, p as MockServerPluginOptions, r as FormidableFile, s as MockHttpItem, t as BodyParserOptions, u as MockOptions } from "./types-Bt_OTa7I.mjs";
-import { HeaderStream, MockData, SSEMessage, createDefineMock, createSSEStream, defineMock, defineMockData } from "./helper.mjs";
-import { a as processMockData, c as Logger, i as baseMiddleware, l as createLogger, n as mockWebSocket, o as processRawData, r as BaseMiddlewareOptions, s as sortByValidator, t as MockSocketOptions, u as logLevels } from "./server-4ETytB7L.mjs";
+import { _ as WebSocketSetupContext, a as LogType, c as MockMatchPriority, d as MockRequest, f as MockResponse, g as ServerBuildOption, h as ResponseBody, i as LogLevel, l as MockMatchSpecialPriority, m as MockWebsocketItem, n as ExtraRequest, o as Method, p as MockServerPluginOptions, r as FormidableFile, s as MockHttpItem, t as BodyParserOptions, u as MockOptions } from "./types-GT6M6WuI.js";
+import { HeaderStream, MockData, SSEMessage, createDefineMock, createSSEStream, defineMock, defineMockData } from "./helper.js";
+import { a as processMockData, c as Logger, i as baseMiddleware, l as createLogger, n as mockWebSocket, o as processRawData, r as BaseMiddlewareOptions, s as sortByValidator, t as MockSocketOptions, u as logLevels } from "./server-_doRwsZm.js";
 import { Compiler, RspackPluginInstance } from "@rspack/core";
 
 //#region src/rspack.d.ts

package/dist/index.js

@@ -0,0 +1,84 @@
+import { createDefineMock, createSSEStream, defineMock, defineMockData } from "./helper.js";
+import { a as processRawData, d as logLevels, i as processMockData, n as baseMiddleware, o as sortByValidator, r as rewriteRequest, s as waitingFor, t as mockWebSocket, u as createLogger } from "./ws-BcLCWVaK.js";
+import { n as buildMockServer, r as createMockCompiler, t as resolvePluginOptions$1 } from "./options-Bd0PSZeT.js";
+import "./server.js";
+import { isFunction, isString, toArray, toTruthy } from "@pengzhanbo/utils";
+import path from "node:path";
+import process from "node:process";
+import rspack from "@rspack/core";
+//#region src/rspack.ts
+const PLUGIN_NAME = "rspack-plugin-mock";
+var MockServerPlugin = class {
+	constructor(options = {}) {
+		this.options = options;
+	}
+	apply(compiler) {
+		const compilerOptions = compiler.options;
+		const options = resolvePluginOptions(compiler, this.options);
+		if (process.env.NODE_ENV !== "production") {
+			if (compilerOptions.devServer === false) {
+				options.logger.warn(`${PLUGIN_NAME} is disabled, because devServer is disabled`);
+				return;
+			}
+			const mockCompiler = createMockCompiler(options);
+			const setupMiddlewares = compilerOptions.devServer?.setupMiddlewares;
+			const waitServerForMockWebSocket = waitingFor((server) => {
+				mockWebSocket(mockCompiler, server, options);
+			});
+			compilerOptions.devServer = {
+				...compilerOptions.devServer,
+				setupMiddlewares: (middlewares, devServer) => {
+					middlewares = setupMiddlewares?.(middlewares, devServer) || middlewares;
+					middlewares.unshift(baseMiddleware(mockCompiler, options));
+					if (options.reload) mockCompiler.on("update", () => {
+						if (devServer.webSocketServer?.clients) devServer.sendMessage(devServer.webSocketServer.clients, "static-changed");
+					});
+					/**
+					* 在 @rspack/dev-server 中, setupMiddlewares 优先于 createServer
+					* 执行，需要等待 server 启动后再注入 mock websocket
+					*/
+					waitServerForMockWebSocket(() => devServer.server);
+					return middlewares;
+				}
+			};
+			const wsPrefix = toArray(options.wsPrefix);
+			if (compilerOptions.devServer?.proxy?.length) {
+				const proxy = compilerOptions.devServer.proxy;
+				compilerOptions.devServer.proxy = proxy.filter((item) => {
+					if (!isFunction(item) && item.ws === true && wsPrefix.length) return !toArray(item.pathFilter || item.context).filter(isString).some((context) => wsPrefix.includes(context));
+					return true;
+				}).map((item) => {
+					if (!isFunction(item) && !item.ws) {
+						const on = item.on ??= {};
+						const onProxyReq = on.proxyReq;
+						on.proxyReq = (proxyReq, req, ...args) => {
+							onProxyReq?.(proxyReq, req, ...args);
+							rewriteRequest(proxyReq, req);
+						};
+					}
+					return item;
+				});
+			}
+			compiler.hooks.watchRun.tap(PLUGIN_NAME, () => mockCompiler.run());
+			compiler.hooks.watchClose.tap(PLUGIN_NAME, () => mockCompiler.close());
+		} else if (options.build !== false) compiler.hooks.afterEmit.tap(PLUGIN_NAME, () => buildMockServer(options, compilerOptions.output.path || path.resolve(process.cwd(), "dist")));
+	}
+};
+function resolvePluginOptions(compiler, options = {}) {
+	const compilerOptions = compiler.options;
+	const alias = compilerOptions.resolve?.alias || {};
+	const context = compilerOptions.context;
+	const definePluginInstance = compilerOptions.plugins?.find((plugin) => plugin instanceof rspack.DefinePlugin);
+	const proxies = ((compilerOptions.devServer || {}).proxy || []).flatMap((item) => {
+		if (!isFunction(item) && !item.ws) return item.pathFilter || item.context;
+		return [];
+	}).filter(toTruthy);
+	return resolvePluginOptions$1(options, {
+		alias,
+		context,
+		plugins: toArray(definePluginInstance),
+		proxies
+	});
+}
+//#endregion
+export { MockServerPlugin, baseMiddleware, createDefineMock, createLogger, createSSEStream, defineMock, defineMockData, logLevels, mockWebSocket, processMockData, processRawData, sortByValidator };

package/dist/json5-loader.mjs

@@ -0,0 +1,8 @@
+import JSON5 from "json5";
+//#region src/json5-loader.ts
+function json5_loader_default(content) {
+	if (!content) return "export default {}";
+	return `export default ${JSON.stringify(JSON5.parse(content))}`;
+}
+//#endregion
+export { json5_loader_default as default };