@cfp-studio/iframe 18.4.1 → 18.4.2

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-//#region ../../../../node_modules/.pnpm/vite@6.4.5_@types+node@24.19.2_jiti@2.6.1_less@4.2.2_lightningcss@1.30.2_sass@1.85.1_terser@5.40.0_tsx@4.19.3_yaml@2.7.0/node_modules/vite/types/hmrPayload.d.ts
+//#region ../../../../node_modules/.pnpm/vite@6.4.5_@types+node@24.1_13c54df9746541450cb8a36e10ae9cdd/node_modules/vite/types/hmrPayload.d.ts
 interface UpdatePayload {
   type: 'update';
   updates: Update[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cfp-studio/iframe",
-  "version": "18.4.1",
+  "version": "18.4.2",
   "license": "MIT",
   "files": [
     "dist",
@@ -16,7 +16,8 @@
     "assert-never": "1.4.0",
     "immer": "10.1.1",
     "typescript": "5.9.3",
-    "vite": "6.4.5"
+    "vite": "6.4.5",
+    "vitest": "5.0.5"
   },
   "engines": {
     "node": ">=20"
@@ -28,6 +29,8 @@
   "scripts": {
     "build": "tsdown",
     "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
     "release": "tsdown --minify",
     "lint": "oxlint",
     "format": "oxfmt --write ."

package/preview/__previewjs_internal__/runtime-bridge.spec.ts

@@ -0,0 +1,79 @@
+import { describe, expect, test } from "vitest";
+
+import { postToParent, type PostParentTarget } from "./runtime-bridge";
+
+/**
+ * `postToParent` 的单播契约 —— 「点一次生成两个 packet」的回归（`docs/todo/32`）。
+ *
+ * ## 曾经的 bug
+ *
+ * iframe 用「向上遍历 5 层祖先、每层发两种载荷（对象 + JSON 字符串）」送消息。
+ * 后来 webview shell 增加了转发（`usePreviewSession` 的 `onWindowMessage`
+ * 把 `kind: "host"` 的消息转给宿主），于是：
+ *
+ * ```
+ * iframe → 逐层广播
+ *            ├→ shell（收到 → 转发给宿主）
+ *            └→ 宿主 window（也直接收到）
+ * ```
+ *
+ * 宿主把同一条消息处理两次 → 点一次 📋 写两份 packet（`selectionId` 只差末位）。
+ *
+ * ## 现在的契约
+ *
+ * 只发给**直接父窗口**，只发**一次**，且**只发对象**（不发 JSON 字符串 ——
+ * 字符串会被路由成 `{ kind: "iframe" }` 再投回 iframe，是无意义的回声）。
+ */
+
+/** 记录所有到某个「窗口」的投递。 */
+function fakeWindow(): { posts: unknown[]; postMessage: (m: unknown, o: string) => void } {
+	const posts: unknown[] = [];
+	return {
+		posts,
+		postMessage(message: unknown) {
+			posts.push(message);
+		},
+	};
+}
+
+describe("postToParent", () => {
+	test("只发一次，且只发给直接父窗口", () => {
+		const parent = fakeWindow();
+		// 顶部再加一层祖父：旧实现会连它也发。
+		const grandparent = fakeWindow();
+		(parent as unknown as { parent: unknown }).parent = grandparent;
+
+		const source = { parent } as unknown as PostParentTarget;
+		const message = { kind: "cfp-selection-action", action: "copy-context", runtimeNodeId: "dom:root/0" };
+
+		expect(postToParent(message, source)).toBe(1);
+		expect(parent.posts).toEqual([message]);
+		// 关键断言：不能广播到祖父层，否则宿主会重复处理。
+		expect(grandparent.posts).toEqual([]);
+	});
+
+	test("只发对象，不发 JSON 字符串", () => {
+		const parent = fakeWindow();
+		const message = { kind: "cfp-runtime-snapshot", snapshot: {} };
+		postToParent(message, { parent } as unknown as PostParentTarget);
+
+		expect(parent.posts).toHaveLength(1);
+		expect(typeof parent.posts[0]).toBe("object");
+	});
+
+	test("没有父窗口时返回 0 且不抛", () => {
+		expect(() => postToParent({ kind: "x" }, { parent: undefined as never })).not.toThrow();
+		expect(postToParent({ kind: "x" }, { parent: undefined as never })).toBe(0);
+	});
+
+	test("父窗口 postMessage 抛错时返回 0", () => {
+		const hostile = {
+			parent: {
+				postMessage() {
+					throw new Error("detached");
+				},
+			},
+		} as unknown as PostParentTarget;
+		expect(postToParent({ kind: "x" }, hostile)).toBe(0);
+	});
+});

package/preview/__previewjs_internal__/runtime-bridge.ts

@@ -386,37 +386,35 @@ function publishToHost(message: unknown): void {
 	if (!window.parent || window.parent === window) {
 		return;
 	}
-	postToAncestors(message);
+	postToParent(message);
 }
 
-function postToAncestors(message: unknown): number {
-	const seen = new Set<Window>();
-	let posted = 0;
-	let target: any = window;
-	for (let depth = 0; depth < 5; depth += 1) {
-		try {
-			const parent = target.parent;
-			if (!parent || parent === target || seen.has(parent)) {
-				break;
-			}
-			seen.add(parent);
-			try {
-				parent.postMessage(message, "*");
-			} catch {
-				// Some embedders only preserve string messages; try the JSON fallback.
-			}
-			try {
-				parent.postMessage(JSON.stringify(message), "*");
-			} catch {
-				// Ignore secondary transport failure.
-			}
-			posted += 1;
-			target = parent;
-		} catch {
-			break;
-		}
+/**
+ * 只发给**直接父窗口**（webview shell），由 shell 负责转发给宿主。
+ *
+ * 为什么不再逐层广播：early 版本确实向上遍历了 5 层，当时 shell 不转发消息；
+ * 现在 shell（`usePreviewSession` 的 `onWindowMessage`）会把 `kind: "host"` 的消息
+ * 转给宿主 —— 于是「逐层广播 + shell 转发」让宿主**收到同一条消息两次**
+ * （多点一次 = 多写一份 packet，`selectionId` 只差最后一位）。
+ *
+ * 只发对象、不发 JSON 字符串：shell 与宿主都按对象处理；字符串分支会被路由成
+ * `{ kind: "iframe" }` 再投回 iframe，属于无意义的回声。
+ */
+export interface PostParentTarget {
+	parent: { postMessage(message: unknown, targetOrigin: string): void };
+}
+
+export function postToParent(message: unknown, source?: PostParentTarget): number {
+	const from = source ?? (typeof window === "undefined" ? undefined : (window as unknown as PostParentTarget));
+	if (!from?.parent) {
+		return 0;
+	}
+	try {
+		from.parent.postMessage(message, "*");
+		return 1;
+	} catch {
+		return 0;
 	}
-	return posted;
 }
 
 function collectRuntimeSnapshot(): RuntimeSnapshot {