Skip to content

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

feature(dashboard): add new retention chart type

Carl-Gerhard Lindesvärdf977c5454a1a
diff --git a/.vscode/settings.json b/.vscode/settings.json
index a616cf8ba..7fcbc5535 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -22,7 +22,8 @@
"editor.formatOnSave": true,
"tailwindCSS.experimental.classRegex": [
["cva\\(([^)]*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"],
- ["cx\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"]
+ ["cx\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"],
+ ["\\b\\w+ClassName\\s*=\\s*[\"'`]([^\"'`]*)[\"'`]", "[\"'`]([^\"'`]*)[\"'`]" ]
],
"typescript.enablePromptUseWorkspaceTsdk": true,
"typescript.tsdk": "node_modules/typescript/lib",
diff --git a/apps/api/src/bots/index.ts b/apps/api/src/bots/index.ts
index bae1873f6..705d7defd 100644
--- a/apps/api/src/bots/index.ts
+++ b/apps/api/src/bots/index.ts
@@ -14,6 +14,6 @@ export function isBot(ua: string) {
return {
name: res.name,
- type: res.category || 'Unknown',
+ type: 'category' in res ? res.category : 'Unknown',
};
}
diff --git a/apps/dashboard/package.json b/apps/dashboard/package.json
index 708d8518d..5732707f5 100644
--- a/apps/dashboard/package.json
+++ b/apps/dashboard/package.json
@@ -18,8 +18,8 @@
"@openpanel/common": "workspace:^",
"@openpanel/constants": "workspace:^",
"@openpanel/db": "workspace:^",
- "@openpanel/nextjs": "1.0.3",
"@openpanel/integrations": "workspace:^",
+ "@openpanel/nextjs": "1.0.3",
"@openpanel/queue": "workspace:^",
"@openpanel/sdk-info": "workspace:^",
"@openpanel/validation": "workspace:^",
@@ -72,7 +72,7 @@
"lodash.isequal": "^4.5.0",
"lodash.throttle": "^4.1.1",
"lottie-react": "^2.4.0",
- "lucide-react": "^0.331.0",
+ "lucide-react": "^0.451.0",
"mathjs": "^12.3.2",
"mitt": "^3.0.1",
"next": "14.2.1",
diff --git a/apps/dashboard/src/app/(app)/[organizationSlug]/[projectId]/dashboards/list-dashboards/list-dashboards.tsx b/apps/dashboard/src/app/(app)/[organizationSlug]/[projectId]/dashboards/list-dashboards/list-dashboards.tsx
index 3bf9dbd45..6dfeb3d94 100644
--- a/apps/dashboard/src/app/(app)/[organizationSlug]/[projectId]/dashboards/list-dashboards/list-dashboards.tsx
+++ b/apps/dashboard/src/app/(app)/[organizationSlug]/[projectId]/dashboards/list-dashboards/list-dashboards.tsx
@@ -12,8 +12,10 @@ import {
AreaChartIcon,
BarChart3Icon,
BarChartHorizontalIcon,
+ ChartScatterIcon,
ConeIcon,
Globe2Icon,
+ Grid3X3Icon,
HashIcon,
LayoutPanelTopIcon,
LineChartIcon,
@@ -110,6 +112,7 @@ export function ListDashboards({ dashboards }: ListDashboardsProps) {
histogram: BarChart3Icon,
funnel: ConeIcon,
area: AreaChartIcon,
+ retention: ChartScatterIcon,
}[report.chartType];
return (
diff --git a/apps/dashboard/src/app/(app)/[organizationSlug]/[projectId]/layout-menu.tsx b/apps/dashboard/src/app/(app)/[organizationSlug]/[projectId]/layout-menu.tsx
index ea6fbd96e..06902e9de 100644
--- a/apps/dashboard/src/app/(app)/[organizationSlug]/[projectId]/layout-menu.tsx
+++ b/apps/dashboard/src/app/(app)/[organizationSlug]/[projectId]/layout-menu.tsx
@@ -1,11 +1,10 @@
'use client';
import { Button } from '@/components/ui/button';
-import { useAppParams } from '@/hooks/useAppParams';
import { pushModal } from '@/modals';
import { cn } from '@/utils/cn';
-import { useUser } from '@clerk/nextjs';
import {
+ ChartLineIcon,
GanttChartIcon,
Globe2Icon,
LayersIcon,
@@ -15,11 +14,10 @@ import {
UsersIcon,
WallpaperIcon,
} from 'lucide-react';
-import type { LucideProps } from 'lucide-react';
-import Link from 'next/link';
+import type { LucideIcon } from 'lucide-react';
import { usePathname } from 'next/navigation';
-import { useEffect } from 'react';
+import { ProjectLink } from '@/components/links';
import type { IServiceDashboards } from '@openpanel/db';
function LinkWithIcon({
@@ -30,7 +28,7 @@ function LinkWithIcon({
className,
}: {
href: string;
- icon: React.ElementType<LucideProps>;
+ icon: LucideIcon;
label: React.ReactNode;
active?: boolean;
className?: string;
@@ -38,7 +36,7 @@ function LinkWithIcon({
const pathname = usePathname();
const active = overrideActive || href === pathname;
return (
- <Link
+ <ProjectLink
className={cn(
'text-text flex items-center gap-2 rounded-md px-3 py-2 font-medium transition-all hover:bg-def-200',
active && 'bg-def-200',
@@ -48,7 +46,7 @@ function LinkWithIcon({
>
<Icon size={20} />
<div className="flex-1">{label}</div>
- </Link>
+ </ProjectLink>
);
}
@@ -56,66 +54,34 @@ interface LayoutMenuProps {
dashboards: IServiceDashboards;
}
export default function LayoutMenu({ dashboards }: LayoutMenuProps) {
- const { user } = useUser();
-
- const params = useAppParams();
- const hasProjectId =
- params.projectId &&
- params.projectId !== 'null' &&
- params.projectId !== 'undefined';
- const projectId = hasProjectId
- ? params.projectId
- : (user?.unsafeMetadata.projectId as string);
-
- useEffect(() => {
- if (hasProjectId) {
- user?.update({
- unsafeMetadata: {
- ...user.unsafeMetadata,
- projectId: params.projectId,
- },
- });
- }
- }, [params.projectId, hasProjectId]);
-
return (
<>
- <LinkWithIcon
- icon={WallpaperIcon}
- label="Overview"
- href={`/${params.organizationSlug}/${projectId}`}
- />
+ <ProjectLink
+ href={'/reports'}
+ className={cn(
+ 'border rounded p-2 row items-center gap-2 hover:bg-def-200 mb-4',
+ )}
+ >
+ <ChartLineIcon size={20} />
+ <div className="flex-1 col gap-1">
+ <div className="font-medium">Create report</div>
+ <div className="text-sm text-muted-foreground">
+ Visualize your events
+ </div>
+ </div>
+ <PlusIcon size={16} className="text-muted-foreground" />
+ </ProjectLink>
+ <LinkWithIcon icon={WallpaperIcon} label="Overview" href={'/'} />
<LinkWithIcon
icon={LayoutPanelTopIcon}
label="Dashboards"
- href={`/${params.organizationSlug}/${projectId}/dashboards`}
- />
- <LinkWithIcon
- icon={LayersIcon}
- label="Pages"
- href={`/${params.organizationSlug}/${projectId}/pages`}
+ href={'/dashboards'}
/>
- <LinkWithIcon
- icon={Globe2Icon}
- label="Realtime"
- href={`/${params.organizationSlug}/${projectId}/realtime`}
- />
- <LinkWithIcon
- icon={GanttChartIcon}
- label="Events"
- href={`/${params.organizationSlug}/${projectId}/events`}
- />
- <LinkWithIcon
- icon={UsersIcon}
- label="Profiles"
- href={`/${params.organizationSlug}/${projectId}/profiles`}
- />
- <LinkWithIcon
- icon={ScanEyeIcon}
- label="Retention"
- href={`/${params.organizationSlug}/${projectId}/retention`}
- />
-
+ <LinkWithIcon icon={LayersIcon} label="Pages" href={'/pages'} />
+ <LinkWithIcon icon={Globe2Icon} label="Realtime" href={'/realtime'} />
+ <LinkWithIcon icon={GanttChartIcon} label="Events" href={'/events'} />
+ <LinkWithIcon icon={UsersIcon} label="Profiles" href={'/profiles'} />
+ <LinkWithIcon icon={ScanEyeIcon} label="Retention" href={'/retention'} />
<div className="mt-4">
<div className="mb-2 flex items-center justify-between">
<div className="text-muted-foreground">Your dashboards</div>
@@ -134,7 +100,7 @@ export default function LayoutMenu({ dashboards }: LayoutMenuProps) {
key={item.id}
icon={LayoutPanelTopIcon}
label={item.name}
- href={`/${item.organizationSlug}/${item.projectId}/dashboards/${item.id}`}
+ href={`/dashboards/${item.id}`}
/>
))}
</div>
diff --git a/apps/dashboard/src/components/overview/filters/overview-filters-drawer-content.tsx b/apps/dashboard/src/components/overview/filters/overview-filters-drawer-content.tsx
index 351ba9989..ddd9bc248 100644
--- a/apps/dashboard/src/components/overview/filters/overview-filters-drawer-content.tsx
+++ b/apps/dashboard/src/components/overview/filters/overview-filters-drawer-content.tsx
@@ -40,8 +40,8 @@ export function OverviewFiltersDrawerContent({
const { interval, range, startDate, endDate } = useOverviewOptions();
const [filters, setFilter] = useEventQueryFilters(nuqsOptions);
const [event, setEvent] = useEventQueryNamesFilter(nuqsOptions);
- const eventNames = useEventNames({ projectId, interval, range });
- const eventProperties = useEventProperties({ projectId, interval, range });
+ const eventNames = useEventNames({ projectId });
+ const eventProperties = useEventProperties({ projectId, event: event[0] });
const profileProperties = useProfileProperties(projectId);
const properties = mode === 'events' ? eventProperties : profileProperties;
@@ -94,8 +94,6 @@ export function OverviewFiltersDrawerContent({
eventName="screen_view"
key={filter.name}
filter={filter}
- range={range}
- interval={interval}
onRemove={() => {
setFilter(filter.name, [], filter.operator);
}}
@@ -105,8 +103,6 @@ export function OverviewFiltersDrawerContent({
onChangeOperator={(operator) => {
setFilter(filter.name, filter.value, operator);
}}
- startDate={startDate}
- endDate={endDate}
/>
) : /* TODO: Implement profile filters */
null;
@@ -128,13 +124,10 @@ export function FilterOptionEvent({
operator: IChartEventFilterOperator,
) => void;
}) {
- const { interval, range } = useOverviewOptions();
const values = usePropertyValues({
projectId,
event: filter.name === 'path' ? 'screen_view' : 'session_start',
property: filter.name,
- interval,
- range,
});
return (
diff --git a/apps/dashboard/src/components/report-chart/common/axis.tsx b/apps/dashboard/src/components/report-chart/common/axis.tsx
index 623279f0d..c58a54dbe 100644
--- a/apps/dashboard/src/components/report-chart/common/axis.tsx
+++ b/apps/dashboard/src/components/report-chart/common/axis.tsx
@@ -25,9 +25,11 @@ export function getYAxisWidth(value: string | undefined | null) {
export const useYAxisProps = ({
data,
hide,
+ tickFormatter,
}: {
data: number[];
hide?: boolean;
+ tickFormatter?: (value: number) => string;
}) => {
const [width, setWidth] = useState(24);
const setWidthDebounced = useDebounceFn(setWidth, 100);
@@ -41,7 +43,7 @@ export const useYAxisProps = ({
tickLine: false,
allowDecimals: false,
tickFormatter: (value: number) => {
- const tick = number.short(value);
+ const tick = tickFormatter ? tickFormatter(value) : number.short(value);
const newWidth = getYAxisWidth(tick);
ref.current.push(newWidth);
setWidthDebounced(Math.max(...ref.current));
diff --git a/apps/dashboard/src/components/report-chart/common/empty.tsx b/apps/dashboard/src/components/report-chart/common/empty.tsx
index 7e0510e92..e5f337021 100644
--- a/apps/dashboard/src/components/report-chart/common/empty.tsx
+++ b/apps/dashboard/src/components/report-chart/common/empty.tsx
@@ -1,13 +1,62 @@
-import { BirdIcon } from 'lucide-react';
+import { cn } from '@/utils/cn';
+import {
+ ArrowUpLeftIcon,
+ BirdIcon,
+ CornerLeftUpIcon,
+ Forklift,
+ ForkliftIcon,
+} from 'lucide-react';
+import { useReportChartContext } from '../context';
+
+export function ReportChartEmpty({
+ title = 'No data',
+ children,
+}: {
+ title?: string;
+ children?: React.ReactNode;
+}) {
+ const {
+ isEditMode,
+ report: { events },
+ } = useReportChartContext();
+
+ if (events.length === 0) {
+ return (
+ <div className="card p-4 center-center h-full w-full flex-col relative">
+ <div className="row gap-2 items-end absolute top-4 left-4">
+ <CornerLeftUpIcon
+ strokeWidth={1.2}
+ className="size-8 animate-pulse text-muted-foreground"
+ />
+ <div className="text-muted-foreground">Start here</div>
+ </div>
+ <ForkliftIcon
+ strokeWidth={1.2}
+ className="mb-4 size-1/3 animate-pulse text-muted-foreground"
+ />
+ <div className="font-medium text-muted-foreground">
+ Ready when you're
+ </div>
+ <div className="text-muted-foreground mt-2">
+ Pick atleast one event to start visualize
+ </div>
+ </div>
+ );
+ }
-export function ReportChartEmpty() {
return (
- <div className="center-center h-full w-full flex-col">
+ <div
+ className={cn(
+ 'center-center h-full w-full flex-col',
+ isEditMode && 'card p-4',
+ )}
+ >
<BirdIcon
strokeWidth={1.2}
- className="mb-4 size-10 animate-pulse text-muted-foreground"
+ className="mb-4 size-1/3 animate-pulse text-muted-foreground"
/>
- <div className="text-sm font-medium text-muted-foreground">No data</div>
+ <div className="font-medium text-muted-foreground">{title}</div>
+ <div className="text-muted-foreground mt-2">{children}</div>
</div>
);
}
diff --git a/apps/dashboard/src/components/report-chart/common/error.tsx b/apps/dashboard/src/components/report-chart/common/error.tsx
index 77279caa5..158421710 100644
--- a/apps/dashboard/src/components/report-chart/common/error.tsx
+++ b/apps/dashboard/src/components/report-chart/common/error.tsx
@@ -1,8 +1,16 @@
+import { cn } from '@/utils/cn';
import { ServerCrashIcon } from 'lucide-react';
+import { useReportChartContext } from '../context';
export function ReportChartError() {
+ const { isEditMode } = useReportChartContext();
return (
- <div className="center-center h-full w-full flex-col">
+ <div
+ className={cn(
+ 'center-center h-full w-full flex-col',
+ isEditMode && 'card p-4',
+ )}
+ >
<ServerCrashIcon
strokeWidth={1.2}
className="mb-4 size-10 animate-pulse text-muted-foreground"
diff --git a/apps/dashboard/src/components/report-chart/common/loading.tsx b/apps/dashboard/src/components/report-chart/common/loading.tsx
index 4b2a6ef0d..5f5bceae0 100644
--- a/apps/dashboard/src/components/report-chart/common/loading.tsx
+++ b/apps/dashboard/src/components/report-chart/common/loading.tsx
@@ -1,3 +1,88 @@
-export function ReportChartLoading() {
- return <div className="h-full w-full animate-pulse rounded bg-def-100" />;
+import { cn } from '@/utils/cn';
+import { AnimatePresence, motion } from 'framer-motion';
+import {
+ ActivityIcon,
+ AlarmClockIcon,
+ BarChart2Icon,
+ BarChartIcon,
+ ChartLineIcon,
+ ChartPieIcon,
+ LineChartIcon,
+ MessagesSquareIcon,
+ PieChartIcon,
+ TrendingUpIcon,
+} from 'lucide-react';
+import React, { useEffect, useState } from 'react';
+import { useReportChartContext } from '../context';
+
+const icons = [
+ { Icon: ActivityIcon, color: 'text-chart-6' },
+ { Icon: BarChart2Icon, color: 'text-chart-9' },
+ { Icon: ChartLineIcon, color: 'text-chart-0' },
+ { Icon: AlarmClockIcon, color: 'text-chart-1' },
+ { Icon: ChartPieIcon, color: 'text-chart-2' },
+ { Icon: MessagesSquareIcon, color: 'text-chart-3' },
+ { Icon: BarChartIcon, color: 'text-chart-4' },
+ { Icon: TrendingUpIcon, color: 'text-chart-5' },
+ { Icon: PieChartIcon, color: 'text-chart-7' },
+ { Icon: LineChartIcon, color: 'text-chart-8' },
+];
+
+export function ReportChartLoading({ things }: { things?: boolean }) {
+ const { isEditMode } = useReportChartContext();
+ const [currentIconIndex, setCurrentIconIndex] = React.useState(0);
+ const [isSlow, setSlow] = useState(false);
+
+ React.useEffect(() => {
+ const interval = setInterval(() => {
+ setCurrentIconIndex((prevIndex) => (prevIndex + 1) % icons.length);
+ }, 1500);
+
+ return () => clearInterval(interval);
+ }, []);
+
+ useEffect(() => {
+ if (currentIconIndex >= 3) {
+ setSlow(true);
+ }
+ }, [currentIconIndex]);
+
+ const { Icon, color } = icons[currentIconIndex]!;
+
+ return (
+ <div className={cn('h-full w-full', isEditMode && 'card p-4')}>
+ <div
+ className={
+ 'relative h-full w-full rounded bg-def-100 overflow-hidden center-center flex'
+ }
+ >
+ <AnimatePresence initial={false} mode="wait">
+ <motion.div
+ key={currentIconIndex}
+ initial={{ x: '100%', opacity: 0 }}
+ animate={{ x: 0, opacity: 1 }}
+ exit={{ x: '-100%', opacity: 0 }}
+ transition={{
+ type: 'spring',
+ stiffness: 500,
+ damping: 30,
+ duration: 0.5,
+ }}
+ className={cn('absolute size-1/3', color)}
+ >
+ <Icon className="w-full h-full" />
+ </motion.div>
+ </AnimatePresence>
+
+ <div
+ className={cn(
+ 'absolute top-3/4 opacity-0 transition-opacity text-muted-foreground',
+ isSlow && 'opacity-100',
+ )}
+ >
+ Stay calm, its coming 🙄
+ </div>
+ </div>
+ </div>
+ );
}
diff --git a/apps/dashboard/src/components/report-chart/common/report-table.tsx b/apps/dashboard/src/components/report-chart/common/report-table.tsx
index bd00f2a57..d0d14b208 100644
--- a/apps/dashboard/src/components/report-chart/common/report-table.tsx
+++ b/apps/dashboard/src/components/report-chart/common/report-table.tsx
@@ -19,6 +19,7 @@ import type { IChartData } from '@/trpc/client';
import { getChartColor } from '@/utils/theme';
import type * as React from 'react';
+import { logDependencies } from 'mathjs';
import { PreviousDiffIndicator } from './previous-diff-indicator';
import { SerieName } from './serie-name';
@@ -80,7 +81,7 @@ export function ReportTable({
);
return (
- <TableRow key={serie.id}>
+ <TableRow key={`${serie.id}-1`}>
{serie.names.map((name, nameIndex) => {
return (
<TableCell className="h-10" key={name}>
@@ -140,7 +141,7 @@ export function ReportTable({
<TableBody>
{paginate(data.series).map((serie) => {
return (
- <TableRow key={serie.id}>
+ <TableRow key={`${serie.id}-2`}>
<TableCell className="h-10">
<div className="flex items-center gap-2 font-medium">
{number.format(serie.metrics.sum)}
diff --git a/apps/dashboard/src/components/report-chart/funnel/chart.tsx b/apps/dashboard/src/components/report-chart/funnel/chart.tsx
index abc21bc0b..d824b352c 100644
--- a/apps/dashboard/src/components/report-chart/funnel/chart.tsx
+++ b/apps/dashboard/src/components/report-chart/funnel/chart.tsx
@@ -3,10 +3,8 @@
import { ColorSquare } from '@/components/color-square';
import { TooltipComplete } from '@/components/tooltip-complete';
import { Progress } from '@/components/ui/progress';
-import { Widget, WidgetBody } from '@/components/widget';
import type { RouterOutputs } from '@/trpc/client';
import { cn } from '@/utils/cn';
-import { getChartColor } from '@/utils/theme';
import { AlertCircleIcon } from 'lucide-react';
import { last } from 'ramda';
@@ -70,7 +68,7 @@ export function Chart({
/>
<MetricCardNumber
label="Percent"
- value={`${round((lastStep.count / totalSessions) * 100, 1)}%`}
+ value={`${totalSessions ? round((lastStep.count / totalSessions) * 100, 1) : 0}%`}
enhancer={
<PreviousDiffIndicator
size="lg"
diff --git a/apps/dashboard/src/components/report-chart/index.tsx b/apps/dashboard/src/components/report-chart/index.tsx
index c1c57630d..535e1435b 100644
--- a/apps/dashboard/src/components/report-chart/index.tsx
+++ b/apps/dashboard/src/components/report-chart/index.tsx
@@ -14,6 +14,7 @@ import { ReportLineChart } from './line';
import { ReportMapChart } from './map';
import { ReportMetricChart } from './metric';
import { ReportPieChart } from './pie';
+import { ReportRetentionChart } from './retention';
export function ReportChart(props: ReportChartProps) {
const ref = useRef<HTMLDivElement>(null);
@@ -48,6 +49,8 @@ export function ReportChart(props: ReportChartProps) {
return <ReportMetricChart />;
case 'funnel':
return <ReportFunnelChart />;
+ case 'retention':
+ return <ReportRetentionChart />;
default:
return null;
}
diff --git a/apps/dashboard/src/components/report-chart/line/index.tsx b/apps/dashboard/src/components/report-chart/line/index.tsx
index e6c856628..09c672392 100644
--- a/apps/dashboard/src/components/report-chart/line/index.tsx
+++ b/apps/dashboard/src/components/report-chart/line/index.tsx
@@ -1,5 +1,6 @@
import { api } from '@/trpc/client';
+import { cn } from '@/utils/cn';
import { AspectContainer } from '../aspect-container';
import { ReportChartEmpty } from '../common/empty';
import { ReportChartError } from '../common/error';
diff --git a/apps/dashboard/src/components/report-chart/retention/chart.tsx b/apps/dashboard/src/components/report-chart/retention/chart.tsx
new file mode 100644
index 000000000..0bcc901bc
--- /dev/null
+++ b/apps/dashboard/src/components/report-chart/retention/chart.tsx
@@ -0,0 +1,113 @@
+'use client';
+
+import type { RouterOutputs } from '@/trpc/client';
+import { cn } from '@/utils/cn';
+import { getChartColor } from '@/utils/theme';
+import {
+ Area,
+ CartesianGrid,
+ ComposedChart,
+ ReferenceLine,
+ ResponsiveContainer,
+ Tooltip,
+ XAxis,
+ YAxis,
+} from 'recharts';
+
+import { average, round } from '@openpanel/common';
+import { fix } from 'mathjs';
+import { useXAxisProps, useYAxisProps } from '../common/axis';
+import { useReportChartContext } from '../context';
+import { RetentionTooltip } from './tooltip';
+
+interface Props {
+ data: RouterOutputs['chart']['cohort'];
+}
+
+export function Chart({ data }: Props) {
+ const {
+ report: { interval },
+ isEditMode,
+ options: { hideXAxis, hideYAxis },
+ } = useReportChartContext();
+
+ const xAxisProps = useXAxisProps({ interval, hide: hideXAxis });
+ const yAxisProps = useYAxisProps({
+ data: [100],
+ hide: hideYAxis,
+ tickFormatter: (value) => `${value}%`,
+ });
+ const averageRow = data[0];
+ const averageRetentionRate = average(averageRow?.percentages || [], true);
+ const rechartData = averageRow?.percentages.map((item, index, list) => ({
+ days: index,
+ percentage: item,
+ value: averageRow.values[index],
+ sum: averageRow.sum,
+ }));
+
+ return (
+ <>
+ <div className={cn('h-full w-full', isEditMode && 'card p-4')}>
+ <ResponsiveContainer>
+ <ComposedChart data={rechartData}>
+ <CartesianGrid
+ strokeDasharray="3 3"
+ horizontal={true}
+ vertical={true}
+ className="stroke-border"
+ />
+ <YAxis {...yAxisProps} dataKey="retentionRate" domain={[0, 100]} />
+ <XAxis
+ {...xAxisProps}
+ dataKey="days"
+ allowDuplicatedCategory
+ scale="linear"
+ tickFormatter={(value) => value.toString()}
+ tickCount={31}
+ interval={0}
+ />
+ <Tooltip content={<RetentionTooltip />} />
+ <defs>
+ <linearGradient id={'color'} x1="0" y1="0" x2="0" y2="1">
+ <stop
+ offset="0%"
+ stopColor={getChartColor(0)}
+ stopOpacity={0.8}
+ />
+ <stop
+ offset="100%"
+ stopColor={getChartColor(0)}
+ stopOpacity={0.1}
+ />
+ </linearGradient>
+ </defs>
+ <ReferenceLine
+ y={averageRetentionRate}
+ stroke={getChartColor(1)}
+ strokeWidth={2}
+ strokeDasharray="3 3"
+ strokeOpacity={0.5}
+ strokeLinecap="round"
+ label={{
+ value: `Average (${round(averageRetentionRate, 2)} %)`,
+ fill: getChartColor(1),
+ position: 'insideBottomRight',
+ fontSize: 12,
+ }}
+ />
+ <Area
+ dataKey="percentage"
+ fill={'url(#color)'}
+ type={'monotone'}
+ isAnimationActive={false}
+ strokeWidth={2}
+ stroke={getChartColor(0)}
+ fillOpacity={0.1}
+ />
+ </ComposedChart>
+ </ResponsiveContainer>
+ </div>
+ </>
+ );
+}
diff --git a/apps/dashboard/src/components/report-chart/retention/index.tsx b/apps/dashboard/src/components/report-chart/retention/index.tsx
new file mode 100644
index 000000000..9fc0e11d4
--- /dev/null
+++ b/apps/dashboard/src/components/report-chart/retention/index.tsx
@@ -0,0 +1,103 @@
+'use client';
+
+import { api } from '@/trpc/client';
+
+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 { Chart } from './chart';
+import CohortTable from './table';
+
+export function ReportRetentionChart() {
+ const {
+ report: {
+ events,
+ range,
+ projectId,
+ startDate,
+ endDate,
+ criteria,
+ interval,
+ },
+ isLazyLoading,
+ } = useReportChartContext();
+ const firstEvent = (events[0]?.filters[0]?.value ?? []).map(String);
+ const secondEvent = (events[1]?.filters[0]?.value ?? []).map(String);
+ const isEnabled = firstEvent.length > 0 && secondEvent.length > 0;
+ const res = api.chart.cohort.useQuery(
+ {
+ firstEvent,
+ secondEvent,
+ projectId,
+ range,
+ startDate,
+ endDate,
+ criteria,
+ interval,
+ },
+ {
+ enabled: isEnabled,
+ },
+ );
+
+ if (!isEnabled) {
+ return <Disabled />;
+ }
+
+ if (isLazyLoading || res.isLoading) {
+ return <Loading />;
+ }
+
+ if (res.isError) {
+ return <Error />;
+ }
+
+ if (res.data.length === 0) {
+ return <Empty />;
+ }
+
+ return (
+ <div className="col gap-4">
+ <AspectContainer>
+ <Chart data={res.data} />
+ </AspectContainer>
+ <CohortTable data={res.data} />
+ </div>
+ );
+}
+
+function Loading() {
+ return (
+ <AspectContainer>
+ <ReportChartLoading />
+ </AspectContainer>
+ );
+}
+
+function Error() {
+ return (
+ <AspectContainer>
+ <ReportChartError />
+ </AspectContainer>
+ );
+}
+
+function Empty() {
+ return (
+ <AspectContainer>
+ <ReportChartEmpty />
+ </AspectContainer>
+ );
+}
+
+function Disabled() {
+ return (
+ <AspectContainer>
+ <ReportChartEmpty title="Select 2 events">
+ We need two events to determine the retention rate.
+ </ReportChartEmpty>
+ </AspectContainer>
+ );
+}
diff --git a/apps/dashboard/src/components/report-chart/retention/table.tsx b/apps/dashboard/src/components/report-chart/retention/table.tsx
new file mode 100644
index 000000000..4a41d3930
--- /dev/null
+++ b/apps/dashboard/src/components/report-chart/retention/table.tsx
@@ -0,0 +1,136 @@
+import { ProjectLink } from '@/components/links';
+import { Tooltiper } from '@/components/ui/tooltip';
+import { useNumber } from '@/hooks/useNumerFormatter';
+import type { RouterOutputs } from '@/trpc/client';
+import { cn } from '@/utils/cn';
+import { max, min, sum } from '@openpanel/common';
+import { intervals } from '@openpanel/constants';
+import type React from 'react';
+import { useReportChartContext } from '../context';
+
+type CohortData = RouterOutputs['chart']['cohort'];
+
+type CohortTableProps = {
+ data: CohortData;
+};
+
+const CohortTable: React.FC<CohortTableProps> = ({ data }) => {
+ const {
+ report: { unit, interval },
+ } = useReportChartContext();
+ const isPercentage = unit === '%';
+ const number = useNumber();
+ const highestValue = max(data.map((row) => max(row.values)));
+ const lowestValue = min(data.map((row) => min(row.values)));
+ const rowWithHigestSum = data.find(
+ (row) => row.sum === max(data.map((row) => row.sum)),
+ );
+
+ const getBackground = (value: number | undefined) => {
+ if (!value)
+ return {
+ backgroundClassName: '',
+ opacity: 0,
+ };
+
+ const percentage = isPercentage
+ ? value / 100
+ : (value - lowestValue) / (highestValue - lowestValue);
+ const opacity = Math.max(0.05, percentage);
+
+ return {
+ backgroundClassName: 'bg-highlight dark:bg-emerald-700',
+ opacity,
+ };
+ };
+
+ const thClassName =
+ 'h-10 align-top pt-3 whitespace-nowrap font-semibold text-muted-foreground';
+
+ return (
+ <div className="relative card overflow-hidden">
+ <div
+ className={'h-10 absolute left-0 right-0 top-px bg-def-100 border-b'}
+ />
+ <div className="w-full overflow-x-auto hide-scrollbar">
+ <div className="min-w-full relative">
+ <table className="w-full table-auto whitespace-nowrap">
+ <thead>
+ <tr>
+ <th className={cn(thClassName, 'sticky left-0 z-10')}>
+ <div className="bg-def-100">
+ <div className="h-10 center-center -mt-3">Date</div>
+ </div>
+ </th>
+ <th className={cn(thClassName, 'pr-1')}>Total profiles</th>
+ {data[0]?.values.map((column, index) => (
+ <th
+ key={index.toString()}
+ className={cn(thClassName, 'capitalize')}
+ >
+ {index === 0 ? `< ${interval} 1` : `${interval} ${index}`}
+ </th>
+ ))}
+ </tr>
+ </thead>
+ <tbody>
+ {data.map((row) => {
+ const values = isPercentage ? row.percentages : row.values;
+ return (
+ <tr key={row.cohort_interval}>
+ <td className="sticky left-0 bg-card z-10 w-36 p-0">
+ <div className="h-10 center-center font-medium text-muted-foreground px-4">
+ {row.cohort_interval}
+ </div>
+ </td>
+ <td className="p-0 min-w-12">
+ <div className={cn('font-mono rounded px-3 font-medium')}>
+ {number.format(row?.sum)}
+ {row.cohort_interval ===
+ rowWithHigestSum?.cohort_interval && ' 🚀'}
+ </div>
+ </td>
+ {values.map((value, index) => {
+ const { opacity, backgroundClassName } =
+ getBackground(value);
+ return (
+ <td
+ key={row.cohort_interval + index.toString()}
+ className="p-0 min-w-24"
+ >
+ <div
+ className={cn(
+ 'h-10 center-center font-mono hover:shadow-[inset_0_0_0_2px_rgb(255,255,255)] relative',
+ opacity > 0.7 &&
+ 'text-white [text-shadow:_0_0_3px_rgb(0_0_0_/_20%)]',
+ )}
+ >
+ <div
+ className={cn(
+ backgroundClassName,
+ 'w-full h-full inset-0 absolute',
+ )}
+ style={{
+ opacity,
+ }}
+ />
+ <div className="relative">
+ {number.formatWithUnit(value, unit)}
+ {value === highestValue && ' 🚀'}
+ </div>
+ </div>
+ </td>
+ );
+ })}
+ </tr>
+ );
+ })}
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ );
+};
+
+export default CohortTable;
diff --git a/apps/dashboard/src/components/report-chart/retention/tooltip.tsx b/apps/dashboard/src/components/report-chart/retention/tooltip.tsx
new file mode 100644
index 000000000..00175877e
--- /dev/null
+++ b/apps/dashboard/src/components/report-chart/retention/tooltip.tsx
@@ -0,0 +1,47 @@
+import { useNumber } from '@/hooks/useNumerFormatter';
+import type { RouterOutputs } from '@/trpc/client';
+import { useReportChartContext } from '../context';
+
+type Props = {
+ active?: boolean;
+ payload?: Array<{
+ payload: any;
+ }>;
+};
+export function RetentionTooltip({ active, payload }: Props) {
+ const {
+ report: { interval },
+ } = useReportChartContext();
+ const number = useNumber();
+ if (!active) {
+ return null;
+ }
+
+ if (!payload?.[0]) {
+ return null;
+ }
+
+ const { days, percentage, value, sum } = payload[0].payload;
+
+ return (
+ <div className="flex min-w-[200px] flex-col gap-2 rounded-xl border bg-card p-3 shadow-xl">
+ <h3 className="font-semibold capitalize">
+ {interval} {days}
+ </h3>
+ <div className="flex justify-between">
+ <span className="text-muted-foreground">Retention Rate:</span>
+ <span className="font-medium">
+ {number.formatWithUnit(percentage, '%')}
+ </span>
+ </div>
+ <div className="flex justify-between">
+ <span className="text-muted-foreground">Retained Users:</span>
+ <span className="font-medium">{number.format(value)}</span>
+ </div>
+ <div className="flex justify-between">
+ <span className="text-muted-foreground">Total Users:</span>
+ <span className="font-medium">{number.format(sum)}</span>
+ </div>
+ </div>
+ );
+}
diff --git a/apps/dashboard/src/components/report/ReportInterval.tsx b/apps/dashboard/src/components/report/ReportInterval.tsx
index 453ad2ca2..dd764a15a 100644
--- a/apps/dashboard/src/components/report/ReportInterval.tsx
+++ b/apps/dashboard/src/components/report/ReportInterval.tsx
@@ -21,7 +21,8 @@ export function ReportInterval({ className }: ReportIntervalProps) {
chartType !== 'linear' &&
chartType !== 'histogram' &&
chartType !== 'area' &&
- chartType !== 'metric'
+ chartType !== 'metric' &&
+ chartType !== 'retention'
) {
return null;
}
diff --git a/apps/dashboard/src/components/report/reportSlice.ts b/apps/dashboard/src/components/report/reportSlice.ts
index f687f9e37..7d1ed18d4 100644
--- a/apps/dashboard/src/components/report/reportSlice.ts
+++ b/apps/dashboard/src/components/report/reportSlice.ts
@@ -24,7 +24,9 @@ import type {
IChartRange,
IChartType,
IInterval,
+ zCriteria,
} from '@openpanel/validation';
+import type { z } from 'zod';
type InitialState = IChartProps & {
dirty: boolean;
@@ -53,6 +55,7 @@ const initialState: InitialState = {
unit: undefined,
metric: 'sum',
limit: 500,
+ criteria: 'on_or_after',
};
export const reportSlice = createSlice({
@@ -251,6 +254,18 @@ export const reportSlice = createSlice({
state.dirty = true;
state.formula = action.payload;
},
+
+ changeCriteria(state, action: PayloadAction<z.infer<typeof zCriteria>>) {
+ state.dirty = true;
+ state.criteria = action.payload;
+ },
+
+ changeUnit(state, action: PayloadAction<string | undefined>) {
+ console.log('here?!?!', action.payload);
+
+ state.dirty = true;
+ state.unit = action.payload || undefined;
+ },
},
});
@@ -276,6 +291,8 @@ export const {
resetDirty,
changeFormula,
changePrevious,
+ changeCriteria,
+ changeUnit,
} = reportSlice.actions;
export default reportSlice.reducer;
diff --git a/apps/dashboard/src/components/report/sidebar/EventPropertiesCombobox.tsx b/apps/dashboard/src/components/report/sidebar/EventPropertiesCombobox.tsx
index fb4cd419c..0648ee621 100644
--- a/apps/dashboard/src/components/report/sidebar/EventPropertiesCombobox.tsx
+++ b/apps/dashboard/src/components/report/sidebar/EventPropertiesCombobox.tsx
@@ -19,14 +19,10 @@ export function EventPropertiesCombobox({
}: EventPropertiesComboboxProps) {
const dispatch = useDispatch();
const { projectId } = useAppParams();
- const range = useSelector((state) => state.report.range);
- const interval = useSelector((state) => state.report.interval);
const properties = useEventProperties(
{
event: event.name,
projectId,
- range,
- interval,
},
{
enabled: !!event.name,
diff --git a/apps/dashboard/src/components/report/sidebar/ReportBreakdowns.tsx b/apps/dashboard/src/components/report/sidebar/ReportBreakdowns.tsx
index f5ed2ca0c..ede3eabd4 100644
--- a/apps/dashboard/src/components/report/sidebar/ReportBreakdowns.tsx
+++ b/apps/dashboard/src/components/report/sidebar/ReportBreakdowns.tsx
@@ -16,14 +16,10 @@ import type { ReportEventMoreProps } from './ReportEventMore';
export function ReportBreakdowns() {
const { projectId } = useAppParams();
const selectedBreakdowns = useSelector((state) => state.report.breakdowns);
- const interval = useSelector((state) => state.report.interval);
- const range = useSelector((state) => state.report.range);
const dispatch = useDispatch();
const properties = useEventProperties({
projectId,
- range,
- interval,
}).map((item) => ({
value: item,
label: item, // <RenderDots truncate>{item}</RenderDots>,
diff --git a/apps/dashboard/src/components/report/sidebar/ReportEvents.tsx b/apps/dashboard/src/components/report/sidebar/ReportEvents.tsx
index aec73468c..02c2004e0 100644
--- a/apps/dashboard/src/components/report/sidebar/ReportEvents.tsx
+++ b/apps/dashboard/src/components/report/sidebar/ReportEvents.tsx
@@ -1,7 +1,6 @@
'use client';
import { ColorSquare } from '@/components/color-square';
-import { Checkbox } from '@/components/ui/checkbox';
import { Combobox } from '@/components/ui/combobox';
import { DropdownMenuComposed } from '@/components/ui/dropdown-menu';
import { Input } from '@/components/ui/input';
@@ -14,12 +13,8 @@ import { GanttChart, GanttChartIcon, Users } from 'lucide-react';
import { alphabetIds } from '@openpanel/constants';
import type { IChartEvent } from '@openpanel/validation';
-import {
- addEvent,
- changeEvent,
- changePrevious,
- removeEvent,
-} from '../reportSlice';
+import { ComboboxAdvanced } from '@/components/ui/combobox-advanced';
+import { addEvent, changeEvent, removeEvent } from '../reportSlice';
import { EventPropertiesCombobox } from './EventPropertiesCombobox';
import { ReportEventMore } from './ReportEventMore';
import type { ReportEventMoreProps } from './ReportEventMore';
@@ -27,25 +22,22 @@ import { FiltersCombobox } from './filters/FiltersCombobox';
import { FiltersList } from './filters/FiltersList';
export function ReportEvents() {
- const previous = useSelector((state) => state.report.previous);
const selectedEvents = useSelector((state) => state.report.events);
- const startDate = useSelector((state) => state.report.startDate);
- const endDate = useSelector((state) => state.report.endDate);
- const range = useSelector((state) => state.report.range);
- const interval = useSelector((state) => state.report.interval);
+ const chartType = useSelector((state) => state.report.chartType);
const dispatch = useDispatch();
const { projectId } = useAppParams();
const eventNames = useEventNames({
projectId,
- startDate,
- endDate,
- range,
- interval,
});
-
+ const showSegment = !['retention', 'funnel'].includes(chartType);
+ const showAddFilter = !['retention'].includes(chartType);
+ const showDisplayNameInput = !['retention'].includes(chartType);
+ const isAddEventDisabled =
+ chartType === 'retention' && selectedEvents.length >= 2;
const dispatchChangeEvent = useDebounceFn((event: IChartEvent) => {
dispatch(changeEvent(event));
});
+ const isSelectManyEvents = chartType === 'retention';
const handleMore = (event: IChartEvent) => {
const callback: ReportEventMoreProps['onClick'] = (action) => {
@@ -68,137 +60,173 @@ export function ReportEvents() {
<div key={event.id} className="rounded-lg border bg-def-100">
<div className="flex items-center gap-2 p-2">
<ColorSquare>{alphabetIds[index]}</ColorSquare>
- <Combobox
- icon={GanttChartIcon}
- className="flex-1"
- searchable
- value={event.name}
- onChange={(value) => {
- dispatch(
- changeEvent({
+ {isSelectManyEvents ? (
+ <ComboboxAdvanced
+ className="flex-1"
+ value={event.filters[0]?.value ?? []}
+ onChange={(value) => {
+ dispatch(
+ changeEvent({
+ id: event.id,
+ segment: 'user',
+ filters: [
+ {
+ name: 'name',
+ operator: 'is',
+ value: value,
+ },
+ ],
+ name: '*',
+ }),
+ );
+ }}
+ items={eventNames.map((item) => ({
+ label: item.name,
+ value: item.name,
+ }))}
+ placeholder="Select event"
+ />
+ ) : (
+ <Combobox
+ icon={GanttChartIcon}
+ className="flex-1"
+ searchable
+ value={event.name}
+ onChange={(value) => {
+ dispatch(
+ changeEvent({
+ ...event,
+ name: value,
+ filters: [],
+ }),
+ );
+ }}
+ items={eventNames.map((item) => ({
+ label: item.name,
+ value: item.name,
+ }))}
+ placeholder="Select event"
+ />
+ )}
+ {showDisplayNameInput && (
+ <Input
+ placeholder={
+ event.name
+ ? `${event.name} (${alphabetIds[index]})`
+ : 'Display name'
+ }
+ defaultValue={event.displayName}
+ onChange={(e) => {
+ dispatchChangeEvent({
...event,
- name: value,
- filters: [],
- }),
- );
- }}
- items={eventNames.map((item) => ({
- label: item.name,
- value: item.name,
- }))}
- placeholder="Select event"
- />
- <Input
- placeholder={
- event.name
- ? `${event.name} (${alphabetIds[index]})`
- : 'Display name'
- }
- defaultValue={event.displayName}
- onChange={(e) => {
- dispatchChangeEvent({
- ...event,
- displayName: e.target.value,
- });
- }}
- />
+ displayName: e.target.value,
+ });
+ }}
+ />
+ )}
<ReportEventMore onClick={handleMore(event)} />
</div>
{/* Segment and Filter buttons */}
- <div className="flex gap-2 p-2 pt-0 ">
- <DropdownMenuComposed
- onChange={(segment) => {
- dispatch(
- changeEvent({
- ...event,
- segment,
- }),
- );
- }}
- items={[
- {
- value: 'event',
- label: 'All events',
- },
- {
- value: 'user',
- label: 'Unique users',
- },
- {
- value: 'session',
- label: 'Unique sessions',
- },
- {
- value: 'user_average',
- label: 'Average event per user',
- },
- {
- value: 'one_event_per_user',
- label: 'One event per user',
- },
- {
- value: 'property_sum',
- label: 'Sum of property',
- },
- {
- value: 'property_average',
- label: 'Average of property',
- },
- ]}
- label="Segment"
- >
- <button
- type="button"
- className="flex items-center gap-1 rounded-md border border-border bg-card p-1 px-2 text-sm font-medium leading-none"
- >
- {event.segment === 'user' ? (
- <>
- <Users size={12} /> Unique users
- </>
- ) : event.segment === 'session' ? (
- <>
- <Users size={12} /> Unique sessions
- </>
- ) : event.segment === 'user_average' ? (
- <>
- <Users size={12} /> Average event per user
- </>
- ) : event.segment === 'one_event_per_user' ? (
- <>
- <Users size={12} /> One event per user
- </>
- ) : event.segment === 'property_sum' ? (
- <>
- <Users size={12} /> Sum of property
- </>
- ) : event.segment === 'property_average' ? (
- <>
- <Users size={12} /> Average of property
- </>
- ) : (
- <>
- <GanttChart size={12} /> All events
- </>
- )}
- </button>
- </DropdownMenuComposed>
- {/* */}
- <FiltersCombobox event={event} />
+ {(showSegment || showAddFilter) && (
+ <div className="flex gap-2 p-2 pt-0 ">
+ {showSegment && (
+ <DropdownMenuComposed
+ onChange={(segment) => {
+ dispatch(
+ changeEvent({
+ ...event,
+ segment,
+ }),
+ );
+ }}
+ items={[
+ {
+ value: 'event',
+ label: 'All events',
+ },
+ {
+ value: 'user',
+ label: 'Unique users',
+ },
+ {
+ value: 'session',
+ label: 'Unique sessions',
+ },
+ {
+ value: 'user_average',
+ label: 'Average event per user',
+ },
+ {
+ value: 'one_event_per_user',
+ label: 'One event per user',
+ },
+ {
+ value: 'property_sum',
+ label: 'Sum of property',
+ },
+ {
+ value: 'property_average',
+ label: 'Average of property',
+ },
+ ]}
+ label="Segment"
+ >
+ <button
+ type="button"
+ className="flex items-center gap-1 rounded-md border border-border bg-card p-1 px-2 text-sm font-medium leading-none"
+ >
+ {event.segment === 'user' ? (
+ <>
+ <Users size={12} /> Unique users
+ </>
+ ) : event.segment === 'session' ? (
+ <>
+ <Users size={12} /> Unique sessions
+ </>
+ ) : event.segment === 'user_average' ? (
+ <>
+ <Users size={12} /> Average event per user
+ </>
+ ) : event.segment === 'one_event_per_user' ? (
+ <>
+ <Users size={12} /> One event per user
+ </>
+ ) : event.segment === 'property_sum' ? (
+ <>
+ <Users size={12} /> Sum of property
+ </>
+ ) : event.segment === 'property_average' ? (
+ <>
+ <Users size={12} /> Average of property
+ </>
+ ) : (
+ <>
+ <GanttChart size={12} /> All events
+ </>
+ )}
+ </button>
+ </DropdownMenuComposed>
+ )}
+ {/* */}
+ {showAddFilter && <FiltersCombobox event={event} />}
- {(event.segment === 'property_average' ||
- event.segment === 'property_sum') && (
- <EventPropertiesCombobox event={event} />
- )}
- </div>
+ {showSegment &&
+ (event.segment === 'property_average' ||
+ event.segment === 'property_sum') && (
+ <EventPropertiesCombobox event={event} />
+ )}
+ </div>
+ )}
{/* Filters */}
- <FiltersList event={event} />
+ {!isSelectManyEvents && <FiltersList event={event} />}
</div>
);
})}
<Combobox
+ disabled={isAddEventDisabled}
icon={GanttChartIcon}
value={''}
searchable
@@ -218,17 +246,6 @@ export function ReportEvents() {
placeholder="Select event"
/>
</div>
- <label
- className="mt-4 flex cursor-pointer select-none items-center gap-2 font-medium"
- htmlFor="previous"
- >
- <Checkbox
- id="previous"
- checked={previous}
- onCheckedChange={(val) => dispatch(changePrevious(!!val))}
- />
- Show previous / Compare
- </label>
</div>
);
}
diff --git a/apps/dashboard/src/components/report/sidebar/ReportSettings.tsx b/apps/dashboard/src/components/report/sidebar/ReportSettings.tsx
new file mode 100644
index 000000000..4f2c6da21
--- /dev/null
+++ b/apps/dashboard/src/components/report/sidebar/ReportSettings.tsx
@@ -0,0 +1,98 @@
+'use client';
+
+import { Combobox } from '@/components/ui/combobox';
+import { useDispatch, useSelector } from '@/redux';
+
+import { Label } from '@/components/ui/label';
+import { Switch } from '@/components/ui/switch';
+import { useMemo } from 'react';
+import { changeCriteria, changePrevious, changeUnit } from '../reportSlice';
+
+export function ReportSettings() {
+ const chartType = useSelector((state) => state.report.chartType);
+ const previous = useSelector((state) => state.report.previous);
+ const criteria = useSelector((state) => state.report.criteria);
+ const unit = useSelector((state) => state.report.unit);
+
+ const dispatch = useDispatch();
+
+ const fields = useMemo(() => {
+ const fields = [];
+
+ if (chartType !== 'retention') {
+ fields.push('previous');
+ }
+
+ if (chartType === 'retention') {
+ fields.push('criteria');
+ fields.push('unit');
+ }
+
+ return fields;
+ }, [chartType]);
+
+ if (fields.length === 0) {
+ return null;
+ }
+
+ return (
+ <div>
+ <h3 className="mb-2 font-medium">Settings</h3>
+ <div className="col rounded-lg border bg-def-100 p-4 gap-2">
+ {fields.includes('previous') && (
+ <Label className="flex items-center justify-between mb-0">
+ <span>Compare to previous period</span>
+ <Switch
+ checked={previous}
+ onCheckedChange={(val) => dispatch(changePrevious(!!val))}
+ />
+ </Label>
+ )}
+ {fields.includes('criteria') && (
+ <div className="flex items-center justify-between">
+ <span>Criteria</span>
+ <Combobox
+ align="end"
+ placeholder="Select criteria"
+ value={criteria}
+ onChange={(val) => dispatch(changeCriteria(val))}
+ items={[
+ {
+ label: 'On or After',
+ value: 'on_or_after',
+ },
+ {
+ label: 'On',
+ value: 'on',
+ },
+ ]}
+ />
+ </div>
+ )}
+ {fields.includes('unit') && (
+ <div className="flex items-center justify-between">
+ <span>Unit</span>
+ <Combobox
+ align="end"
+ placeholder="Unit"
+ value={unit || 'count'}
+ onChange={(val) => {
+ dispatch(changeUnit(val === 'count' ? undefined : val));
+ }}
+ items={[
+ {
+ label: 'Count',
+ value: 'count',
+ },
+ {
+ label: '%',
+ value: '%',
+ },
+ ]}
+ />
+ </div>
+ )}
+ </div>
+ </div>
+ );
+}
diff --git a/apps/dashboard/src/components/report/sidebar/ReportSidebar.tsx b/apps/dashboard/src/components/report/sidebar/ReportSidebar.tsx
index 8e7152684..ef1e8699c 100644
--- a/apps/dashboard/src/components/report/sidebar/ReportSidebar.tsx
+++ b/apps/dashboard/src/components/report/sidebar/ReportSidebar.tsx
@@ -5,15 +5,17 @@ import { useSelector } from '@/redux';
import { ReportBreakdowns } from './ReportBreakdowns';
import { ReportEvents } from './ReportEvents';
import { ReportFormula } from './ReportFormula';
+import { ReportSettings } from './ReportSettings';
export function ReportSidebar() {
const { chartType } = useSelector((state) => state.report);
- const showFormula = chartType !== 'funnel';
- const showBreakdown = chartType !== 'funnel';
+ const showFormula = chartType !== 'funnel' && chartType !== 'retention';
+ const showBreakdown = chartType !== 'funnel' && chartType !== 'retention';
return (
<>
<div className="flex flex-col gap-8">
<ReportEvents />
+ <ReportSettings />
{showFormula && <ReportFormula />}
{showBreakdown && <ReportBreakdowns />}
</div>
diff --git a/apps/dashboard/src/components/report/sidebar/filters/FilterItem.tsx b/apps/dashboard/src/components/report/sidebar/filters/FilterItem.tsx
index 1a10901cb..8c44c6a53 100644
--- a/apps/dashboard/src/components/report/sidebar/filters/FilterItem.tsx
+++ b/apps/dashboard/src/components/report/sidebar/filters/FilterItem.tsx
@@ -34,10 +34,6 @@ interface FilterProps {
interface PureFilterProps {
eventName: string;
filter: IChartEventFilter;
- range: IChartRange;
- startDate: string | null;
- endDate: string | null;
- interval: IInterval;
onRemove: (filter: IChartEventFilter) => void;
onChangeValue: (
value: IChartEventFilterValue[],
@@ -111,10 +107,6 @@ export function FilterItem({ filter, event }: FilterProps) {
<PureFilterItem
filter={filter}
eventName={event.name}
- range={range}
- startDate={startDate}
- endDate={endDate}
- interval={interval}
onRemove={onRemove}
onChangeValue={onChangeValue}
onChangeOperator={onChangeOperator}
@@ -126,10 +118,6 @@ export function FilterItem({ filter, event }: FilterProps) {
export function PureFilterItem({
filter,
eventName,
- range,
- startDate,
- endDate,
- interval,
onRemove,
onChangeValue,
onChangeOperator,
@@ -142,10 +130,6 @@ export function PureFilterItem({
event: eventName,
property: filter.name,
projectId,
- range,
- interval,
- startDate,
- endDate,
});
const valuesCombobox =
@@ -188,11 +172,7 @@ export function PureFilterItem({
}))}
label="Operator"
>
- <Button
- variant={'outline'}
- className="whitespace-nowrap"
- size="default"
- >
+ <Button variant={'outline'} className="whitespace-nowrap">
{operators[filter.operator]}
</Button>
</DropdownMenuComposed>
diff --git a/apps/dashboard/src/components/report/sidebar/filters/FiltersCombobox.tsx b/apps/dashboard/src/components/report/sidebar/filters/FiltersCombobox.tsx
index 59bd75251..52f27414e 100644
--- a/apps/dashboard/src/components/report/sidebar/filters/FiltersCombobox.tsx
+++ b/apps/dashboard/src/components/report/sidebar/filters/FiltersCombobox.tsx
@@ -15,20 +15,12 @@ interface FiltersComboboxProps {
export function FiltersCombobox({ event }: FiltersComboboxProps) {
const dispatch = useDispatch();
- const interval = useSelector((state) => state.report.interval);
- const range = useSelector((state) => state.report.range);
- const startDate = useSelector((state) => state.report.startDate);
- const endDate = useSelector((state) => state.report.endDate);
const { projectId } = useAppParams();
const properties = useEventProperties(
{
event: event.name,
projectId,
- range,
- interval,
- startDate,
- endDate,
},
{
enabled: !!event.name,
diff --git a/apps/dashboard/src/components/ui/button.tsx b/apps/dashboard/src/components/ui/button.tsx
index 224c16619..6d34badda 100644
--- a/apps/dashboard/src/components/ui/button.tsx
+++ b/apps/dashboard/src/components/ui/button.tsx
@@ -45,6 +45,26 @@ export interface ButtonProps
loading?: boolean;
icon?: LucideIcon;
responsive?: boolean;
+ autoHeight?: boolean;
+}
+
+function fixHeight({
+ autoHeight,
+ size,
+}: { autoHeight?: boolean; size: ButtonProps['size'] }) {
+ if (autoHeight) {
+ switch (size) {
+ case 'lg':
+ return 'h-auto min-h-11 py-2';
+ case 'icon':
+ return 'h-auto min-h-8 py-1';
+ case 'default':
+ return 'h-auto min-h-10 py-2';
+ default:
+ return 'h-auto min-h-8 py-1';
+ }
+ }
+ return '';
}
const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(
@@ -59,6 +79,7 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(
disabled,
icon,
responsive,
+ autoHeight,
...props
},
ref,
@@ -67,7 +88,10 @@ const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(
const Icon = loading ? Loader2 : (icon ?? null);
return (
<Comp
- className={cn(buttonVariants({ variant, size, className }))}
+ className={cn(
+ buttonVariants({ variant, size, className }),
+ fixHeight({ autoHeight, size }),
+ )}
ref={ref}
disabled={loading || disabled}
{...props}
diff --git a/apps/dashboard/src/components/ui/combobox-advanced.tsx b/apps/dashboard/src/components/ui/combobox-advanced.tsx
index 0d34771be..ec883fb91 100644
--- a/apps/dashboard/src/components/ui/combobox-advanced.tsx
+++ b/apps/dashboard/src/components/ui/combobox-advanced.tsx
@@ -6,7 +6,7 @@ import VirtualList from 'rc-virtual-list';
import * as React from 'react';
import { useOnClickOutside } from 'usehooks-ts';
-import { Button } from './button';
+import { Button, type ButtonProps } from './button';
import { Checkbox, DumpCheckbox } from './checkbox';
import { Popover, PopoverContent, PopoverTrigger } from './popover';
@@ -19,6 +19,7 @@ interface ComboboxAdvancedProps {
items: IItem[];
placeholder: string;
className?: string;
+ size?: ButtonProps['size'];
}
export function ComboboxAdvanced({
@@ -27,6 +28,7 @@ export function ComboboxAdvanced({
onChange,
placeholder,
className,
+ size,
}: ComboboxAdvancedProps) {
const [open, setOpen] = React.useState(false);
const [inputValue, setInputValue] = React.useState('');
@@ -99,7 +101,9 @@ export function ComboboxAdvanced({
<Button
variant={'outline'}
onClick={() => setOpen((prev) => !prev)}
- className={cn('h-auto min-h-10 py-2', className)}
+ className={className}
+ size={size}
+ autoHeight
>
<div className="flex w-full flex-wrap gap-1">
{value.length === 0 && placeholder}
diff --git a/apps/dashboard/src/components/ui/combobox.tsx b/apps/dashboard/src/components/ui/combobox.tsx
index 3008e8485..da29f9b36 100644
--- a/apps/dashboard/src/components/ui/combobox.tsx
+++ b/apps/dashboard/src/components/ui/combobox.tsx
@@ -38,6 +38,7 @@ export interface ComboboxProps<T> {
align?: 'start' | 'end' | 'center';
portal?: boolean;
error?: string;
+ disabled?: boolean;
}
export type ExtendedComboboxProps<T> = Omit<
@@ -61,6 +62,7 @@ export function Combobox<T extends string>({
align = 'start',
portal,
error,
+ disabled,
}: ComboboxProps<T>) {
const [open, setOpen] = React.useState(false);
const [search, setSearch] = React.useState('');
@@ -75,6 +77,7 @@ export function Combobox<T extends string>({
<PopoverTrigger asChild>
{children ?? (
<Button
+ disabled={disabled}
size={size}
variant="outline"
role="combobox"
diff --git a/apps/dashboard/src/components/ui/dropdown-menu.tsx b/apps/dashboard/src/components/ui/dropdown-menu.tsx
index 7aca6330a..65b27b8b9 100644
--- a/apps/dashboard/src/components/ui/dropdown-menu.tsx
+++ b/apps/dashboard/src/components/ui/dropdown-menu.tsx
@@ -4,6 +4,7 @@ import { cn } from '@/utils/cn';
import * as DropdownMenuPrimitive from '@radix-ui/react-dropdown-menu';
import { Check, ChevronRight, Circle } from 'lucide-react';
import * as React from 'react';
+import { ButtonProps } from './button';
const DropdownMenu = DropdownMenuPrimitive.Root;
diff --git a/apps/dashboard/src/components/ui/tooltip.tsx b/apps/dashboard/src/components/ui/tooltip.tsx
index 3a932a742..67813b77d 100644
--- a/apps/dashboard/src/components/ui/tooltip.tsx
+++ b/apps/dashboard/src/components/ui/tooltip.tsx
@@ -38,6 +38,7 @@ interface TooltiperProps {
content: React.ReactNode;
children: React.ReactNode;
className?: string;
+ tooltipClassName?: string;
onClick?: () => void;
side?: 'top' | 'right' | 'bottom' | 'left';
delayDuration?: number;
@@ -49,6 +50,7 @@ export function Tooltiper({
content,
children,
className,
+ tooltipClassName,
onClick,
side,
delayDuration = 0,
@@ -62,7 +64,11 @@ export function Tooltiper({
{children}
</TooltipTrigger>
<TooltipPortal>
- <TooltipContent sideOffset={sideOffset} side={side}>
+ <TooltipContent
+ sideOffset={sideOffset}
+ side={side}
+ className={tooltipClassName}
+ >
{content}
</TooltipContent>
</TooltipPortal>
diff --git a/apps/dashboard/src/hooks/useNumerFormatter.ts b/apps/dashboard/src/hooks/useNumerFormatter.ts
index adace0299..c6c6f5e40 100644
--- a/apps/dashboard/src/hooks/useNumerFormatter.ts
+++ b/apps/dashboard/src/hooks/useNumerFormatter.ts
@@ -13,9 +13,7 @@ export const formatNumber =
if (isNil(value)) {
return 'N/A';
}
- return new Intl.NumberFormat(locale, {
- maximumSignificantDigits: 3,
- }).format(value);
+ return new Intl.NumberFormat(locale).format(value);
};
export const shortNumber =
diff --git a/apps/dashboard/src/modals/add-notification-rule.tsx b/apps/dashboard/src/modals/add-notification-rule.tsx
index 45354f75d..650d5f237 100644
--- a/apps/dashboard/src/modals/add-notification-rule.tsx
+++ b/apps/dashboard/src/modals/add-notification-rule.tsx
@@ -3,7 +3,6 @@
import { type RouterOutputs, api } from '@/trpc/client';
import { SheetContent } from '@/components/ui/sheet';
-import type { NotificationRule } from '@openpanel/db';
import { useQueryClient } from '@tanstack/react-query';
import { getQueryKey } from '@trpc/react-query';
import { toast } from 'sonner';
@@ -11,7 +10,6 @@ import { popModal } from '.';
import { ModalHeader } from './Modal/Container';
import { ColorSquare } from '@/components/color-square';
-import { CheckboxItem } from '@/components/forms/checkbox-item';
import { InputWithLabel, WithLabel } from '@/components/forms/input-with-label';
import { PureFilterItem } from '@/components/report/sidebar/filters/FilterItem';
import { Button } from '@/components/ui/button';
@@ -22,19 +20,8 @@ import { useEventNames } from '@/hooks/useEventNames';
import { useEventProperties } from '@/hooks/useEventProperties';
import { zodResolver } from '@hookform/resolvers/zod';
import { shortId } from '@openpanel/common';
-import {
- IChartEvent,
- type IChartRange,
- type IInterval,
- zCreateNotificationRule,
-} from '@openpanel/validation';
-import {
- FilterIcon,
- PlusIcon,
- SaveIcon,
- SmartphoneIcon,
- TrashIcon,
-} from 'lucide-react';
+import { zCreateNotificationRule } from '@openpanel/validation';
+import { FilterIcon, PlusIcon, SaveIcon, TrashIcon } from 'lucide-react';
import {
Controller,
type SubmitHandler,
@@ -200,9 +187,6 @@ export default function AddNotificationRule({ rule }: Props) {
);
}
-const interval: IInterval = 'day';
-const range: IChartRange = 'lastMonth';
-
function EventField({
form,
index,
@@ -213,7 +197,7 @@ function EventField({
remove: () => void;
}) {
const { projectId } = useAppParams();
- const eventNames = useEventNames({ projectId, interval, range });
+ const eventNames = useEventNames({ projectId });
const filtersArray = useFieldArray({
control: form.control,
name: `config.events.${index}.filters`,
@@ -222,7 +206,7 @@ function EventField({
control: form.control,
name: `config.events.${index}.name`,
});
- const properties = useEventProperties({ projectId, interval, range });
+ const properties = useEventProperties({ projectId });
return (
<div className="border bg-def-100 rounded">
@@ -280,10 +264,6 @@ function EventField({
<PureFilterItem
eventName={eventName}
filter={filter}
- range={range}
- startDate={null}
- endDate={null}
- interval={interval}
onRemove={() => {
filtersArray.remove(index);
}}
diff --git a/apps/docs/src/pages/docs/sdks/export.mdx b/apps/docs/src/pages/docs/sdks/export.mdx
index f8cd42047..fa605b60b 100644
--- a/apps/docs/src/pages/docs/sdks/export.mdx
+++ b/apps/docs/src/pages/docs/sdks/export.mdx
@@ -1,10 +1,14 @@
# Export API
+The Export API allows you to retrieve event data and chart data from your OpenPanel projects.
+
## Authentication
To authenticate with the Export API, you need to use your `clientId` and `clientSecret`. Make sure your client has `read` or `root` mode. The default client does not have access to the Export API.
-We expect you to send `openpanel-client-id` and `openpanel-client-secret` headers with your requests.
+Include the following headers with your requests:
+- `openpanel-client-id`: Your OpenPanel client ID
+- `openpanel-client-secret`: Your OpenPanel client secret
Example:
@@ -37,6 +41,136 @@ curl 'https://api.openpanel.dev/export/events?project_id=abc&event=screen_view&s
-H 'openpanel-client-secret: YOUR_CLIENT_SECRET'
```
-## Profiles
+### Query Parameters
+
+| Parameter | Type | Description | Example |
+|-----------|------|-------------|---------|
+| projectId | string | The ID of the project to fetch events from | `abc123` |
+| event | string or string[] | Event name(s) to filter | `screen_view` or `["screen_view","button_click"]` |
+| start | string | Start date for the event range (ISO format) | `2024-04-15` |
+| end | string | End date for the event range (ISO format) | `2024-04-18` |
+| page | number | Page number for pagination (default: 1) | `2` |
+| limit | number | Number of events per page (default: 50, max: 50) | `25` |
+| includes | string or string[] | Additional fields to include in the response | `profile` or `["profile","meta"]` |
+
+### Example Request
+
+```bash
+curl 'https://api.openpanel.dev/export/events?project_id=abc123&event=screen_view&start=2024-04-15&end=2024-04-18&page=1&limit=50&includes=profile,meta' \
+ -H 'openpanel-client-id: YOUR_CLIENT_ID' \
+ -H 'openpanel-client-secret: YOUR_CLIENT_SECRET'
+```
+
+### Response
+
+```json
+{
+ "meta": {
+ "count": number,
+ "totalCount": number,
+ "pages": number,
+ "current": number
+ },
+ "data": Array<Event>
+}
+```
+
+## Charts
+
+Retrieve chart data for a specific project.
+
+### Endpoint
+
+```
+GET /export/charts
+```
+
+### Query Parameters
+
+| Parameter | Type | Description | Example |
+|-----------|------|-------------|---------|
+| projectId | string | The ID of the project to fetch chart data from | `abc123` |
+| events | string[] | Array of event names to include in the chart | `["sign_up","purchase"]` |
+| breakdowns | object[] | Array of breakdown configurations | `[{"name":"country"}]` |
+| interval | string | Time interval for data points | `day` |
+| range | string | Predefined date range | `last_7_days` |
+| previous | boolean | Include data from the previous period | `true` |
+| startDate | string | Custom start date (ISO format) | `2024-04-01` |
+| endDate | string | Custom end date (ISO format) | `2024-04-30` |
+| chartType | string | Type of chart to generate | `linear` |
+| metric | string | Metric to use for calculations | `sum` |
+| limit | number | Limit the number of results | `10` |
+| offset | number | Offset for pagination | `0` |
+
+### Example Request
+
+```bash
+curl 'https://api.openpanel.dev/export/charts?projectId=abc123&events=["sign_up","purchase"]&interval=day&range=last_30_days&chartType=linear&metric=sum' \
+ -H 'openpanel-client-id: YOUR_CLIENT_ID' \
+ -H 'openpanel-client-secret: YOUR_CLIENT_SECRET'
+```
+
+### Response
+
+The response will include chart data with series, metrics, and optional previous period comparisons based on the input parameters.
+
+## Funnel
+
+Retrieve funnel data for a specific project.
+
+### Endpoint
+
+```
+GET /export/funnel
+```
+
+### Query Parameters
+
+| Parameter | Type | Description | Example |
+|-----------|------|-------------|---------|
+| projectId | string | The ID of the project to fetch funnel data from | `abc123` |
+| events | object[] | Array of event configurations for the funnel steps | `[{"name":"sign_up","filters":[]}]` |
+| range | string | Predefined date range | `last_30_days` |
+| startDate | string | Custom start date (ISO format) | `2024-04-01` |
+| endDate | string | Custom end date (ISO format) | `2024-04-30` |
+
+### Example Request
+
+```bash
+curl 'https://api.openpanel.dev/export/funnel?projectId=abc123&events=[{"name":"sign_up"},{"name":"purchase"}]&range=last_30_days' \
+ -H 'openpanel-client-id: YOUR_CLIENT_ID' \
+ -H 'openpanel-client-secret: YOUR_CLIENT_SECRET'
+```
+
+### Response
+
+The response will include funnel data with total sessions and step-by-step breakdown of the funnel progression.
+
+```json
+{
+ "totalSessions": number,
+ "steps": [
+ {
+ "event": {
+ "name": string,
+ "displayName": string
+ },
+ "count": number,
+ "percent": number,
+ "dropoffCount": number,
+ "dropoffPercent": number,
+ "previousCount": number
+ }
+ ]
+}
+```
+
+## Notes
+
+- All date parameters should be in ISO format (YYYY-MM-DD).
+- The `range` parameter accepts values like `today`, `yesterday`, `last_7_days`, `last_30_days`, `this_month`, `last_month`, `this_year`, `last_year`, `all_time`.
+- The `interval` parameter accepts values like `minute`, `hour`, `day`, `month`.
+- The `chartType` parameter can be `linear` or other supported chart types.
+- The `metric` parameter can be `sum`, `average`, `min`, or `max`.
-During development
+Remember to replace `YOUR_CLIENT_ID` and `YOUR_CLIENT_SECRET` with your actual OpenPanel API credentials.
\ No newline at end of file
diff --git a/biome.json b/biome.json
index c1894cdbd..aa8e58970 100644
--- a/biome.json
+++ b/biome.json
@@ -30,7 +30,8 @@
"noNonNullAssertion": "off"
},
"correctness": {
- "useExhaustiveDependencies": "off"
+ "useExhaustiveDependencies": "off",
+ "noUnreachable": "off"
},
"performance": {
"noDelete": "off",
diff --git a/packages/common/src/date.ts b/packages/common/src/date.ts
index 2f520cc29..dd7f09aa0 100644
--- a/packages/common/src/date.ts
+++ b/packages/common/src/date.ts
@@ -32,6 +32,19 @@ export function getTimezoneFromDateString(_date: string) {
'-10:00': 'Pacific/Honolulu',
'-11:00': 'Pacific/Midway',
'-12:00': 'Pacific/Tarawa',
+ // Additional time zones
+ '+05:30': 'Asia/Kolkata',
+ '+05:45': 'Asia/Kathmandu',
+ '+08:45': 'Australia/Eucla',
+ '+09:30': 'Australia/Darwin',
+ '+10:30': 'Australia/Adelaide',
+ '+12:45': 'Pacific/Chatham',
+ '+13:00': 'Pacific/Apia',
+ '+14:00': 'Pacific/Kiritimati',
+ '-02:30': 'America/St_Johns',
+ '-03:30': 'America/St_Johns',
+ '-04:30': 'America/Caracas',
+ '-09:30': 'Pacific/Marquesas',
};
const defaultTimezone = 'UTC';
diff --git a/packages/common/src/math.ts b/packages/common/src/math.ts
index 06707264d..56d3781b6 100644
--- a/packages/common/src/math.ts
+++ b/packages/common/src/math.ts
@@ -5,10 +5,13 @@ export const round = (num: number, decimals = 2) => {
return Math.round((num + Number.EPSILON) * factor) / factor;
};
-export const average = (arr: (number | null)[]) => {
+export const average = (arr: (number | null)[], includeZero = false) => {
const filtered = arr.filter(
(n): n is number =>
- isNumber(n) && !Number.isNaN(n) && Number.isFinite(n) && n !== 0,
+ isNumber(n) &&
+ !Number.isNaN(n) &&
+ Number.isFinite(n) &&
+ (includeZero || n !== 0),
);
const avg = filtered.reduce((p, c) => p + c, 0) / filtered.length;
return Number.isNaN(avg) ? 0 : avg;
@@ -17,10 +20,10 @@ export const average = (arr: (number | null)[]) => {
export const sum = (arr: (number | null | undefined)[]): number =>
round(arr.filter(isNumber).reduce((acc, item) => acc + item, 0));
-export const min = (arr: (number | null)[]): number =>
+export const min = (arr: (number | null | undefined)[]): number =>
Math.min(...arr.filter(isNumber));
-export const max = (arr: (number | null)[]): number =>
+export const max = (arr: (number | null | undefined)[]): number =>
Math.max(...arr.filter(isNumber));
export const isFloat = (n: number) => n % 1 !== 0;
diff --git a/packages/constants/index.ts b/packages/constants/index.ts
index 1e302075c..776a06e74 100644
--- a/packages/constants/index.ts
+++ b/packages/constants/index.ts
@@ -106,6 +106,7 @@ export const intervals = {
minute: 'minute',
day: 'day',
hour: 'hour',
+ week: 'week',
month: 'month',
} as const;
diff --git a/packages/db/migrations/20241007210706_retention_mv.sql b/packages/db/migrations/20241007210706_retention_mv.sql
new file mode 100644
index 000000000..58cce2100
--- /dev/null
+++ b/packages/db/migrations/20241007210706_retention_mv.sql
@@ -0,0 +1,58 @@
+-- +goose Up
+-- +goose StatementBegin
+CREATE MATERIALIZED VIEW cohort_events_mv ENGINE = AggregatingMergeTree()
+ORDER BY (project_id, name, created_at, profile_id) POPULATE AS
+SELECT project_id,
+ name,
+ toDate(created_at) AS created_at,
+ profile_id,
+ COUNT() AS event_count
+FROM events_v2
+WHERE profile_id != device_id
+GROUP BY project_id,
+ name,
+ created_at,
+ profile_id;
+-- +goose StatementEnd
+-- +goose StatementBegin
+CREATE MATERIALIZED VIEW distinct_event_names_mv ENGINE = AggregatingMergeTree()
+ORDER BY (project_id, name, created_at) POPULATE AS
+SELECT project_id,
+ name,
+ max(created_at) AS created_at,
+ count() AS event_count
+FROM events_v2
+GROUP BY project_id,
+ name;
+-- +goose StatementEnd
+-- +goose StatementBegin
+CREATE MATERIALIZED VIEW event_property_values_mv ENGINE = AggregatingMergeTree()
+ORDER BY (project_id, name, property_key, property_value) POPULATE AS
+select project_id,
+ name,
+ key_value.keys as property_key,
+ key_value.values as property_value,
+ created_at
+from (
+ SELECT project_id,
+ name,
+ untuple(arrayJoin(properties)) as key_value,
+ max(created_at) as created_at
+ from events_v2
+ group by project_id,
+ name,
+ key_value
+ )
+where property_value != ''
+ and property_key != ''
+ and property_key NOT IN ('__duration_from', '__properties_from')
+group by project_id,
+ name,
+ property_key,
+ property_value,
+ created_at;
+-- +goose StatementEnd
+-- +goose Down
+-- +goose StatementBegin
+SELECT 'down SQL query';
+-- +goose StatementEnd
\ No newline at end of file
diff --git a/packages/db/prisma/migrations/20240922184723_add_retention/migration.sql b/packages/db/prisma/migrations/20240922184723_add_retention/migration.sql
new file mode 100644
index 000000000..49de778ec
--- /dev/null
+++ b/packages/db/prisma/migrations/20240922184723_add_retention/migration.sql
@@ -0,0 +1,2 @@
+-- AlterEnum
+ALTER TYPE "ChartType" ADD VALUE 'retention';
diff --git a/packages/db/prisma/migrations/20241010202123_add_week_as_interval/migration.sql b/packages/db/prisma/migrations/20241010202123_add_week_as_interval/migration.sql
new file mode 100644
index 000000000..53d86fac3
--- /dev/null
+++ b/packages/db/prisma/migrations/20241010202123_add_week_as_interval/migration.sql
@@ -0,0 +1,2 @@
+-- AlterEnum
+ALTER TYPE "Interval" ADD VALUE 'week';
diff --git a/packages/db/prisma/migrations/20241015090417_add_criteria/migration.sql b/packages/db/prisma/migrations/20241015090417_add_criteria/migration.sql
new file mode 100644
index 000000000..943e41170
--- /dev/null
+++ b/packages/db/prisma/migrations/20241015090417_add_criteria/migration.sql
@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "reports" ADD COLUMN "criteria" TEXT;
diff --git a/packages/db/prisma/schema.prisma b/packages/db/prisma/schema.prisma
index 181e6314f..b49c25efa 100644
--- a/packages/db/prisma/schema.prisma
+++ b/packages/db/prisma/schema.prisma
@@ -192,6 +192,7 @@ enum Interval {
day
month
minute
+ week
}
enum ChartType {
@@ -203,6 +204,7 @@ enum ChartType {
area
map
funnel
+ retention
}
model Dashboard {
@@ -243,6 +245,7 @@ model Report {
projectId String
project Project @relation(fields: [projectId], references: [id])
previous Boolean @default(false)
+ criteria String?
dashboardId String
dashboard Dashboard @relation(fields: [dashboardId], references: [id])
diff --git a/packages/db/src/clickhouse-client.ts b/packages/db/src/clickhouse-client.ts
index e469dd22b..f1b5842c9 100644
--- a/packages/db/src/clickhouse-client.ts
+++ b/packages/db/src/clickhouse-client.ts
@@ -14,6 +14,9 @@ export const TABLE_NAMES = {
self_hosting: 'self_hosting',
events_bots: 'events_bots',
dau_mv: 'dau_mv',
+ event_names_mv: 'distinct_event_names_mv',
+ event_property_values_mv: 'event_property_values_mv',
+ cohort_events_mv: 'cohort_events_mv',
};
export const originalCh = createClient({
@@ -129,6 +132,10 @@ export function formatClickhouseDate(
_date: Date | string,
skipTime = false,
): string {
+ if (typeof _date === 'string') {
+ return _date.slice(0, 19).replace('T', ' ');
+ }
+
const date = typeof _date === 'string' ? new Date(_date) : _date;
if (skipTime) {
return date.toISOString().split('T')[0]!;
diff --git a/packages/db/src/services/chart.service.ts b/packages/db/src/services/chart.service.ts
index 6fa93a4bd..d408ba291 100644
--- a/packages/db/src/services/chart.service.ts
+++ b/packages/db/src/services/chart.service.ts
@@ -81,6 +81,10 @@ export function getChartSql({
sb.select.date = `toStartOfDay(toTimeZone(created_at, '${getTimezoneFromDateString(startDate)}')) as date`;
break;
}
+ case 'week': {
+ sb.select.date = `toStartOfWeek(toTimeZone(created_at, '${getTimezoneFromDateString(startDate)}')) as date`;
+ break;
+ }
case 'month': {
sb.select.date = `toStartOfMonth(toTimeZone(created_at, '${getTimezoneFromDateString(startDate)}')) as date`;
break;
diff --git a/packages/db/src/services/reports.service.ts b/packages/db/src/services/reports.service.ts
index 1cad4cfce..b1fbf4e44 100644
--- a/packages/db/src/services/reports.service.ts
+++ b/packages/db/src/services/reports.service.ts
@@ -10,6 +10,7 @@ import type {
IChartLineType,
IChartProps,
IChartRange,
+ ICriteria,
} from '@openpanel/validation';
import { db } from '../prisma-client';
@@ -64,6 +65,7 @@ export function transformReport(
formula: report.formula ?? undefined,
metric: report.metric ?? 'sum',
unit: report.unit ?? undefined,
+ criteria: (report.criteria as ICriteria) ?? undefined,
};
}
diff --git a/packages/trpc/src/routers/chart.ts b/packages/trpc/src/routers/chart.ts
index d498287a2..a55b07124 100644
--- a/packages/trpc/src/routers/chart.ts
+++ b/packages/trpc/src/routers/chart.ts
@@ -1,4 +1,4 @@
-import { flatten, map, pipe, prop, sort, uniq } from 'ramda';
+import { flatten, map, pipe, prop, range, sort, uniq } from 'ramda';
import { escape } from 'sqlstring';
import { z } from 'zod';
@@ -7,12 +7,23 @@ import {
chQuery,
createSqlBuilder,
db,
- formatClickhouseDate,
getSelectPropertyKey,
toDate,
} from '@openpanel/db';
-import { zChartInput, zRange, zTimeInterval } from '@openpanel/validation';
+import {
+ zChartInput,
+ zCriteria,
+ zRange,
+ zTimeInterval,
+} from '@openpanel/validation';
+import { round } from '@openpanel/common';
+import {
+ differenceInDays,
+ differenceInMonths,
+ differenceInWeeks,
+ formatISO,
+} from 'date-fns';
import { getProjectAccessCached } from '../access';
import { TRPCAccessError } from '../errors';
import { createTRPCRouter, protectedProcedure, publicProcedure } from '../trpc';
@@ -24,21 +35,23 @@ import {
getFunnelStep,
} from './chart.helpers';
+function utc(date: string | Date) {
+ if (typeof date === 'string') {
+ return date.replace('T', ' ').slice(0, 19);
+ }
+ return formatISO(date).replace('T', ' ').slice(0, 19);
+}
+
export const chartRouter = createTRPCRouter({
events: protectedProcedure
.input(
z.object({
projectId: z.string(),
- range: zRange,
- interval: zTimeInterval,
- startDate: z.string().nullish(),
- endDate: z.string().nullish(),
}),
)
- .query(async ({ input: { projectId, ...input } }) => {
- const { startDate, endDate } = getChartStartEndDate(input);
+ .query(async ({ input: { projectId } }) => {
const events = await chQuery<{ name: string }>(
- `SELECT DISTINCT name FROM ${TABLE_NAMES.events} WHERE project_id = ${escape(projectId)} AND ${toDate('created_at', input.interval)} BETWEEN ${toDate(formatClickhouseDate(startDate), input.interval)} AND ${toDate(formatClickhouseDate(endDate), input.interval)};`,
+ `SELECT DISTINCT name FROM ${TABLE_NAMES.event_names_mv} WHERE project_id = ${escape(projectId)}`,
);
return [
@@ -54,23 +67,22 @@ export const chartRouter = createTRPCRouter({
z.object({
event: z.string().optional(),
projectId: z.string(),
- range: zRange,
- interval: zTimeInterval,
- startDate: z.string().nullish(),
- endDate: z.string().nullish(),
}),
)
- .query(async ({ input: { projectId, event, ...input } }) => {
- const { startDate, endDate } = getChartStartEndDate(input);
- const events = await chQuery<{ keys: string[] }>(
- `SELECT distinct mapKeys(properties) as keys from ${TABLE_NAMES.events} where ${
- event && event !== '*' ? `name = ${escape(event)} AND ` : ''
- } project_id = ${escape(projectId)} AND
- ${toDate('created_at', input.interval)} BETWEEN ${toDate(formatClickhouseDate(startDate), input.interval)} AND ${toDate(formatClickhouseDate(endDate), input.interval)};`,
+ .query(async ({ input: { projectId, event } }) => {
+ const res = await chQuery<{ property_key: string; created_at: string }>(
+ `SELECT
+ distinct property_key,
+ max(created_at) as created_at
+ FROM ${TABLE_NAMES.event_property_values_mv}
+ WHERE project_id = ${escape(projectId)}
+ ${event && event !== '*' ? `AND name = ${escape(event)}` : ''}
+ GROUP BY property_key
+ ORDER BY created_at DESC`,
);
- const properties = events
- .flatMap((event) => event.keys)
+ const properties = res
+ .map((item) => item.property_key)
.map((item) => item.replace(/\.([0-9]+)\./g, '.*.'))
.map((item) => item.replace(/\.([0-9]+)/g, '[*]'))
.map((item) => `properties.${item}`);
@@ -108,36 +120,55 @@ export const chartRouter = createTRPCRouter({
event: z.string(),
property: z.string(),
projectId: z.string(),
- range: zRange,
- interval: zTimeInterval,
- startDate: z.string().nullish(),
- endDate: z.string().nullish(),
}),
)
.query(async ({ input: { event, property, projectId, ...input } }) => {
- const { startDate, endDate } = getChartStartEndDate(input);
if (property === 'has_profile') {
return {
values: ['true', 'false'],
};
}
- const { sb, getSql } = createSqlBuilder();
- sb.where.project_id = `project_id = ${escape(projectId)}`;
- if (event !== '*') {
- sb.where.event = `name = ${escape(event)}`;
- }
- sb.select.values = `distinct ${getSelectPropertyKey(property)} as values`;
- sb.where.date = `${toDate('created_at', input.interval)} BETWEEN ${toDate(formatClickhouseDate(startDate), input.interval)} AND ${toDate(formatClickhouseDate(endDate), input.interval)};`;
+ const values: string[] = [];
- const events = await chQuery<{ values: string[] }>(getSql());
+ if (property.startsWith('properties.')) {
+ const propertyKey = property.replace(/^properties\./, '');
- const values = pipe(
- (data: typeof events) => map(prop('values'), data),
- flatten,
- uniq,
- sort((a, b) => a.length - b.length),
- )(events);
+ const res = await chQuery<{
+ property_value: string;
+ created_at: string;
+ }>(
+ `SELECT
+ distinct property_value,
+ max(created_at) as created_at
+ FROM ${TABLE_NAMES.event_property_values_mv}
+ WHERE project_id = ${escape(projectId)}
+ AND property_key = ${escape(propertyKey)}
+ ${event && event !== '*' ? `AND name = ${escape(event)}` : ''}
+ GROUP BY property_value
+ ORDER BY created_at DESC`,
+ );
+
+ values.push(...res.map((e) => e.property_value));
+ } else {
+ const { sb, getSql } = createSqlBuilder();
+ sb.where.project_id = `project_id = ${escape(projectId)}`;
+ if (event !== '*') {
+ sb.where.event = `name = ${escape(event)}`;
+ }
+ sb.select.values = `distinct ${getSelectPropertyKey(property)} as values`;
+ sb.where.date = `${toDate('created_at', 'month')} > now() - INTERVAL 6 MONTH`;
+ const events = await chQuery<{ values: string[] }>(getSql());
+
+ values.push(
+ ...pipe(
+ (data: typeof events) => map(prop('values'), data),
+ flatten,
+ uniq,
+ sort((a, b) => a.length - b.length),
+ )(events),
+ );
+ }
return {
values,
@@ -204,4 +235,208 @@ export const chartRouter = createTRPCRouter({
return getChart(input);
}),
+ cohort: protectedProcedure
+ .input(
+ z.object({
+ projectId: z.string(),
+ firstEvent: z.array(z.string()).min(1),
+ secondEvent: z.array(z.string()).min(1),
+ criteria: zCriteria.default('on_or_after'),
+ startDate: z.string().nullish(),
+ endDate: z.string().nullish(),
+ interval: zTimeInterval.default('day'),
+ range: zRange,
+ }),
+ )
+ .query(async ({ input }) => {
+ const { projectId, firstEvent, secondEvent } = input;
+ const dates = getChartStartEndDate(input);
+ const diffInterval = {
+ minute: () => differenceInDays(dates.endDate, dates.startDate),
+ hour: () => differenceInDays(dates.endDate, dates.startDate),
+ day: () => differenceInDays(dates.endDate, dates.startDate),
+ week: () => differenceInWeeks(dates.endDate, dates.startDate),
+ month: () => differenceInMonths(dates.endDate, dates.startDate),
+ }[input.interval]();
+ const sqlInterval = {
+ minute: 'DAY',
+ hour: 'DAY',
+ day: 'DAY',
+ week: 'WEEK',
+ month: 'MONTH',
+ }[input.interval];
+
+ const sqlToStartOf = {
+ minute: 'toDate',
+ hour: 'toDate',
+ day: 'toDate',
+ week: 'toStartOfWeek',
+ month: 'toStartOfMonth',
+ }[input.interval];
+
+ const countCriteria = input.criteria === 'on_or_after' ? '>=' : '=';
+
+ const usersSelect = range(0, diffInterval + 1)
+ .map(
+ (index) =>
+ `groupUniqArrayIf(profile_id, x_after_cohort ${countCriteria} ${index}) AS interval_${index}_users`,
+ )
+ .join(',\n');
+
+ const countsSelect = range(0, diffInterval + 1)
+ .map(
+ (index) =>
+ `length(interval_${index}_users) AS interval_${index}_user_count`,
+ )
+ .join(',\n');
+
+ const whereEventNameIs = (event: string[]) => {
+ if (event.length === 1) {
+ return `name = ${escape(event[0])}`;
+ }
+ return `name IN (${event.map((e) => escape(e)).join(',')})`;
+ };
+
+ // const dropoffsSelect = range(1, diffInterval + 1)
+ // .map(
+ // (index) =>
+ // `arrayFilter(x -> NOT has(interval_${index}_users, x), interval_${index - 1}_users) AS interval_${index}_dropoffs`,
+ // )
+ // .join(',\n');
+
+ // const dropoffCountsSelect = range(1, diffInterval + 1)
+ // .map(
+ // (index) =>
+ // `length(interval_${index}_dropoffs) AS interval_${index}_dropoff_count`,
+ // )
+ // .join(',\n');
+
+ // SELECT
+ // project_id,
+ // profile_id AS userID,
+ // name,
+ // toDate(created_at) AS cohort_interval
+ // FROM events_v2
+ // WHERE profile_id != device_id
+ // AND ${whereEventNameIs(firstEvent)}
+ // AND project_id = ${escape(projectId)}
+ // AND created_at BETWEEN toDate('${utc(dates.startDate)}') AND toDate('${utc(dates.endDate)}')
+ // GROUP BY project_id, name, cohort_interval, userID
+
+ const cohortQuery = `
+ WITH
+ cohort_users AS (
+ SELECT
+ profile_id AS userID,
+ project_id,
+ ${sqlToStartOf}(created_at) AS cohort_interval
+ FROM ${TABLE_NAMES.cohort_events_mv}
+ WHERE ${whereEventNameIs(firstEvent)}
+ AND project_id = ${escape(projectId)}
+ AND created_at BETWEEN toDate('${utc(dates.startDate)}') AND toDate('${utc(dates.endDate)}')
+ ),
+ retention_matrix AS (
+ SELECT
+ c.cohort_interval,
+ e.profile_id,
+ dateDiff('${sqlInterval}', c.cohort_interval, ${sqlToStartOf}(e.created_at)) AS x_after_cohort
+ FROM cohort_users AS c
+ INNER JOIN ${TABLE_NAMES.cohort_events_mv} AS e ON c.userID = e.profile_id
+ WHERE (${whereEventNameIs(secondEvent)}) AND (e.project_id = ${escape(projectId)})
+ AND ((e.created_at >= c.cohort_interval) AND (e.created_at <= (c.cohort_interval + INTERVAL ${diffInterval} ${sqlInterval})))
+ ),
+ interval_users AS (
+ SELECT
+ cohort_interval,
+ ${usersSelect}
+ FROM retention_matrix
+ GROUP BY cohort_interval
+ ),
+ cohort_sizes AS (
+ SELECT
+ cohort_interval,
+ COUNT(DISTINCT userID) AS total_first_event_count
+ FROM cohort_users
+ GROUP BY cohort_interval
+ )
+ SELECT
+ cohort_interval,
+ cohort_sizes.total_first_event_count,
+ ${countsSelect}
+ FROM interval_users
+ LEFT JOIN cohort_sizes AS cs ON cohort_interval = cs.cohort_interval
+ ORDER BY cohort_interval ASC
+ `;
+
+ const cohortData = await chQuery<{
+ cohort_interval: string;
+ total_first_event_count: number;
+ [key: string]: any;
+ }>(cohortQuery);
+
+ return processCohortData(cohortData, diffInterval);
+ }),
});
+
+function processCohortData(
+ data: Array<{
+ cohort_interval: string;
+ total_first_event_count: number;
+ [key: string]: any;
+ }>,
+ diffInterval: number,
+) {
+ if (data.length === 0) {
+ return [];
+ }
+
+ const processed = data.map((row) => {
+ const sum = row.total_first_event_count;
+ const values = range(0, diffInterval + 1).map(
+ (index) => (row[`interval_${index}_user_count`] || 0) as number,
+ );
+
+ return {
+ cohort_interval: row.cohort_interval,
+ sum,
+ values: values,
+ percentages: values.map((value) =>
+ sum > 0 ? round((value / sum) * 100, 2) : 0,
+ ),
+ };
+ });
+
+ // Initialize aggregation for averages
+ const averageData: {
+ sum: number;
+ values: Array<number>;
+ percentages: Array<number>;
+ } = {
+ sum: 0,
+ values: range(0, diffInterval + 1).map(() => 0),
+ percentages: range(0, diffInterval + 1).map(() => 0),
+ };
+
+ // Aggregate data for averages
+ processed.forEach((row) => {
+ averageData.sum += row.sum;
+ row.values.forEach((value, index) => {
+ averageData.values[index] += value;
+ averageData.percentages[index] += row.percentages[index]!;
+ });
+ });
+
+ const cohortCount = processed.length;
+
+ // Calculate average values
+ const averageRow = {
+ cohort_interval: 'Average',
+ sum: cohortCount > 0 ? round(averageData.sum / cohortCount, 0) : 0,
+ percentages: averageData.percentages.map((item) =>
+ round(item / cohortCount, 2),
+ ),
+ values: averageData.values.map((item) => round(item / cohortCount, 0)),
+ };
+
+ return [averageRow, ...processed];
+}
diff --git a/packages/trpc/src/routers/report.ts b/packages/trpc/src/routers/report.ts
index dc0eab54a..6a6143e49 100644
--- a/packages/trpc/src/routers/report.ts
+++ b/packages/trpc/src/routers/report.ts
@@ -44,6 +44,7 @@ export const reportRouter = createTRPCRouter({
range: report.range === 'custom' ? '30d' : report.range,
formula: report.formula,
previous: report.previous ?? false,
+ unit: report.unit,
},
});
}),
@@ -84,6 +85,7 @@ export const reportRouter = createTRPCRouter({
range: report.range === 'custom' ? '30d' : report.range,
formula: report.formula,
previous: report.previous ?? false,
+ unit: report.unit,
},
});
}),
diff --git a/packages/validation/src/index.ts b/packages/validation/src/index.ts
index 341e4d91e..475553734 100644
--- a/packages/validation/src/index.ts
+++ b/packages/validation/src/index.ts
@@ -75,10 +75,13 @@ export const zChartInput = z.object({
offset: z.number().optional(),
});
+export const zCriteria = z.enum(['on_or_after', 'on']);
+
export const zReportInput = zChartInput.extend({
name: z.string(),
lineType: zLineType,
unit: z.string().optional(),
+ criteria: zCriteria.optional(),
});
export const zInviteUser = z.object({
diff --git a/packages/validation/src/types.validation.ts b/packages/validation/src/types.validation.ts
index c5236e57f..b5795add0 100644
--- a/packages/validation/src/types.validation.ts
+++ b/packages/validation/src/types.validation.ts
@@ -5,6 +5,7 @@ import type {
zChartEvent,
zChartInput,
zChartType,
+ zCriteria,
zLineType,
zMetric,
zRange,
@@ -41,6 +42,7 @@ export type IGetChartDataInput = {
startDate: string;
endDate: string;
} & Omit<IChartInput, 'events' | 'name' | 'startDate' | 'endDate' | 'range'>;
+export type ICriteria = z.infer<typeof zCriteria>;
export type PreviousValue =
| {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 49d1519bb..cafe87a8f 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -341,8 +341,8 @@ importers:
specifier: ^2.4.0
lucide-react:
- specifier: ^0.331.0
- version: 0.331.0([email protected])
+ specifier: ^0.451.0
+ version: 0.451.0([email protected])
mathjs:
specifier: ^12.3.2
version: 12.3.2
@@ -14549,10 +14549,10 @@ packages:
react: 18.2.0
dev: false
- resolution: {integrity: sha512-CHFJ0ve9vaZ7bB2VRAl27SlX1ELh6pfNC0jS96qGpPEEzLkLDGq4pDBFU8RhOoRMqsjXqTzLm9U6bZ1OcIHq7Q==}
+ resolution: {integrity: sha512-OwQ3uljZLp2cerj8sboy5rnhtGTCl9UCJIhT1J85/yOuGVlEH+xaUPR7tvNdddPvmV5M5VLdr7cQuWE3hzA4jw==}
peerDependencies:
- react: ^16.5.1 || ^17.0.0 || ^18.0.0
+ react: ^16.5.1 || ^17.0.0 || ^18.0.0 || ^19.0.0-rc
dependencies:
react: 18.2.0
dev: false
diff --git a/tooling/typescript/base.json b/tooling/typescript/base.json
index da39eda6d..e3d719eeb 100644
--- a/tooling/typescript/base.json
+++ b/tooling/typescript/base.json
@@ -16,7 +16,8 @@
"isolatedModules": true,
"jsx": "preserve",
"incremental": true,
- "noUncheckedIndexedAccess": true
+ "noUncheckedIndexedAccess": true,
+ "allowUnreachableCode": true
},
"exclude": ["node_modules", "build", "dist"]
}