fix(shared): Disable telemetry collection from browser controlled via…

… automation
clerk · Dec 22, 2023 · c7aba82 · c7aba82
1 parent 4b85989
commit c7aba82
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/.changeset/happy-dolls-taste.md b/.changeset/happy-dolls-taste.md
@@ -0,0 +1,5 @@
+---
+'@clerk/shared': patch
+---
+
+Disable telemetry collection when window.navigator.webdriver is defined, indicating traffic from an automation tool.
diff --git a/packages/shared/src/telemetry/collector.ts b/packages/shared/src/telemetry/collector.ts
@@ -91,6 +91,13 @@ export class TelemetryCollector {
       return false;
     }
 
+    // navigator.webdriver is a property generally set by headless browsers that are running in an automated testing environment.
+    // Data from these environments is not meaningful for us and has the potential to produce a large volume of events, so we disable
+    // collection in this case. (ref: https://developer.mozilla.org/en-US/docs/Web/API/Navigator/webdriver)
+    if (typeof window !== 'undefined' && !!window?.navigator?.webdriver) {
+      return false;
+    }
+
     return true;
   }