Skip to content

Avoid rerendering the branch picker while scrolling #4013

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
cursor wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Avoid rerendering the branch picker while scrolling #4013

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
191 changes: 128 additions & 63 deletions apps/web/src/components/BranchToolbarBranchSelector.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
useRef,
useState,
useTransition,
type RefObject,
} from "react";

import { useComposerDraftStore, type DraftId } from "../composerDraftStore";
Expand Down Expand Up @@ -73,6 +74,116 @@ interface BranchToolbarBranchSelectorProps {
onComposerFocusRequest?: () => void;
}

const TOP_BRANCH_SCROLL_FADE_CLASS = "mask-t-from-[calc(100%-var(--fade-size))]";
const BOTTOM_BRANCH_SCROLL_FADE_CLASS = "mask-b-from-[calc(100%-var(--fade-size))]";

interface BranchListScrollBehaviorOptions {
branchListRef: RefObject<LegendListRef | null>;
branchListScrollElementRef: RefObject<HTMLElement | null>;
deferredQuery: string;
filteredItemCount: number;
isOpen: boolean;
maybeFetchNextPage: () => void;
refsLength: number;
}

function useBranchListScrollBehavior({
branchListRef,
branchListScrollElementRef,
deferredQuery,
filteredItemCount,
isOpen,
maybeFetchNextPage,
refsLength,
}: BranchListScrollBehaviorOptions): () => void {
const updateScrollFades = useCallback(() => {
const scrollElement = branchListRef.current?.getScrollableNode?.();
if (!(scrollElement instanceof HTMLElement)) {
return;
}

branchListScrollElementRef.current = scrollElement;
const maxScrollOffset = Math.max(0, scrollElement.scrollHeight - scrollElement.clientHeight);
scrollElement.classList.toggle(TOP_BRANCH_SCROLL_FADE_CLASS, scrollElement.scrollTop > 1);
scrollElement.classList.toggle(
BOTTOM_BRANCH_SCROLL_FADE_CLASS,
maxScrollOffset - scrollElement.scrollTop > 1,
);
}, [branchListRef, branchListScrollElementRef]);

useLayoutEffect(() => {
if (!isOpen) {
return;
}

const scrollElement = branchListRef.current?.getScrollableNode?.();
if (scrollElement instanceof HTMLElement) {
branchListScrollElementRef.current = scrollElement;
scrollElement.classList.remove(TOP_BRANCH_SCROLL_FADE_CLASS);
scrollElement.classList.toggle(BOTTOM_BRANCH_SCROLL_FADE_CLASS, filteredItemCount > 8);
}

let nestedFrame = 0;
const frame = requestAnimationFrame(() => {
updateScrollFades();
nestedFrame = requestAnimationFrame(updateScrollFades);
});
return () => {
cancelAnimationFrame(frame);
cancelAnimationFrame(nestedFrame);
};
}, [
branchListRef,
branchListScrollElementRef,
deferredQuery,
filteredItemCount,
isOpen,
updateScrollFades,
]);

useEffect(() => {
if (!isOpen) {
return;
}

void branchListRef.current?.scrollToOffset?.({ offset: 0, animated: false });
}, [branchListRef, deferredQuery, isOpen]);

useEffect(() => {
maybeFetchNextPage();
}, [maybeFetchNextPage, refsLength]);

return updateScrollFades;
}

interface InitialWorktreeBranchOptions {
activeThreadBranch: string | null;
activeWorktreePath: string | null;
currentGitBranch: string | null;
effectiveEnvMode: "local" | "worktree";
setThreadBranch: (branch: string | null, worktreePath: string | null) => void;
}

function useInitialWorktreeBranch({
activeThreadBranch,
activeWorktreePath,
currentGitBranch,
effectiveEnvMode,
setThreadBranch,
}: InitialWorktreeBranchOptions): void {
useEffect(() => {
if (
effectiveEnvMode !== "worktree" ||
activeWorktreePath ||
activeThreadBranch ||
!currentGitBranch
) {
return;
}
setThreadBranch(currentGitBranch, null);
}, [activeThreadBranch, activeWorktreePath, currentGitBranch, effectiveEnvMode, setThreadBranch]);
}

function toBranchActionErrorMessage(error: unknown): string {
return error instanceof Error ? error.message : "An error occurred.";
}
Expand Down Expand Up @@ -422,17 +533,13 @@ export function BranchToolbarBranchSelector({
});
};

