diff --git a/.changeset/instance-label-brand-name.md b/.changeset/instance-label-brand-name.md new file mode 100644 index 0000000000..19c3ac011d --- /dev/null +++ b/.changeset/instance-label-brand-name.md @@ -0,0 +1,7 @@ +--- +'@hyperdx/app': patch +--- + +feat: add optional `NEXT_PUBLIC_INSTANCE_LABEL` suffix to the tab title and sidebar + +Operators running multiple HyperDX instances (e.g. one per region) can now set `NEXT_PUBLIC_INSTANCE_LABEL` to append a short label to the browser tab title and sidebar, e.g. "HyperDX UK". Empty by default, no behavior change if unset. The sidebar label only shows when the sidebar is expanded, and replaces the UTC badge there when both are set. diff --git a/docker-compose.yml b/docker-compose.yml index 14593c179d..c2d85bd419 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -88,6 +88,9 @@ services: # NEXT_PUBLIC_ENABLE_PROMQL: 'true' # Uncomment to enable the alert detail page (in development) # NEXT_PUBLIC_ENABLE_ALERT_DETAILS: 'true' + # Uncomment and set to append a label to the browser tab title, e.g. + # for operators running multiple instances (produces "HyperDX UK") + # NEXT_PUBLIC_INSTANCE_LABEL: 'UK' DEFAULT_CONNECTIONS: '[{"name":"Local ClickHouse","host":"http://ch-server:8123","username":"default","password":""}]' diff --git a/packages/app/pages/_app.tsx b/packages/app/pages/_app.tsx index 989dab72b2..fb64f6fd68 100644 --- a/packages/app/pages/_app.tsx +++ b/packages/app/pages/_app.tsx @@ -23,7 +23,11 @@ import { } from '@/config/fonts'; import { ibmPlexMono, inter, roboto, robotoMono } from '@/fonts'; import { fetchServerVersion, installHdxDebug } from '@/hdxDebug'; -import { AppThemeProvider, useAppTheme } from '@/theme/ThemeProvider'; +import { + AppThemeProvider, + useAppTheme, + usePageTitle, +} from '@/theme/ThemeProvider'; import { ThemeWrapper } from '@/ThemeWrapper'; import { NextApiConfigResponseData } from '@/types'; import { ConfirmProvider } from '@/useConfirm'; @@ -70,11 +74,11 @@ type AppPropsWithLayout = AppProps & { // Component that renders Head content requiring user preferences // Must be rendered inside AppThemeProvider to avoid hydration mismatch function AppHeadContent() { - const { theme } = useAppTheme(); + const title = usePageTitle(); return ( - {theme.displayName} + {title} diff --git a/packages/app/src/AlertDetailPage.tsx b/packages/app/src/AlertDetailPage.tsx index 787b76f41b..841000c604 100644 --- a/packages/app/src/AlertDetailPage.tsx +++ b/packages/app/src/AlertDetailPage.tsx @@ -30,7 +30,7 @@ import { TimePicker } from '@/components/TimePicker'; import { IS_ALERT_DETAILS_ENABLED } from '@/config'; import { getAlertSourceLabel, getAlertSourceUrl } from '@/utils/alerts'; -import { useBrandDisplayName } from './theme/ThemeProvider'; +import { usePageTitle } from './theme/ThemeProvider'; import api from './api'; import { withAppNavForSurface } from './layout'; import { useDefaultTimeRange, useNewTimeQuery } from './timeQuery'; @@ -223,7 +223,6 @@ function AlertDetailBody({ alert }: { alert: AlertsPageItem }) { } export default function AlertDetailPage() { - const brandName = useBrandDisplayName(); const router = useRouter(); const alertId = typeof router.query.alertId === 'string' ? router.query.alertId : undefined; @@ -238,6 +237,9 @@ export default function AlertDetailPage() { const { data, isLoading, isError } = api.useAlert(alertId); const alert = data?.data; + const title = usePageTitle( + alert ? `${alert.displayName} - Alerts` : 'Alerts', + ); if (!IS_ALERT_DETAILS_ENABLED) { return null; @@ -249,9 +251,7 @@ export default function AlertDetailPage() { style={{ display: 'flex', flexDirection: 'column', height: '100%' }} > - - {alert ? `${alert.displayName} - Alerts` : 'Alerts'} - {brandName} - + {title} {isLoading && ( diff --git a/packages/app/src/AlertsPage.tsx b/packages/app/src/AlertsPage.tsx index 2ff9b8beb3..2c3c2d3387 100644 --- a/packages/app/src/AlertsPage.tsx +++ b/packages/app/src/AlertsPage.tsx @@ -21,14 +21,14 @@ import EmptyState from '@/components/EmptyState'; import { PageHeader } from '@/components/PageHeader'; import { ALERT_STATE_FILTER_OPTIONS } from '@/utils/alerts'; -import { useBrandDisplayName } from './theme/ThemeProvider'; +import { usePageTitle } from './theme/ThemeProvider'; import api from './api'; import { withAppNav } from './layout'; const SEARCH_DEBOUNCE_MS = 300; export default function AlertsPage() { - const brandName = useBrandDisplayName(); + const title = usePageTitle('Alerts'); const mounted = useMounted(); const [search, setSearch] = useQueryState('search'); @@ -114,7 +114,7 @@ export default function AlertsPage() { style={{ display: 'flex', flexDirection: 'column', minHeight: '100%' }} > - Alerts - {brandName} + {title}
{ // If an OSS user accidentally lands on /register after already creating a team diff --git a/packages/app/src/CareersPage.tsx b/packages/app/src/CareersPage.tsx index 82c842761f..6344202a15 100644 --- a/packages/app/src/CareersPage.tsx +++ b/packages/app/src/CareersPage.tsx @@ -13,6 +13,7 @@ import { } from '@mantine/core'; import { useQuery } from '@tanstack/react-query'; +import { INSTANCE_TITLE_SUFFIX } from '@/config'; interface GreenhouseJob { id: number; title: string; @@ -91,7 +92,7 @@ export default function CareersPage() { return ( - Careers | HyperDX + {`Careers | HyperDX${INSTANCE_TITLE_SUFFIX}`} diff --git a/packages/app/src/ClickhousePage.tsx b/packages/app/src/ClickhousePage.tsx index b4944a492b..d190d89867 100644 --- a/packages/app/src/ClickhousePage.tsx +++ b/packages/app/src/ClickhousePage.tsx @@ -45,7 +45,7 @@ import { DBSqlRowTable } from './components/DBRowTable'; import DBTableChart from './components/DBTableChart'; import OnboardingModal from './components/OnboardingModal'; import { useDashboardRefresh } from './hooks/useDashboardRefresh'; -import { useBrandDisplayName } from './theme/ThemeProvider'; +import { usePageTitle } from './theme/ThemeProvider'; import { clickhouseSql } from './utils/codeMirror'; import { useConnections } from './connection'; import { useDefaultTimeRange, useNewTimeQuery } from './timeQuery'; @@ -491,7 +491,7 @@ const DEFAULT_INTERVAL = 'Past 1h'; function ClickhousePage() { const defaultTimeRange = useDefaultTimeRange(DEFAULT_INTERVAL); - const brandName = useBrandDisplayName(); + const title = usePageTitle('ClickHouse Dashboard'); const { colorScheme } = useMantineColorScheme(); const { data: connections } = useConnections(); const [_connection, setConnection] = useQueryState('connection'); @@ -644,7 +644,7 @@ function ClickhousePage() { content={ <> <Head> - <title>ClickHouse Dashboard – {brandName} + {title} - Chart Explorer - {brandName} + {title} - Import Dashboard - {brandName} + {title} diff --git a/packages/app/src/DBDashboardPage.tsx b/packages/app/src/DBDashboardPage.tsx index 82c19c3857..41e19d39b9 100644 --- a/packages/app/src/DBDashboardPage.tsx +++ b/packages/app/src/DBDashboardPage.tsx @@ -188,7 +188,7 @@ import { Tags } from './components/Tags'; import useDashboardFilters from './hooks/useDashboardFilters'; import { useDashboardRefresh } from './hooks/useDashboardRefresh'; import useTileSelection from './hooks/useTileSelection'; -import { useBrandDisplayName } from './theme/ThemeProvider'; +import { usePageTitle } from './theme/ThemeProvider'; import { parseAsJsonEncoded, parseAsStringEncoded } from './utils/queryParsers'; import { buildDashboardReplaySearchUrl, @@ -1890,7 +1890,7 @@ function DBDashboardPage({ isFetching: isFetchingDashboard, isSetting: isSavingDashboard, } = dashboardProps; - const brandName = useBrandDisplayName(); + const title = usePageTitle(dashboard?.name ? dashboard.name : 'Dashboard'); const confirm = useConfirm(); const { userPreferences: { isUTC }, @@ -3226,9 +3226,7 @@ function DBDashboardPage({ const dashboardBody = ( <> - - {dashboard?.name ? `${dashboard.name}` : 'Dashboard'} – {brandName} - + {title} {!isKioskMode && } {!isKioskMode && ( diff --git a/packages/app/src/DBSearchPage.tsx b/packages/app/src/DBSearchPage.tsx index ad2248916d..e7a257d397 100644 --- a/packages/app/src/DBSearchPage.tsx +++ b/packages/app/src/DBSearchPage.tsx @@ -124,7 +124,7 @@ import { } from '@/savedSearch'; import { useSearchPageFilterState } from '@/searchFilters'; import { getEventBody, useSource, useSources } from '@/source'; -import { useAppTheme, useBrandDisplayName } from '@/theme/ThemeProvider'; +import { useAppTheme, usePageTitle } from '@/theme/ThemeProvider'; import { parseRelativeTimeQuery, useDefaultTimeRange, @@ -1038,7 +1038,6 @@ function DBSearchPageContent() { // Read again here, not passed down: this component re-renders from its own // query-state hooks without the wrapper, and must see the current path. const savedSearchId = getSavedSearchIdFromPath(); - const brandName = useBrandDisplayName(); const defaultTimeRange = useDefaultTimeRange('Past 15m'); const [rawSearchedConfig, setSearchedConfig] = useQueryStates(queryStateMap); @@ -1067,6 +1066,9 @@ function DBSearchPageContent() { enabled: savedSearchId != null, }, ); + const title = usePageTitle( + savedSearch ? `${savedSearch.name} Search` : 'Search', + ); const { data: sources } = useSources(); const [lastSelectedSourceId, setLastSelectedSourceId] = useLocalStorage( @@ -2215,9 +2217,7 @@ function DBSearchPageContent() { data-testid="search-page" > - - {savedSearch ? `${savedSearch.name} Search` : 'Search'} - {brandName} - + {title} {!IS_LOCAL_MODE && isAlertModalOpen && ( ( <> - Service Map - {brandName} + {title} ), - [brandName], + [title], ); const sourceSelect = source ? ( diff --git a/packages/app/src/JoinTeamPage.tsx b/packages/app/src/JoinTeamPage.tsx index e700478fc1..ec4e4e3b4a 100644 --- a/packages/app/src/JoinTeamPage.tsx +++ b/packages/app/src/JoinTeamPage.tsx @@ -10,12 +10,12 @@ import { TextInput, } from '@mantine/core'; -import { useBrandDisplayName } from './theme/ThemeProvider'; +import { usePageTitle } from './theme/ThemeProvider'; import { PasswordCheck } from './PasswordCheck'; export default function JoinTeam() { const router = useRouter(); - const brandName = useBrandDisplayName(); + const title = usePageTitle('Join Team'); const { err, reason, token } = router.query; const [password, setPassword] = useState(''); @@ -31,7 +31,7 @@ export default function JoinTeam() { return (
- +
diff --git a/packages/app/src/KubernetesDashboardPage.tsx b/packages/app/src/KubernetesDashboardPage.tsx index 062abb09ee..d4c64baca9 100644 --- a/packages/app/src/KubernetesDashboardPage.tsx +++ b/packages/app/src/KubernetesDashboardPage.tsx @@ -58,7 +58,7 @@ import { SourceSelectControlled } from './components/SourceSelect'; import { useQueriedChartConfig } from './hooks/useChartConfig'; import { useDashboardRefresh } from './hooks/useDashboardRefresh'; import { useJsonColumns } from './hooks/useMetadata'; -import { useBrandDisplayName } from './theme/ThemeProvider'; +import { usePageTitle } from './theme/ThemeProvider'; import { convertV1ChartConfigToV2, K8S_CPU_PERCENTAGE_NUMBER_FORMAT, @@ -1049,7 +1049,7 @@ const DEFAULT_INTERVAL = 'Past 1h'; function KubernetesDashboardPage() { const defaultTimeRange = useDefaultTimeRange(DEFAULT_INTERVAL); - const brandName = useBrandDisplayName(); + const title = usePageTitle('Kubernetes Dashboard'); const { data: sources } = useSources(); const [_logSourceId, setLogSourceId] = useQueryState('logSource'); @@ -1378,7 +1378,7 @@ function KubernetesDashboardPage() { const dashboardBody = ( <> - Kubernetes Dashboard – {brandName} + {title} {metricSource && logSource && ( diff --git a/packages/app/src/ServicesDashboardPage/ServicesDashboardPage.tsx b/packages/app/src/ServicesDashboardPage/ServicesDashboardPage.tsx index b8aa1742dc..d703020653 100644 --- a/packages/app/src/ServicesDashboardPage/ServicesDashboardPage.tsx +++ b/packages/app/src/ServicesDashboardPage/ServicesDashboardPage.tsx @@ -57,7 +57,7 @@ import { useResolvedSourceParam } from '@/hooks/useResolvedSourceParam'; import { withAppNavForSurface } from '@/layout'; import { useServiceDashboardExpressions } from '@/serviceDashboard'; import { useSource, useSources } from '@/source'; -import { useBrandDisplayName } from '@/theme/ThemeProvider'; +import { usePageTitle } from '@/theme/ThemeProvider'; import { useDefaultTimeRange, useNewTimeQuery } from '@/timeQuery'; import DatabaseTab from './DatabaseTab'; @@ -166,7 +166,7 @@ const DEFAULT_INTERVAL = 'Past 1h'; function ServicesDashboardPage() { const defaultTimeRange = useDefaultTimeRange(DEFAULT_INTERVAL); - const brandName = useBrandDisplayName(); + const title = usePageTitle('Services Dashboard'); const [tab, setTab] = useQueryState( 'tab', parseAsStringEnum(['http', 'database', 'errors']).withDefault( @@ -313,7 +313,7 @@ function ServicesDashboardPage() { return ( - Services Dashboard – {brandName} + {title} diff --git a/packages/app/src/ServicesDashboardPage/__tests__/ServicesDashboardPage.test.tsx b/packages/app/src/ServicesDashboardPage/__tests__/ServicesDashboardPage.test.tsx index 7f4d58301b..76f26b5a05 100644 --- a/packages/app/src/ServicesDashboardPage/__tests__/ServicesDashboardPage.test.tsx +++ b/packages/app/src/ServicesDashboardPage/__tests__/ServicesDashboardPage.test.tsx @@ -165,6 +165,7 @@ jest.mock('@/layout', () => ({ jest.mock('@/theme/ThemeProvider', () => ({ __esModule: true, useBrandDisplayName: () => 'HyperDX', + usePageTitle: (page?: string) => (page ? `${page} - HyperDX` : 'HyperDX'), })); import ServicesDashboardPage from '@/ServicesDashboardPage'; diff --git a/packages/app/src/SessionsPage.tsx b/packages/app/src/SessionsPage.tsx index bdaef6d7ea..51c6be1ff5 100644 --- a/packages/app/src/SessionsPage.tsx +++ b/packages/app/src/SessionsPage.tsx @@ -53,7 +53,7 @@ import OnboardingModal from './components/OnboardingModal'; import SearchWhereInput, { getStoredLanguage, } from './components/SearchInput/SearchWhereInput'; -import { useBrandDisplayName } from './theme/ThemeProvider'; +import { useBrandDisplayName, usePageTitle } from './theme/ThemeProvider'; import { withAppNavForSurface } from './layout'; import { Session, useSessions } from './sessions'; import SessionSidePanel from './SessionSidePanel'; @@ -240,7 +240,7 @@ const DEFAULT_INTERVAL = 'Past 1h'; function SessionsPage() { const defaultTimeRange = useDefaultTimeRange(DEFAULT_INTERVAL); - const brandName = useBrandDisplayName(); + const title = usePageTitle('Client Sessions'); const [appliedConfig, setAppliedConfig] = useQueryStates(appliedConfigMap); // `?sessionSource=` accepts a source name as well as a source ID. The form // holds the resolved ID, so nothing downstream ever sees a name. @@ -397,7 +397,7 @@ function SessionsPage() { return ( <> - Client Sessions - {brandName} + {title} {selectedSession != null && diff --git a/packages/app/src/TeamPage.tsx b/packages/app/src/TeamPage.tsx index 3880370159..b536fe5290 100644 --- a/packages/app/src/TeamPage.tsx +++ b/packages/app/src/TeamPage.tsx @@ -34,7 +34,7 @@ import SecurityPoliciesSection from './components/TeamSettings/SecurityPoliciesS import SourcesSection from './components/TeamSettings/SourcesSection'; import TeamMembersSection from './components/TeamSettings/TeamMembersSection'; import TeamQueryConfigSection from './components/TeamSettings/TeamQueryConfigSection'; -import { useBrandDisplayName } from './theme/ThemeProvider'; +import { usePageTitle } from './theme/ThemeProvider'; import api from './api'; import { IS_IAC_EXPORT_ENABLED } from './config'; import { APP_CONTENT_SCROLL_CONTAINER_ID, withAppNav } from './layout'; @@ -73,7 +73,7 @@ function TeamTabContent({ } export default function TeamPage() { - const brandName = useBrandDisplayName(); + const title = usePageTitle('My Team'); const router = useRouter(); const { data: team, refetch: refetchTeam, isLoading } = api.useTeam(); const setTeamName = api.useSetTeamName(); @@ -269,7 +269,7 @@ export default function TeamPage() { return (
- My Team - {brandName} + {title}
diff --git a/packages/app/src/__tests__/DBSearchPage.directTrace.test.tsx b/packages/app/src/__tests__/DBSearchPage.directTrace.test.tsx index a6fe0278b6..fdee8e270e 100644 --- a/packages/app/src/__tests__/DBSearchPage.directTrace.test.tsx +++ b/packages/app/src/__tests__/DBSearchPage.directTrace.test.tsx @@ -132,6 +132,7 @@ jest.mock('@/hooks/useExplainQuery', () => ({ jest.mock('@/theme/ThemeProvider', () => ({ useAppTheme: () => ({ themeName: 'hyperdx' }), useBrandDisplayName: () => 'HyperDX', + usePageTitle: (page?: string) => (page ? `${page} - HyperDX` : 'HyperDX'), })); jest.mock('../hooks/useMetadata', () => ({ diff --git a/packages/app/src/__tests__/config.instanceLabel.emoji.test.ts b/packages/app/src/__tests__/config.instanceLabel.emoji.test.ts new file mode 100644 index 0000000000..7131f979b4 --- /dev/null +++ b/packages/app/src/__tests__/config.instanceLabel.emoji.test.ts @@ -0,0 +1,12 @@ +jest.mock('next-runtime-env', () => ({ + env: (key: string) => + key === 'NEXT_PUBLIC_INSTANCE_LABEL' ? ' prod-U😀 ' : undefined, +})); + +import { INSTANCE_LABEL } from '@/config'; + +describe('INSTANCE_LABEL (emoji input)', () => { + it('trims without mangling multi-byte characters', () => { + expect(INSTANCE_LABEL).toBe('prod-U😀'); + }); +}); diff --git a/packages/app/src/__tests__/config.instanceLabel.test.ts b/packages/app/src/__tests__/config.instanceLabel.test.ts new file mode 100644 index 0000000000..e0c8b69cdc --- /dev/null +++ b/packages/app/src/__tests__/config.instanceLabel.test.ts @@ -0,0 +1,12 @@ +jest.mock('next-runtime-env', () => ({ + env: (key: string) => + key === 'NEXT_PUBLIC_INSTANCE_LABEL' ? ' ExtraLongLabel ' : undefined, +})); + +import { INSTANCE_LABEL } from '@/config'; + +describe('INSTANCE_LABEL', () => { + it('trims whitespace without capping length', () => { + expect(INSTANCE_LABEL).toBe('ExtraLongLabel'); + }); +}); diff --git a/packages/app/src/__tests__/config.instanceLabel.whitespace.test.ts b/packages/app/src/__tests__/config.instanceLabel.whitespace.test.ts new file mode 100644 index 0000000000..afa9478224 --- /dev/null +++ b/packages/app/src/__tests__/config.instanceLabel.whitespace.test.ts @@ -0,0 +1,12 @@ +jest.mock('next-runtime-env', () => ({ + env: (key: string) => + key === 'NEXT_PUBLIC_INSTANCE_LABEL' ? 'EU West' : undefined, +})); + +import { INSTANCE_LABEL } from '@/config'; + +describe('INSTANCE_LABEL (internal whitespace run)', () => { + it('collapses internal whitespace to a single space', () => { + expect(INSTANCE_LABEL).toBe('EU West'); + }); +}); diff --git a/packages/app/src/__tests__/config.instanceTitleSuffix.no-label.test.ts b/packages/app/src/__tests__/config.instanceTitleSuffix.no-label.test.ts new file mode 100644 index 0000000000..89994228f5 --- /dev/null +++ b/packages/app/src/__tests__/config.instanceTitleSuffix.no-label.test.ts @@ -0,0 +1,12 @@ +jest.mock('next-runtime-env', () => ({ + env: (key: string) => + key === 'NEXT_PUBLIC_INSTANCE_LABEL' ? undefined : 'unexpected', +})); + +import { INSTANCE_TITLE_SUFFIX } from '@/config'; + +describe('INSTANCE_TITLE_SUFFIX (INSTANCE_LABEL unset)', () => { + it('is empty', () => { + expect(INSTANCE_TITLE_SUFFIX).toBe(''); + }); +}); diff --git a/packages/app/src/__tests__/config.instanceTitleSuffix.test.ts b/packages/app/src/__tests__/config.instanceTitleSuffix.test.ts new file mode 100644 index 0000000000..17dfc176c9 --- /dev/null +++ b/packages/app/src/__tests__/config.instanceTitleSuffix.test.ts @@ -0,0 +1,12 @@ +jest.mock('next-runtime-env', () => ({ + env: (key: string) => + key === 'NEXT_PUBLIC_INSTANCE_LABEL' ? 'UK' : undefined, +})); + +import { INSTANCE_TITLE_SUFFIX } from '@/config'; + +describe('INSTANCE_TITLE_SUFFIX', () => { + it('is the label with a leading space, ready to append to a title', () => { + expect(INSTANCE_TITLE_SUFFIX).toBe(' UK'); + }); +}); diff --git a/packages/app/src/components/AppNav/AppNav.module.scss b/packages/app/src/components/AppNav/AppNav.module.scss index 9613ba65f9..80415250fb 100644 --- a/packages/app/src/components/AppNav/AppNav.module.scss +++ b/packages/app/src/components/AppNav/AppNav.module.scss @@ -109,6 +109,11 @@ $transition-slow: 0.2s ease; align-items: center; justify-content: center; color: var(--color-text); + + // Shrinkable (not growable) so a long label can still ellipsis when the + // sidebar is narrow, without stretching this link to fill the empty + // header space next to it (that space shouldn't be part of the link). + min-width: 0; } .logoIconWrapper { diff --git a/packages/app/src/components/AppNav/AppNav.tsx b/packages/app/src/components/AppNav/AppNav.tsx index 32ef55d9be..2d9bccd8a5 100644 --- a/packages/app/src/components/AppNav/AppNav.tsx +++ b/packages/app/src/components/AppNav/AppNav.tsx @@ -30,6 +30,7 @@ import { import api from '@/api'; import { AlertStatusIcon } from '@/components/AlertStatusIcon'; +import { InstanceLabel } from '@/components/AppNav/InstanceLabel'; import { APP_VERSION, IS_LOCAL_MODE } from '@/config'; import { Dashboard, useDashboards } from '@/dashboard'; import { useFavorites } from '@/favorites'; @@ -364,19 +365,30 @@ export default function AppNav({ fixed = false }: { fixed?: boolean }) { {isCollapsed ? (
{logomark}
) : ( - + {wordmark} - {isUTC && ( - - UTC - - )} + {/* Label and UTC badge are mutually exclusive - showing both + would be redundant and crowd this already-tight row. */} + + UTC + + ) + } + /> )} diff --git a/packages/app/src/components/AppNav/InstanceLabel.tsx b/packages/app/src/components/AppNav/InstanceLabel.tsx new file mode 100644 index 0000000000..eaf755891e --- /dev/null +++ b/packages/app/src/components/AppNav/InstanceLabel.tsx @@ -0,0 +1,32 @@ +import { ReactNode } from 'react'; +import { Badge } from '@mantine/core'; + +import { INSTANCE_LABEL } from '@/config'; + +// Styled to match the sidebar's UTC badge. `fallback` lets AppNav render the +// UTC badge in the same slot without needing its own INSTANCE_LABEL check - +// this component owns the one guard for whether a label is configured. +export function InstanceLabel({ fallback = null }: { fallback?: ReactNode }) { + if (!INSTANCE_LABEL) { + return fallback; + } + return ( + + {INSTANCE_LABEL} + + ); +} diff --git a/packages/app/src/components/AppNav/__tests__/InstanceLabel.no-label.test.tsx b/packages/app/src/components/AppNav/__tests__/InstanceLabel.no-label.test.tsx new file mode 100644 index 0000000000..f3176b51ce --- /dev/null +++ b/packages/app/src/components/AppNav/__tests__/InstanceLabel.no-label.test.tsx @@ -0,0 +1,17 @@ +import { render, screen } from '@testing-library/react'; + +jest.mock('@/config', () => ({ INSTANCE_LABEL: '' })); + +import { InstanceLabel } from '@/components/AppNav/InstanceLabel'; + +describe('InstanceLabel (INSTANCE_LABEL unset)', () => { + it('renders nothing by default', () => { + const { container } = render(); + expect(container).toBeEmptyDOMElement(); + }); + + it('renders the fallback instead, e.g. the sidebar UTC badge', () => { + render(UTC} />); + expect(screen.getByText('UTC')).toBeInTheDocument(); + }); +}); diff --git a/packages/app/src/components/AppNav/__tests__/InstanceLabel.test.tsx b/packages/app/src/components/AppNav/__tests__/InstanceLabel.test.tsx new file mode 100644 index 0000000000..0313e526f2 --- /dev/null +++ b/packages/app/src/components/AppNav/__tests__/InstanceLabel.test.tsx @@ -0,0 +1,27 @@ +import { MantineProvider } from '@mantine/core'; +import { render, screen } from '@testing-library/react'; + +jest.mock('@/config', () => ({ INSTANCE_LABEL: 'UK' })); + +import { InstanceLabel } from '@/components/AppNav/InstanceLabel'; + +describe('InstanceLabel', () => { + it('renders the label when INSTANCE_LABEL is set', () => { + render( + + + , + ); + expect(screen.getByText('UK')).toBeInTheDocument(); + }); + + it('ignores the fallback when a label is set, so they stay mutually exclusive', () => { + render( + + UTC} /> + , + ); + expect(screen.getByText('UK')).toBeInTheDocument(); + expect(screen.queryByText('UTC')).not.toBeInTheDocument(); + }); +}); diff --git a/packages/app/src/components/Dashboards/DashboardTemplatesPage.tsx b/packages/app/src/components/Dashboards/DashboardTemplatesPage.tsx index 27a0bc7dd6..2fe6470909 100644 --- a/packages/app/src/components/Dashboards/DashboardTemplatesPage.tsx +++ b/packages/app/src/components/Dashboards/DashboardTemplatesPage.tsx @@ -15,10 +15,10 @@ import { IconUpload } from '@tabler/icons-react'; import { DASHBOARD_TEMPLATES } from '@/dashboardTemplates'; import { withAppNav } from '@/layout'; -import { useBrandDisplayName } from '@/theme/ThemeProvider'; +import { usePageTitle } from '@/theme/ThemeProvider'; export default function DashboardTemplatesPage() { - const brandName = useBrandDisplayName(); + const title = usePageTitle('Dashboard Templates'); const templatesByTag = useMemo(() => { const groups = new Map(); @@ -44,7 +44,7 @@ export default function DashboardTemplatesPage() { return (
- Dashboard Templates - {brandName} + {title} diff --git a/packages/app/src/components/Dashboards/DashboardsListPage.tsx b/packages/app/src/components/Dashboards/DashboardsListPage.tsx index 2a4b62e284..10299cd622 100644 --- a/packages/app/src/components/Dashboards/DashboardsListPage.tsx +++ b/packages/app/src/components/Dashboards/DashboardsListPage.tsx @@ -55,7 +55,7 @@ import { } from '@/dashboard'; import { useFavorites } from '@/favorites'; import { withAppNav } from '@/layout'; -import { useBrandDisplayName } from '@/theme/ThemeProvider'; +import { usePageTitle } from '@/theme/ThemeProvider'; import { useConfirm } from '@/useConfirm'; function getDashboardAlerts(tiles: Dashboard['tiles']) { @@ -97,7 +97,7 @@ const PRESET_DASHBOARDS = [ ]; export default function DashboardsListPage() { - const brandName = useBrandDisplayName(); + const title = usePageTitle('Dashboards'); const { data: dashboards, isLoading, isError } = useDashboards(); const { data: me, isPending: isMePending } = api.useMe(); const confirm = useConfirm(); @@ -218,7 +218,7 @@ export default function DashboardsListPage() { style={{ display: 'flex', flexDirection: 'column', minHeight: '100%' }} > - Dashboards - {brandName} + {title} ({ })); jest.mock('@/theme/ThemeProvider', () => ({ useBrandDisplayName: () => 'HyperDX', + usePageTitle: (page?: string) => (page ? `${page} - HyperDX` : 'HyperDX'), })); jest.mock('@/useConfirm', () => ({ useConfirm: () => jest.fn(), diff --git a/packages/app/src/components/SavedSearches/SavedSearchesListPage.tsx b/packages/app/src/components/SavedSearches/SavedSearchesListPage.tsx index 415919d010..a97b062170 100644 --- a/packages/app/src/components/SavedSearches/SavedSearchesListPage.tsx +++ b/packages/app/src/components/SavedSearches/SavedSearchesListPage.tsx @@ -33,12 +33,12 @@ import { PageHeader } from '@/components/PageHeader'; import { useFavorites } from '@/favorites'; import { withAppNav } from '@/layout'; import { useDeleteSavedSearch, useSavedSearches } from '@/savedSearch'; -import { useBrandDisplayName } from '@/theme/ThemeProvider'; +import { usePageTitle } from '@/theme/ThemeProvider'; import { useConfirm } from '@/useConfirm'; import { groupByTags } from '@/utils/groupByTags'; export default function SavedSearchesListPage() { - const brandName = useBrandDisplayName(); + const title = usePageTitle('Saved Searches'); const { data: savedSearches, isLoading, isError } = useSavedSearches(); const confirm = useConfirm(); const deleteSavedSearch = useDeleteSavedSearch(); @@ -126,7 +126,7 @@ export default function SavedSearchesListPage() { style={{ display: 'flex', flexDirection: 'column', height: '100%' }} > - Saved Searches - {brandName} + {title} = { promql: IS_PROMQL_ENABLED, llmCost: IS_LLM_COST_ENABLED, alertDetails: IS_ALERT_DETAILS_ENABLED, + instanceLabel: Boolean(INSTANCE_LABEL), }; // config.ts's IS_OSS has a precedence quirk (`?? 'true' === 'true'`), so a set diff --git a/packages/app/src/llm/dashboard/LLMDashboardPage.tsx b/packages/app/src/llm/dashboard/LLMDashboardPage.tsx index 1d52766293..12f4bef3a1 100644 --- a/packages/app/src/llm/dashboard/LLMDashboardPage.tsx +++ b/packages/app/src/llm/dashboard/LLMDashboardPage.tsx @@ -39,7 +39,7 @@ import { } from '@/llm/hooks/useLLMDashboardExpressions'; import { getEffectiveTraceSourceId } from '@/ServicesDashboardPage'; import { useSource, useSources } from '@/source'; -import { useBrandDisplayName } from '@/theme/ThemeProvider'; +import { usePageTitle } from '@/theme/ThemeProvider'; import { useDefaultTimeRange, useNewTimeQuery } from '@/timeQuery'; import { AgentToolCharts } from './AgentToolCharts'; @@ -76,7 +76,7 @@ const queryParamMap = { */ function LLMDashboardPage() { const defaultTimeRange = useDefaultTimeRange(DEFAULT_INTERVAL); - const brandName = useBrandDisplayName(); + const title = usePageTitle('LLM Dashboard'); const [rawTab, setTab] = useQueryState( 'tab', @@ -212,7 +212,7 @@ function LLMDashboardPage() { return ( - LLM Dashboard – {brandName} + {title} diff --git a/packages/app/src/theme/ThemeProvider.tsx b/packages/app/src/theme/ThemeProvider.tsx index 071601dfa9..4ba8c23528 100644 --- a/packages/app/src/theme/ThemeProvider.tsx +++ b/packages/app/src/theme/ThemeProvider.tsx @@ -8,6 +8,8 @@ import React, { useState, } from 'react'; +import { INSTANCE_TITLE_SUFFIX } from '@/config'; + import { DEFAULT_THEME, getDevThemeName, @@ -241,3 +243,14 @@ export function useBrandDisplayName(): string { const { theme } = useAppTheme(); return theme.displayName; } + +/** + * Hook to build a ``/`<NextSeo title>` value: brand name plus the + * configured instance label, with an optional page name prepended. + * e.g. usePageTitle('Search') => "Search - HyperDX USA" + */ +export function usePageTitle(page?: string): string { + const brandName = useBrandDisplayName(); + const brandTitle = `${brandName}${INSTANCE_TITLE_SUFFIX}`; + return page ? `${page} - ${brandTitle}` : brandTitle; +} diff --git a/packages/app/src/theme/__tests__/ThemeProvider.test.tsx b/packages/app/src/theme/__tests__/ThemeProvider.test.tsx index 8f213d0829..008239a8f3 100644 --- a/packages/app/src/theme/__tests__/ThemeProvider.test.tsx +++ b/packages/app/src/theme/__tests__/ThemeProvider.test.tsx @@ -17,10 +17,13 @@ import { AppThemeProvider, useAppTheme, useLogomark, + usePageTitle, useThemeName, useWordmark, } from '@/theme/ThemeProvider'; +jest.mock('@/config', () => ({ INSTANCE_TITLE_SUFFIX: ' UK' })); + // Mock localStorage let localStorageMock: jest.Mocked<Storage>; @@ -144,6 +147,24 @@ describe('ThemeProvider', () => { }); }); + describe('usePageTitle', () => { + const wrapper = ({ children }: { children: React.ReactNode }) => ( + <AppThemeProvider>{children}</AppThemeProvider> + ); + + it('appends the brand name and instance suffix with no page name', () => { + const { result } = renderHook(() => usePageTitle(), { wrapper }); + + expect(result.current).toBe('HyperDX UK'); + }); + + it('prepends the page name when given one', () => { + const { result } = renderHook(() => usePageTitle('Search'), { wrapper }); + + expect(result.current).toBe('Search - HyperDX UK'); + }); + }); + describe('useThemeName', () => { it('should return current theme name', () => { const wrapper = ({ children }: { children: React.ReactNode }) => ( diff --git a/packages/app/tests/e2e/page-objects/DashboardPage.ts b/packages/app/tests/e2e/page-objects/DashboardPage.ts index 419aaf3260..35bca0b325 100644 --- a/packages/app/tests/e2e/page-objects/DashboardPage.ts +++ b/packages/app/tests/e2e/page-objects/DashboardPage.ts @@ -275,7 +275,7 @@ export class DashboardPage { // The document title comes from the saved dashboard, so it only changes // once the rename has persisted. const escaped = newName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); - await expect(this.page).toHaveTitle(new RegExp(`^${escaped} – `), { + await expect(this.page).toHaveTitle(new RegExp(`^${escaped} - `), { timeout: 10000, }); }