diff --git a/.changeset/compact-search-layout.md b/.changeset/compact-search-layout.md new file mode 100644 index 0000000000..95f4e21bb3 --- /dev/null +++ b/.changeset/compact-search-layout.md @@ -0,0 +1,7 @@ +--- +'@hyperdx/app': patch +--- + +fix: saved search is usable on a phone. Below 900px the filters open in a +drawer, SELECT and ORDER BY stay behind "Columns", and the log table +keeps the remaining screen. diff --git a/agent_docs/page_layout.md b/agent_docs/page_layout.md index 1c34590d26..c1ca244760 100644 --- a/agent_docs/page_layout.md +++ b/agent_docs/page_layout.md @@ -131,6 +131,21 @@ Sessions keeps a **single-row** query toolbar (source, where filter, time range, - Kubernetes Dashboard, Clickhouse Dashboard — `PageLayout` with `breadcrumbs`, `leading`, `actions`, `padded` (no `title`) - Client Sessions — `PageLayout` with custom `PageHeader` containing the full single-row query toolbar +## Compact viewports + +A viewport under 900px is compact. `useCompactViewport` (`packages/app/src/components/CompactViewport/useCompactViewport.ts`) is the cutoff, and the nav collapses on the same width. Pages that switch layout use this hook. + +A page that is a side panel plus a main pane uses `ResponsiveSidePanel` (`packages/app/src/components/CompactViewport/ResponsiveSidePanel.tsx`): + +- Wide: the panel sits beside the main pane. +- Compact: the main pane uses the full width. The panel opens in a drawer and does not take horizontal space. Pass a `title`; the drawer has no default. The panel stays unmounted until the first open, then stays mounted so closing the drawer does not drop its state. + +The caller owns whether the panel is open. Keep that state separate from any desktop collapse preference stored in localStorage. A phone session that wrote the desktop preference would hide the panel the next time the same browser opened the page on a desktop. + +Give the main pane `flex: 1` and `min-height: 0` inside a full-height column, so it keeps the space under the toolbar and scrolls inside itself. A hard `min-width` on the panel inside `overflow: hidden` clips the main pane on a phone. + +Search is the first page on this pattern. Other side-panel pages should adopt it the same way instead of a one-off media query. + ## Knip `packages/app` Knip entry roots are `pages/`, `scripts/`, and e2e tests. After you add or move a `PageLayout` import, run `yarn knip` from the repo root (or `yarn knip` in `packages/app` if configured) so new consumers stay wired. diff --git a/packages/app/src/DBSearchPage.tsx b/packages/app/src/DBSearchPage.tsx index e7a257d397..4a9e9e5d3f 100644 --- a/packages/app/src/DBSearchPage.tsx +++ b/packages/app/src/DBSearchPage.tsx @@ -88,6 +88,8 @@ import CodeMirror from '@uiw/react-codemirror'; import api, { useCompleteOnboardingTask } from '@/api'; import { ActiveFilterPills } from '@/components/ActiveFilterPills'; import { AlertStatusIcon } from '@/components/AlertStatusIcon'; +import { ResponsiveSidePanel } from '@/components/CompactViewport/ResponsiveSidePanel'; +import { useCompactViewport } from '@/components/CompactViewport/useCompactViewport'; import { ContactSupportText } from '@/components/ContactSupportText'; import { DBSearchPageFilters } from '@/components/DBSearchPageFilters'; import { cleanClickHouseExpression } from '@/components/DBSearchPageFilters/utils'; @@ -1117,6 +1119,31 @@ function DBSearchPageContent() { const [isFilterSidebarCollapsed, setIsFilterSidebarCollapsed] = useLocalStorage('isFilterSidebarCollapsed', false); + // Compact open state stays out of `isFilterSidebarCollapsed`. Writing that + // key from a phone would collapse the sidebar the next time the same + // browser opens the page on a desktop. + const [isCompactFiltersOpen, setIsCompactFiltersOpen] = useState(false); + // SELECT grows with its text. On a phone that pushes the logs off the + // screen, so the column editors stay closed until the user asks. + const [columnsOpen, setColumnsOpen] = useState(false); + const isCompact = useCompactViewport(); + const filtersCollapsed = isCompact + ? !isCompactFiltersOpen + : isFilterSidebarCollapsed; + const collapseFilters = useCallback(() => { + if (isCompact) { + setIsCompactFiltersOpen(false); + return; + } + setIsFilterSidebarCollapsed(true); + }, [isCompact, setIsFilterSidebarCollapsed]); + const expandFilters = useCallback(() => { + if (isCompact) { + setIsCompactFiltersOpen(true); + return; + } + setIsFilterSidebarCollapsed(false); + }, [isCompact, setIsFilterSidebarCollapsed]); const [denoiseResults, _setDenoiseResults] = useQueryState( 'denoise', @@ -2209,6 +2236,52 @@ function DBSearchPageContent() { [setValue, setNewSourceModalClosed], ); + const columnFields = (allowMultiline: boolean, stacked: boolean) => { + const select = ( + + ); + const orderBy = ( + + ); + if (stacked) { + return ( + <> + {select} + {orderBy} + + ); + } + return ( + <> + {select} + {orderBy} + + ); + }; + return ( {/* */} - + setIsSourceSchemaPreviewOpen(false)} /> - - - - - - + {!isCompact && columnFields(true, false)} <> {!savedSearchId ? ( )} + {isCompact && ( + + )} + {isCompact && columnsOpen && ( + + {columnFields(false, true)} + + )} - + {!queryReady ? ( @@ -2544,14 +2618,12 @@ function DBSearchPageContent() { /> ) : ( <> -
- {!isFilterSidebarCollapsed && ( + opened={!filtersCollapsed} + onClose={collapseFilters} + title="Filters" + panel={ setIsFilterSidebarCollapsed(true)} + onCollapse={isCompact ? undefined : collapseFilters} + fill={isCompact} {...searchFilters} /> - )} + } + > {analysisMode === 'pattern' && histogramTimeChartConfig != null && ( @@ -2583,10 +2657,8 @@ function DBSearchPageContent() { style={{ width: '100%' }} > - setIsFilterSidebarCollapsed(false) - } + isFilterSidebarCollapsed={filtersCollapsed} + onExpandFilters={expandFilters} histogramTimeChartConfig={histogramTimeChartConfig} /> {!hasQueryError && ( + + {filtersCollapsed && ( + + + + )} + + + + )} {analysisMode === 'results' && ( @@ -2674,10 +2759,8 @@ function DBSearchPageContent() { style={{ width: '100%' }} > - setIsFilterSidebarCollapsed(false) - } + isFilterSidebarCollapsed={filtersCollapsed} + onExpandFilters={expandFilters} histogramTimeChartConfig={histogramTimeChartConfig} enableParallelQueries /> @@ -2704,7 +2787,11 @@ function DBSearchPageContent() { {!hasQueryError && ( )} -
+ )}
diff --git a/packages/app/src/__tests__/DBSearchPage.directTrace.test.tsx b/packages/app/src/__tests__/DBSearchPage.directTrace.test.tsx index fdee8e270e..e67ec50517 100644 --- a/packages/app/src/__tests__/DBSearchPage.directTrace.test.tsx +++ b/packages/app/src/__tests__/DBSearchPage.directTrace.test.tsx @@ -255,6 +255,7 @@ jest.mock('@/utils', () => ({ jest.fn(), ], usePrevious: (value: unknown) => value, + useWindowSize: () => ({ width: 1200, height: 800 }), })); jest.mock('@tanstack/react-query', () => ({ diff --git a/packages/app/src/components/AppNav/AppNav.tsx b/packages/app/src/components/AppNav/AppNav.tsx index 217ffe4bf3..3f5b1f12c9 100644 --- a/packages/app/src/components/AppNav/AppNav.tsx +++ b/packages/app/src/components/AppNav/AppNav.tsx @@ -31,6 +31,7 @@ import { import api from '@/api'; import { AlertStatusIcon } from '@/components/AlertStatusIcon'; import { InstanceLabel } from '@/components/AppNav/InstanceLabel'; +import { useCompactViewport } from '@/components/CompactViewport/useCompactViewport'; import { APP_VERSION, IS_LOCAL_MODE } from '@/config'; import { Dashboard, useDashboards } from '@/dashboard'; import { useFavorites } from '@/favorites'; @@ -41,7 +42,6 @@ import { useSavedSearches } from '@/savedSearch'; import { useLogomark, useWordmark } from '@/theme/ThemeProvider'; import { UserPreferencesModal } from '@/UserPreferencesModal'; import { useUserPreferences } from '@/useUserPreferences'; -import { useWindowSize } from '@/utils'; import { AppNavCloudBanner, @@ -185,15 +185,12 @@ export default function AppNav({ fixed = false }: { fixed?: boolean }) { const { data: meData } = api.useMe(); - const { width } = useWindowSize(); - const [isPreferCollapsed, setIsPreferCollapsed] = useLocalStorage({ key: 'isNavCollapsed', defaultValue: false, }); - const isSmallScreen = (width ?? 1000) < 900; - const isCollapsed = isSmallScreen || isPreferCollapsed; + const isCollapsed = useCompactViewport() || isPreferCollapsed; const navWidth = isCollapsed ? 50 : 250; diff --git a/packages/app/src/components/CompactViewport/ResponsiveSidePanel.tsx b/packages/app/src/components/CompactViewport/ResponsiveSidePanel.tsx new file mode 100644 index 0000000000..a9f940f652 --- /dev/null +++ b/packages/app/src/components/CompactViewport/ResponsiveSidePanel.tsx @@ -0,0 +1,82 @@ +import { type ReactNode, useState } from 'react'; +import { Drawer } from '@mantine/core'; + +import { useZIndex } from '@/zIndex'; + +import { useCompactViewport } from './useCompactViewport'; + +/** + * Side panel beside a main pane. On a compact viewport the panel opens in a + * drawer so it does not take horizontal space from the main pane. The caller + * owns `opened`; this component does not persist that state. + */ +export function ResponsiveSidePanel({ + panel, + children, + opened, + onClose, + title, + className, +}: { + panel: ReactNode; + children: ReactNode; + opened: boolean; + onClose: () => void; + title: string; + className?: string; +}) { + const isCompact = useCompactViewport(); + const drawerZIndex = useZIndex() + 10; + // Stay unmounted until the first open, so a phone does not fetch facets + // before the user asks. After that, keep the panel mounted so closing the + // drawer does not drop facet state or repeat those queries. + const [keepPanelMounted, setKeepPanelMounted] = useState(opened); + if (opened && !keepPanelMounted) { + setKeepPanelMounted(true); + } + + return ( +
+ {!isCompact && opened ? panel : null} + {children} + {isCompact && ( + + {keepPanelMounted ? panel : null} + + )} +
+ ); +} diff --git a/packages/app/src/components/CompactViewport/__tests__/ResponsiveSidePanel.test.tsx b/packages/app/src/components/CompactViewport/__tests__/ResponsiveSidePanel.test.tsx new file mode 100644 index 0000000000..e55831169e --- /dev/null +++ b/packages/app/src/components/CompactViewport/__tests__/ResponsiveSidePanel.test.tsx @@ -0,0 +1,69 @@ +import { MantineProvider } from '@mantine/core'; +import { render, screen, waitFor } from '@testing-library/react'; +import userEvent from '@testing-library/user-event'; + +import { ResponsiveSidePanel } from '@/components/CompactViewport/ResponsiveSidePanel'; +import { useCompactViewport } from '@/components/CompactViewport/useCompactViewport'; + +jest.mock('@/components/CompactViewport/useCompactViewport', () => ({ + useCompactViewport: jest.fn(() => false), +})); + +const useCompactViewportMock = jest.mocked(useCompactViewport); + +function panelTree(opened: boolean, onClose: () => void = () => {}) { + return ( + + Service name} + > +
Logs
+
+
+ ); +} + +function renderPanel(opened: boolean, onClose?: () => void) { + return render(panelTree(opened, onClose)); +} + +describe('ResponsiveSidePanel', () => { + it('renders the panel inline on a wide viewport', () => { + useCompactViewportMock.mockReturnValue(false); + renderPanel(true); + expect(screen.getByText('Logs')).toBeInTheDocument(); + expect(screen.getByText('Service name')).toBeInTheDocument(); + expect(screen.queryByRole('dialog')).not.toBeInTheDocument(); + }); + + it('hides the panel until it is opened on a compact viewport', async () => { + useCompactViewportMock.mockReturnValue(true); + const { rerender } = renderPanel(false); + expect(screen.getByText('Logs')).toBeInTheDocument(); + expect(screen.queryByText('Service name')).not.toBeInTheDocument(); + + rerender(panelTree(true)); + await waitFor(() => { + expect(screen.getByRole('dialog')).toBeInTheDocument(); + }); + expect(screen.getByText('Service name')).toBeInTheDocument(); + + rerender(panelTree(false)); + expect(screen.getByText('Service name')).toBeInTheDocument(); + }); + + it('calls onClose when the drawer is dismissed', async () => { + useCompactViewportMock.mockReturnValue(true); + const onClose = jest.fn(); + const user = userEvent.setup(); + renderPanel(true, onClose); + await waitFor(() => { + expect(screen.getByRole('dialog')).toBeInTheDocument(); + }); + await user.click(screen.getByRole('button')); + expect(onClose).toHaveBeenCalledTimes(1); + }); +}); diff --git a/packages/app/src/components/CompactViewport/__tests__/useCompactViewport.test.tsx b/packages/app/src/components/CompactViewport/__tests__/useCompactViewport.test.tsx new file mode 100644 index 0000000000..c131012378 --- /dev/null +++ b/packages/app/src/components/CompactViewport/__tests__/useCompactViewport.test.tsx @@ -0,0 +1,42 @@ +import { renderHook } from '@testing-library/react'; + +import { + COMPACT_MAX_WIDTH, + useCompactViewport, +} from '@/components/CompactViewport/useCompactViewport'; +import { useWindowSize } from '@/utils'; + +jest.mock('@/utils', () => ({ + useWindowSize: jest.fn(() => ({ width: undefined, height: undefined })), +})); + +const useWindowSizeMock = jest.mocked(useWindowSize); + +describe('useCompactViewport', () => { + it('treats an unknown width as desktop', () => { + useWindowSizeMock.mockReturnValue({ + width: undefined, + height: undefined, + }); + const { result } = renderHook(() => useCompactViewport()); + expect(result.current).toBe(false); + }); + + it('is compact below the cutoff', () => { + useWindowSizeMock.mockReturnValue({ + width: COMPACT_MAX_WIDTH - 1, + height: 800, + }); + const { result } = renderHook(() => useCompactViewport()); + expect(result.current).toBe(true); + }); + + it('is not compact at the cutoff', () => { + useWindowSizeMock.mockReturnValue({ + width: COMPACT_MAX_WIDTH, + height: 800, + }); + const { result } = renderHook(() => useCompactViewport()); + expect(result.current).toBe(false); + }); +}); diff --git a/packages/app/src/components/CompactViewport/useCompactViewport.ts b/packages/app/src/components/CompactViewport/useCompactViewport.ts new file mode 100644 index 0000000000..4c8a6595d1 --- /dev/null +++ b/packages/app/src/components/CompactViewport/useCompactViewport.ts @@ -0,0 +1,17 @@ +import { useWindowSize } from '@/utils'; + +/** + * Viewports below this width use the compact layout. Same cutoff the nav + * uses to collapse, so a page and the shell switch together. + */ +export const COMPACT_MAX_WIDTH = 900; + +export function useCompactViewport() { + const { width } = useWindowSize(); + // Width is unknown during SSR and the first client render. AppNav is + // prerendered, so that first render has to match the server HTML. Treat + // the unknown width as desktop; the compact layout applies once + // useWindowSize reports a width. + if (width == null) return false; + return width < COMPACT_MAX_WIDTH; +} diff --git a/packages/app/src/components/DBSearchPageFilters.tsx b/packages/app/src/components/DBSearchPageFilters.tsx index cd99aa2d23..2b75b5fcf5 100644 --- a/packages/app/src/components/DBSearchPageFilters.tsx +++ b/packages/app/src/components/DBSearchPageFilters.tsx @@ -1129,6 +1129,7 @@ const DBSearchPageFiltersComponent = ({ onColumnToggle, displayedColumns, onCollapse, + fill = false, }: { analysisMode: 'results' | 'delta' | 'pattern'; setAnalysisMode: (mode: 'results' | 'delta' | 'pattern') => void; @@ -1142,6 +1143,8 @@ const DBSearchPageFiltersComponent = ({ onColumnToggle?: (column: string) => void; displayedColumns?: string[]; onCollapse?: () => void; + /** Fill the parent instead of the resizable desktop width. Used in the compact drawer. */ + fill?: boolean; } & FilterStateHook) => { const setFilterValue = useCallback( ( @@ -1686,8 +1689,23 @@ const DBSearchPageFiltersComponent = ({ ); return ( - -
+ + {!fill && ( +
+ )}