Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.
TypeScript analyticsaudience-segmentationchartscohort-analysisgoogle-analyticsproduct-analyticsstatisticsuser-journeyweb-analytics
fix chart and timezone issues, pass consistent dates to DB.
Francis Cao6751bf88bbc6
diff --git a/src/app/(main)/websites/[websiteId]/WebsiteChart.tsx b/src/app/(main)/websites/[websiteId]/WebsiteChart.tsxindex 2406cde24..b949e60fc 100644--- a/src/app/(main)/websites/[websiteId]/WebsiteChart.tsx+++ b/src/app/(main)/websites/[websiteId]/WebsiteChart.tsx@@ -1,5 +1,5 @@import { LoadingPanel } from '@/components/common/LoadingPanel';-import { useDateRange } from '@/components/hooks';+import { useDateRange, useTimezone } from '@/components/hooks';import { useWebsitePageviewsQuery } from '@/components/hooks/queries/useWebsitePageviewsQuery';import { PageviewsChart } from '@/components/metrics/PageviewsChart';import { useMemo } from 'react';@@ -11,7 +11,8 @@ export function WebsiteChart({websiteId: string;compareMode?: boolean;}) {- const { dateRange, dateCompare } = useDateRange();+ const { timezone } = useTimezone();+ const { dateRange, dateCompare } = useDateRange({ timezone: timezone });const { startDate, endDate, unit, value } = dateRange;const { data, isLoading, isFetching, error } = useWebsitePageviewsQuery({websiteId,diff --git a/src/components/hooks/useDateParameters.ts b/src/components/hooks/useDateParameters.tsindex 16e123142..d84b4236a 100644--- a/src/components/hooks/useDateParameters.ts+++ b/src/components/hooks/useDateParameters.ts@@ -5,13 +5,13 @@ export function useDateParameters() {const {dateRange: { startDate, endDate, unit },} = useDateRange();- const { timezone, toUtc, canonicalizeTimezone } = useTimezone();+ const { timezone, localToUtc, canonicalizeTimezone } = useTimezone();return {- startAt: +toUtc(startDate),- endAt: +toUtc(endDate),- startDate: toUtc(startDate).toISOString(),- endDate: toUtc(endDate).toISOString(),+ startAt: +localToUtc(startDate),+ endAt: +localToUtc(endDate),+ startDate: localToUtc(startDate).toISOString(),+ endDate: localToUtc(endDate).toISOString(),unit,timezone: canonicalizeTimezone(timezone),};diff --git a/src/components/hooks/useDateRange.ts b/src/components/hooks/useDateRange.tsindex de53343a7..7d3884334 100644--- a/src/components/hooks/useDateRange.ts+++ b/src/components/hooks/useDateRange.ts@@ -5,7 +5,7 @@ import { useLocale } from '@/components/hooks/useLocale';import { DATE_RANGE_CONFIG, DEFAULT_DATE_RANGE_VALUE } from '@/lib/constants';import { getItem } from '@/lib/storage';-export function useDateRange(options: { ignoreOffset?: boolean } = {}) {+export function useDateRange(options: { ignoreOffset?: boolean; timezone?: string } = {}) {const {query: { date = '', offset = 0, compare = 'prev' },} = useNavigation();@@ -15,6 +15,7 @@ export function useDateRange(options: { ignoreOffset?: boolean } = {}) {const dateRangeObject = parseDateRange(date || getItem(DATE_RANGE_CONFIG) || DEFAULT_DATE_RANGE_VALUE,locale,+ options.timezone,);return !options.ignoreOffset && offsetdiff --git a/src/components/hooks/useTimezone.ts b/src/components/hooks/useTimezone.tsindex 3770c26bd..22a34194c 100644--- a/src/components/hooks/useTimezone.ts+++ b/src/components/hooks/useTimezone.ts@@ -3,11 +3,13 @@ import { TIMEZONE_CONFIG, TIMEZONE_LEGACY } from '@/lib/constants';import { formatInTimeZone, zonedTimeToUtc, utcToZonedTime } from 'date-fns-tz';import { useApp, setTimezone } from '@/store/app';import { useLocale } from './useLocale';+import { getTimezone } from '@/lib/date';const selector = (state: { timezone: string }) => state.timezone;export function useTimezone() {const timezone = useApp(selector);+ const localTimeZone = getTimezone();const { dateLocale } = useLocale();const saveTimezone = (value: string) => {@@ -26,6 +28,38 @@ export function useTimezone() {);};+ const formatSeriesTimezone = (data: any, column: string, timezone: string) => {+ return data.map(item => {+ const date = new Date(item[column]);++ const format = new Intl.DateTimeFormat('en-US', {+ timeZone: timezone,+ hour12: false,+ year: 'numeric',+ month: '2-digit',+ day: '2-digit',+ hour: '2-digit',+ minute: '2-digit',+ second: '2-digit',+ });++ const parts = format.formatToParts(date);+ const get = type => parts.find(p => p.type === type)?.value;++ const year = get('year');+ const month = get('month');+ const day = get('day');+ const hour = get('hour');+ const minute = get('minute');+ const second = get('second');++ return {+ ...item,+ [column]: `${year}-${month}-${day} ${hour}:${minute}:${second}`,+ };+ });+ };+const toUtc = (date: Date | string | number) => {return zonedTimeToUtc(date, timezone);};@@ -34,16 +68,28 @@ export function useTimezone() {return utcToZonedTime(date, timezone);};+ const localToUtc = (date: Date | string | number) => {+ return zonedTimeToUtc(date, localTimeZone);+ };++ const localFromUtc = (date: Date | string | number) => {+ return utcToZonedTime(date, localTimeZone);+ };+const canonicalizeTimezone = (timezone: string): string => {return TIMEZONE_LEGACY[timezone] ?? timezone;};return {timezone,- saveTimezone,- formatTimezoneDate,+ localTimeZone,toUtc,fromUtc,+ localToUtc,+ localFromUtc,+ saveTimezone,+ formatTimezoneDate,+ formatSeriesTimezone,canonicalizeTimezone,};}diff --git a/src/components/metrics/EventsChart.tsx b/src/components/metrics/EventsChart.tsxindex 246772b3e..03ed6e298 100644--- a/src/components/metrics/EventsChart.tsx+++ b/src/components/metrics/EventsChart.tsx@@ -1,6 +1,11 @@import { BarChart, BarChartProps } from '@/components/charts/BarChart';import { LoadingPanel } from '@/components/common/LoadingPanel';-import { useDateRange, useLocale, useWebsiteEventsSeriesQuery } from '@/components/hooks';+import {+ useDateRange,+ useLocale,+ useTimezone,+ useWebsiteEventsSeriesQuery,+} from '@/components/hooks';import { renderDateLabels } from '@/lib/charts';import { CHART_COLORS } from '@/lib/constants';import { generateTimeSeries } from '@/lib/date';@@ -13,9 +18,10 @@ export interface EventsChartProps extends BarChartProps {}export function EventsChart({ websiteId, focusLabel }: EventsChartProps) {+ const { timezone } = useTimezone();const {dateRange: { startDate, endDate, unit },- } = useDateRange();+ } = useDateRange({ timezone: timezone });const { locale, dateLocale } = useLocale();const { data, isLoading, error } = useWebsiteEventsSeriesQuery(websiteId);const [label, setLabel] = useState<string>(focusLabel);@@ -33,20 +39,32 @@ export function EventsChart({ websiteId, focusLabel }: EventsChartProps) {return obj;}, {});- return {- datasets: Object.keys(map).map((key, index) => {- const color = colord(CHART_COLORS[index % CHART_COLORS.length]);- return {- label: key,- data: generateTimeSeries(map[key], startDate, endDate, unit, dateLocale),- lineTension: 0,- backgroundColor: color.alpha(0.6).toRgbString(),- borderColor: color.alpha(0.7).toRgbString(),- borderWidth: 1,- };- }),- focusLabel,- };+ if (!map || Object.keys(map).length === 0) {+ return {+ datasets: [+ {+ data: generateTimeSeries([], startDate, endDate, unit, dateLocale),+ lineTension: 0,+ borderWidth: 1,+ },+ ],+ };+ } else {+ return {+ datasets: Object.keys(map).map((key, index) => {+ const color = colord(CHART_COLORS[index % CHART_COLORS.length]);+ return {+ label: key,+ data: generateTimeSeries(map[key], startDate, endDate, unit, dateLocale),+ lineTension: 0,+ backgroundColor: color.alpha(0.6).toRgbString(),+ borderColor: color.alpha(0.7).toRgbString(),+ borderWidth: 1,+ };+ }),+ focusLabel,+ };+ }}, [data, startDate, endDate, unit, focusLabel]);useEffect(() => {diff --git a/src/components/metrics/RealtimeChart.tsx b/src/components/metrics/RealtimeChart.tsxindex a70361d72..a71c03c36 100644--- a/src/components/metrics/RealtimeChart.tsx+++ b/src/components/metrics/RealtimeChart.tsx@@ -3,6 +3,7 @@ import { startOfMinute, subMinutes, isBefore } from 'date-fns';import { PageviewsChart } from './PageviewsChart';import { DEFAULT_ANIMATION_DURATION, REALTIME_RANGE } from '@/lib/constants';import { RealtimeData } from '@/lib/types';+import { useTimezone } from '@/components/hooks';export interface RealtimeChartProps {data: RealtimeData;@@ -11,6 +12,7 @@ export interface RealtimeChartProps {}export function RealtimeChart({ data, unit, ...props }: RealtimeChartProps) {+ const { formatSeriesTimezone, fromUtc, timezone } = useTimezone();const endDate = startOfMinute(new Date());const startDate = subMinutes(endDate, REALTIME_RANGE);const prevEndDate = useRef(endDate);@@ -21,8 +23,8 @@ export function RealtimeChart({ data, unit, ...props }: RealtimeChartProps) {}return {- pageviews: data.series.views,- sessions: data.series.visitors,+ pageviews: formatSeriesTimezone(data.series.views, 'x', timezone),+ sessions: formatSeriesTimezone(data.series.visitors, 'x', timezone),};}, [data, startDate, endDate, unit]);@@ -38,8 +40,8 @@ export function RealtimeChart({ data, unit, ...props }: RealtimeChartProps) {return (<PageviewsChart{...props}- minDate={startDate}- maxDate={endDate}+ minDate={fromUtc(startDate)}+ maxDate={fromUtc(endDate)}unit={unit}data={chartData}animationDuration={animationDuration}diff --git a/src/lib/clickhouse.ts b/src/lib/clickhouse.tsindex 4880e122e..652b9d118 100644--- a/src/lib/clickhouse.ts+++ b/src/lib/clickhouse.ts@@ -51,12 +51,12 @@ function getUTCString(date?: Date | string | number) {return formatInTimeZone(date || new Date(), 'UTC', 'yyyy-MM-dd HH:mm:ss');}-function getDateStringSQL(data: any, unit: string = 'utc', timezone?: string) {+function getDateStringSQL(field: string, unit: string, timezone?: string) {if (timezone) {- return `formatDateTime(${data}, '${CLICKHOUSE_DATE_FORMATS[unit]}', '${timezone}')`;+ return `formatDateTime(${field}, '${CLICKHOUSE_DATE_FORMATS[unit]}', '${timezone}')`;}- return `formatDateTime(${data}, '${CLICKHOUSE_DATE_FORMATS[unit]}')`;+ return `formatDateTime(${field}, '${CLICKHOUSE_DATE_FORMATS[unit]}')`;}function getDateSQL(field: string, unit: string, timezone?: string) {diff --git a/src/lib/date.ts b/src/lib/date.tsindex afbe07211..81b70c62c 100644--- a/src/lib/date.ts+++ b/src/lib/date.ts@@ -1,44 +1,45 @@+import { getDateLocale } from '@/lib/lang';+import { DateRange } from '@/lib/types';import {- addMinutes,- addHours,addDays,+ addHours,+ addMinutes,addMonths,+ addWeeks,addYears,- subMinutes,- subHours,- subDays,- subMonths,- subYears,- startOfMinute,- startOfHour,- startOfDay,- startOfWeek,- startOfMonth,- startOfYear,- endOfHour,- endOfDay,- endOfWeek,- endOfMonth,- endOfYear,- differenceInMinutes,- differenceInHours,differenceInCalendarDays,- differenceInCalendarWeeks,differenceInCalendarMonths,+ differenceInCalendarWeeks,differenceInCalendarYears,+ differenceInHours,+ differenceInMinutes,+ endOfDay,+ endOfHour,+ endOfMinute,+ endOfMonth,+ endOfWeek,+ endOfYear,format,+ isBefore,+ isDate,+ isEqual,+ isSameDay,max,min,- isDate,- addWeeks,+ startOfDay,+ startOfHour,+ startOfMinute,+ startOfMonth,+ startOfWeek,+ startOfYear,+ subDays,+ subHours,+ subMinutes,+ subMonths,subWeeks,- endOfMinute,- isSameDay,- isBefore,- isEqual,+ subYears,} from 'date-fns';-import { getDateLocale } from '@/lib/lang';-import { DateRange } from '@/lib/types';+import { utcToZonedTime } from 'date-fns-tz';export const TIME_UNIT = {minute: 'minute',@@ -135,7 +136,7 @@ export function parseDateValue(value: string) {return { num: +num, unit };}-export function parseDateRange(value: string, locale = 'en-US'): DateRange {+export function parseDateRange(value: string, locale = 'en-US', timezone?: string): DateRange {if (typeof value !== 'string') {return null;}@@ -156,7 +157,8 @@ export function parseDateRange(value: string, locale = 'en-US'): DateRange {};}- const now = new Date();+ const date = new Date();+ const now = timezone ? utcToZonedTime(date, timezone) : date;const dateLocale = getDateLocale(locale);const { num = 1, unit } = parseDateValue(value);diff --git a/src/lib/prisma.ts b/src/lib/prisma.tsindex d441bcec1..2242069cf 100644--- a/src/lib/prisma.ts+++ b/src/lib/prisma.ts@@ -27,6 +27,14 @@ const DATE_FORMATS = {year: 'YYYY-01-01 HH24:00:00',};+const DATE_FORMATS_UTC = {+ minute: 'YYYY-MM-DD"T"HH24:MI:00"Z"',+ hour: 'YYYY-MM-DD"T"HH24:00:00"Z"',+ day: 'YYYY-MM-DD"T"HH24:00:00"Z"',+ month: 'YYYY-MM-01"T"HH24:00:00"Z"',+ year: 'YYYY-01-01"T"HH24:00:00"Z"',+};+function getAddIntervalQuery(field: string, interval: string): string {return `${field} + interval '${interval}'`;}@@ -40,11 +48,11 @@ function getCastColumnQuery(field: string, type: string): string {}function getDateSQL(field: string, unit: string, timezone?: string): string {- if (timezone) {+ if (timezone && timezone !== 'utc') {return `to_char(date_trunc('${unit}', ${field} at time zone '${timezone}'), '${DATE_FORMATS[unit]}')`;}- return `to_char(date_trunc('${unit}', ${field}), '${DATE_FORMATS[unit]}')`;+ return `to_char(date_trunc('${unit}', ${field}), '${DATE_FORMATS_UTC[unit]}')`;}function getDateWeeklySQL(field: string, timezone?: string) {diff --git a/src/queries/sql/getRealtimeData.ts b/src/queries/sql/getRealtimeData.tsindex b004c4208..58384a545 100644--- a/src/queries/sql/getRealtimeData.ts+++ b/src/queries/sql/getRealtimeData.ts@@ -1,7 +1,7 @@-import { getPageviewStats } from '@/queries/sql/pageviews/getPageviewStats';+import { QueryFilters } from '@/lib/types';import { getRealtimeActivity } from '@/queries/sql/getRealtimeActivity';+import { getPageviewStats } from '@/queries/sql/pageviews/getPageviewStats';import { getSessionStats } from '@/queries/sql/sessions/getSessionStats';-import { QueryFilters } from '@/lib/types';function increment(data: object, key: string) {if (key) {