useEffect(() => {
if (
effectiveEnvMode !== "worktree" ||
activeWorktreePath ||
activeThreadBranch ||
!currentGitBranch
) {
return;
}
setThreadBranch(currentGitBranch, null);
}, [activeThreadBranch, activeWorktreePath, currentGitBranch, effectiveEnvMode, setThreadBranch]);
useInitialWorktreeBranch({
activeThreadBranch,
activeWorktreePath,
currentGitBranch,
effectiveEnvMode,
setThreadBranch,
});

// ---------------------------------------------------------------------------
// Combobox / list plumbing
Expand All @@ -450,8 +557,6 @@ export function BranchToolbarBranchSelector({
);

const branchListScrollElementRef = useRef<HTMLElement | null>(null);
const [showTopBranchScrollFade, setShowTopBranchScrollFade] = useState(false);
const [showBottomBranchScrollFade, setShowBottomBranchScrollFade] = useState(false);
const fetchNextBranchPage = useCallback(() => {
if (!hasNextPage || isFetchingNextPage) {
return;
Expand Down Expand Up @@ -479,51 +584,15 @@ export function BranchToolbarBranchSelector({
}, [fetchNextBranchPage, hasNextPage, isBranchMenuOpen, isFetchingNextPage]);

const branchListRef = useRef<LegendListRef | null>(null);
const updateBranchListScrollFades = useCallback(() => {
const scrollElement = branchListRef.current?.getScrollableNode?.();
if (!(scrollElement instanceof HTMLElement)) {
return;
}
branchListScrollElementRef.current = scrollElement;
const maxScrollOffset = Math.max(0, scrollElement.scrollHeight - scrollElement.clientHeight);
setShowTopBranchScrollFade(scrollElement.scrollTop > 1);
setShowBottomBranchScrollFade(maxScrollOffset - scrollElement.scrollTop > 1);
}, []);

useLayoutEffect(() => {
if (!isBranchMenuOpen) {
return;
}

setShowTopBranchScrollFade(false);
setShowBottomBranchScrollFade(filteredBranchPickerItems.length > 8);
let nestedFrame = 0;
const frame = requestAnimationFrame(() => {
updateBranchListScrollFades();
nestedFrame = requestAnimationFrame(updateBranchListScrollFades);
});
return () => {
cancelAnimationFrame(frame);
cancelAnimationFrame(nestedFrame);
};
}, [
deferredTrimmedBranchQuery,
filteredBranchPickerItems.length,
isBranchMenuOpen,
updateBranchListScrollFades,
]);

useEffect(() => {
if (!isBranchMenuOpen) {
return;
}

void branchListRef.current?.scrollToOffset?.({ offset: 0, animated: false });
}, [deferredTrimmedBranchQuery, isBranchMenuOpen]);

useEffect(() => {
maybeFetchNextBranchPage();
}, [refs.length, maybeFetchNextBranchPage]);
const updateBranchListScrollFades = useBranchListScrollBehavior({
branchListRef,
branchListScrollElementRef,
deferredQuery: deferredTrimmedBranchQuery,
filteredItemCount: filteredBranchPickerItems.length,
isOpen: isBranchMenuOpen,
maybeFetchNextPage: maybeFetchNextBranchPage,
refsLength: refs.length,
});

const triggerLabel = getBranchTriggerLabel({
activeWorktreePath,
Expand Down Expand Up @@ -719,11 +788,7 @@ export function BranchToolbarBranchSelector({
updateBranchListScrollFades();
maybeFetchNextBranchPage();
}}
className={cn(
"scrollbar-gutter-stable overflow-x-hidden overscroll-y-contain ps-1 pe-0 pt-2 pb-1 [--fade-size:1.5rem]",
showTopBranchScrollFade && "mask-t-from-[calc(100%-var(--fade-size))]",
showBottomBranchScrollFade && "mask-b-from-[calc(100%-var(--fade-size))]",
)}
className="scrollbar-gutter-stable overflow-x-hidden overscroll-y-contain ps-1 pe-0 pt-2 pb-1 [--fade-size:1.5rem]"
style={{ maxHeight: "14rem" }}
/>
</ComboboxListVirtualized>
Expand Down
Loading