π OpenHands: AI-Driven Development
feat(conversation-panel): persist filter-menu preferences in localStorage (#510)
Robert Brennanb5bb513c8209
diff --git a/__tests__/stores/conversation-panel-preferences-store.test.ts b/__tests__/stores/conversation-panel-preferences-store.test.tsnew file mode 100644index 0000000000..6639a0a95a--- /dev/null+++ b/__tests__/stores/conversation-panel-preferences-store.test.ts@@ -0,0 +1,73 @@+import { beforeEach, describe, expect, it } from "vitest";+import { useConversationPanelPreferencesStore } from "#/stores/conversation-panel-preferences-store";++const STORAGE_KEY = "conversation-panel-preferences";++describe("conversation-panel-preferences store", () => {+ beforeEach(() => {+ window.localStorage.clear();+ });++ it("defaults to showing older conversations and hiding repo/branch metadata", () => {+ const state = useConversationPanelPreferencesStore.getState();+ expect(state.showOlderConversations).toBe(true);+ expect(state.showRepoBranchMetadata).toBe(false);+ });++ it("toggles showOlderConversations and persists the new value to localStorage", () => {+ useConversationPanelPreferencesStore+ .getState()+ .toggleShowOlderConversations();++ expect(+ useConversationPanelPreferencesStore.getState().showOlderConversations,+ ).toBe(false);++ const persisted = JSON.parse(+ window.localStorage.getItem(STORAGE_KEY) ?? "{}",+ );+ expect(persisted.state.showOlderConversations).toBe(false);+ });++ it("toggles showRepoBranchMetadata and persists the new value to localStorage", () => {+ useConversationPanelPreferencesStore+ .getState()+ .toggleShowRepoBranchMetadata();++ expect(+ useConversationPanelPreferencesStore.getState().showRepoBranchMetadata,+ ).toBe(true);++ const persisted = JSON.parse(+ window.localStorage.getItem(STORAGE_KEY) ?? "{}",+ );+ expect(persisted.state.showRepoBranchMetadata).toBe(true);+ });++ it("supports explicit setters for both preferences", () => {+ useConversationPanelPreferencesStore+ .getState()+ .setShowOlderConversations(false);+ useConversationPanelPreferencesStore+ .getState()+ .setShowRepoBranchMetadata(true);++ const state = useConversationPanelPreferencesStore.getState();+ expect(state.showOlderConversations).toBe(false);+ expect(state.showRepoBranchMetadata).toBe(true);+ });++ it("persists data fields but not action functions", () => {+ useConversationPanelPreferencesStore+ .getState()+ .toggleShowOlderConversations();++ const persisted = JSON.parse(+ window.localStorage.getItem(STORAGE_KEY) ?? "{}",+ );+ expect(Object.keys(persisted.state).sort()).toEqual([+ "showOlderConversations",+ "showRepoBranchMetadata",+ ]);+ });+});diff --git a/src/components/features/conversation-panel/conversation-panel.tsx b/src/components/features/conversation-panel/conversation-panel.tsxindex dbbc69ef17..5bb43caa73 100644--- a/src/components/features/conversation-panel/conversation-panel.tsx+++ b/src/components/features/conversation-panel/conversation-panel.tsx@@ -24,6 +24,7 @@ import { ConversationCard } from "./conversation-card/conversation-card";import { StartTaskCard } from "./start-task-card/start-task-card";import { ConversationCardSkeleton } from "./conversation-card/conversation-card-skeleton";import { CompactConversationRow } from "./compact-conversation-row";+import { useConversationPanelPreferencesStore } from "#/stores/conversation-panel-preferences-store";import { cn } from "#/utils/utils";interface ConversationPanelProps {@@ -86,11 +87,22 @@ export function ConversationPanel({] = React.useState(false);const [confirmDeleteOlderVisible, setConfirmDeleteOlderVisible] =React.useState(false);- const [showOlderConversations, setShowOlderConversations] =- React.useState(true);+ // Filter-menu toggles persist across reloads via the preferences store β+ // the menu's open/closed state stays transient (React.useState) since+ // users expect a dropdown to start closed every time they revisit.+ const showOlderConversations = useConversationPanelPreferencesStore(+ (state) => state.showOlderConversations,+ );+ const toggleShowOlderConversations = useConversationPanelPreferencesStore(+ (state) => state.toggleShowOlderConversations,+ );+ const showRepoBranchMetadata = useConversationPanelPreferencesStore(+ (state) => state.showRepoBranchMetadata,+ );+ const toggleShowRepoBranchMetadata = useConversationPanelPreferencesStore(+ (state) => state.toggleShowRepoBranchMetadata,+ );const [olderFilterMenuOpen, setOlderFilterMenuOpen] = React.useState(false);- const [showRepoBranchMetadata, setShowRepoBranchMetadata] =- React.useState(false);const [isListScrolled, setIsListScrolled] = React.useState(false);const olderFilterMenuRef = useClickOutsideElement<HTMLDivElement>(() => {setOlderFilterMenuOpen(false);@@ -340,7 +352,7 @@ export function ConversationPanel({type="button"data-testid="toggle-older-conversations"onClick={() => {- setShowOlderConversations((value) => !value);+ toggleShowOlderConversations();setOlderFilterMenuOpen(false);}}className="block w-full rounded px-2 py-2 text-left text-sm text-white hover:bg-[var(--oh-interactive-hover)]"@@ -365,7 +377,7 @@ export function ConversationPanel({type="button"data-testid="toggle-repo-branch-metadata"onClick={() => {- setShowRepoBranchMetadata((value) => !value);+ toggleShowRepoBranchMetadata();setOlderFilterMenuOpen(false);}}className="block w-full rounded px-2 py-2 text-left text-sm text-white hover:bg-[var(--oh-interactive-hover)]"diff --git a/src/stores/conversation-panel-preferences-store.ts b/src/stores/conversation-panel-preferences-store.tsnew file mode 100644index 0000000000..c63803a30e--- /dev/null+++ b/src/stores/conversation-panel-preferences-store.ts@@ -0,0 +1,67 @@+import { create } from "zustand";+import { persist, createJSONStorage } from "zustand/middleware";++/**+ * User-toggleable display preferences for the sidebar conversation list+ * filter menu. These are intentionally persisted to localStorage (via the+ * same `zustand/persist` pattern used by `home-store` and `workspaces-store`)+ * so the menu state survives full reloads.+ *+ * To add a new preference exposed by the filter menu:+ * 1. Add a field here with a sensible default in `initialState`.+ * 2. Add matching `setX`/`toggleX` actions below.+ * 3. Read/write through the store in `conversation-panel.tsx`.+ * No additional plumbing (storage keys, sanitization, etc.) is required β+ * `persist` handles migration of unknown fields gracefully.+ */+interface ConversationPanelPreferencesState {+ showOlderConversations: boolean;+ showRepoBranchMetadata: boolean;+}++interface ConversationPanelPreferencesActions {+ setShowOlderConversations: (value: boolean) => void;+ toggleShowOlderConversations: () => void;+ setShowRepoBranchMetadata: (value: boolean) => void;+ toggleShowRepoBranchMetadata: () => void;+}++type ConversationPanelPreferencesStore = ConversationPanelPreferencesState &+ ConversationPanelPreferencesActions;++const initialState: ConversationPanelPreferencesState = {+ showOlderConversations: true,+ showRepoBranchMetadata: false,+};++export const useConversationPanelPreferencesStore =+ create<ConversationPanelPreferencesStore>()(+ persist(+ (set) => ({+ ...initialState,++ setShowOlderConversations: (value) =>+ set(() => ({ showOlderConversations: value })),+ toggleShowOlderConversations: () =>+ set((state) => ({+ showOlderConversations: !state.showOlderConversations,+ })),++ setShowRepoBranchMetadata: (value) =>+ set(() => ({ showRepoBranchMetadata: value })),+ toggleShowRepoBranchMetadata: () =>+ set((state) => ({+ showRepoBranchMetadata: !state.showRepoBranchMetadata,+ })),+ }),+ {+ name: "conversation-panel-preferences",+ storage: createJSONStorage(() => localStorage),+ // Only persist the data fields β actions are recreated on each load.+ partialize: (state): ConversationPanelPreferencesState => ({+ showOlderConversations: state.showOlderConversations,+ showRepoBranchMetadata: state.showRepoBranchMetadata,+ }),+ },+ ),+ );