Skip to content

A local-first personal finance app

[AI] Allow the Reports page to be hidden from the sidebar (#9406)

James N288bf88f2ffa
diff --git a/packages/desktop-client/e2e/settings.test.ts-snapshots/Settings-checks-the-page-visuals-2-chromium-linux.png b/packages/desktop-client/e2e/settings.test.ts-snapshots/Settings-checks-the-page-visuals-2-chromium-linux.png
index 117586563a..39131de714 100644
Binary files a/packages/desktop-client/e2e/settings.test.ts-snapshots/Settings-checks-the-page-visuals-2-chromium-linux.png and b/packages/desktop-client/e2e/settings.test.ts-snapshots/Settings-checks-the-page-visuals-2-chromium-linux.png differ
diff --git a/packages/desktop-client/e2e/settings.test.ts-snapshots/Settings-checks-the-page-visuals-3-chromium-linux.png b/packages/desktop-client/e2e/settings.test.ts-snapshots/Settings-checks-the-page-visuals-3-chromium-linux.png
index 79d849ff2b..ea092dc621 100644
Binary files a/packages/desktop-client/e2e/settings.test.ts-snapshots/Settings-checks-the-page-visuals-3-chromium-linux.png and b/packages/desktop-client/e2e/settings.test.ts-snapshots/Settings-checks-the-page-visuals-3-chromium-linux.png differ
diff --git a/packages/desktop-client/src/components/settings/SettingsNav.test.tsx b/packages/desktop-client/src/components/settings/SettingsNav.test.tsx
index 72cf6e8d2b..6e51c5aed0 100644
--- a/packages/desktop-client/src/components/settings/SettingsNav.test.tsx
+++ b/packages/desktop-client/src/components/settings/SettingsNav.test.tsx
@@ -81,6 +81,14 @@ describe('SettingsNav', () => {
]);
});
+ it('leaves out a hidden reports page', () => {
+ renderNav('/settings', [{ id: 'reports', hidden: true }]);
+
+ expect(
+ screen.queryByRole('link', { name: 'Reports' }),
+ ).not.toBeInTheDocument();
+ });
+
it('hides bank sync without a server', () => {
vi.mocked(useSyncServerStatus).mockReturnValue('no-server');
diff --git a/packages/desktop-client/src/components/settings/SidebarMenuListItem.tsx b/packages/desktop-client/src/components/settings/SidebarMenuListItem.tsx
index 4b614c4b34..bb96920370 100644
--- a/packages/desktop-client/src/components/settings/SidebarMenuListItem.tsx
+++ b/packages/desktop-client/src/components/settings/SidebarMenuListItem.tsx
@@ -9,11 +9,16 @@ import { theme } from '@actual-app/components/theme';
import { Toggle } from '@actual-app/components/toggle';
import { css } from '@emotion/css';
-import { isSidebarMenuItemLocked } from '#components/sidebar/sidebarMenu';
+import {
+ getSidebarMenuItemPath,
+ isSettingsSection,
+ isSidebarMenuItemLocked,
+} from '#components/sidebar/sidebarMenu';
import type {
SidebarMenuItem,
SidebarMenuItemId,
} from '#components/sidebar/sidebarMenu';
+import { useNavigate } from '#hooks/useNavigate';
type SidebarMenuListItemProps = {
item: SidebarMenuItem;
@@ -33,6 +38,7 @@ export function SidebarMenuListItem({
onToggle,
}: SidebarMenuListItemProps) {
const { t } = useTranslation();
+ const navigate = useNavigate();
return (
<GridListItem
@@ -93,6 +99,15 @@ export function SidebarMenuListItem({
<Trans>Start page</Trans>
</Text>
)}
+ {item.hidden && !isSettingsSection(item.id) && (
+ <Button
+ variant="bare"
+ aria-label={t('Open {{ pageName }}', { pageName: label })}
+ onPress={() => navigate(getSidebarMenuItemPath(item.id, false))}
+ >
+ <Trans>Open</Trans>
+ </Button>
+ )}
{isSidebarMenuItemLocked(item.id) ? (
<Text
size="small"
diff --git a/packages/desktop-client/src/components/settings/SidebarSettings.test.tsx b/packages/desktop-client/src/components/settings/SidebarSettings.test.tsx
new file mode 100644
index 0000000000..510f58c5f6
--- /dev/null
+++ b/packages/desktop-client/src/components/settings/SidebarSettings.test.tsx
@@ -0,0 +1,61 @@
+import { MemoryRouter, Route, Routes } from 'react-router';
+
+import { render, screen } from '@testing-library/react';
+import { userEvent } from '@testing-library/user-event';
+
+import { useIsTestEnv } from '#hooks/useIsTestEnv';
+import { useSyncServerStatus } from '#hooks/useSyncServerStatus';
+import { createTestAppStore, TestProviders } from '#mocks';
+import { mergeSyncedPrefs } from '#prefs/prefsSlice';
+
+import { SidebarSettings } from './SidebarSettings';
+
+vi.mock('#hooks/useSyncServerStatus', () => ({
+ useSyncServerStatus: vi.fn(),
+}));
+vi.mock('#hooks/useIsTestEnv', () => ({
+ useIsTestEnv: vi.fn(),
+}));
+
+function renderSettings(sidebarMenuItems: unknown[]) {
+ const store = createTestAppStore();
+ store.dispatch(
+ mergeSyncedPrefs({
+ 'sidebar-menu-items': JSON.stringify(sidebarMenuItems),
+ }),
+ );
+
+ return render(
+ <TestProviders store={store}>
+ <MemoryRouter initialEntries={['/settings/general']}>
+ <Routes>
+ <Route path="/settings/general" element={<SidebarSettings />} />
+ <Route path="/reports" element={<div>Reports page</div>} />
+ </Routes>
+ </MemoryRouter>
+ </TestProviders>,
+ );
+}
+
+describe('SidebarSettings', () => {
+ beforeEach(() => {
+ vi.mocked(useSyncServerStatus).mockReturnValue('online');
+ vi.mocked(useIsTestEnv).mockReturnValue(false);
+ });
+
+ it('opens a hidden reports page from its row', async () => {
+ renderSettings([{ id: 'reports', hidden: true }]);
+
+ await userEvent.click(screen.getByRole('button', { name: 'Open Reports' }));
+
+ expect(screen.getByText('Reports page')).toBeInTheDocument();
+ });
+
+ it('has no open button while reports is in the sidebar', () => {
+ renderSettings([{ id: 'reports', hidden: false }]);
+
+ expect(
+ screen.queryByRole('button', { name: 'Open Reports' }),
+ ).not.toBeInTheDocument();
+ });
+});
diff --git a/packages/desktop-client/src/components/sidebar/sidebarMenu.test.ts b/packages/desktop-client/src/components/sidebar/sidebarMenu.test.ts
index 5e7a1534e4..562c65d303 100644
--- a/packages/desktop-client/src/components/sidebar/sidebarMenu.test.ts
+++ b/packages/desktop-client/src/components/sidebar/sidebarMenu.test.ts
@@ -77,7 +77,7 @@ describe('parseSidebarMenuItems', () => {
expect(items.find(item => item.id === 'payees')?.hidden).toBe(true);
});
- it('always keeps budget and reports in the sidebar', () => {
+ it('always keeps budget in the sidebar', () => {
const items = parseSidebarMenuItems(
JSON.stringify(
getDefaultSidebarMenuItems().map(item => ({ ...item, hidden: true })),
@@ -86,8 +86,8 @@ describe('parseSidebarMenuItems', () => {
expect(items.filter(item => !item.hidden)).toEqual([
{ id: 'budget', hidden: false },
- { id: 'reports', hidden: false },
]);
+ expect(items.find(item => item.id === 'reports')?.hidden).toBe(true);
});
});
diff --git a/packages/desktop-client/src/components/sidebar/sidebarMenu.ts b/packages/desktop-client/src/components/sidebar/sidebarMenu.ts
index 11a0c1ee43..accbfbce4f 100644
--- a/packages/desktop-client/src/components/sidebar/sidebarMenu.ts
+++ b/packages/desktop-client/src/components/sidebar/sidebarMenu.ts
@@ -32,7 +32,7 @@ export function isSettingsSection(
}
export function isSidebarMenuItemLocked(id: SidebarMenuItemId): boolean {
- return !isSettingsSection(id);
+ return id === 'budget';
}
export function isSettingsSectionOnMobile(id: SettingsSectionId): boolean {
diff --git a/packages/desktop-client/src/hooks/useSidebarMenu.test.tsx b/packages/desktop-client/src/hooks/useSidebarMenu.test.tsx
new file mode 100644
index 0000000000..d93106defb
--- /dev/null
+++ b/packages/desktop-client/src/hooks/useSidebarMenu.test.tsx
@@ -0,0 +1,86 @@
+import type { ReactNode } from 'react';
+import { MemoryRouter } from 'react-router';
+
+import { act, renderHook } from '@testing-library/react';
+
+import { useIsTestEnv } from '#hooks/useIsTestEnv';
+import { useNavigate } from '#hooks/useNavigate';
+import { useSyncServerStatus } from '#hooks/useSyncServerStatus';
+import { createTestAppStore, TestProviders } from '#mocks';
+import { mergeSyncedPrefs } from '#prefs/prefsSlice';
+
+import { useSidebarMenu } from './useSidebarMenu';
+
+vi.mock('#hooks/useSyncServerStatus', () => ({
+ useSyncServerStatus: vi.fn(),
+}));
+vi.mock('#hooks/useIsTestEnv', () => ({
+ useIsTestEnv: vi.fn(),
+}));
+
+function renderSidebarMenu(initialPath: string) {
+ const store = createTestAppStore();
+ store.dispatch(
+ mergeSyncedPrefs({
+ 'sidebar-menu-items': JSON.stringify([{ id: 'reports', hidden: true }]),
+ }),
+ );
+
+ const { result } = renderHook(
+ () => ({ ...useSidebarMenu(), navigate: useNavigate() }),
+ {
+ wrapper: ({ children }: { children: ReactNode }) => (
+ <TestProviders store={store}>
+ <MemoryRouter initialEntries={[initialPath]}>{children}</MemoryRouter>
+ </TestProviders>
+ ),
+ },
+ );
+
+ return result;
+}
+
+describe('useSidebarMenu', () => {
+ beforeEach(() => {
+ vi.mocked(useSyncServerStatus).mockReturnValue('online');
+ vi.mocked(useIsTestEnv).mockReturnValue(false);
+ });
+
+ it('leaves a hidden reports page out of the sidebar', () => {
+ const { sidebarItems } = renderSidebarMenu('/budget').current;
+
+ expect(sidebarItems.map(item => item.id)).toEqual(['budget', 'schedules']);
+ });
+
+ it('shows a hidden reports page in the sidebar while it is open', () => {
+ const { sidebarItems } = renderSidebarMenu('/reports/custom').current;
+
+ expect(sidebarItems.map(item => item.id)).toEqual([
+ 'budget',
+ 'reports',
+ 'schedules',
+ ]);
+ });
+
+ it('removes a hidden reports page after navigating away', () => {
+ const result = renderSidebarMenu('/reports/custom');
+ expect(result.current.sidebarItems.map(item => item.id)).toContain(
+ 'reports',
+ );
+
+ act(() => {
+ void result.current.navigate('/budget');
+ });
+
+ expect(result.current.sidebarItems.map(item => item.id)).toEqual([
+ 'budget',
+ 'schedules',
+ ]);
+ });
+
+ it('never moves a hidden reports page into settings', () => {
+ const { settingsItems } = renderSidebarMenu('/budget').current;
+
+ expect(settingsItems.map(item => item.id)).not.toContain('reports');
+ });
+});
diff --git a/packages/desktop-client/src/hooks/useSidebarMenu.ts b/packages/desktop-client/src/hooks/useSidebarMenu.ts
index 51b9bb5ca2..ee49ee8adc 100644
--- a/packages/desktop-client/src/hooks/useSidebarMenu.ts
+++ b/packages/desktop-client/src/hooks/useSidebarMenu.ts
@@ -1,7 +1,10 @@
+import { matchPath, useLocation } from 'react-router';
+
import type { SyncedPrefs } from '@actual-app/core/types/prefs';
import {
getSidebarMenuItemPath,
+ isSettingsSection,
parseSidebarMenuItems,
parseSidebarStartPage,
} from '#components/sidebar/sidebarMenu';
@@ -28,8 +31,17 @@ export function useSidebarMenu() {
const items = parseSidebarMenuItems(itemsPref);
const availableItems = items.filter(item => isItemAvailable(item.id));
- const sidebarItems = availableItems.filter(item => !item.hidden);
- const settingsItems = availableItems.filter(item => item.hidden);
+ // A hidden page with no settings page stays in the sidebar while it is open
+ const { pathname } = useLocation();
+ const isItemOpen = (id: SidebarMenuItemId) =>
+ matchPath(`/${id}/*`, pathname) !== null;
+ const sidebarItems = availableItems.filter(
+ item =>
+ !item.hidden || (!isSettingsSection(item.id) && isItemOpen(item.id)),
+ );
+ const settingsItems = availableItems.filter(
+ item => item.hidden && isSettingsSection(item.id),
+ );
const startPage = parseSidebarStartPage(startPagePref, availableItems);
const startPath = getSidebarMenuItemPath(
diff --git a/upcoming-release-notes/hide-reports-page.md b/upcoming-release-notes/hide-reports-page.md
new file mode 100644
index 0000000000..baa9ae60e4
--- /dev/null
+++ b/upcoming-release-notes/hide-reports-page.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [RandomSpaceship]
+---
+
+Allow the Reports page to be hidden from the sidebar