🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Enhance DateSelector and store management for dashboard time ranges
Bill Yanga798506fdd2a
diff --git a/client/src/components/DateSelector/DateSelector.tsx b/client/src/components/DateSelector/DateSelector.tsxindex 676226321..d202866aa 100644--- a/client/src/components/DateSelector/DateSelector.tsx+++ b/client/src/components/DateSelector/DateSelector.tsx@@ -11,6 +11,7 @@ import {DropdownMenuTrigger,} from "@/components/ui/dropdown-menu";import { getTimezoneLabel, hour12, timezones } from "@/lib/dateTimeUtils";+import { setStoredDashboardDefaultTimeRange } from "@/lib/defaultTimeRange";import { getTimezone, useStore } from "@/lib/store";import { cn } from "@/lib/utils";import { Calendar } from "lucide-react";@@ -46,7 +47,7 @@ const stepDateTimeBucket = (dt: DateTime, bucket: TimeBucket, direction: 1 | -1)export function DateSelector({time,- setTime,+ setTime: setSelectedTime,pastMinutesEnabled = true,}: {time: Time;@@ -56,26 +57,52 @@ export function DateSelector({const { timezone, setTimezone, bucket } = useStore();const t = useExtracted();+ const setTime = (nextTime: Time) => {+ if (nextTime.wellKnown) {+ setStoredDashboardDefaultTimeRange(nextTime.wellKnown);+ }++ setSelectedTime(nextTime);+ };+const getWellKnownLabel = (wellKnown: string): string => {switch (wellKnown) {- case "today": return t("Today");- case "yesterday": return t("Yesterday");- case "last-3-days": return t("Last 3 Days");- case "last-7-days": return t("Last 7 Days");- case "last-14-days": return t("Last 14 Days");- case "last-30-days": return t("Last 30 Days");- case "last-60-days": return t("Last 60 Days");- case "last-30-minutes": return t("Last 30 Minutes");- case "last-1-hour": return t("Last 1 Hour");- case "last-6-hours": return t("Last 6 Hours");- case "last-24-hours": return t("Last 24 Hours");- case "this-week": return t("This Week");- case "last-week": return t("Last Week");- case "this-month": return t("This Month");- case "last-month": return t("Last Month");- case "this-year": return t("This Year");- case "all-time": return t("All Time");- default: return wellKnown;+ case "today":+ return t("Today");+ case "yesterday":+ return t("Yesterday");+ case "last-3-days":+ return t("Last 3 Days");+ case "last-7-days":+ return t("Last 7 Days");+ case "last-14-days":+ return t("Last 14 Days");+ case "last-30-days":+ return t("Last 30 Days");+ case "last-60-days":+ return t("Last 60 Days");+ case "last-30-minutes":+ return t("Last 30 Minutes");+ case "last-1-hour":+ return t("Last 1 Hour");+ case "last-6-hours":+ return t("Last 6 Hours");+ case "last-24-hours":+ return t("Last 24 Hours");+ case "this-week":+ return t("This Week");+ case "last-week":+ return t("Last Week");+ case "this-month":+ return t("This Month");+ case "last-month":+ return t("Last Month");+ case "this-year":+ return t("This Year");+ case "all-time":+ return t("All Time");+ default:+ return wellKnown;}};@@ -368,9 +395,7 @@ export function DateSelector({<CustomDateRangePicker setTime={setTime} time={time} /><DropdownMenuSeparator /><DropdownMenuSub>- <DropdownMenuSubTrigger>- {getTimezoneLabel(timezone)}- </DropdownMenuSubTrigger>+ <DropdownMenuSubTrigger>{getTimezoneLabel(timezone)}</DropdownMenuSubTrigger><DropdownMenuSubContent>{timezones.map(tz => (<DropdownMenuItemdiff --git a/client/src/lib/defaultTimeRange.ts b/client/src/lib/defaultTimeRange.tsnew file mode 100644index 000000000..a4ed4fac3--- /dev/null+++ b/client/src/lib/defaultTimeRange.ts@@ -0,0 +1,187 @@+import { DateTime } from "luxon";+import type { Time } from "../components/DateSelector/types";++export type DashboardDefaultTimeRange = NonNullable<Time["wellKnown"]>;++export const DASHBOARD_DEFAULT_TIME_RANGE_STORAGE_KEY = "rybbit-default-time-range";++export const DASHBOARD_DEFAULT_TIME_RANGES = [+ "today",+ "yesterday",+ "last-3-days",+ "last-7-days",+ "last-14-days",+ "last-30-days",+ "last-60-days",+ "this-week",+ "last-week",+ "this-month",+ "last-month",+ "this-year",+ "last-30-minutes",+ "last-1-hour",+ "last-6-hours",+ "last-24-hours",+ "all-time",+] as const satisfies readonly DashboardDefaultTimeRange[];++const DEFAULT_DASHBOARD_TIME_RANGE: DashboardDefaultTimeRange = "today";++const DEFAULT_TIME_RANGE_ALIASES: Record<string, DashboardDefaultTimeRange> = {+ today: "today",+ yesterday: "yesterday",+ "last-3-days": "last-3-days",+ "last-3d": "last-3-days",+ "last-7-days": "last-7-days",+ "last-7d": "last-7-days",+ "last-14-days": "last-14-days",+ "last-14d": "last-14-days",+ "last-30-days": "last-30-days",+ "last-30d": "last-30-days",+ "last-60-days": "last-60-days",+ "last-60d": "last-60-days",+ "this-week": "this-week",+ "last-week": "last-week",+ "this-month": "this-month",+ "last-month": "last-month",+ "this-year": "this-year",+ "last-30-minutes": "last-30-minutes",+ "last-30m": "last-30-minutes",+ "last-1-hour": "last-1-hour",+ "last-1h": "last-1-hour",+ "last-hour": "last-1-hour",+ "last-6-hours": "last-6-hours",+ "last-6h": "last-6-hours",+ "last-24-hours": "last-24-hours",+ "last-24h": "last-24-hours",+ "all-time": "all-time",+ all: "all-time",+};++export function normalizeDashboardDefaultTimeRange(+ value: string | null | undefined,+ fallback: DashboardDefaultTimeRange = DEFAULT_DASHBOARD_TIME_RANGE+): DashboardDefaultTimeRange {+ const key = value?.trim().toLowerCase().replace(/_/g, "-");+ return (key && DEFAULT_TIME_RANGE_ALIASES[key]) || fallback;+}++export function getStoredDashboardDefaultTimeRange(): DashboardDefaultTimeRange {+ if (typeof window === "undefined") return DEFAULT_DASHBOARD_TIME_RANGE;++ try {+ return normalizeDashboardDefaultTimeRange(localStorage.getItem(DASHBOARD_DEFAULT_TIME_RANGE_STORAGE_KEY));+ } catch {+ return DEFAULT_DASHBOARD_TIME_RANGE;+ }+}++export function setStoredDashboardDefaultTimeRange(value: string) {+ if (typeof window === "undefined") return;++ try {+ localStorage.setItem(DASHBOARD_DEFAULT_TIME_RANGE_STORAGE_KEY, normalizeDashboardDefaultTimeRange(value));+ } catch {+ // Ignore storage failures in private browsing or locked-down embeds.+ }+}++export function getDashboardTimeForRange(value: string, timezone: string): Time {+ const range = normalizeDashboardDefaultTimeRange(value);+ const now = DateTime.now().setZone(timezone);+ const today = now.toISODate() ?? "";++ switch (range) {+ case "today":+ return { mode: "day", day: today, wellKnown: "today" };+ case "yesterday":+ return { mode: "day", day: now.minus({ days: 1 }).toISODate() ?? "", wellKnown: "yesterday" };+ case "last-3-days":+ return {+ mode: "range",+ startDate: now.minus({ days: 2 }).toISODate() ?? "",+ endDate: today,+ wellKnown: "last-3-days",+ };+ case "last-7-days":+ return {+ mode: "range",+ startDate: now.minus({ days: 6 }).toISODate() ?? "",+ endDate: today,+ wellKnown: "last-7-days",+ };+ case "last-14-days":+ return {+ mode: "range",+ startDate: now.minus({ days: 13 }).toISODate() ?? "",+ endDate: today,+ wellKnown: "last-14-days",+ };+ case "last-30-days":+ return {+ mode: "range",+ startDate: now.minus({ days: 29 }).toISODate() ?? "",+ endDate: today,+ wellKnown: "last-30-days",+ };+ case "last-60-days":+ return {+ mode: "range",+ startDate: now.minus({ days: 59 }).toISODate() ?? "",+ endDate: today,+ wellKnown: "last-60-days",+ };+ case "this-week":+ return { mode: "week", week: now.startOf("week").toISODate() ?? "", wellKnown: "this-week" };+ case "last-week":+ return {+ mode: "week",+ week: now.minus({ weeks: 1 }).startOf("week").toISODate() ?? "",+ wellKnown: "last-week",+ };+ case "this-month":+ return { mode: "month", month: now.startOf("month").toISODate() ?? "", wellKnown: "this-month" };+ case "last-month":+ return {+ mode: "month",+ month: now.minus({ months: 1 }).startOf("month").toISODate() ?? "",+ wellKnown: "last-month",+ };+ case "this-year":+ return { mode: "year", year: now.startOf("year").toISODate() ?? "", wellKnown: "this-year" };+ case "last-30-minutes":+ return {+ mode: "past-minutes",+ pastMinutesStart: 30,+ pastMinutesEnd: 0,+ wellKnown: "last-30-minutes",+ };+ case "last-1-hour":+ return {+ mode: "past-minutes",+ pastMinutesStart: 60,+ pastMinutesEnd: 0,+ wellKnown: "last-1-hour",+ };+ case "last-6-hours":+ return {+ mode: "past-minutes",+ pastMinutesStart: 360,+ pastMinutesEnd: 0,+ wellKnown: "last-6-hours",+ };+ case "last-24-hours":+ return {+ mode: "past-minutes",+ pastMinutesStart: 1440,+ pastMinutesEnd: 0,+ wellKnown: "last-24-hours",+ };+ case "all-time":+ return { mode: "all-time", wellKnown: "all-time" };+ }+}++export function getStoredDashboardDefaultTime(timezone: string): Time {+ return getDashboardTimeForRange(getStoredDashboardDefaultTimeRange(), timezone);+}diff --git a/client/src/lib/store.ts b/client/src/lib/store.tsindex d0c656b96..b97dd93ab 100644--- a/client/src/lib/store.ts+++ b/client/src/lib/store.ts@@ -4,6 +4,7 @@ import { create } from "zustand";import { persist } from "zustand/middleware";import { Time } from "../components/DateSelector/types";import { LITE_DASHBOARD } from "./const";+import { getStoredDashboardDefaultTime } from "./defaultTimeRange";// The lite dashboard is backed by hourly materialized views, so anything finer// than an hour has no underlying data. Clamp auto-selected buckets up to "hour".@@ -140,6 +141,82 @@ const getBucketForDateTimeRange = (start: DateTime, end: DateTime): TimeBucket =return "month";};+const getTimeState = (time: Time): Pick<Store, "time" | "previousTime" | "bucket"> => {+ let bucketToUse: TimeBucket = "hour";+ let previousTime: Time;++ if (time.mode === "day") {+ bucketToUse = "hour";+ previousTime = {+ mode: "day",+ day: DateTime.fromISO(time.day).minus({ days: 1 }).toISODate() ?? "",+ };+ } else if (time.mode === "past-minutes") {+ const timeDiff = time.pastMinutesStart - time.pastMinutesEnd;++ if (timeDiff <= 120) {+ bucketToUse = "minute";+ }++ previousTime = {+ mode: "past-minutes",+ pastMinutesStart: time.pastMinutesStart + timeDiff,+ pastMinutesEnd: time.pastMinutesEnd + timeDiff,+ };+ } else if (time.mode === "range") {+ if (hasRangeTimes(time)) {+ const { start, end } = getRangeDateTimeBounds(time);+ const duration = end.diff(start);+ bucketToUse = getBucketForDateTimeRange(start, end);++ previousTime = toRangeWithTimes(start.minus(duration), end.minus(duration));+ } else {+ const timeRangeLength = DateTime.fromISO(time.endDate).diff(DateTime.fromISO(time.startDate), "days").days + 1;++ if (timeRangeLength > 180) {+ bucketToUse = "month";+ } else if (timeRangeLength > 31) {+ bucketToUse = "week";+ } else {+ bucketToUse = "day";+ }++ previousTime = {+ mode: "range",+ startDate: DateTime.fromISO(time.startDate).minus({ days: timeRangeLength }).toISODate() ?? "",+ endDate: DateTime.fromISO(time.startDate).minus({ days: 1 }).toISODate() ?? "",+ };+ }+ } else if (time.mode === "week") {+ bucketToUse = "day";+ previousTime = {+ mode: "week",+ week: DateTime.fromISO(time.week).minus({ weeks: 1 }).toISODate() ?? "",+ };+ } else if (time.mode === "month") {+ bucketToUse = "day";+ previousTime = {+ mode: "month",+ month: DateTime.fromISO(time.month).minus({ months: 1 }).toISODate() ?? "",+ };+ } else if (time.mode === "year") {+ bucketToUse = "month";+ previousTime = {+ mode: "year",+ year: DateTime.fromISO(time.year).minus({ years: 1 }).toISODate() ?? "",+ };+ } else if (time.mode === "all-time") {+ bucketToUse = "day";+ previousTime = {+ mode: "all-time",+ };+ } else {+ previousTime = time;+ }++ return { time, previousTime, bucket: clampBucketForLite(bucketToUse) };+};+type Store = {site: string;setSite: (site: string) => void;@@ -163,17 +240,9 @@ type PersistedStore = Pick<Store, "timezone">;const getUrlParams = () => (typeof window !== "undefined" ? new URLSearchParams(globalThis.location.search) : null);-const getDefaultTime = (): Time => ({- mode: "day",- day: DateTime.now().toISODate(),- wellKnown: "today",-});+const getDefaultTime = (): Time => getStoredDashboardDefaultTime(getSystemTimezone());-const getDefaultPreviousTime = (): Time => ({- mode: "day",- day: DateTime.now().minus({ days: 1 }).toISODate(),- wellKnown: "yesterday",-});+const getDefaultTimeState = () => getTimeState(getDefaultTime());const getSiteStateForUrl = (state: Store, site: string, privateKey?: string | null): Partial<Store> => {const urlParams = getUrlParams();@@ -181,13 +250,14 @@ const getSiteStateForUrl = (state: Store, site: string, privateKey?: string | nuconst hasBucketInUrl = urlParams?.has("bucket");const hasStatInUrl = urlParams?.has("stat");const hasFiltersInUrl = urlParams?.has("filters");+ const defaultTimeState = getDefaultTimeState();return {site,...(privateKey !== undefined ? { privateKey } : {}),- time: hasTimeInUrl ? state.time : getDefaultTime(),- previousTime: hasTimeInUrl ? state.previousTime : getDefaultPreviousTime(),- bucket: hasBucketInUrl ? state.bucket : "hour",+ time: hasTimeInUrl ? state.time : defaultTimeState.time,+ previousTime: hasTimeInUrl ? state.previousTime : defaultTimeState.previousTime,+ bucket: hasBucketInUrl ? state.bucket : defaultTimeState.bucket,selectedStat: hasStatInUrl ? state.selectedStat : "users",filters: hasFiltersInUrl ? state.filters : [],};@@ -205,97 +275,16 @@ export const useStore = create<Store, [["zustand/persist", PersistedStore]]>(setSiteContext: (site, privateKey) => {set(state => getSiteStateForUrl(state, site, privateKey));},- time: {- mode: "day",- day: DateTime.now().toISODate(),- wellKnown: "today",- },- previousTime: {- mode: "day",- day: DateTime.now().minus({ days: 1 }).toISODate(),- wellKnown: "yesterday",- },+ ...getDefaultTimeState(),setTime: (time, changeBucket = true) => {- let bucketToUse: TimeBucket = "hour";- let previousTime: Time;-- if (time.mode === "day") {- bucketToUse = "hour";- previousTime = {- mode: "day",- day: DateTime.fromISO(time.day).minus({ days: 1 }).toISODate() ?? "",- };- } else if (time.mode === "past-minutes") {- const timeDiff = time.pastMinutesStart - time.pastMinutesEnd;-- if (timeDiff <= 120) {- bucketToUse = "minute";- }-- previousTime = {- mode: "past-minutes",- pastMinutesStart: time.pastMinutesStart + timeDiff,- pastMinutesEnd: time.pastMinutesEnd + timeDiff,- };- } else if (time.mode === "range") {- if (hasRangeTimes(time)) {- const { start, end } = getRangeDateTimeBounds(time);- const duration = end.diff(start);- bucketToUse = getBucketForDateTimeRange(start, end);-- previousTime = toRangeWithTimes(start.minus(duration), end.minus(duration));- } else {- const timeRangeLength =- DateTime.fromISO(time.endDate).diff(DateTime.fromISO(time.startDate), "days").days + 1;-- if (timeRangeLength > 180) {- bucketToUse = "month";- } else if (timeRangeLength > 31) {- bucketToUse = "week";- } else {- bucketToUse = "day";- }-- previousTime = {- mode: "range",- startDate: DateTime.fromISO(time.startDate).minus({ days: timeRangeLength }).toISODate() ?? "",- endDate: DateTime.fromISO(time.startDate).minus({ days: 1 }).toISODate() ?? "",- };- }- } else if (time.mode === "week") {- bucketToUse = "day";- previousTime = {- mode: "week",- week: DateTime.fromISO(time.week).minus({ weeks: 1 }).toISODate() ?? "",- };- } else if (time.mode === "month") {- bucketToUse = "day";- previousTime = {- mode: "month",- month: DateTime.fromISO(time.month).minus({ months: 1 }).toISODate() ?? "",- };- } else if (time.mode === "year") {- bucketToUse = "month";- previousTime = {- mode: "year",- year: DateTime.fromISO(time.year).minus({ years: 1 }).toISODate() ?? "",- };- } else if (time.mode === "all-time") {- bucketToUse = "day";- previousTime = {- mode: "all-time",- };- } else {- previousTime = time; // fallback case- }+ const nextTimeState = getTimeState(time);if (changeBucket) {- set({ time, previousTime, bucket: clampBucketForLite(bucketToUse) });+ set(nextTimeState);} else {- set({ time, previousTime });+ set({ time, previousTime: nextTimeState.previousTime });}},- bucket: "hour",setBucket: bucket => set({ bucket }),selectedStat: "users",setSelectedStat: stat => set({ selectedStat: stat }),@@ -336,11 +325,10 @@ export const toUserTimezone = (dt: DateTime): DateTime => {};export const resetStore = () => {- const { setSite, setPrivateKey, setTime, setBucket, setSelectedStat, setFilters } = useStore.getState();+ const { setSite, setPrivateKey, setTime, setSelectedStat, setFilters } = useStore.getState();setSite("");setPrivateKey(null);- setTime({ mode: "day", day: DateTime.now().toISODate(), wellKnown: "today" });- setBucket("hour");+ setTime(getDefaultTime());setSelectedStat("users");setFilters([]);};diff --git a/client/src/lib/urlParams.ts b/client/src/lib/urlParams.tsindex beec85408..dd841329e 100644--- a/client/src/lib/urlParams.ts+++ b/client/src/lib/urlParams.ts@@ -1,135 +1,14 @@"use client";-import { DateTime } from "luxon";import { usePathname, useSearchParams } from "next/navigation";import { useQueryStates } from "nuqs";import React, { useEffect } from "react";import { Time } from "../components/DateSelector/types";+import { getDashboardTimeForRange, getStoredDashboardDefaultTime } from "./defaultTimeRange";import { analyticsParsers } from "./parsers";import { getSiteRouteContext, isSyncedAnalyticsRoute } from "./siteRoute";import { getTimezone, useStore } from "./store";-// Map of wellKnown presets to their dynamic time calculations-// Uses timezone-aware dates based on the user's selected timezone-const wellKnownPresets: Record<string, () => Time> = {- today: () => {- const now = DateTime.now().setZone(getTimezone());- return { mode: "day", day: now.toISODate()!, wellKnown: "today" };- },- yesterday: () => {- const now = DateTime.now().setZone(getTimezone());- return { mode: "day", day: now.minus({ days: 1 }).toISODate()!, wellKnown: "yesterday" };- },- "last-3-days": () => {- const now = DateTime.now().setZone(getTimezone());- return {- mode: "range",- startDate: now.minus({ days: 2 }).toISODate()!,- endDate: now.toISODate()!,- wellKnown: "last-3-days",- };- },- "last-7-days": () => {- const now = DateTime.now().setZone(getTimezone());- return {- mode: "range",- startDate: now.minus({ days: 6 }).toISODate()!,- endDate: now.toISODate()!,- wellKnown: "last-7-days",- };- },- "last-14-days": () => {- const now = DateTime.now().setZone(getTimezone());- return {- mode: "range",- startDate: now.minus({ days: 13 }).toISODate()!,- endDate: now.toISODate()!,- wellKnown: "last-14-days",- };- },- "last-30-days": () => {- const now = DateTime.now().setZone(getTimezone());- return {- mode: "range",- startDate: now.minus({ days: 29 }).toISODate()!,- endDate: now.toISODate()!,- wellKnown: "last-30-days",- };- },- "last-60-days": () => {- const now = DateTime.now().setZone(getTimezone());- return {- mode: "range",- startDate: now.minus({ days: 59 }).toISODate()!,- endDate: now.toISODate()!,- wellKnown: "last-60-days",- };- },- "this-week": () => {- const now = DateTime.now().setZone(getTimezone());- return { mode: "week", week: now.startOf("week").toISODate()!, wellKnown: "this-week" };- },- "last-week": () => {- const now = DateTime.now().setZone(getTimezone());- return {- mode: "week",- week: now.minus({ weeks: 1 }).startOf("week").toISODate()!,- wellKnown: "last-week",- };- },- "this-month": () => {- const now = DateTime.now().setZone(getTimezone());- return {- mode: "month",- month: now.startOf("month").toISODate()!,- wellKnown: "this-month",- };- },- "last-month": () => {- const now = DateTime.now().setZone(getTimezone());- return {- mode: "month",- month: now.minus({ months: 1 }).startOf("month").toISODate()!,- wellKnown: "last-month",- };- },- "this-year": () => {- const now = DateTime.now().setZone(getTimezone());- return { mode: "year", year: now.startOf("year").toISODate()!, wellKnown: "this-year" };- },- "last-30-minutes": () => ({- mode: "past-minutes",- pastMinutesStart: 30,- pastMinutesEnd: 0,- wellKnown: "last-30-minutes",- }),- "last-1-hour": () => ({- mode: "past-minutes",- pastMinutesStart: 60,- pastMinutesEnd: 0,- wellKnown: "last-1-hour",- }),- "last-6-hours": () => ({- mode: "past-minutes",- pastMinutesStart: 360,- pastMinutesEnd: 0,- wellKnown: "last-6-hours",- }),- "last-24-hours": () => ({- mode: "past-minutes",- pastMinutesStart: 1440,- pastMinutesEnd: 0,- wellKnown: "last-24-hours",- }),- "all-time": () => ({ mode: "all-time", wellKnown: "all-time" }),-};--const getDefaultTime = (): Time => ({- mode: "day",- day: DateTime.now().setZone(getTimezone()).toISODate()!,- wellKnown: "today",-});-// Hook to sync store state with URLexport const useSyncStateWithUrl = () => {const pathname = usePathname();@@ -163,8 +42,8 @@ export const useSyncStateWithUrl = () => {let timeFromUrl: Time | null = null;// Try to resolve wellKnown preset first- if (urlParams.wellKnown && wellKnownPresets[urlParams.wellKnown]) {- timeFromUrl = wellKnownPresets[urlParams.wellKnown]();+ if (urlParams.wellKnown) {+ timeFromUrl = getDashboardTimeForRange(urlParams.wellKnown, getTimezone());} else if (urlParams.timeMode) {// Fallback to explicit date parametersif (urlParams.timeMode === "day" && urlParams.day) {@@ -204,7 +83,7 @@ export const useSyncStateWithUrl = () => {if (timeFromUrl) {setTime(timeFromUrl, !urlParams.bucket);} else {- setTime(getDefaultTime(), !urlParams.bucket);+ setTime(getStoredDashboardDefaultTime(getTimezone()), !urlParams.bucket);}// Process bucket separately