diff --git a/.changeset/service-map-sampling-storage.md b/.changeset/service-map-sampling-storage.md new file mode 100644 index 0000000000..e4dc2adb08 --- /dev/null +++ b/.changeset/service-map-sampling-storage.md @@ -0,0 +1,5 @@ +--- +'@hyperdx/app': patch +--- + +feat: Remember the service map sampling rate in local storage; a `samplingFactor` URL param still takes precedence diff --git a/packages/app/src/DBServiceMapPage.tsx b/packages/app/src/DBServiceMapPage.tsx index 110da6d2dd..459cf3bae8 100644 --- a/packages/app/src/DBServiceMapPage.tsx +++ b/packages/app/src/DBServiceMapPage.tsx @@ -38,6 +38,7 @@ import { IS_LOCAL_MODE } from '@/config'; import { useGetKeyValues } from '@/hooks/useMetadata'; import { useResolvedSourceParam } from '@/hooks/useResolvedSourceParam'; import { withAppNavForSurface } from '@/layout'; +import { useLocalStorage } from '@/utils'; import { parseAsStringEncoded } from '@/utils/queryParsers'; import OnboardingModal from './components/OnboardingModal'; @@ -76,6 +77,9 @@ const SAMPLING_FACTORS = [ }, ]; +const DEFAULT_SAMPLING_FACTOR = 10; +const SAMPLING_FACTOR_STORAGE_KEY = 'hdx-service-map-sampling-factor'; + const DEFAULT_INTERVAL = 'Past 1h'; const searchQueryStateMap = { @@ -210,9 +214,28 @@ function DBServiceMapPage() { })(); }, [handleSubmit, setSearchedConfig, displayedTimeInputValue, onSearch]); - const [samplingFactor, setSamplingFactor] = useQueryState( + // The URL param wins so shared links reproduce the sender's view, but only + // slider changes are remembered: opening a link must not overwrite the + // viewer's saved preference. + const [samplingFactorParam, setSamplingFactorParam] = useQueryState( 'samplingFactor', - parseAsInteger.withDefault(10), + parseAsInteger, + ); + const [storedSamplingFactor, setStoredSamplingFactor] = useLocalStorage( + SAMPLING_FACTOR_STORAGE_KEY, + DEFAULT_SAMPLING_FACTOR, + ); + const samplingFactor = + samplingFactorParam ?? + (SAMPLING_FACTORS.some(factor => factor.value === storedSamplingFactor) + ? storedSamplingFactor + : DEFAULT_SAMPLING_FACTOR); + const setSamplingFactor = useCallback( + (value: number) => { + setStoredSamplingFactor(value); + setSamplingFactorParam(value); + }, + [setStoredSamplingFactor, setSamplingFactorParam], ); const { label: samplingLabel = '' } = SAMPLING_FACTORS.find(factor => factor.value === samplingFactor) ?? {}; @@ -253,7 +276,7 @@ function DBServiceMapPage() { const headerActions = ( - + Sampling {samplingLabel}
@@ -266,6 +289,7 @@ function DBServiceMapPage() { )} onChange={v => setSamplingFactor(SAMPLING_FACTORS[v].value)} showLabelOnHover={false} + data-testid="service-map-sampling-slider" />
window.localStorage.getItem(key), STORAGE_KEY); +} + +async function gotoServiceMap(page: Page, query = '') { + await page.goto(`/service-map${query}`); + await expect(page.getByTestId('service-map-sampling-slider')).toBeVisible(); +} + +test.describe('Service map sampling rate', { tag: ['@service-map'] }, () => { + test('persists slider selections to local storage', async ({ page }) => { + await gotoServiceMap(page); + const label = page.getByTestId('service-map-sampling-label'); + await expect(label).toHaveText('Sampling 10%'); + expect(await getStoredSamplingFactor(page)).toBeNull(); + + await page + .getByTestId('service-map-sampling-slider') + .getByRole('slider') + .press('ArrowRight'); + + await expect(label).toHaveText('Sampling 50%'); + await expect(page).toHaveURL(/samplingFactor=2/); + expect(await getStoredSamplingFactor(page)).toBe('2'); + + await gotoServiceMap(page); + await expect(label).toHaveText('Sampling 50%'); + }); + + test('prefers the URL param without overwriting local storage', async ({ + page, + }) => { + await gotoServiceMap(page); + await page.evaluate( + key => window.localStorage.setItem(key, JSON.stringify(2)), + STORAGE_KEY, + ); + + await gotoServiceMap(page, '?samplingFactor=100'); + const label = page.getByTestId('service-map-sampling-label'); + await expect(label).toHaveText('Sampling 1%'); + expect(await getStoredSamplingFactor(page)).toBe('2'); + + await gotoServiceMap(page); + await expect(label).toHaveText('Sampling 50%'); + }); +});