disable analytics.page() when url tracking disabled

voxel51 · Sep 16, 2024 · 12dac08 · 12dac08
1 parent 38527cb
commit 12dac08
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 3 deletions.
diff --git a/app/packages/analytics/src/analytics.test.ts b/app/packages/analytics/src/analytics.test.ts
@@ -167,7 +167,6 @@ describe("Analytics", () => {
     });
     analytics.track("random_event", { uri: "@my_name/my_plugin/my_operator" });
     // segment should be called with properties.uri = "<redacted>"
-    console.log(mockSegment.track.mock.calls[0]);
     expect(mockSegment.track).toHaveBeenCalledWith(
       "random_event",
       { uri: "<redacted>" },
@@ -195,4 +194,30 @@ describe("Analytics", () => {
     const redacted4 = analytics.redact(undefined);
     expect(redacted4).toEqual(undefined);
   });
+
+  describe("analytics.page()", () => {
+    it("should call segment.page()", () => {
+      analytics = new Analytics();
+      analytics.load({
+        writeKey: "test",
+        userId: "user",
+        userGroup: "group",
+        debug: false,
+      });
+      analytics.page("my_page");
+      expect(mockSegment.page).toHaveBeenCalled();
+    });
+    it("should be a no-op if disableUrlTracking is set to true", () => {
+      analytics = new Analytics();
+      analytics.load({
+        writeKey: "test",
+        userId: "user",
+        userGroup: "group",
+        debug: false,
+        disableUrlTracking: true,
+      });
+      analytics.page("my_page");
+      expect(mockSegment.page).not.toHaveBeenCalled();
+    });
+  });
 });
diff --git a/app/packages/analytics/src/usingAnalytics.ts b/app/packages/analytics/src/usingAnalytics.ts
@@ -31,7 +31,7 @@ export class Analytics {
   private _debug = false;
   private _lastEventTimestamps: Record<string, number> = {}; // Tracks last event times
   private _debounceInterval = 1000; // Default debounce interval in milliseconds (5 seconds)
-  private _disableUrlTracking = false;
+  private _disableUrlTracking = false; // Disable tracking page URL and .page() calls
   private _redactedProperties: string[] = [];
 
   constructor(config?: AnalyticsConfig) {
@@ -88,7 +88,7 @@ export class Analytics {
   }
 
   page(name?: string, properties?: {}) {
-    if (!this._segment) return;
+    if (!this._segment || this._disableUrlTracking) return;
     properties = this.redact(properties);
     this._segment.page(name, properties);
   }