rspack-plugin-mock 2.0.0 → 2.1.0

package/dist/helper.d.ts

@@ -1,8 +1,8 @@
-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 { A as ResponseBody, C as HandleFunction, D as MockResponse, E as MockRequest, M as CookiesOption, N as GetCookieOption, O as NextFunction, P as SetCookieOption, S as ExtraRequest, T as Method, _ as RecordedMeta, a as MockWebsocketItem, b as RecordedRes, c as MockHttpItem, d as LogType, f as MockMatchPriority, g as RecordOptions, h as ServerBuildOption, i as MockOptions, j as SimpleHandleFunction, k as NextHandleFunction, l as BodyParserOptions, m as MockServerPluginOptions, n as HttpProxyPlugin, o as WebSocketSetupContext, p as MockMatchSpecialPriority, r as PathFilter, s as MockErrorConfig, t as FormidableFile, u as LogLevel, v as RecordedReq, w as Headers, x as ResolvedRecordOptions, y as RecordedRequest } from "./index-BMMGM-eD.js";
 import { IncomingMessage, OutgoingHttpHeaders, ServerResponse } from "node:http";
+import { Transform } from "node:stream";
 
-//#region src/helper/createSSEStream.d.ts
+//#region src/helpers/createSSEStream.d.ts
 interface SSEMessage {
   data?: string | object;
   comment?: string;
@@ -56,9 +56,9 @@ declare class SSEStream extends Transform {
 */
 declare function createSSEStream(req: IncomingMessage, res: ServerResponse): SSEStream;
 //#endregion
-//#region src/helper/defineMock.d.ts
+//#region src/helpers/defineMock.d.ts
 /**
-* mock config Type helper
+* Mock config Type helper
 *
 * mock配置 类型帮助函数
 * @param config see config docs:
@@ -117,10 +117,48 @@ declare function defineMock(config: MockOptions): MockOptions;
 */
 declare function createDefineMock(transformer: (mock: MockHttpItem | MockWebsocketItem) => MockHttpItem | MockWebsocketItem | void): typeof defineMock;
 //#endregion
-//#region src/helper/defineMockData.d.ts
+//#region src/helpers/defineMockData.d.ts
+/**
+* Options for defineMockData
+*
+* defineMockData 的选项
+*/
+interface DefineMockDataOptions {
+  /**
+  * Whether to persist the data value on HMR (Hot Module Replacement).
+  *
+  * 热更新时是否保持数据值
+  *
+  * @default false
+  */
+  persistOnHMR?: boolean;
+}
+/**
+* Mock data type with getter, setter, and value property
+*
+* 带有 getter、setter 和 value 属性的 Mock 数据类型
+*
+* @template T - Type of mock data / Mock 数据的类型
+*/
 type MockData<T = any> = readonly [() => T, (val: T | ((val: T) => T | void)) => void] & {
+  /**
+  * Current value
+  *
+  * 当前值
+  */
   value: T;
 };
-declare function defineMockData<T = any>(key: string, initialData: T): MockData<T>;
+/**
+* Define mock data with memory-based sharing mechanism
+*
+* 定义带有基于内存的共享机制的 Mock 数据
+*
+* @template T - Type of mock data / Mock 数据的类型
+* @param key - Unique key for mock data / Mock 数据的唯一键
+* @param initialData - Initial data value / 初始数据值
+* @param options - Options / 选项
+* @returns MockData object with getter, setter, and value property / 带有 getter、setter 和 value 属性的 MockData 对象
+*/
+declare function defineMockData<T = any>(key: string, initialData: T, options?: DefineMockDataOptions): MockData<T>;
 //#endregion
-export { BodyParserOptions, ExtraRequest, FormidableFile, HeaderStream, LogLevel, LogType, Method, MockData, MockHttpItem, MockMatchPriority, MockMatchSpecialPriority, MockOptions, MockRequest, MockResponse, MockServerPluginOptions, MockWebsocketItem, ResponseBody, SSEMessage, ServerBuildOption, WebSocketSetupContext, createDefineMock, createSSEStream, defineMock, defineMockData };
+export { BodyParserOptions, CookiesOption, DefineMockDataOptions, ExtraRequest, FormidableFile, GetCookieOption, HandleFunction, HeaderStream, Headers, HttpProxyPlugin, LogLevel, LogType, Method, MockData, MockErrorConfig, MockHttpItem, MockMatchPriority, MockMatchSpecialPriority, MockOptions, MockRequest, MockResponse, MockServerPluginOptions, MockWebsocketItem, NextFunction, NextHandleFunction, PathFilter, RecordOptions, RecordedMeta, RecordedReq, RecordedRequest, RecordedRes, ResolvedRecordOptions, ResponseBody, SSEMessage, ServerBuildOption, SetCookieOption, SimpleHandleFunction, WebSocketSetupContext, createDefineMock, createSSEStream, defineMock, defineMockData };

package/dist/helper.js

@@ -1,6 +1,7 @@
+import { deepClone, isArray, isFunction } from "@pengzhanbo/utils";
+import { createHash } from "node:crypto";
 import { Transform } from "node:stream";
-import { deepClone, deepEqual, isArray, isFunction } from "@pengzhanbo/utils";
-//#region src/helper/createSSEStream.ts
+//#region src/helpers/createSSEStream.ts
 /**
 * Transforms "messages" to W3C event stream content.
 * See https://html.spec.whatwg.org/multipage/server-sent-events.html
@@ -81,7 +82,7 @@ function createSSEStream(req, res) {
 	return sse;
 }
 //#endregion
-//#region src/helper/defineMock.ts
+//#region src/helpers/defineMock.ts
 function defineMock(config) {
 	return config;
 }
@@ -110,47 +111,138 @@ function createDefineMock(transformer) {
 	return define;
 }
 //#endregion
-//#region src/helper/defineMockData.ts
+//#region src/helpers/defineMockData.ts
 /**
-* 由于插件是 分别独立对 `*.mock.*` 等文件作为单独入口进行编译的，
+* Since the plugin compiles `*.mock.*` files as separate independent entries,
+* this leads to inconsistent dependency relationships after mock file compilation,
+* with each mock file having its own scope.
+* Even if multiple `*.mock.*` files import the same `data.ts` file, they are
+* completely different instances of `data`, making operations on `data` not
+* shareable across different `*.mock.*` files.
+*
+* To address this, the plugin provides a memory-based data sharing mechanism.
+*
+* 由于插件是分别独立对 `*.mock.*` 等文件作为单独入口进行编译的，
 * 这导致了 mock 文件编译后的依赖关系不一致，每个 mock 文件拥有独立的作用域，
 * 使得即使多个 `*.mock.*` 虽然引入了同一个 `data.ts` 文件，然而确是完全不同两份 `data`，
 * 使得对 `data` 的操作，在不同的 `*.mock.*` 文件中并不能共享。
 *
 * 为此，插件提供了一种基于 memory 的数据共享机制。
 */
+/**
+* Mock data cache
+*
+* Mock 数据缓存
+*/
 const mockDataCache = /* @__PURE__ */ new Map();
+/**
+* Response cache for MockData objects
+*
+* MockData 对象的响应缓存
+*/
 const responseCache = /* @__PURE__ */ new WeakMap();
+/**
+* Stale interval in milliseconds
+*
+* 缓存过期间隔（毫秒）
+*/
 const staleInterval = 70;
+/**
+* Cache implementation for mock data
+*
+* Mock 数据缓存实现
+*
+* @template T - Type of cached data / 缓存数据的类型
+*/
 var CacheImpl = class {
+	/**
+	* Current cached value
+	*
+	* 当前缓存值
+	*/
 	value;
-	#initialValue;
+	/**
+	* Initial value hash, used to detect if initial data has changed
+	*
+	* 初始化数据的哈希值，用于判断传入的初始化数据是否发生变更
+	*/
+	#hash;
+	/**
+	* Last update timestamp
+	*
+	* 最后更新时间戳
+	*/
 	#lastUpdate;
-	constructor(value) {
+	/**
+	* Whether to persist data on HMR
+	*
+	* 热更新时是否保持数据
+	*/
+	#persistOnHMR;
+	/**
+	* Constructor
+	*
+	* 构造函数
+	*
+	* @param value - Initial value / 初始值
+	* @param persistOnHMR - Whether to persist data on HMR / 热更新时是否保持数据
+	*/
+	constructor(value, persistOnHMR) {
 		this.value = value;
-		this.#initialValue = deepClone(value);
+		this.#hash = getHash(value);
 		this.#lastUpdate = Date.now();
+		this.#persistOnHMR = persistOnHMR ?? false;
 	}
+	/**
+	* Hot update cached value
+	*
+	* 热更新缓存值
+	*
+	* @param value - New value / 新值
+	*/
 	hotUpdate(value) {
+		if (this.#persistOnHMR) return;
 		if (Date.now() - this.#lastUpdate < staleInterval) return;
-		if (!deepEqual(value, this.#initialValue)) {
-			this.value = value;
-			this.#initialValue = deepClone(value);
+		const hash = getHash(value);
+		if (this.#hash !== hash) {
+			this.value = deepClone(value);
+			this.#hash = hash;
 			this.#lastUpdate = Date.now();
 		}
 	}
+	/**
+	* Set persistOnHMR
+	*
+	* 设置 persistOnHMR
+	*
+	* @param persistOnHMR - Whether to persist data on HMR / 热更新时是否保持数据
+	*/
+	setPersistOnHMR(persistOnHMR) {
+		if (!this.#persistOnHMR) this.#persistOnHMR = persistOnHMR;
+	}
 };
-function defineMockData(key, initialData) {
+/**
+* Define mock data with memory-based sharing mechanism
+*
+* 定义带有基于内存的共享机制的 Mock 数据
+*
+* @template T - Type of mock data / Mock 数据的类型
+* @param key - Unique key for mock data / Mock 数据的唯一键
+* @param initialData - Initial data value / 初始数据值
+* @param options - Options / 选项
+* @returns MockData object with getter, setter, and value property / 带有 getter、setter 和 value 属性的 MockData 对象
+*/
+function defineMockData(key, initialData, options) {
 	let cache = mockDataCache.get(key);
 	if (!cache) {
-		const newCache = new CacheImpl(initialData);
+		const newCache = new CacheImpl(initialData, options?.persistOnHMR);
 		const existing = mockDataCache.get(key);
 		if (existing) cache = existing;
 		else {
 			mockDataCache.set(key, newCache);
 			cache = newCache;
 		}
-	}
+	} else cache.setPersistOnHMR(options?.persistOnHMR ?? false);
 	cache.hotUpdate(initialData);
 	if (responseCache.has(cache)) return responseCache.get(cache);
 	const res = [() => cache.value, (val) => {
@@ -168,5 +260,8 @@ function defineMockData(key, initialData) {
 	responseCache.set(cache, res);
 	return res;
 }
+function getHash(data) {
+	return createHash("sha256").update(JSON.stringify(data)).digest("hex");
+}
 //#endregion
 export { createDefineMock, createSSEStream, defineMock, defineMockData };