Skip to content

Commit 0a986b2

Browse files
fix(web): scope PR restore cancellation to viewer input
1 parent 8786925 commit 0a986b2

3 files changed

Lines changed: 29 additions & 37 deletions

File tree

‎apps/web/src/components/pullRequest/PullRequestCodeTab.tsx‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1396,11 +1396,7 @@ function PullRequestCodeTab({
13961396
savePullRequestCodeScroll(current, instance.getScrollTop(), loadedSlices.length),
13971397
);
13981398
};
1399-
const stopObservingIntent = observePullRequestCodeScrollIntent(
1400-
surface,
1401-
cancel,
1402-
surface.ownerDocument,
1403-
);
1399+
const stopObservingIntent = observePullRequestCodeScrollIntent(surface, cancel);
14041400
restore();
14051401
return () => {
14061402
stopObserving();

‎apps/web/src/components/pullRequest/pullRequestCodeScroll.logic.ts‎

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -88,42 +88,19 @@ export function pullRequestCodeScrollSurface(
8888
};
8989
}
9090

91-
export function observePullRequestCodeScrollIntent(
92-
surface: EventTarget,
93-
cancel: () => void,
94-
keyboardTarget: EventTarget = surface,
95-
) {
96-
const cancelOnFind = (event: Event) => {
97-
const key = event as KeyboardEvent;
98-
if ((key.ctrlKey || key.metaKey) && key.key.toLowerCase() === "f") cancel();
99-
};
100-
const cancelOnKey = (event: Event) => {
101-
if (
102-
event instanceof KeyboardEvent &&
103-
["ArrowUp", "ArrowDown", "PageUp", "PageDown", "Home", "End", " "].includes(event.key) &&
104-
!event
105-
.composedPath()
106-
.some(
107-
(node) =>
108-
node instanceof HTMLElement &&
109-
(node.isContentEditable || node.matches("input, textarea")),
110-
)
111-
)
112-
cancel();
113-
};
91+
export function observePullRequestCodeScrollIntent(surface: EventTarget, cancel: () => void) {
11492
surface.addEventListener("wheel", cancel, { passive: true });
11593
surface.addEventListener("touchmove", cancel, { passive: true });
11694
surface.addEventListener("pointerdown", cancel, { capture: true });
11795
// Native scrollbar interactions can emit mouse events without a pointer event.
11896
surface.addEventListener("mousedown", cancel, { capture: true });
119-
surface.addEventListener("keydown", cancelOnKey);
120-
keyboardTarget.addEventListener("keydown", cancelOnFind, { capture: true });
97+
// Keyboard interaction in the viewer, including Find input, takes priority over restoration.
98+
surface.addEventListener("keydown", cancel, { capture: true });
12199
return () => {
122100
surface.removeEventListener("wheel", cancel);
123101
surface.removeEventListener("touchmove", cancel);
124102
surface.removeEventListener("pointerdown", cancel, { capture: true });
125103
surface.removeEventListener("mousedown", cancel, { capture: true });
126-
surface.removeEventListener("keydown", cancelOnKey);
127-
keyboardTarget.removeEventListener("keydown", cancelOnFind, { capture: true });
104+
surface.removeEventListener("keydown", cancel, { capture: true });
128105
};
129106
}

‎apps/web/src/components/pullRequest/pullRequestCodeViewState.test.ts‎

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,26 @@ describe("pull request file keys", () => {
251251
});
252252

253253
describe("pull request scroll restoration", () => {
254+
it.each(["Enter", "F3"])(
255+
"keeps navigation from an already-open Find input (%s) while pages arrive",
256+
(key) => {
257+
const restore = new PullRequestCodeScrollRestoration({ scrollTop: 1800, loadedPageCount: 3 });
258+
const surface = Object.assign(new EventTarget(), {
259+
scrollTop: 0,
260+
scrollHeight: 600,
261+
clientHeight: 400,
262+
});
263+
const stop = observePullRequestCodeScrollIntent(surface, () => restore.cancel());
264+
expect(restore.restore(surface, 1, true)).toBe("load-more");
265+
surface.dispatchEvent(Object.assign(new Event("keydown"), { key }));
266+
surface.scrollTop = 120;
267+
surface.scrollHeight = 3000;
268+
expect(restore.restore(surface, 3, false)).toBe("waiting");
269+
expect(surface.scrollTop).toBe(120);
270+
stop();
271+
},
272+
);
273+
254274
it("keeps a pending target when refresh arrives before its saved pages", () => {
255275
const initial = new PullRequestCodeScrollRestoration({ scrollTop: 1800, loadedPageCount: 3 });
256276
const surface = { scrollTop: 0, scrollHeight: 600, clientHeight: 400 };
@@ -277,15 +297,14 @@ describe("pull request scroll restoration", () => {
277297
clientHeight: 400,
278298
});
279299
const keyboardTarget = new EventTarget();
280-
const stop = observePullRequestCodeScrollIntent(
281-
surface,
282-
() => restore.cancel(),
283-
keyboardTarget,
284-
);
300+
const stop = observePullRequestCodeScrollIntent(surface, () => restore.cancel());
285301
expect(restore.restore(surface, 1, true)).toBe("load-more");
286302
keyboardTarget.dispatchEvent(
287303
Object.assign(new Event("keydown"), { key: "f", ctrlKey: true }),
288304
);
305+
expect(restore.pending).toBe(true);
306+
surface.dispatchEvent(Object.assign(new Event("keydown"), { key: "f", ctrlKey: true }));
307+
expect(restore.pending).toBe(false);
289308
const toggled = toggleFileDiffFoldForViewed("match", false, foldOverride, new Set());
290309
expect(isFileDiffCollapsed("match", foldOverride, toggled)).toBe(false);
291310
surface.scrollTop = 120;

0 commit comments

Comments
 (0)