add version tracking

voxel51 · Sep 24, 2024 · 75e8e87 · 75e8e87
1 parent 65cfa91
commit 75e8e87
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/app/packages/analytics/src/analytics.test.ts b/app/packages/analytics/src/analytics.test.ts
@@ -195,4 +195,18 @@ describe("Analytics", () => {
     const redacted4 = analytics.redact(undefined);
     expect(redacted4).toEqual(undefined);
   });
+
+  it("should allow setting version", () => {
+    analytics.load({
+      writeKey: "test",
+      userId: "user",
+      userGroup: "group",
+      debug: false,
+      version: "1.0.0",
+    });
+    analytics.track("custom_event");
+    expect(mockSegment.track).toHaveBeenCalledWith("custom_event", undefined, {
+      version: "1.0.0",
+    });
+  });
 });
diff --git a/app/packages/analytics/src/usingAnalytics.ts b/app/packages/analytics/src/usingAnalytics.ts
@@ -8,6 +8,7 @@ export type AnalyticsInfo = {
   debug: boolean;
   disableUrlTracking?: boolean;
   redact?: string[];
+  version?: string;
 };
 
 export type AnalyticsConfig = {
@@ -33,6 +34,7 @@ export class Analytics {
   private _debounceInterval = 1000; // Default debounce interval in milliseconds (5 seconds)
   private _disableUrlTracking = false;
   private _redactedProperties: string[] = [];
+  private _version?: string;
 
   constructor(config?: AnalyticsConfig) {
     if (config?.debounceInterval) {
@@ -75,6 +77,9 @@ export class Analytics {
     this._segment = AnalyticsBrowser.load({
       writeKey: info.writeKey,
     });
+    if (info.version) {
+      this._version = info.version;
+    }
     if (info.userId) {
       this.identify(info.userId);
     }
@@ -116,6 +121,9 @@ export class Analytics {
     if (this._disableUrlTracking) {
       opts = { context: { page: { url: undefined } } };
     }
+    if (this._version) {
+      opts = { ...opts, version: this._version };
+    }
     this._segment.track(name, properties, opts);
   }