TypeScript
fix(web): the main sidebar stays collapsed after relaunch (#24202)
shivamf8c7c7593f32
diff --git a/apps/web/src/components/AppSidebarLayout.tsx b/apps/web/src/components/AppSidebarLayout.tsxindex 91df5616f7f..bdcd278dc8f 100644--- a/apps/web/src/components/AppSidebarLayout.tsx+++ b/apps/web/src/components/AppSidebarLayout.tsx@@ -447,7 +447,7 @@ export function AppSidebarLayout({ children }: { children: ReactNode }) {<SidebarProviderclassName="h-dvh! min-h-0!"data-panel-animations={routePanelAnimationsActive ? "true" : "false"}- defaultOpen+ storageKey="chat_thread_sidebar_open"style={sidebarProviderStyle}><SidebarBrandWidthProbe isElectron={isElectron} onWidthChange={setBrandWidth} />diff --git a/apps/web/src/components/ui/sidebar.browser.test.tsx b/apps/web/src/components/ui/sidebar.browser.test.tsxindex 288367fa4a3..3e1d24db40e 100644--- a/apps/web/src/components/ui/sidebar.browser.test.tsx+++ b/apps/web/src/components/ui/sidebar.browser.test.tsx@@ -72,3 +72,61 @@ describe("Sidebar", () => {expect(onResize).toHaveBeenCalledTimes(1);});});++it("restores collapsed and expanded desktop state after remounting", async () => {+ await page.viewport(1280, 800);+ const storageKey = "sidebar_persistence_test";+ localStorage.removeItem(storageKey);+ const layout = () => (+ <SidebarProvider storageKey={storageKey}>+ <SidebarTrigger />+ </SidebarProvider>+ );+ {+ await using screen = await render(layout(), { router: false /* no routes involved */ });+ const trigger = screen.getByRole("button", { name: "Toggle Sidebar" });+ await expect.element(trigger).toHaveAttribute("aria-pressed", "true");+ await userEvent.click(trigger);+ await expect.element(trigger).toHaveAttribute("aria-pressed", "false");+ }+ {+ await using screen = await render(layout(), { router: false /* no routes involved */ });+ const trigger = screen.getByRole("button", { name: "Toggle Sidebar" });+ await expect.element(trigger).toHaveAttribute("aria-pressed", "false");+ await userEvent.click(trigger);+ }+ await using screen = await render(layout(), { router: false /* no routes involved */ });+ await expect+ .element(screen.getByRole("button", { name: "Toggle Sidebar" }))+ .toHaveAttribute("aria-pressed", "true");+ localStorage.removeItem(storageKey);+});++it("keeps the mobile sheet closed and leaves the saved desktop state alone", async () => {+ await page.viewport(390, 844);+ const storageKey = "sidebar_mobile_persistence_test";+ localStorage.setItem(storageKey, "false");+ {+ await using screen = await render(+ <SidebarProvider storageKey={storageKey}>+ <SidebarTrigger />+ </SidebarProvider>,+ { router: false /* no routes involved */ },+ );+ const trigger = screen.getByRole("button", { name: "Toggle Sidebar" });+ await expect.element(trigger).toHaveAttribute("aria-pressed", "false");+ await userEvent.click(trigger);+ await expect.element(trigger).toHaveAttribute("aria-pressed", "true");+ expect(localStorage.getItem(storageKey)).toBe("false");+ }+ await using screen = await render(+ <SidebarProvider storageKey={storageKey}>+ <SidebarTrigger />+ </SidebarProvider>,+ { router: false /* no routes involved */ },+ );+ await expect+ .element(screen.getByRole("button", { name: "Toggle Sidebar" }))+ .toHaveAttribute("aria-pressed", "false");+ localStorage.removeItem(storageKey);+});diff --git a/apps/web/src/components/ui/sidebar.tsx b/apps/web/src/components/ui/sidebar.tsxindex e99509c8ce6..6c961ab093f 100644--- a/apps/web/src/components/ui/sidebar.tsx+++ b/apps/web/src/components/ui/sidebar.tsx@@ -18,13 +18,15 @@ import {import { Tooltip, TooltipPopup, TooltipTrigger } from "~/components/ui/tooltip";import { useResizeDrag } from "~/hooks/useResizeDrag";import { useMediaQuery } from "~/hooks/useMediaQuery";-import { setLocalStorageItem } from "~/hooks/useLocalStorage";+import {+ getLocalStorageItem,+ setLocalStorageItem,+ writeLocalStorageValue,+} from "~/hooks/useLocalStorage";import { resolveSidebarState, type ResponsiveSidebarState } from "./sidebarState";import * as Schema from "effect/Schema";import { announceSidebarVisibility } from "~/lib/accessibilityAnnouncements";-const SIDEBAR_COOKIE_NAME = "sidebar_state";-const SIDEBAR_COOKIE_MAX_AGE = 60 * 60 * 24 * 7;const SIDEBAR_WIDTH = "16rem";const SIDEBAR_WIDTH_MOBILE = "calc(100vw - var(--spacing(3)))";const SIDEBAR_WIDTH_ICON = "3rem";@@ -104,13 +106,14 @@ function isMobileViewport(): boolean {return typeof window !== "undefined" && window.matchMedia(SIDEBAR_MOBILE_QUERY).matches;}-async function persistSidebarOpen(open: boolean) {- await cookieStore.set({- expires: Date.now() + SIDEBAR_COOKIE_MAX_AGE * 1000,- name: SIDEBAR_COOKIE_NAME,- path: "/",- value: String(open),- });+function readStoredSidebarOpen(storageKey: string | undefined): boolean | null {+ if (!storageKey) return null;+ try {+ return getLocalStorageItem(storageKey, Schema.Boolean);+ } catch (error) {+ console.error("Could not restore persisted sidebar state.", error);+ return null;+ }}// An offcanvas sidebar turns inert once collapsed, which drops focus to the body.@@ -132,8 +135,11 @@ interface SidebarOpenState {}/** Per-provider open state, kept outside React so shortcuts can toggle it at event time. */-function createSidebarOpenStore(defaultOpen: boolean) {- let state: SidebarOpenState = { open: defaultOpen, openMobile: false };+function createSidebarOpenStore(defaultOpen: boolean, storageKey: string | undefined) {+ let state: SidebarOpenState = {+ open: readStoredSidebarOpen(storageKey) ?? defaultOpen,+ openMobile: false,+ };const listeners = new Set<() => void>();const collapseListeners = new Set<() => void>();const publish = (next: SidebarOpenState) => {@@ -149,7 +155,7 @@ function createSidebarOpenStore(defaultOpen: boolean) {if (!isMobileViewport()) announceSidebarVisibility(open);publish({ ...state, open });}- void persistSidebarOpen(open);+ if (storageKey) writeLocalStorageValue(storageKey, open, defaultOpen, Schema.Boolean);};const setOpenMobile = (openMobile: boolean) => {if (openMobile !== state.openMobile) publish({ ...state, openMobile });@@ -176,15 +182,17 @@ function createSidebarOpenStore(defaultOpen: boolean) {function SidebarProvider({defaultOpen = true,+ storageKey,className,style,children,...props}: React.ComponentProps<"div"> & {defaultOpen?: boolean;+ storageKey?: string;}) {const isMobile = useMediaQuery(SIDEBAR_MOBILE_QUERY);- const [store] = React.useState(() => createSidebarOpenStore(defaultOpen));+ const [store] = React.useState(() => createSidebarOpenStore(defaultOpen, storageKey));const { open, openMobile } = React.useSyncExternalStore(store.subscribe,store.getSnapshot,