cleanup and tests

Author: OmerKat

src/client.ts

@@ -159,6 +159,7 @@ export function createClient(config: CreateClientConfig): Base44Client {
       userAuthModule,
     }),
     cleanup: () => {
+      userModules.analytics.cleanup();
       if (socket) {
         socket.disconnect();
       }

src/client.types.ts

@@ -6,6 +6,7 @@ import type { ConnectorsModule } from "./modules/connectors.types.js";
 import type { FunctionsModule } from "./modules/functions.types.js";
 import type { AgentsModule } from "./modules/agents.types.js";
 import type { AppLogsModule } from "./modules/app-logs.types.js";
+import type { AnalyticsModule } from "./modules/analytics.types.js";
 
 /**
  * Options for creating a Base44 client.
@@ -85,6 +86,8 @@ export interface Base44Client {
   agents: AgentsModule;
   /** {@link AppLogsModule | App logs module} for tracking app usage. */
   appLogs: AppLogsModule;
+  /** {@link AnalyticsModule | Analytics module} for tracking app usage. */
+  analytics: AnalyticsModule;
   /** Cleanup function to disconnect WebSocket connections. Call when you're done with the client. */
   cleanup: () => void;
 

src/modules/analytics.ts

@@ -105,7 +105,7 @@ export const createAnalyticsModule = ({
   };
 
   const onDocHidden = () => {
-    analyticsSharedState.isProcessing = false;
+    stopAnalyticsProcessor();
     //  flush entire queue on visibility change and hope for the best //
     const eventsData = analyticsSharedState.requestsQueue.splice(0);
     flush(eventsData);
@@ -139,11 +139,22 @@ export const createAnalyticsModule = ({
     });
   }
 
+  const cleanup = () => {
+    if (typeof window === "undefined") return;
+    window.removeEventListener("visibilitychange", onVisibilityChange);
+    stopAnalyticsProcessor();
+  };
+
   return {
     track,
+    cleanup,
   };
 };
 
+function stopAnalyticsProcessor() {
+  analyticsSharedState.isProcessing = false;
+}
+
 async function startAnalyticsProcessor(
   handleTrack: (eventsData: TrackEventData[]) => Promise<void>,
   options?: {

tests/unit/analytics.test.ts

@@ -0,0 +1,63 @@
+import { describe, test, expect, beforeEach, afterEach, vi } from "vitest";
+import {
+  AnalyticsModuleOptions,
+  createClient,
+  SessionContext,
+  TrackEventData,
+} from "../../src/index.ts";
+import { getSharedInstance } from "../../src/utils/sharedInstance.ts";
+
+describe("Analytics Module", () => {
+  let base44: ReturnType<typeof createClient>;
+  let sharedState: null | {
+    requestsQueue: TrackEventData[];
+    isProcessing: boolean;
+    sessionContext: SessionContext;
+    config: AnalyticsModuleOptions;
+  };
+  const appId = "test-app-id";
+  const serverUrl = "https://api.base44.com";
+
+  beforeEach(() => {
+    base44 = createClient({
+      serverUrl,
+      appId,
+    });
+    sharedState = getSharedInstance("analytics", () => ({
+      requestsQueue: [],
+      isProcessing: false,
+      sessionContext: {
+        user_id: "test-user-id",
+      },
+      config: {
+        enabled: true,
+        maxQueueSize: 1000,
+        throttleTime: 1000,
+        batchSize: 30,
+      },
+    }));
+  });
+
+  afterEach(() => {
+    base44.cleanup();
+    sharedState = null;
+  });
+
+  test("should create analytics module with shared state", () => {
+    expect(base44.analytics).toBeDefined();
+    expect(sharedState).toBeDefined();
+    expect(sharedState?.requestsQueue).toBeDefined();
+    expect(sharedState?.isProcessing).toBe(true);
+  });
+
+  test("should track an event", () => {
+    vi.spyOn(base44.analytics, "track").mockImplementation(() => {
+      console.log("track called");
+    });
+
+    base44.analytics.track({ eventName: "test-event" });
+    expect(base44.analytics.track).toHaveBeenCalledWith({
+      eventName: "test-event",
+    });
+  });
+});

tests/unit/client.test.js

@@ -12,6 +12,7 @@ describe('Client Creation', () => {
     expect(client.entities).toBeDefined();
     expect(client.integrations).toBeDefined();
     expect(client.auth).toBeDefined();
+    expect(client.analytics).toBeDefined();
 
     const config = client.getConfig();
     expect(config.appId).toBe('test-app-id');