feat: refactor insights SQL builders and update related tests

Author: moonrailgun

example/web/package.json

@@ -3,7 +3,7 @@
   "version": "0.1.0",
   "private": true,
   "scripts": {
-    "dev": "next dev --turbopack",
+    "dev": "PORT=7788 next dev --turbopack",
     "build": "next build",
     "start": "next start",
     "lint": "next lint"

package.json

@@ -10,6 +10,7 @@
     "start": "cd src/server && cross-env NODE_ENV=production node ./dist/src/server/main.js",
     "start:docker": "pnpm start:docker:db && pnpm start",
     "start:docker:db": "cd src/server && pnpm db:migrate:apply && pnpm db:migrate:script",
+    "example": "cd example/web && pnpm dev",
     "test": "vitest",
     "build": "pnpm build:tracker && pnpm build:app && pnpm build:geo",
     "build:static": "pnpm build:tracker && pnpm build:client && pnpm build:geo",

src/server/model/insights/__snapshots__/survey.spec.ts.snap

@@ -1,21 +1,21 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`buildInsightsSurveySql > groups > sql 1`] = `
+exports[`SurveyInsightsSqlBuilder > groups > sql 1`] = `
 "select
-        to_char(date_trunc('day', "SurveyResult"."createdAt" at time zone 'UTC'), 'YYYY-MM-DD') date,
-        "payload" ->> 'rating' as "%rating" , count(1) as "$all_event"
-      from "SurveyResult"
-      
-      where "SurveyResult"."surveyId" = 'cm658i2tqw96upkejldn8rpbs' AND "SurveyResult"."createdAt" between '2025-02-10T16:00:00.000Z'::timestamptz and '2025-03-13T15:59:59.999Z'::timestamptz
-      group by 1 , 2"
+      to_char(date_trunc('day', "SurveyResult"."createdAt" at time zone 'UTC'), 'YYYY-MM-DD') date,
+      "SurveyResult"."payload" ->> 'rating' as "%rating" , count(1) as "$all_event"
+    from "SurveyResult"
+    
+    where "SurveyResult"."surveyId" = 'cm658i2tqw96upkejldn8rpbs' AND "SurveyResult"."createdAt" between '2025-02-10T16:00:00.000Z'::timestamptz and '2025-03-13T15:59:59.999Z'::timestamptz
+    group by 1 , 2"
 `;
 
-exports[`buildInsightsSurveySql > groups with custom bucket > sql 1`] = `
+exports[`SurveyInsightsSqlBuilder > groups with custom bucket > sql 1`] = `
 "select
-        to_char(date_trunc('day', "SurveyResult"."createdAt" at time zone 'UTC'), 'YYYY-MM-DD') date,
-        ("SurveyResult"."payload"->> 'rating') IN ('1' , '2' , '3') as "%rating|in list|1,2,3" , count(1) as "$all_event"
-      from "SurveyResult"
-      
-      where "SurveyResult"."surveyId" = 'cm658i2tqw96upkejldn8rpbs' AND "SurveyResult"."createdAt" between '2025-02-10T16:00:00.000Z'::timestamptz and '2025-03-13T15:59:59.999Z'::timestamptz
-      group by 1 , 2"
+      to_char(date_trunc('day', "SurveyResult"."createdAt" at time zone 'UTC'), 'YYYY-MM-DD') date,
+      ("SurveyResult"."payload"->> 'rating') IN ('1' , '2' , '3') as "%rating|in list|1,2,3" , count(1) as "$all_event"
+    from "SurveyResult"
+    
+    where "SurveyResult"."surveyId" = 'cm658i2tqw96upkejldn8rpbs' AND "SurveyResult"."createdAt" between '2025-02-10T16:00:00.000Z'::timestamptz and '2025-03-13T15:59:59.999Z'::timestamptz
+    group by 1 , 2"
 `;

src/server/model/insights/__snapshots__/website.spec.ts.snap

