feat(analytics): add clickhouse (#11174)

packages/twenty-server/test/integration/analytics/suites/clickhouse-event-registration.integration-spec.ts

@@ -0,0 +1,74 @@
+import process from 'process';
+
+import request from 'supertest';
+import { createClient, ClickHouseClient } from '@clickhouse/client';
+
+import { GenericTrackEvent } from 'src/engine/core-modules/analytics/utils/events/track/track';
+import { OBJECT_RECORD_CREATED_EVENT } from 'src/engine/core-modules/analytics/utils/events/track/object-record/object-record-created';
+describe('ClickHouse Event Registration (integration)', () => {
+  let clickhouseClient: ClickHouseClient;
+
+  beforeAll(async () => {
+    jest.useRealTimers();
+
+    clickhouseClient = createClient({
+      url: process.env.CLICKHOUSE_URL,
+    });
+
+    await clickhouseClient.query({
+      query: 'TRUNCATE TABLE events',
+      format: 'JSONEachRow',
+    });
+  });
+
+  afterAll(async () => {
+    if (clickhouseClient) {
+      await clickhouseClient.close();
+    }
+  });
+
+  it('should register events in ClickHouse when sending an event', async () => {
+    const mutation = `
+      mutation TrackAnalytics($type: AnalyticsType!, $event: String, $name: String, $properties: JSON) {
+        trackAnalytics(type: $type, event: $event, name: $name, properties: $properties) {
+          success
+        }
+      }
+    `;
+
+    const variables = {
+      type: 'TRACK',
+      event: OBJECT_RECORD_CREATED_EVENT,
+      properties: {},
+    };
+
+    const response = await request(`http://localhost:${APP_PORT}`)
+      .post('/graphql')
+      .send({
+        query: mutation,
+        variables,
+      });
+
+    expect(response.status).toBe(200);
+    expect(response.body.data.trackAnalytics.success).toBe(true);
+
+    const queryResult = await clickhouseClient.query({
+      query: `
+        SELECT *
+        FROM events
+        WHERE event = '${OBJECT_RECORD_CREATED_EVENT}' AND timestamp >= now() - INTERVAL 1 SECOND
+
+      `,
+      format: 'JSONEachRow',
+    });
+
+    const rows = await queryResult.json<GenericTrackEvent>();
+
+    expect(rows.length).toEqual(1);
+    expect(rows[0].properties).toEqual(variables.properties);
+    expect(rows[0].event).toEqual(variables.event);
+    expect(rows[0].workspaceId).toEqual('');
+    expect(rows[0].userId).toEqual('');
+    expect(rows[0].timestamp).toHaveLength(23);
+  });
+});

packages/twenty-server/test/utils/analytics-context.mock.ts

@@ -0,0 +1,19 @@
+import { TrackEventName } from 'src/engine/core-modules/analytics/types/events.type';
+
+export const AnalyticsContextMock = (params?: {
+  track?:
+    | ((
+        event: TrackEventName,
+        properties: any,
+      ) => Promise<{ success: boolean }>)
+    | jest.Mock<any, any>;
+  pageview?:
+    | ((name: string, properties: any) => Promise<{ success: boolean }>)
+    | jest.Mock<any, any>;
+}) => {
+  return {
+    track: params?.track ?? jest.fn().mockResolvedValue({ success: true }),
+    pageview:
+      params?.pageview ?? jest.fn().mockResolvedValue({ success: true }),
+  };
+};