Skip to content

Commit b0dffd0

Browse files
committed
fix(web): delegated dispatch restores the event's currentTarget and target
1 parent 55c7329 commit b0dffd0

3 files changed

Lines changed: 142 additions & 28 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@solidjs/web": patch
3+
---
4+
5+
Delegated dispatch removes its `currentTarget` and `target` overrides from the native event when its walk ends, even when a handler throws. Native listeners that run later in the same dispatch, such as ones on `document`, `window` or an element above the render root, read their own `currentTarget` again instead of the last node Solid visited.

‎packages/web/src/client.ts‎

Lines changed: 31 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2971,7 +2971,6 @@ function eventHandler(e, container, state) {
29712971

29722972
let node = resumeNode || e.target;
29732973
const key = EVENT_KEY + e.type;
2974-
const oriTarget = e.target;
29752974
const retarget = value =>
29762975
Object.defineProperty(e, "target", {
29772976
configurable: true,
@@ -3009,35 +3008,39 @@ function eventHandler(e, container, state) {
30093008
return node || owner;
30103009
}
30113010
});
3012-
if (resumeNode) {
3013-
// If the boundary was the target, the inner walk already fired it.
3014-
// Resume above it so boundary handlers do not run twice.
3015-
if (resumeNode === e.target)
3016-
node = resumeNode._$host || resumeNode.parentNode || resumeNode.host;
3017-
if (node && node !== owner) walkUpTree();
3018-
} else if (e.composedPath) {
3019-
const path = e.composedPath();
3020-
if (path.length) {
3021-
retarget(path[0]);
3022-
for (let i = 0; i < path.length; i++) {
3023-
node = path[i];
3024-
if (!handleNode()) break;
3025-
if (node._$host) {
3026-
node = node._$host;
3027-
// bubble up from portal mount instead of composedPath
3028-
walkUpTree();
3029-
break;
3030-
}
3031-
if (node === owner || node.parentNode === owner) {
3032-
break; // don't bubble above root of event delegation
3011+
try {
3012+
if (resumeNode) {
3013+
// If the boundary was the target, the inner walk already fired it.
3014+
// Resume above it so boundary handlers do not run twice.
3015+
if (resumeNode === e.target)
3016+
node = resumeNode._$host || resumeNode.parentNode || resumeNode.host;
3017+
if (node && node !== owner) walkUpTree();
3018+
} else if (e.composedPath) {
3019+
const path = e.composedPath();
3020+
if (path.length) {
3021+
retarget(path[0]);
3022+
for (let i = 0; i < path.length; i++) {
3023+
node = path[i];
3024+
if (!handleNode()) break;
3025+
if (node._$host) {
3026+
node = node._$host;
3027+
// bubble up from portal mount instead of composedPath
3028+
walkUpTree();
3029+
break;
3030+
}
3031+
if (node === owner || node.parentNode === owner) {
3032+
break; // don't bubble above root of event delegation
3033+
}
30333034
}
3034-
}
3035-
} else walkUpTree();
3035+
} else walkUpTree();
3036+
}
3037+
// fallback for browsers that don't support composedPath
3038+
else walkUpTree();
3039+
} finally {
3040+
// Later native listeners (document, window, outer roots) see the real getters.
3041+
delete e.target;
3042+
delete e.currentTarget;
30363043
}
3037-
// fallback for browsers that don't support composedPath
3038-
else walkUpTree();
3039-
// Mixing portals and shadow dom can lead to a nonstandard target, so reset here.
3040-
retarget(oriTarget);
30413044
}
30423045

30433046
function insertExpression(parent, value, current, marker) {
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
/**
2+
* @jsxImportSource @solidjs/web
3+
* @vitest-environment jsdom
4+
*/
5+
import { describe, expect, test } from "vitest";
6+
import { render } from "@solidjs/web";
7+
8+
describe("delegated dispatch restores the native Event", () => {
9+
test("a native listener above the render root sees its own currentTarget", () => {
10+
const root = document.createElement("div");
11+
document.body.appendChild(root);
12+
let btn!: HTMLButtonElement;
13+
const seen: any[] = [];
14+
const listener = (e: Event) => seen.push(e.currentTarget);
15+
document.addEventListener("click", listener);
16+
const dispose = render(() => <section><button ref={btn} onClick={() => {}} /></section>, root);
17+
btn.click();
18+
document.removeEventListener("click", listener);
19+
dispose();
20+
root.remove();
21+
expect(seen[0]).toBe(document);
22+
});
23+
24+
test("a native listener on the root's ancestor sees its own currentTarget", () => {
25+
const outer = document.createElement("div");
26+
const root = document.createElement("div");
27+
outer.appendChild(root);
28+
document.body.appendChild(outer);
29+
let btn!: HTMLButtonElement;
30+
const seen: any[] = [];
31+
outer.addEventListener("click", e => seen.push(e.currentTarget));
32+
const dispose = render(() => <button ref={btn} onClick={() => {}} />, root);
33+
btn.click();
34+
dispose();
35+
outer.remove();
36+
expect(seen[0]).toBe(outer);
37+
});
38+
39+
test("a throwing handler still restores currentTarget and target", () => {
40+
const root = document.createElement("div");
41+
document.body.appendChild(root);
42+
let btn!: HTMLButtonElement;
43+
const dispose = render(() => <button ref={btn} onClick={() => { throw new Error("boom"); }} />, root);
44+
const e = new MouseEvent("click", { bubbles: true });
45+
const onError = (ev: ErrorEvent) => ev.preventDefault();
46+
window.addEventListener("error", onError);
47+
let seen: any;
48+
document.addEventListener("click", ev => (seen = [ev.currentTarget, ev.target]), { once: true });
49+
btn.dispatchEvent(e);
50+
window.removeEventListener("error", onError);
51+
expect(seen).toEqual([document, btn]);
52+
expect(Object.getOwnPropertyNames(e)).not.toContain("currentTarget");
53+
expect(Object.getOwnPropertyNames(e)).not.toContain("target");
54+
dispose();
55+
root.remove();
56+
});
57+
});
58+
59+
describe("re-dispatching a delegated event object", () => {
60+
test.fails("the same Event object dispatched twice runs the handler twice", () => {
61+
const root = document.createElement("div");
62+
document.body.appendChild(root);
63+
let btn!: HTMLButtonElement;
64+
let calls = 0;
65+
const dispose = render(() => <button ref={btn} onClick={() => calls++} />, root);
66+
const e = new MouseEvent("click", { bubbles: true });
67+
btn.dispatchEvent(e);
68+
btn.dispatchEvent(e);
69+
expect(calls).toBe(2);
70+
dispose();
71+
root.remove();
72+
});
73+
test("re-dispatching to another element reports the new target", () => {
74+
const root = document.createElement("div");
75+
document.body.appendChild(root);
76+
let a!: HTMLButtonElement, b!: HTMLButtonElement;
77+
const targets: any[] = [];
78+
const dispose = render(() => <div><button ref={a} onClick={() => {}} /><button ref={b} /></div>, root);
79+
const e = new MouseEvent("click", { bubbles: true });
80+
a.dispatchEvent(e);
81+
const native: any[] = [];
82+
b.addEventListener("click", ev => native.push(ev.target));
83+
b.dispatchEvent(e);
84+
expect(native[0]).toBe(b);
85+
dispose();
86+
root.remove();
87+
});
88+
89+
test.fails("nested roots each run once per dispatch of the same Event object", () => {
90+
const outerRoot = document.createElement("div");
91+
document.body.appendChild(outerRoot);
92+
let slot!: HTMLDivElement, btn!: HTMLButtonElement;
93+
const calls: string[] = [];
94+
const disposeOuter = render(() => <div ref={slot} onClick={() => calls.push("outer")} />, outerRoot);
95+
const innerRoot = document.createElement("div");
96+
slot.appendChild(innerRoot);
97+
const disposeInner = render(() => <button ref={btn} onClick={() => calls.push("inner")} />, innerRoot);
98+
const e = new MouseEvent("click", { bubbles: true });
99+
btn.dispatchEvent(e);
100+
btn.dispatchEvent(e);
101+
expect(calls).toEqual(["inner", "outer", "inner", "outer"]);
102+
disposeInner();
103+
disposeOuter();
104+
outerRoot.remove();
105+
});
106+
});

0 commit comments

Comments
 (0)