@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`buildInsightsWebsiteSql > groups > sql 1`] = `
+exports[`WebsiteInsightsSqlBuilder > groups > sql 1`] = `
 "select
       to_char(date_trunc('day', "WebsiteEvent"."createdAt" at time zone 'UTC'), 'YYYY-MM-DD') date,
       "WebsiteEventData"."numberValue" as "%number" , count(1) as "$all_event"
@@ -9,7 +9,7 @@ exports[`buildInsightsWebsiteSql > groups > sql 1`] = `
     group by 1 , 2"
 `;
 
-exports[`buildInsightsWebsiteSql > groups with custom bucket > sql 1`] = `
+exports[`WebsiteInsightsSqlBuilder > groups with custom bucket > sql 1`] = `
 "select
       to_char(date_trunc('day', "WebsiteEvent"."createdAt" at time zone 'UTC'), 'YYYY-MM-DD') date,
       "WebsiteEventData"."numberValue" != '1' as "%number|not equals|1" , count(1) as "$all_event"

src/server/model/insights/shared.ts

@@ -9,16 +9,71 @@ import {
 } from '@tianji/shared';
 import { get } from 'lodash-es';
 import { castToDate, castToNumber, castToString } from '../../utils/cast.js';
+import dayjs from 'dayjs';
 
