feature(dashboard): add new retention chart type

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

packages/db/prisma/migrations/20240922184723_add_retention/migration.sql

@@ -0,0 +1,2 @@
+-- AlterEnum
+ALTER TYPE "ChartType" ADD VALUE 'retention';

packages/db/prisma/migrations/20241010202123_add_week_as_interval/migration.sql

@@ -0,0 +1,2 @@
+-- AlterEnum
+ALTER TYPE "Interval" ADD VALUE 'week';

packages/db/prisma/migrations/20241015090417_add_criteria/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "reports" ADD COLUMN     "criteria" TEXT;

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])

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]!;

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;

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,
   };
 }