mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 18:05:11 +03:00
## Problem The dashboard's timezone picker (#45517) propagates to log timestamps and the shared TimestampInfo component, but observability and reports charts still render their X-axis labels, range labels, and tooltip headers in the browser's local timezone. The result is jarring once a user picks a non-local timezone: hover a chart and you get one tz, hover a log row and you get another. ## Fix Routes all display-side timestamp formatting in the chart layer through the existing picker-aware helpers (\`useFormatDateTime\` / \`formatDateTime\`) so chart UI matches the rest of the dashboard. - **ComposedChart.utils** \`CustomTooltip\` (the hotspot — drives every observability dashboard tooltip): reads the active timezone via \`useTimezone\` for both the header label and the formatted timestamp. - **AreaChart** / **BarChart**: introduce a \`formatChartDate\` helper that honours each component's existing \`displayDateInUtc\` prop, otherwise routes through the picker. - **ChartBlock**: the two recharts \`labelFormatter\` arrows now close over \`useFormatDateTime\`. - **ChartHighlightActions**: range labels in the zoom dropdown migrated to the same hook. Intentionally untouched (must stay UTC): - \`ChartHandler\` / \`ChartBlock\` \`startDate\`/\`endDate\` (API range params, day boundary). - \`ChartBlock.tsx:166\` explicit \`.utc()\` data-key normalisation. - \`useFillTimeseriesSorted\` and friends (range math, no display). ## How to test - Sign in. Open the avatar dropdown, pick a timezone different from your browser local (e.g. Asia/Tokyo). - Visit any project, then \`/project/<ref>/reports/database\` (or any \`/observability/...\` page). - Hover any chart series — the tooltip header should display the chosen IANA name and times in that timezone. - Click-drag a range on a chart to open the zoom dropdown — start/end labels in the menu should also be in the chosen timezone. - Switch back to "Auto detect" and confirm everything reverts to browser-local. - For an AreaChart/BarChart that uses \`displayDateInUtc\` (e.g. some legacy reports), confirm those still render in UTC regardless of picker. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Refactor** * Standardized date/time formatting across charts, tooltips, axis labels, header/footer labels, and highlight range labels in Reports and chart components. * Switched to a shared, timezone-aware formatter that respects UTC display mode or the selected picker/timezone, ensuring consistent, human-readable timestamps throughout the UI. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
168 lines
5.3 KiB
TypeScript
168 lines
5.3 KiB
TypeScript
import { useState } from 'react'
|
|
import { Area, AreaChart as RechartAreaChart, Tooltip, XAxis } from 'recharts'
|
|
|
|
import { ChartHeader } from './ChartHeader'
|
|
import type { CommonChartProps, Datum } from './Charts.types'
|
|
import { numberFormatter, useChartSize } from './Charts.utils'
|
|
import NoDataPlaceholder from './NoDataPlaceholder'
|
|
import { useChartHoverState } from './useChartHoverState'
|
|
import { CHART_COLORS, DateTimeFormats } from '@/components/ui/Charts/Charts.constants'
|
|
import { formatDateTime, useFormatDateTime } from '@/lib/datetime'
|
|
|
|
export interface AreaChartProps<D = Datum> extends CommonChartProps<D> {
|
|
yAxisKey: string
|
|
xAxisKey: string
|
|
format?: string
|
|
customDateFormat?: string
|
|
displayDateInUtc?: boolean
|
|
syncId?: string
|
|
}
|
|
|
|
const AreaChart = ({
|
|
data,
|
|
yAxisKey,
|
|
xAxisKey,
|
|
format,
|
|
customDateFormat = DateTimeFormats.FULL,
|
|
title,
|
|
highlightedValue,
|
|
highlightedLabel,
|
|
displayDateInUtc,
|
|
minimalHeader,
|
|
className = '',
|
|
valuePrecision,
|
|
size = 'normal',
|
|
syncId,
|
|
}: AreaChartProps) => {
|
|
const { Container } = useChartSize(size)
|
|
const { hoveredIndex, syncTooltip, setHover, clearHover } = useChartHoverState(
|
|
syncId || 'default'
|
|
)
|
|
const [focusDataIndex, setFocusDataIndex] = useState<number | null>(null)
|
|
|
|
// When `displayDateInUtc` is set the chart explicitly wants UTC labels (used
|
|
// by views that display server time). Otherwise honour the user's selected
|
|
// timezone via the picker, which `useFormatDateTime` reads from context.
|
|
const formatPickerDate = useFormatDateTime()
|
|
const formatChartDate = (value: number | string) =>
|
|
displayDateInUtc
|
|
? formatDateTime(value, { tz: 'UTC', format: customDateFormat })
|
|
: formatPickerDate(value, customDateFormat)
|
|
const resolvedHighlightedLabel =
|
|
(focusDataIndex !== null &&
|
|
data &&
|
|
data[focusDataIndex] !== undefined &&
|
|
formatChartDate(data[focusDataIndex][xAxisKey])) ||
|
|
highlightedLabel
|
|
|
|
const resolvedHighlightedValue =
|
|
focusDataIndex !== null ? data[focusDataIndex]?.[yAxisKey] : highlightedValue
|
|
|
|
if (data.length === 0) {
|
|
return (
|
|
<NoDataPlaceholder
|
|
description="It may take up to 24 hours for data to refresh"
|
|
size={size}
|
|
className={className}
|
|
attribute={title}
|
|
format={format}
|
|
/>
|
|
)
|
|
}
|
|
|
|
return (
|
|
<div className={['flex flex-col gap-3', className].join(' ')}>
|
|
<ChartHeader
|
|
title={title}
|
|
format={format}
|
|
customDateFormat={customDateFormat}
|
|
highlightedValue={
|
|
typeof resolvedHighlightedValue === 'number'
|
|
? numberFormatter(resolvedHighlightedValue, valuePrecision)
|
|
: resolvedHighlightedValue
|
|
}
|
|
highlightedLabel={resolvedHighlightedLabel}
|
|
minimalHeader={minimalHeader}
|
|
syncId={syncId}
|
|
data={data}
|
|
xAxisKey={xAxisKey}
|
|
yAxisKey={yAxisKey}
|
|
xAxisIsDate={true}
|
|
displayDateInUtc={displayDateInUtc}
|
|
valuePrecision={valuePrecision}
|
|
attributes={[]}
|
|
/>
|
|
<Container>
|
|
<RechartAreaChart
|
|
data={data}
|
|
margin={{
|
|
top: 0,
|
|
right: 0,
|
|
left: 0,
|
|
bottom: 0,
|
|
}}
|
|
className="overflow-visible"
|
|
onMouseMove={(e: any) => {
|
|
if (e.activeTooltipIndex !== focusDataIndex) {
|
|
setFocusDataIndex(e.activeTooltipIndex)
|
|
}
|
|
|
|
setHover(e.activeTooltipIndex)
|
|
}}
|
|
onMouseLeave={() => {
|
|
setFocusDataIndex(null)
|
|
|
|
clearHover()
|
|
}}
|
|
>
|
|
<defs>
|
|
<linearGradient id="colorUv" x1="0" y1="0" x2="0" y2="1">
|
|
<stop offset="5%" stopColor={CHART_COLORS.GREEN_1} stopOpacity={0.8} />
|
|
<stop offset="95%" stopColor={CHART_COLORS.GREEN_1} stopOpacity={0} />
|
|
</linearGradient>
|
|
</defs>
|
|
<XAxis
|
|
dataKey={xAxisKey}
|
|
interval={data.length - 2}
|
|
angle={0}
|
|
// hide the tick
|
|
tick={false}
|
|
// color the axis
|
|
axisLine={{ stroke: CHART_COLORS.AXIS }}
|
|
tickLine={{ stroke: CHART_COLORS.AXIS }}
|
|
/>
|
|
<Tooltip
|
|
content={(_props) =>
|
|
syncId && syncTooltip && hoveredIndex !== null ? (
|
|
<div className="bg-black/90 text-white p-2 rounded-sm text-xs">
|
|
<div className="font-medium">
|
|
{formatChartDate(data[hoveredIndex]?.[xAxisKey] as number | string)}
|
|
</div>
|
|
<div>
|
|
{numberFormatter(Number(data[hoveredIndex]?.[yAxisKey]) || 0, valuePrecision)}
|
|
{format}
|
|
</div>
|
|
</div>
|
|
) : null
|
|
}
|
|
/>
|
|
<Area
|
|
type="monotone"
|
|
dataKey={yAxisKey}
|
|
stroke={CHART_COLORS.GREEN_1}
|
|
fillOpacity={1}
|
|
fill="url(#colorUv)"
|
|
/>
|
|
</RechartAreaChart>
|
|
</Container>
|
|
{data && (
|
|
<div className="text-foreground-lighter -mt-8 flex items-center justify-between text-xs">
|
|
<span>{formatChartDate(data[0][xAxisKey] as number | string)}</span>
|
|
<span>{formatChartDate(data[data?.length - 1]?.[xAxisKey] as number | string)}</span>
|
|
</div>
|
|
)}
|
|
</div>
|
|
)
|
|
}
|
|
export default AreaChart
|