Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

feat: store visual series in db

Carl-Gerhard Lindesvärd6938fc733ff9
diff --git a/apps/start/src/components/report-chart/area/chart.tsx b/apps/start/src/components/report-chart/area/chart.tsx
index 872ed19b3..644c66dc1 100644
--- a/apps/start/src/components/report-chart/area/chart.tsx
+++ b/apps/start/src/components/report-chart/area/chart.tsx
@@ -2,6 +2,7 @@ import { useRechartDataModel } from '@/hooks/use-rechart-data-model';
import { useVisibleSeries } from '@/hooks/use-visible-series';
import { useTRPC } from '@/integrations/trpc/react';
import { pushModal } from '@/modals';
+import { useDispatch } from '@/redux';
import type { IChartData } from '@/trpc/client';
import { cn } from '@/utils/cn';
import { getChartColor } from '@/utils/theme';
@@ -24,6 +25,7 @@ import {
YAxis,
} from 'recharts';
+import { changeVisibleSeries } from '@/components/report/reportSlice';
import { useDashedStroke } from '@/hooks/use-dashed-stroke';
import { useXAxisProps, useYAxisProps } from '../common/axis';
import {
@@ -52,10 +54,12 @@ export function Chart({ data }: Props) {
lineType,
series: reportSeries,
breakdowns,
+ visibleSeries: savedVisibleSeries,
},
isEditMode,
options: { hideXAxis, hideYAxis },
} = useReportChartContext();
+ const dispatch = useDispatch();
const trpc = useTRPC();
const references = useQuery(
trpc.reference.getChartReferences.queryOptions(
@@ -70,7 +74,12 @@ export function Chart({ data }: Props) {
},
),
);
- const { series, setVisibleSeries } = useVisibleSeries(data);
+ const { series, setVisibleSeries } = useVisibleSeries(data, {
+ savedVisibleSeries,
+ onVisibleSeriesChange: isEditMode
+ ? (ids) => dispatch(changeVisibleSeries(ids))
+ : undefined,
+ });
const rechartData = useRechartDataModel(series);
let dotIndex = undefined;
diff --git a/apps/start/src/components/report-chart/area/index.tsx b/apps/start/src/components/report-chart/area/index.tsx
index e4f5052e5..8b5946b88 100644
--- a/apps/start/src/components/report-chart/area/index.tsx
+++ b/apps/start/src/components/report-chart/area/index.tsx
@@ -5,17 +5,18 @@ import { AspectContainer } from '../aspect-container';
import { ReportChartEmpty } from '../common/empty';
import { ReportChartError } from '../common/error';
import { ReportChartLoading } from '../common/loading';
-import { useReportChartContext } from '../context';
+import { useChartInput, useReportChartContext } from '../context';
import { Chart } from './chart';
export function ReportAreaChart() {
- const { isLazyLoading, report, shareId } = useReportChartContext();
+ const { isLazyLoading, shareId } = useReportChartContext();
+ const chartInput = useChartInput();
const trpc = useTRPC();
const res = useQuery(
trpc.chart.chart.queryOptions(
{
- ...report,
+ ...chartInput,
shareId,
},
{
diff --git a/apps/start/src/components/report-chart/bar/chart.tsx b/apps/start/src/components/report-chart/bar/chart.tsx
index 13e4b6db7..2d7e0ffc0 100644
--- a/apps/start/src/components/report-chart/bar/chart.tsx
+++ b/apps/start/src/components/report-chart/bar/chart.tsx
@@ -54,7 +54,7 @@ export function Chart({ data }: Props) {
const number = useNumber();
// Use useVisibleSeries to add index property for colors
- const { series: allSeriesWithIndex } = useVisibleSeries(data, 500);
+ const { series: allSeriesWithIndex } = useVisibleSeries(data, { limit: 500 });
const totalSum = data.metrics.sum || 1;
diff --git a/apps/start/src/components/report-chart/bar/index.tsx b/apps/start/src/components/report-chart/bar/index.tsx
index d6f463525..f17f5f1a3 100644
--- a/apps/start/src/components/report-chart/bar/index.tsx
+++ b/apps/start/src/components/report-chart/bar/index.tsx
@@ -5,17 +5,18 @@ import { cn } from '@/utils/cn';
import { AspectContainer } from '../aspect-container';
import { ReportChartEmpty } from '../common/empty';
import { ReportChartError } from '../common/error';
-import { useReportChartContext } from '../context';
+import { useChartInput, useReportChartContext } from '../context';
import { Chart } from './chart';
export function ReportBarChart() {
- const { isLazyLoading, report, shareId } = useReportChartContext();
+ const { isLazyLoading, shareId } = useReportChartContext();
+ const chartInput = useChartInput();
const trpc = useTRPC();
const res = useQuery(
trpc.chart.aggregate.queryOptions(
{
- ...report,
+ ...chartInput,
shareId,
},
{
diff --git a/apps/start/src/components/report-chart/context.tsx b/apps/start/src/components/report-chart/context.tsx
index fc648623e..d313f3c51 100644
--- a/apps/start/src/components/report-chart/context.tsx
+++ b/apps/start/src/components/report-chart/context.tsx
@@ -1,6 +1,6 @@
import isEqual from 'lodash.isequal';
import type { LucideIcon } from 'lucide-react';
-import { createContext, useContext, useEffect, useState } from 'react';
+import { createContext, useContext, useEffect, useMemo, useState } from 'react';
import type { IChartSerie, IReportInput } from '@openpanel/validation';
@@ -51,6 +51,18 @@ export const useReportChartContext = () => {
return ctx;
};
+/**
+ * Returns the report input suitable for chart queries — strips display-only
+ * fields (like visibleSeries) that shouldn't affect the query cache key.
+ */
+export const useChartInput = () => {
+ const { report } = useReportChartContext();
+ return useMemo(() => {
+ const { visibleSeries, ...input } = report;
+ return input;
+ }, [report]);
+};
+
export const ReportChartProvider = ({
children,
...propsToContext
diff --git a/apps/start/src/components/report-chart/conversion/chart.tsx b/apps/start/src/components/report-chart/conversion/chart.tsx
index c427916f1..1be114c19 100644
--- a/apps/start/src/components/report-chart/conversion/chart.tsx
+++ b/apps/start/src/components/report-chart/conversion/chart.tsx
@@ -1,4 +1,6 @@
+import { changeVisibleSeries } from '@/components/report/reportSlice';
import { pushModal } from '@/modals';
+import { useDispatch } from '@/redux';
import type { RouterOutputs } from '@/trpc/client';
import { cn } from '@/utils/cn';
import { getChartColor } from '@/utils/theme';
@@ -40,11 +42,26 @@ interface Props {
export function Chart({ data }: Props) {
const {
- report: { interval, projectId, startDate, endDate, range, lineType },
+ report: {
+ interval,
+ projectId,
+ startDate,
+ endDate,
+ range,
+ lineType,
+ visibleSeries: savedVisibleSeries,
+ },
isEditMode,
options: { hideXAxis, hideYAxis, maxDomain },
} = useReportChartContext();
- const { series, setVisibleSeries } = useVisibleConversionSeries(data, 5);
+ const dispatch = useDispatch();
+ const { series, setVisibleSeries } = useVisibleConversionSeries(data, {
+ limit: 5,
+ savedVisibleSeries,
+ onVisibleSeriesChange: isEditMode
+ ? (ids) => dispatch(changeVisibleSeries(ids))
+ : undefined,
+ });
const rechartData = useConversionRechartDataModel(series);
const trpc = useTRPC();
const references = useQuery(
diff --git a/apps/start/src/components/report-chart/conversion/index.tsx b/apps/start/src/components/report-chart/conversion/index.tsx
index b099c1419..2081d3a0d 100644
--- a/apps/start/src/components/report-chart/conversion/index.tsx
+++ b/apps/start/src/components/report-chart/conversion/index.tsx
@@ -6,17 +6,18 @@ import { AspectContainer } from '../aspect-container';
import { ReportChartEmpty } from '../common/empty';
import { ReportChartError } from '../common/error';
import { ReportChartLoading } from '../common/loading';
-import { useReportChartContext } from '../context';
+import { useChartInput, useReportChartContext } from '../context';
import { Chart } from './chart';
import { Summary } from './summary';
export function ReportConversionChart() {
- const { isLazyLoading, report, shareId } = useReportChartContext();
+ const { isLazyLoading, shareId } = useReportChartContext();
+ const chartInput = useChartInput();
const trpc = useTRPC();
const res = useQuery(
trpc.chart.conversion.queryOptions(
{
- ...report,
+ ...chartInput,
shareId,
},
{
diff --git a/apps/start/src/components/report-chart/funnel/index.tsx b/apps/start/src/components/report-chart/funnel/index.tsx
index f13a0cb5f..0a098ff5d 100644
--- a/apps/start/src/components/report-chart/funnel/index.tsx
+++ b/apps/start/src/components/report-chart/funnel/index.tsx
@@ -1,4 +1,6 @@
+import { changeVisibleSeries } from '@/components/report/reportSlice';
import { useTRPC } from '@/integrations/trpc/react';
+import { useDispatch } from '@/redux';
import type { RouterOutputs } from '@/trpc/client';
import { useQuery } from '@tanstack/react-query';
@@ -6,29 +8,38 @@ import { AspectContainer } from '../aspect-container';
import { ReportChartEmpty } from '../common/empty';
import { ReportChartError } from '../common/error';
import { ReportChartLoading } from '../common/loading';
-import { useReportChartContext } from '../context';
+import { useChartInput, useReportChartContext } from '../context';
import { useVisibleFunnelBreakdowns } from '@/hooks/use-visible-funnel-breakdowns';
import { Chart, Summary } from './chart';
import { BreakdownList } from './breakdown-list';
export function ReportFunnelChart() {
- const { isLazyLoading, report, shareId } = useReportChartContext();
+ const { isLazyLoading, report, shareId, isEditMode } =
+ useReportChartContext();
+ const chartInput = useChartInput();
+ const dispatch = useDispatch();
const trpc = useTRPC();
const res = useQuery(
trpc.chart.funnel.queryOptions(
{
- ...report,
+ ...chartInput,
shareId,
},
{
- enabled: !isLazyLoading && report.series.length > 0,
+ enabled: !isLazyLoading && chartInput.series.length > 0,
},
),
);
// Hook for limiting which breakdowns are shown in the chart only
const { breakdowns: visibleBreakdowns, setVisibleSeries } =
- useVisibleFunnelBreakdowns(res.data?.current ?? [], 10);
+ useVisibleFunnelBreakdowns(res.data?.current ?? [], {
+ limit: 10,
+ savedVisibleSeries: report.visibleSeries,
+ onVisibleSeriesChange: isEditMode
+ ? (ids) => dispatch(changeVisibleSeries(ids))
+ : undefined,
+ });
if (isLazyLoading || res.isLoading) {
return <Loading />;
diff --git a/apps/start/src/components/report-chart/histogram/chart.tsx b/apps/start/src/components/report-chart/histogram/chart.tsx
index ac63c2c49..3e36e0f37 100644
--- a/apps/start/src/components/report-chart/histogram/chart.tsx
+++ b/apps/start/src/components/report-chart/histogram/chart.tsx
@@ -3,6 +3,7 @@ import { useTheme } from '@/hooks/use-theme';
import { useVisibleSeries } from '@/hooks/use-visible-series';
import { useTRPC } from '@/integrations/trpc/react';
import { pushModal } from '@/modals';
+import { useDispatch } from '@/redux';
import type { IChartData } from '@/trpc/client';
import { cn } from '@/utils/cn';
import { getChartColor } from '@/utils/theme';
@@ -20,6 +21,7 @@ import {
YAxis,
} from 'recharts';
+import { changeVisibleSeries } from '@/components/report/reportSlice';
import { useXAxisProps, useYAxisProps } from '../common/axis';
import {
ChartClickMenu,
@@ -62,9 +64,11 @@ export function Chart({ data }: Props) {
series: reportSeries,
breakdowns,
options: reportOptions,
+ visibleSeries: savedVisibleSeries,
},
options: { hideXAxis, hideYAxis },
} = useReportChartContext();
+ const dispatch = useDispatch();
const histogramOptions =
reportOptions?.type === 'histogram' ? reportOptions : undefined;
@@ -83,7 +87,12 @@ export function Chart({ data }: Props) {
},
),
);
- const { series, setVisibleSeries } = useVisibleSeries(data);
+ const { series, setVisibleSeries } = useVisibleSeries(data, {
+ savedVisibleSeries,
+ onVisibleSeriesChange: isEditMode
+ ? (ids) => dispatch(changeVisibleSeries(ids))
+ : undefined,
+ });
const rechartData = useRechartDataModel(series);
const yAxisProps = useYAxisProps({
hide: hideYAxis,
diff --git a/apps/start/src/components/report-chart/histogram/index.tsx b/apps/start/src/components/report-chart/histogram/index.tsx
index a2f7f78e0..219e853e0 100644
--- a/apps/start/src/components/report-chart/histogram/index.tsx
+++ b/apps/start/src/components/report-chart/histogram/index.tsx
@@ -5,17 +5,18 @@ import { AspectContainer } from '../aspect-container';
import { ReportChartEmpty } from '../common/empty';
import { ReportChartError } from '../common/error';
import { ReportChartLoading } from '../common/loading';
-import { useReportChartContext } from '../context';
+import { useChartInput, useReportChartContext } from '../context';
import { Chart } from './chart';
export function ReportHistogramChart() {
- const { isLazyLoading, report, shareId } = useReportChartContext();
+ const { isLazyLoading, shareId } = useReportChartContext();
+ const chartInput = useChartInput();
const trpc = useTRPC();
const res = useQuery(
trpc.chart.chart.queryOptions(
{
- ...report,
+ ...chartInput,
shareId,
},
{
diff --git a/apps/start/src/components/report-chart/line/chart.tsx b/apps/start/src/components/report-chart/line/chart.tsx
index d546258de..4f7979271 100644
--- a/apps/start/src/components/report-chart/line/chart.tsx
+++ b/apps/start/src/components/report-chart/line/chart.tsx
@@ -2,6 +2,7 @@ import { useRechartDataModel } from '@/hooks/use-rechart-data-model';
import { useVisibleSeries } from '@/hooks/use-visible-series';
import { useTRPC } from '@/integrations/trpc/react';
import { pushModal } from '@/modals';
+import { useDispatch } from '@/redux';
import type { IChartData } from '@/trpc/client';
import { cn } from '@/utils/cn';
import { getChartColor } from '@/utils/theme';
@@ -23,6 +24,7 @@ import {
YAxis,
} from 'recharts';
+import { changeVisibleSeries } from '@/components/report/reportSlice';
import { useDashedStroke } from '@/hooks/use-dashed-stroke';
import { useXAxisProps, useYAxisProps } from '../common/axis';
import {
@@ -51,10 +53,12 @@ export function Chart({ data }: Props) {
lineType,
series: reportSeries,
breakdowns,
+ visibleSeries: savedVisibleSeries,
},
isEditMode,
options: { hideXAxis, hideYAxis, maxDomain },
} = useReportChartContext();
+ const dispatch = useDispatch();
const dataLength = data.series[0]?.data?.length || 0;
const trpc = useTRPC();
const references = useQuery(
@@ -70,7 +74,12 @@ export function Chart({ data }: Props) {
},
),
);
- const { series, setVisibleSeries } = useVisibleSeries(data);
+ const { series, setVisibleSeries } = useVisibleSeries(data, {
+ savedVisibleSeries,
+ onVisibleSeriesChange: isEditMode
+ ? (ids) => dispatch(changeVisibleSeries(ids))
+ : undefined,
+ });
const rechartData = useRechartDataModel(series);
let dotIndex = undefined;
diff --git a/apps/start/src/components/report-chart/line/index.tsx b/apps/start/src/components/report-chart/line/index.tsx
index b83f37b1e..56f74b163 100644
--- a/apps/start/src/components/report-chart/line/index.tsx
+++ b/apps/start/src/components/report-chart/line/index.tsx
@@ -5,16 +5,17 @@ import { AspectContainer } from '../aspect-container';
import { ReportChartEmpty } from '../common/empty';
import { ReportChartError } from '../common/error';
import { ReportChartLoading } from '../common/loading';
-import { useReportChartContext } from '../context';
+import { useChartInput, useReportChartContext } from '../context';
import { Chart } from './chart';
export function ReportLineChart() {
- const { isLazyLoading, report, shareId } = useReportChartContext();
+ const { isLazyLoading, shareId } = useReportChartContext();
+ const chartInput = useChartInput();
const trpc = useTRPC();
const res = useQuery(
trpc.chart.chart.queryOptions(
{
- ...report,
+ ...chartInput,
shareId,
},
{
diff --git a/apps/start/src/components/report-chart/map/chart.tsx b/apps/start/src/components/report-chart/map/chart.tsx
index d1eb8c697..f3f8d3aec 100644
--- a/apps/start/src/components/report-chart/map/chart.tsx
+++ b/apps/start/src/components/report-chart/map/chart.tsx
@@ -15,7 +15,7 @@ export function Chart({ data }: Props) {
const {
report: { metric, unit },
} = useReportChartContext();
- const { series } = useVisibleSeries(data, 99999);
+ const { series } = useVisibleSeries(data, { limit: 99999 });
const [_, setFilter] = useEventQueryFilters();
const mapData = useMemo(
() =>
diff --git a/apps/start/src/components/report-chart/map/index.tsx b/apps/start/src/components/report-chart/map/index.tsx
index 2c4b26636..39912235e 100644
--- a/apps/start/src/components/report-chart/map/index.tsx
+++ b/apps/start/src/components/report-chart/map/index.tsx
@@ -5,17 +5,18 @@ import { AspectContainer } from '../aspect-container';
import { ReportChartEmpty } from '../common/empty';
import { ReportChartError } from '../common/error';
import { ReportChartLoading } from '../common/loading';
-import { useReportChartContext } from '../context';
+import { useChartInput, useReportChartContext } from '../context';
import { Chart } from './chart';
export function ReportMapChart() {
- const { isLazyLoading, report, shareId } = useReportChartContext();
+ const { isLazyLoading, shareId } = useReportChartContext();
+ const chartInput = useChartInput();
const trpc = useTRPC();
const res = useQuery(
trpc.chart.chart.queryOptions(
{
- ...report,
+ ...chartInput,
shareId,
},
{
diff --git a/apps/start/src/components/report-chart/metric/chart.tsx b/apps/start/src/components/report-chart/metric/chart.tsx
index 823210c6e..8d5a96c1b 100644
--- a/apps/start/src/components/report-chart/metric/chart.tsx
+++ b/apps/start/src/components/report-chart/metric/chart.tsx
@@ -14,7 +14,7 @@ export function Chart({ data }: Props) {
isEditMode,
report: { unit },
} = useReportChartContext();
- const { series } = useVisibleSeries(data, isEditMode ? 20 : 4);
+ const { series } = useVisibleSeries(data, { limit: isEditMode ? 20 : 4 });
return (
<div
className={cn(
diff --git a/apps/start/src/components/report-chart/metric/index.tsx b/apps/start/src/components/report-chart/metric/index.tsx
index 5171bcb99..47aad7d43 100644
--- a/apps/start/src/components/report-chart/metric/index.tsx
+++ b/apps/start/src/components/report-chart/metric/index.tsx
@@ -4,17 +4,18 @@ import { keepPreviousData, useQuery } from '@tanstack/react-query';
import { AspectContainer } from '../aspect-container';
import { ReportChartEmpty } from '../common/empty';
import { ReportChartError } from '../common/error';
-import { useReportChartContext } from '../context';
+import { useChartInput, useReportChartContext } from '../context';
import { Chart } from './chart';
export function ReportMetricChart() {
- const { isLazyLoading, report, shareId } = useReportChartContext();
+ const { isLazyLoading, shareId } = useReportChartContext();
+ const chartInput = useChartInput();
const trpc = useTRPC();
const res = useQuery(
trpc.chart.chart.queryOptions(
{
- ...report,
+ ...chartInput,
shareId,
},
{
diff --git a/apps/start/src/components/report-chart/pie/chart.tsx b/apps/start/src/components/report-chart/pie/chart.tsx
index d75ada3fd..ae19c3104 100644
--- a/apps/start/src/components/report-chart/pie/chart.tsx
+++ b/apps/start/src/components/report-chart/pie/chart.tsx
@@ -1,4 +1,6 @@
+import { changeVisibleSeries } from '@/components/report/reportSlice';
import { useVisibleSeries } from '@/hooks/use-visible-series';
+import { useDispatch } from '@/redux';
import type { IChartData } from '@/trpc/client';
import { cn } from '@/utils/cn';
import { round } from '@/utils/math';
@@ -64,8 +66,17 @@ const PieTooltip = (props: { payload?: any[] }) => {
};
export function Chart({ data }: Props) {
- const { isEditMode } = useReportChartContext();
- const { series, setVisibleSeries } = useVisibleSeries(data);
+ const {
+ isEditMode,
+ report: { visibleSeries: savedVisibleSeries },
+ } = useReportChartContext();
+ const dispatch = useDispatch();
+ const { series, setVisibleSeries } = useVisibleSeries(data, {
+ savedVisibleSeries,
+ onVisibleSeriesChange: isEditMode
+ ? (ids) => dispatch(changeVisibleSeries(ids))
+ : undefined,
+ });
const sum = series.reduce((acc, serie) => acc + serie.metrics.sum, 0);
const pieData = series.map((serie) => ({
diff --git a/apps/start/src/components/report-chart/pie/index.tsx b/apps/start/src/components/report-chart/pie/index.tsx
index e7a37e995..0f87c78c8 100644
--- a/apps/start/src/components/report-chart/pie/index.tsx
+++ b/apps/start/src/components/report-chart/pie/index.tsx
@@ -5,17 +5,18 @@ import { AspectContainer } from '../aspect-container';
import { ReportChartEmpty } from '../common/empty';
import { ReportChartError } from '../common/error';
import { ReportChartLoading } from '../common/loading';
-import { useReportChartContext } from '../context';
+import { useChartInput, useReportChartContext } from '../context';
import { Chart } from './chart';
export function ReportPieChart() {
- const { isLazyLoading, report, shareId } = useReportChartContext();
+ const { isLazyLoading, shareId } = useReportChartContext();
+ const chartInput = useChartInput();
const trpc = useTRPC();
const res = useQuery(
trpc.chart.aggregate.queryOptions(
{
- ...report,
+ ...chartInput,
shareId,
},
{
diff --git a/apps/start/src/components/report/reportSlice.ts b/apps/start/src/components/report/reportSlice.ts
index 8b4ebd99a..a6ffddd9b 100644
--- a/apps/start/src/components/report/reportSlice.ts
+++ b/apps/start/src/components/report/reportSlice.ts
@@ -50,6 +50,7 @@ const initialState: InitialState = {
metric: 'sum',
limit: 500,
options: undefined,
+ visibleSeries: undefined,
};
export const reportSlice = createSlice({
@@ -75,8 +76,8 @@ export const reportSlice = createSlice({
return {
...state,
...action.payload,
- startDate: null,
- endDate: null,
+ startDate: action.payload.startDate ?? null,
+ endDate: action.payload.endDate ?? null,
dirty: false,
ready: true,
};
@@ -383,6 +384,13 @@ export const reportSlice = createSlice({
state.series.splice(toIndex, 0, movedEvent);
}
},
+ changeVisibleSeries(
+ state,
+ action: PayloadAction<string[] | undefined>,
+ ) {
+ state.dirty = true;
+ state.visibleSeries = action.payload;
+ },
},
});
@@ -419,6 +427,7 @@ export const {
changeSankeyInclude,
changeStacked,
reorderEvents,
+ changeVisibleSeries,
} = reportSlice.actions;
export default reportSlice.reducer;
diff --git a/apps/start/src/hooks/use-visible-conversion-series.ts b/apps/start/src/hooks/use-visible-conversion-series.ts
index f64266045..b3d891f27 100644
--- a/apps/start/src/hooks/use-visible-conversion-series.ts
+++ b/apps/start/src/hooks/use-visible-conversion-series.ts
@@ -1,5 +1,5 @@
import type { RouterOutputs } from '@/trpc/client';
-import { useEffect, useMemo, useState } from 'react';
+import { useCallback, useMemo, useRef, useState } from 'react';
export type IVisibleConversionSeries = ReturnType<
typeof useVisibleConversionSeries
@@ -7,29 +7,60 @@ export type IVisibleConversionSeries = ReturnType<
export function useVisibleConversionSeries(
data: RouterOutputs['chart']['conversion'],
- limit?: number | undefined,
+ options?: {
+ limit?: number;
+ savedVisibleSeries?: string[] | null;
+ onVisibleSeriesChange?: (ids: string[]) => void;
+ },
) {
- const max = limit ?? 5;
- const [visibleSeries, setVisibleSeries] = useState<string[]>(
- data?.current?.slice(0, max).map((serie) => serie.id) ?? [],
+ const max = options?.limit ?? 5;
+ const savedVisibleSeries = options?.savedVisibleSeries;
+
+ const onChangeRef = useRef(options?.onVisibleSeriesChange);
+ onChangeRef.current = options?.onVisibleSeriesChange;
+
+ const seriesKey = data?.current?.map((s) => s.id).join(',') ?? '';
+
+ const resolveIds = (
+ series: RouterOutputs['chart']['conversion']['current'],
+ ): string[] => {
+ if (savedVisibleSeries && savedVisibleSeries.length > 0) {
+ const valid = savedVisibleSeries.filter((id) =>
+ series.some((s) => s.id === id),
+ );
+ if (valid.length > 0) return valid;
+ }
+ return series.slice(0, max).map((s) => s.id);
+ };
+
+ const [visibleSeries, setVisibleSeries] = useState<string[]>(() =>
+ resolveIds(data?.current ?? []),
);
- useEffect(() => {
- setVisibleSeries(
- data?.current?.slice(0, max).map((serie) => serie.id) ?? [],
- );
- }, [data, max]);
+ const prevKeyRef = useRef(seriesKey);
+ if (prevKeyRef.current !== seriesKey) {
+ prevKeyRef.current = seriesKey;
+ setVisibleSeries(resolveIds(data?.current ?? []));
+ }
- return useMemo(() => {
- return {
+ const handleSet = useCallback<React.Dispatch<React.SetStateAction<string[]>>>(
+ (action) => {
+ setVisibleSeries((prev) => {
+ const next = typeof action === 'function' ? action(prev) : action;
+ onChangeRef.current?.(next);
+ return next;
+ });
+ },
+ [],
+ );
+
+ return useMemo(
+ () => ({
series: data.current
- .map((serie, index) => ({
- ...serie,
- index,
- }))
+ .map((serie, index) => ({ ...serie, index }))
.filter((serie) => visibleSeries.includes(serie.id)),
- setVisibleSeries,
- } as const;
- }, [visibleSeries, data.current]);
+ setVisibleSeries: handleSet,
+ }),
+ [visibleSeries, data.current, handleSet],
+ );
}
-
diff --git a/apps/start/src/hooks/use-visible-funnel-breakdowns.ts b/apps/start/src/hooks/use-visible-funnel-breakdowns.ts
index e6d52b703..86c072b76 100644
--- a/apps/start/src/hooks/use-visible-funnel-breakdowns.ts
+++ b/apps/start/src/hooks/use-visible-funnel-breakdowns.ts
@@ -1,5 +1,5 @@
import type { RouterOutputs } from '@/trpc/client';
-import { useEffect, useMemo, useState } from 'react';
+import { useCallback, useMemo, useRef, useState } from 'react';
export type IVisibleFunnelBreakdowns = ReturnType<
typeof useVisibleFunnelBreakdowns
@@ -7,26 +7,60 @@ export type IVisibleFunnelBreakdowns = ReturnType<
export function useVisibleFunnelBreakdowns(
data: RouterOutputs['chart']['funnel']['current'],
- limit?: number | undefined,
+ options?: {
+ limit?: number;
+ savedVisibleSeries?: string[] | null;
+ onVisibleSeriesChange?: (ids: string[]) => void;
+ },
) {
- const max = limit ?? 10;
- const [visibleSeries, setVisibleSeries] = useState<string[]>(
- data?.slice(0, max).map((item) => item.id) ?? [],
+ const max = options?.limit ?? 10;
+ const savedVisibleSeries = options?.savedVisibleSeries;
+
+ const onChangeRef = useRef(options?.onVisibleSeriesChange);
+ onChangeRef.current = options?.onVisibleSeriesChange;
+
+ const seriesKey = data?.map((s) => s.id).join(',') ?? '';
+
+ const resolveIds = (
+ items: RouterOutputs['chart']['funnel']['current'],
+ ): string[] => {
+ if (savedVisibleSeries && savedVisibleSeries.length > 0) {
+ const valid = savedVisibleSeries.filter((id) =>
+ items.some((s) => s.id === id),
+ );
+ if (valid.length > 0) return valid;
+ }
+ return items.slice(0, max).map((s) => s.id);
+ };
+
+ const [visibleSeries, setVisibleSeries] = useState<string[]>(() =>
+ resolveIds(data ?? []),
);
- useEffect(() => {
- setVisibleSeries(data?.slice(0, max).map((item) => item.id) ?? []);
- }, [data, max]);
+ const prevKeyRef = useRef(seriesKey);
+ if (prevKeyRef.current !== seriesKey) {
+ prevKeyRef.current = seriesKey;
+ setVisibleSeries(resolveIds(data ?? []));
+ }
- return useMemo(() => {
- return {
+ const handleSet = useCallback<React.Dispatch<React.SetStateAction<string[]>>>(
+ (action) => {
+ setVisibleSeries((prev) => {
+ const next = typeof action === 'function' ? action(prev) : action;
+ onChangeRef.current?.(next);
+ return next;
+ });
+ },
+ [],
+ );
+
+ return useMemo(
+ () => ({
breakdowns: data
- .map((item, index) => ({
- ...item,
- index,
- }))
+ .map((item, index) => ({ ...item, index }))
.filter((item) => visibleSeries.includes(item.id)),
- setVisibleSeries,
- } as const;
- }, [visibleSeries, data]);
+ setVisibleSeries: handleSet,
+ }),
+ [visibleSeries, data, handleSet],
+ );
}
diff --git a/apps/start/src/hooks/use-visible-series.ts b/apps/start/src/hooks/use-visible-series.ts
index 2b6b5cbc1..07935d3f6 100644
--- a/apps/start/src/hooks/use-visible-series.ts
+++ b/apps/start/src/hooks/use-visible-series.ts
@@ -1,28 +1,68 @@
import type { IChartData } from '@/trpc/client';
-import { useEffect, useMemo, useState } from 'react';
+import { useCallback, useMemo, useRef, useState } from 'react';
export type IVisibleSeries = ReturnType<typeof useVisibleSeries>['series'];
-export function useVisibleSeries(data: IChartData, limit?: number | undefined) {
- const max = limit ?? 5;
- const [visibleSeries, setVisibleSeries] = useState<string[]>(
- data?.series?.slice(0, max).map((serie) => serie.id) ?? [],
+
+export function useVisibleSeries(
+ data: IChartData,
+ options?: {
+ limit?: number;
+ savedVisibleSeries?: string[] | null;
+ onVisibleSeriesChange?: (ids: string[]) => void;
+ },
+) {
+ const max = options?.limit ?? 5;
+ const savedVisibleSeries = options?.savedVisibleSeries;
+
+ // Ref for the callback so handleSet never changes identity
+ const onChangeRef = useRef(options?.onVisibleSeriesChange);
+ onChangeRef.current = options?.onVisibleSeriesChange;
+
+ // Stable key derived from actual series IDs — not the data reference
+ const seriesKey = data?.series?.map((s) => s.id).join(',') ?? '';
+
+ const resolveIds = (series: IChartData['series']): string[] => {
+ if (savedVisibleSeries && savedVisibleSeries.length > 0) {
+ const valid = savedVisibleSeries.filter((id) =>
+ series.some((s) => s.id === id),
+ );
+ if (valid.length > 0) return valid;
+ }
+ return series.slice(0, max).map((s) => s.id);
+ };
+
+ const [visibleSeries, setVisibleSeries] = useState<string[]>(() =>
+ resolveIds(data?.series ?? []),
);
- useEffect(() => {
- setVisibleSeries(
- data?.series?.slice(0, max).map((serie) => serie.id) ?? [],
- );
- }, [data, max]);
+ // Reset only when the actual series IDs change (breakdowns/events changed),
+ // not when the data object reference changes. This is React's recommended
+ // pattern for adjusting state based on changed props during render.
+ const prevKeyRef = useRef(seriesKey);
+ if (prevKeyRef.current !== seriesKey) {
+ prevKeyRef.current = seriesKey;
+ setVisibleSeries(resolveIds(data?.series ?? []));
+ }
+
+ // Stable setter that notifies parent without recreating on every render
+ const handleSet = useCallback<React.Dispatch<React.SetStateAction<string[]>>>(
+ (action) => {
+ setVisibleSeries((prev) => {
+ const next = typeof action === 'function' ? action(prev) : action;
+ onChangeRef.current?.(next);
+ return next;
+ });
+ },
+ [],
+ );
- return useMemo(() => {
- return {
+ return useMemo(
+ () => ({
series: data.series
- .map((serie, index) => ({
- ...serie,
- index,
- }))
+ .map((serie, index) => ({ ...serie, index }))
.filter((serie) => visibleSeries.includes(serie.id)),
- setVisibleSeries,
- } as const;
- }, [visibleSeries, data.series]);
+ setVisibleSeries: handleSet,
+ }),
+ [visibleSeries, data.series, handleSet],
+ );
}
diff --git a/packages/constants/index.ts b/packages/constants/index.ts
index 45c694942..911297512 100644
--- a/packages/constants/index.ts
+++ b/packages/constants/index.ts
@@ -185,7 +185,6 @@ export const deprecated_timeRanges = {
'14d': '14d',
'1m': '1m',
'3m': '3m',
- '6m': '6m',
'1y': '1y',
};
diff --git a/packages/db/prisma/migrations/20260422090246_add_visible_series_and_dates_to_report/migration.sql b/packages/db/prisma/migrations/20260422090246_add_visible_series_and_dates_to_report/migration.sql
new file mode 100644
index 000000000..081c79943
--- /dev/null
+++ b/packages/db/prisma/migrations/20260422090246_add_visible_series_and_dates_to_report/migration.sql
@@ -0,0 +1,4 @@
+-- AlterTable
+ALTER TABLE "public"."reports" ADD COLUMN "endDate" TEXT,
+ADD COLUMN "startDate" TEXT,
+ADD COLUMN "visibleSeries" TEXT[];
diff --git a/packages/db/prisma/schema.prisma b/packages/db/prisma/schema.prisma
index a1083cabe..4897bbf98 100644
--- a/packages/db/prisma/schema.prisma
+++ b/packages/db/prisma/schema.prisma
@@ -373,7 +373,10 @@ model Report {
funnelGroup String?
funnelWindow Float?
/// [IReportOptions]
- options Json?
+ options Json?
+ visibleSeries String[]
+ startDate String?
+ endDate String?
dashboardId String
dashboard Dashboard @relation(fields: [dashboardId], references: [id], onDelete: Cascade)
diff --git a/packages/db/src/services/reports.service.ts b/packages/db/src/services/reports.service.ts
index 2f5d6d8ca..57dc5cf3a 100644
--- a/packages/db/src/services/reports.service.ts
+++ b/packages/db/src/services/reports.service.ts
@@ -48,6 +48,7 @@ export function transformReportEventItem(
id: item.id ?? alphabetIds[index]!,
formula: item.formula || '',
displayName: item.displayName,
+ hideSeries: item.hideSeries,
};
}
@@ -91,6 +92,9 @@ export function transformReport(
unit: report.unit ?? undefined,
layout: report.layout ?? undefined,
options: options ?? undefined,
+ visibleSeries: report.visibleSeries ?? undefined,
+ startDate: report.startDate ?? undefined,
+ endDate: report.endDate ?? undefined,
};
}
diff --git a/packages/trpc/src/routers/report.ts b/packages/trpc/src/routers/report.ts
index 8ca15e882..bd9f91f83 100644
--- a/packages/trpc/src/routers/report.ts
+++ b/packages/trpc/src/routers/report.ts
@@ -51,12 +51,15 @@ export const reportRouter = createTRPCRouter({
breakdowns: report.breakdowns,
chartType: report.chartType,
lineType: report.lineType,
- range: report.range === 'custom' ? '30d' : report.range,
+ range: report.range,
formula: report.formula,
previous: report.previous ?? false,
unit: report.unit,
metric: report.metric === 'count' ? 'sum' : report.metric,
options: report.options,
+ visibleSeries: report.visibleSeries ?? [],
+ startDate: report.range === 'custom' ? report.startDate : null,
+ endDate: report.range === 'custom' ? report.endDate : null,
},
});
}),
@@ -94,12 +97,15 @@ export const reportRouter = createTRPCRouter({
breakdowns: report.breakdowns,
chartType: report.chartType,
lineType: report.lineType,
- range: report.range === 'custom' ? '30d' : report.range,
+ range: report.range,
formula: report.formula,
previous: report.previous ?? false,
unit: report.unit,
metric: report.metric === 'count' ? 'sum' : report.metric,
options: report.options,
+ visibleSeries: report.visibleSeries ?? [],
+ startDate: report.range === 'custom' ? report.startDate : null,
+ endDate: report.range === 'custom' ? report.endDate : null,
},
});
}),
@@ -169,6 +175,9 @@ export const reportRouter = createTRPCRouter({
unit: report.unit,
metric: report.metric,
options: report.options,
+ visibleSeries: report.visibleSeries,
+ startDate: report.startDate,
+ endDate: report.endDate,
},
});
}),
diff --git a/packages/validation/src/index.ts b/packages/validation/src/index.ts
index 119388a68..8817d9447 100644
--- a/packages/validation/src/index.ts
+++ b/packages/validation/src/index.ts
@@ -228,6 +228,10 @@ export const zReportInput = z.object({
.number()
.optional()
.describe('Skip how many series should be returned'),
+ visibleSeries: z
+ .array(z.string())
+ .nullish()
+ .describe('IDs of series that should be visible on the chart'),
options: zReportOptions
.optional()
.describe('Chart-specific options (funnel, retention, sankey)'),