-export function buildCommonFilterQueryOperator(
-  type: FilterInfoType,
-  _operator: string,
-  value: FilterInfoValue | null,
-  valueField: Prisma.Sql
-) {
-  if (type === 'number') {
-    const operator = _operator as FilterNumberOperator;
+export class InsightsSqlBuilder {
+  protected getDateQuery(
+    field: string,
+    unit: string,
+    timezone: string
+  ): Prisma.Sql {
+    return Prisma.sql`to_char(date_trunc(${unit}, ${Prisma.raw(field)} at time zone ${timezone}), 'YYYY-MM-DD')`;
+  }
+
+  protected buildGroupByText(length: number): string {
+    return Array.from({ length })
+      .map((_, i) => `${i + 1}`)
+      .join(' , ');
+  }
+
+  protected buildDateRangeQuery(
+    field: string,
+    startAt: number,
+    endAt: number
+  ): Prisma.Sql {
+    return Prisma.sql`${Prisma.raw(field)} between ${dayjs(startAt).toISOString()}::timestamptz and ${dayjs(endAt).toISOString()}::timestamptz`;
+  }
+
+  public buildCommonFilterQueryOperator(
+    type: FilterInfoType,
+    _operator: string,
+    value: FilterInfoValue | null,
+    valueField: Prisma.Sql
+  ): Prisma.Sql {
+    if (type === 'number') {
+      return this.buildNumberFilterOperator(
+        _operator as FilterNumberOperator,
+        value,
+        valueField
+      );
+    } else if (type === 'string') {
+      return this.buildStringFilterOperator(
+        _operator as FilterStringOperator,
+        value,
+        valueField
+      );
+    } else if (type === 'boolean') {
+      return this.buildBooleanFilterOperator(
+        _operator as FilterBooleanOperator,
+        value,
+        valueField
+      );
+    } else if (type === 'date') {
+      return this.buildDateFilterOperator(
+        _operator as FilterDateOperator,
+        value,
+        valueField
+      );
+    }
+
+    return Prisma.sql`1 = 1`;
+  }
 
+  private buildNumberFilterOperator(
+    operator: FilterNumberOperator,
+    value: FilterInfoValue | null,
+    valueField: Prisma.Sql
+  ): Prisma.Sql {
     if (operator === 'equals') {
       return Prisma.sql`${valueField} = ${castToNumber(value)}`;
     }
@@ -46,9 +101,15 @@ export function buildCommonFilterQueryOperator(
     if (operator === 'between') {
       return Prisma.sql`${valueField} BETWEEN ${castToNumber(get(value, '0'))} AND ${castToNumber(get(value, '1'))}`;
     }
-  } else if (type === 'string') {
-    const operator = _operator as FilterStringOperator;
 
+    return Prisma.sql`1 = 1`;
+  }
+
+  private buildStringFilterOperator(
+    operator: FilterStringOperator,
+    value: FilterInfoValue | null,
+    valueField: Prisma.Sql
+  ): Prisma.Sql {
     if (operator === 'equals') {
       return Prisma.sql`${valueField} = ${castToString(value)}`;
     }
@@ -67,25 +128,53 @@ export function buildCommonFilterQueryOperator(
     if (operator === 'not in list' && Array.isArray(value)) {
       return Prisma.sql`${valueField} NOT IN (${value.join(',')})`;
     }
-  } else if (type === 'boolean') {
-    const operator = _operator as FilterBooleanOperator;
 
+    return Prisma.sql`1 = 1`;
+  }
+
+  private buildBooleanFilterOperator(
+    operator: FilterBooleanOperator,
+    value: FilterInfoValue | null,
+    valueField: Prisma.Sql
+  ): Prisma.Sql {
     if (operator === 'equals') {
       return Prisma.sql`${valueField} = ${castToNumber(value)}`;
     }
     if (operator === 'not equals') {
       return Prisma.sql`${valueField} != ${castToNumber(value)}`;
     }
-  } else if (type === 'date') {
-    const operator = _operator as FilterDateOperator;
 
+    return Prisma.sql`1 = 1`;
+  }
+
+  private buildDateFilterOperator(
+    operator: FilterDateOperator,
+    value: FilterInfoValue | null,
+    valueField: Prisma.Sql
+  ): Prisma.Sql {
     if (operator === 'between') {
       return Prisma.sql`${valueField} BETWEEN ${castToDate(get(value, '0'))} AND ${castToDate(get(value, '1'))}`;
     }
     if (operator === 'in day') {
       return Prisma.sql`${valueField} = DATE(${castToDate(value)})`;
     }
+
+    return Prisma.sql`1 = 1`;
   }
+}
 
-  return Prisma.sql`1 = 1`;
+// 为了向后兼容，保留这个函数，但内部使用 InsightsSqlBuilder 的实现
+export function buildCommonFilterQueryOperator(
+  type: FilterInfoType,
+  _operator: string,
+  value: FilterInfoValue | null,
+  valueField: Prisma.Sql
+): Prisma.Sql {
+  const builder = new InsightsSqlBuilder();
+  return builder.buildCommonFilterQueryOperator(
+    type,
+    _operator,
+    value,
+    valueField
+  );
 }

src/server/model/insights/survey.spec.ts

@@ -1,13 +1,13 @@
 import { describe, expect, test } from 'vitest';
-import { buildInsightsSurveySql } from './survey.js';
+import { SurveyInsightsSqlBuilder } from './survey.js';
 import { unwrapSQL } from '../../utils/prisma.js';
 
-describe('buildInsightsSurveySql', () => {
+describe('SurveyInsightsSqlBuilder', () => {
   const insightId = 'cm658i2tqw96upkejldn8rpbs';
   const insightType = 'survey';
 
   test('groups', () => {
-    const sql = buildInsightsSurveySql(
+    const builder = new SurveyInsightsSqlBuilder(
       {
         insightId,
         insightType,
@@ -35,11 +35,12 @@ describe('buildInsightsSurveySql', () => {
       }
     );
 
+    const sql = builder.build();
     expect(unwrapSQL(sql)).toMatchSnapshot('sql');
   });
 
   test('groups with custom bucket', () => {
-    const sql = buildInsightsSurveySql(
+    const builder = new SurveyInsightsSqlBuilder(
       {
         insightId,
         insightType,
@@ -73,6 +74,7 @@ describe('buildInsightsSurveySql', () => {
       }
     );
 
+    const sql = builder.build();
     expect(unwrapSQL(sql)).toMatchSnapshot('sql');
   });
 });