Skip to content

Commit 5651d76

Browse files
EtanHeyclaudemaria-rcks
authored
fix(web): horizontal scrolling inside diff and file panes no longer switches threads (#28091)
Co-authored-by: Claude Opus 5.5 <[email protected]> Co-authored-by: maria-rcks <[email protected]>
1 parent 71d52eb commit 5651d76

2 files changed

Lines changed: 73 additions & 13 deletions

File tree

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
import { describe, expect, it, vi } from "vite-plus/test";
2+
3+
import { render } from "../../test/render";
4+
import { HistorySwipeNavigation } from "./HistorySwipeNavigation";
5+
6+
const navigateHistory = vi.hoisted(() => vi.fn());
7+
vi.mock("../navigationHistory", () => ({ canNavigateHistory: () => true, navigateHistory }));
8+
9+
function swipe(target: Element, deltaX: number) {
10+
for (const delta of [deltaX, 0]) {
11+
target.dispatchEvent(new WheelEvent("wheel", { deltaX: delta, bubbles: true, composed: true }));
12+
}
13+
}
14+
15+
describe("HistorySwipeNavigation", () => {
16+
it.each([
17+
["scrolling left inside a shadow-root scroller keeps the thread", "shadow", 100, -130, false],
18+
["scrolling right inside a shadow-root scroller keeps the thread", "shadow", 100, 130, false],
19+
[
20+
"scrolling after a shadow scroller remount keeps the thread",
21+
"shadow-remount",
22+
100,
23+
130,
24+
false,
25+
],
26+
["scrolling left inside a scroller keeps the thread", "light", 100, -130, false],
27+
["swiping back at a shadow-root scroller's left edge navigates", "shadow", 0, -130, true],
28+
["swiping back over a panel without overflow navigates", "none", 0, -130, true],
29+
["a swipe that started in a closed dialog keeps the thread", "closed-dialog", 0, -130, false],
30+
] as const)("%s", async (_name, scroller, scrollLeft, deltaX, navigates) => {
31+
navigateHistory.mockReset();
32+
await using screen = await render(<HistorySwipeNavigation />);
33+
const panel = screen.container.appendChild(document.createElement("div"));
34+
const root = scroller.startsWith("shadow") ? panel.attachShadow({ mode: "open" }) : panel;
35+
const viewport = root.appendChild(document.createElement("div"));
36+
const noOverflow = scroller === "none" || scroller === "closed-dialog";
37+
viewport.style.cssText = `width: 200px; overflow-x: ${noOverflow ? "visible" : "auto"}`;
38+
const content = viewport.appendChild(document.createElement("div"));
39+
content.style.cssText = `height: 20px; width: ${noOverflow ? 100 : 1000}px`;
40+
viewport.scrollLeft = scrollLeft;
41+
42+
if (scroller === "closed-dialog") {
43+
panel.setAttribute("role", "dialog");
44+
content.dispatchEvent(new WheelEvent("wheel", { deltaX: -1, bubbles: true, composed: true }));
45+
panel.remove();
46+
screen.container.appendChild(viewport);
47+
}
48+
49+
if (scroller === "shadow-remount") {
50+
content.dispatchEvent(new WheelEvent("wheel", { deltaX: 1, bubbles: true, composed: true }));
51+
const replacement = viewport.cloneNode(true) as HTMLDivElement;
52+
viewport.replaceWith(replacement);
53+
replacement.scrollLeft = scrollLeft;
54+
swipe(replacement, deltaX);
55+
} else {
56+
swipe(content, deltaX);
57+
}
58+
59+
expect(navigateHistory).toHaveBeenCalledTimes(navigates ? 1 : 0);
60+
});
61+
});

‎apps/web/src/components/HistorySwipeNavigation.tsx‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const MOMENTUM_SAMPLE_SIZE = 5;
1111

1212
type SwipeBounds = { left: number; top: number; width: number; height: number };
1313
type SwipeGesture =
14-
| { kind: "pending"; target: EventTarget | null; y: number; sumX: number; sumY: number }
14+
| { kind: "pending"; path: EventTarget[]; y: number; sumX: number; sumY: number }
1515
| {
1616
kind: "tracking";
1717
direction: HistoryDirection;
@@ -37,13 +37,10 @@ function readMainContentBounds(): SwipeBounds {
3737
return { left, top, width, height };
3838
}
3939

40-
function canScrollHorizontally(target: EventTarget | null, deltaX: number): boolean {
41-
for (
42-
let element = target instanceof Element ? target : null;
43-
element;
44-
element = element.parentElement
45-
) {
46-
if (element.scrollWidth <= element.clientWidth) continue;
40+
// `event.target` stops at a shadow host; the composed path also reaches scrollers inside it.
41+
function canScrollHorizontally(path: readonly EventTarget[], deltaX: number): boolean {
42+
for (const element of path) {
43+
if (!(element instanceof Element) || element.scrollWidth <= element.clientWidth) continue;
4744
const { overflowX } = getComputedStyle(element);
4845
if (overflowX !== "auto" && overflowX !== "scroll") continue;
4946
const canScroll =
@@ -58,10 +55,12 @@ function canScrollHorizontally(target: EventTarget | null, deltaX: number): bool
5855
function lockSwipeAxis(
5956
pending: Extract<SwipeGesture, { kind: "pending" }>,
6057
): Exclude<SwipeGesture, { kind: "pending" }> {
61-
const { target, sumX, sumY } = pending;
58+
const { path, sumX, sumY } = pending;
6259
if (Math.abs(sumX) <= Math.abs(sumY)) return { kind: "ignored" };
63-
if (target instanceof Element && target.closest('[role="dialog"]')) return { kind: "ignored" };
64-
if (canScrollHorizontally(target, sumX)) return { kind: "ignored" };
60+
if (path.some((node) => node instanceof Element && node.matches('[role="dialog"]'))) {
61+
return { kind: "ignored" };
62+
}
63+
if (canScrollHorizontally(path, sumX)) return { kind: "ignored" };
6564
const direction = sumX < 0 ? "back" : "forward";
6665
if (!canNavigateHistory(direction)) return { kind: "ignored" };
6766
return {
@@ -119,14 +118,14 @@ export function HistorySwipeNavigation() {
119118
gesture =
120119
event.ctrlKey || event.deltaMode !== WheelEvent.DOM_DELTA_PIXEL
121120
? { kind: "ignored" }
122-
: { kind: "pending", target: event.target, y: event.clientY, sumX: 0, sumY: 0 };
121+
: { kind: "pending", path: event.composedPath(), y: event.clientY, sumX: 0, sumY: 0 };
123122
}
124123
if (gesture.kind === "ignored") return;
125124
if (gesture.kind === "pending") {
126125
gesture.sumX += event.deltaX;
127126
gesture.sumY += event.deltaY;
128127
if (Math.abs(gesture.sumX) + Math.abs(gesture.sumY) < SWIPE_AXIS_LOCK_DISTANCE) return;
129-
gesture = lockSwipeAxis(gesture);
128+
gesture = lockSwipeAxis({ ...gesture, path: [...gesture.path, ...event.composedPath()] });
130129
if (gesture.kind === "ignored") return;
131130
} else {
132131
const delta = gesture.direction === "back" ? -event.deltaX : event.deltaX;

0 commit comments

Comments
 (0)