diff --git a/.changeset/dashboard-tiles-refresh-pulse.md b/.changeset/dashboard-tiles-refresh-pulse.md new file mode 100644 index 0000000000..13588b524c --- /dev/null +++ b/.changeset/dashboard-tiles-refresh-pulse.md @@ -0,0 +1,9 @@ +--- +'@hyperdx/app': patch +--- + +fix: show that number, bar and pie tiles are refreshing + +During a dashboard refresh these tiles kept the previous result on screen with +no sign that new data was loading, so stale values looked current. They now +pulse while the refetch runs, like line and stacked-bar time charts already do. diff --git a/packages/app/src/components/DBBarChart.tsx b/packages/app/src/components/DBBarChart.tsx index c95bdd5064..dcbd026378 100644 --- a/packages/app/src/components/DBBarChart.tsx +++ b/packages/app/src/components/DBBarChart.tsx @@ -1,4 +1,5 @@ import { memo } from 'react'; +import cx from 'classnames'; import { Bar, BarChart, @@ -64,6 +65,7 @@ export const DBBarChart = (props: CategoricalChartProps) => { toolbarItems, data, isLoading, + isPlaceholderData, isError, error, chartData, @@ -84,7 +86,12 @@ export const DBBarChart = (props: CategoricalChartProps) => { variant={props.errorVariant} /> ) : data?.data.length === 0 ? ( -
+
No data found within time range.
) : ( @@ -98,7 +105,7 @@ export const DBBarChart = (props: CategoricalChartProps) => { prev, queryKeyPrefix, enabled, - }, - ); + }); // The value is the first numeric value in the first row of the result const valueColumn = data?.meta @@ -383,11 +382,19 @@ export default function DBNumberChart({ ) : resultError ? ( ) : data?.data.length === 0 ? ( -
+
No data found within time range.
) : ( -
+
{config.backgroundChart && ( { toolbarItems, data, isLoading, + isPlaceholderData, isError, error, chartData, @@ -111,7 +113,12 @@ export const DBPieChart = (props: CategoricalChartProps) => { ) : responseFormatError ? ( ) : data?.data.length === 0 ? ( -
+
No data found within time range.
) : ( @@ -121,12 +128,10 @@ export const DBPieChart = (props: CategoricalChartProps) => { justify="center" h="100%" style={{ flexGrow: 1, overflow: 'hidden' }} + // Pulse the pie and its legend together: the legend shows values too + className={isLoading || isPlaceholderData ? 'effect-pulse' : ''} > - + { expect(screen.getByText('Loading Chart Data...')).toBeInTheDocument(); }); + describe('refresh indicator', () => { + const groupedData = { + data: [ + { status: 'success', count: 100 }, + { status: 'error', count: 50 }, + ], + meta: [ + { name: 'status', type: 'String' }, + { name: 'count', type: 'UInt64' }, + ], + }; + + it('pulses while a refetch is showing the previous result', () => { + mockUseQueriedChartConfig.mockReturnValue({ + data: groupedData, + isLoading: false, + isPlaceholderData: true, + isError: false, + }); + + renderWithMantine(); + expect( + screen + .getByTestId('bar-chart-container') + .querySelector('.effect-pulse'), + ).not.toBeNull(); + }); + + it('does not pulse once fresh data has loaded', () => { + mockUseQueriedChartConfig.mockReturnValue({ + data: groupedData, + isLoading: false, + isPlaceholderData: false, + isError: false, + }); + + renderWithMantine(); + expect( + screen + .getByTestId('bar-chart-container') + .querySelector('.effect-pulse'), + ).toBeNull(); + }); + + it('pulses the empty state while a refetch is running', () => { + mockUseQueriedChartConfig.mockReturnValue({ + data: { data: [], meta: groupedData.meta }, + isLoading: false, + isPlaceholderData: true, + isError: false, + }); + + renderWithMantine(); + expect(screen.getByText('No data found within time range.')).toHaveClass( + 'effect-pulse', + ); + }); + }); + it('handles error state correctly', () => { mockUseQueriedChartConfig.mockReturnValue({ data: undefined, diff --git a/packages/app/src/components/__tests__/DBNumberChart.test.tsx b/packages/app/src/components/__tests__/DBNumberChart.test.tsx index e97b35ecb4..672581a9ab 100644 --- a/packages/app/src/components/__tests__/DBNumberChart.test.tsx +++ b/packages/app/src/components/__tests__/DBNumberChart.test.tsx @@ -210,6 +210,66 @@ describe('DBNumberChart', () => { expect(screen.getByText('Loading Chart Data...')).toBeInTheDocument(); }); + describe('refresh indicator', () => { + it('pulses while a refetch is showing the previous value', () => { + mockUseQueriedChartConfig.mockReturnValue({ + data: { data: [{ value: 1234 }] }, + isLoading: false, + isPlaceholderData: true, + isError: false, + }); + + renderWithMantine(); + expect( + screen.getByTestId('number-chart-value').closest('.effect-pulse'), + ).not.toBeNull(); + }); + + it('pulses while still loading with a value on screen', () => { + // useQueriedChartConfig's isLoading also covers the MV-optimization + // check, which can be pending while a value is shown + mockUseQueriedChartConfig.mockReturnValue({ + data: { data: [{ value: 1234 }] }, + isLoading: true, + isPlaceholderData: false, + isError: false, + }); + + renderWithMantine(); + expect( + screen.getByTestId('number-chart-value').closest('.effect-pulse'), + ).not.toBeNull(); + }); + + it('does not pulse once the fresh value has loaded', () => { + mockUseQueriedChartConfig.mockReturnValue({ + data: { data: [{ value: 1234 }] }, + isLoading: false, + isPlaceholderData: false, + isError: false, + }); + + renderWithMantine(); + expect( + screen.getByTestId('number-chart-value').closest('.effect-pulse'), + ).toBeNull(); + }); + + it('pulses the empty state while a refetch is running', () => { + mockUseQueriedChartConfig.mockReturnValue({ + data: { data: [] }, + isLoading: false, + isPlaceholderData: true, + isError: false, + }); + + renderWithMantine(); + expect(screen.getByText('No data found within time range.')).toHaveClass( + 'effect-pulse', + ); + }); + }); + it('handles error state correctly', () => { mockUseQueriedChartConfig.mockReturnValue({ data: undefined, diff --git a/packages/app/src/components/__tests__/DBPieChart.test.tsx b/packages/app/src/components/__tests__/DBPieChart.test.tsx index 37d8e612ec..335e7f25e1 100644 --- a/packages/app/src/components/__tests__/DBPieChart.test.tsx +++ b/packages/app/src/components/__tests__/DBPieChart.test.tsx @@ -69,6 +69,65 @@ describe('DBPieChart', () => { expect(screen.getByText('Loading Chart Data...')).toBeInTheDocument(); }); + describe('refresh indicator', () => { + const groupedData = { + data: [ + { status: 'success', count: 100 }, + { status: 'error', count: 50 }, + ], + meta: [ + { name: 'status', type: 'String' }, + { name: 'count', type: 'UInt64' }, + ], + }; + + it('pulses while a refetch is showing the previous result', () => { + mockUseQueriedChartConfig.mockReturnValue({ + data: groupedData, + isLoading: false, + isPlaceholderData: true, + isError: false, + }); + + renderWithMantine(); + expect(screen.getByTestId('pie-chart-container')).toHaveClass( + 'effect-pulse', + ); + // The legend shows values too, so it pulses along with the pie + expect( + screen.getByTestId('pie-chart-legend').closest('.effect-pulse'), + ).not.toBeNull(); + }); + + it('does not pulse once fresh data has loaded', () => { + mockUseQueriedChartConfig.mockReturnValue({ + data: groupedData, + isLoading: false, + isPlaceholderData: false, + isError: false, + }); + + renderWithMantine(); + expect(screen.getByTestId('pie-chart-container')).not.toHaveClass( + 'effect-pulse', + ); + }); + + it('pulses the empty state while a refetch is running', () => { + mockUseQueriedChartConfig.mockReturnValue({ + data: { data: [], meta: groupedData.meta }, + isLoading: false, + isPlaceholderData: true, + isError: false, + }); + + renderWithMantine(); + expect(screen.getByText('No data found within time range.')).toHaveClass( + 'effect-pulse', + ); + }); + }); + it('handles error state correctly', () => { mockUseQueriedChartConfig.mockReturnValue({ data: undefined, diff --git a/packages/app/src/components/charts/CategoricalChart.tsx b/packages/app/src/components/charts/CategoricalChart.tsx index 936af713cd..bc4bd6f4ae 100644 --- a/packages/app/src/components/charts/CategoricalChart.tsx +++ b/packages/app/src/components/charts/CategoricalChart.tsx @@ -56,14 +56,12 @@ export function useCategoricalChart({ const { data: mvOptimizationData } = useMVOptimizationExplanation(builderQueriedConfig); - const { data, isLoading, isError, error } = useQueriedChartConfig( - queriedConfig, - { + const { data, isLoading, isError, error, isPlaceholderData } = + useQueriedChartConfig(queriedConfig, { placeholderData: (prev: any) => prev, queryKey: [queryKeyPrefix, queriedConfig], enabled, - }, - ); + }); const toolbarItems = useMemo(() => { const allToolbarItems: React.ReactNode[] = []; @@ -130,6 +128,8 @@ export function useCategoricalChart({ toolbarItems, data, isLoading, + // True while a refetch (e.g. dashboard refresh) shows the previous result + isPlaceholderData, isError, error, chartData,