chore(shared): Add additional test cases

Author: brkalow

packages/shared/src/__tests__/telemetry.test.ts

@@ -2,13 +2,33 @@ import { TelemetryCollector } from '../telemetry';
 
 jest.useFakeTimers();
 
+const TEST_PK = 'pk_test_Zm9vLWJhci0xMy5jbGVyay5hY2NvdW50cy5kZXYk';
+
 describe('TelemetryCollector', () => {
   test('does nothing when disabled', async () => {
     const fetchSpy = jest.spyOn(global, 'fetch');
 
     const collector = new TelemetryCollector({
       disabled: true,
-      publishableKey: 'pk_test_Zm9vLWJhci0xMy5jbGVyay5hY2NvdW50cy5kZXYk',
+      publishableKey: TEST_PK,
+    });
+
+    collector.record('TEST_EVENT', {});
+
+    jest.runAllTimers();
+
+    expect(fetchSpy).not.toHaveBeenCalled();
+
+    fetchSpy.mockRestore();
+  });
+
+  test('does nothing when CLERK_TELEMETRY_DISABLED is set', async () => {
+    process.env.CLERK_TELEMETRY_DISABLED = '1';
+
+    const fetchSpy = jest.spyOn(global, 'fetch');
+
+    const collector = new TelemetryCollector({
+      publishableKey: TEST_PK,
     });
 
     collector.record('TEST_EVENT', {});
@@ -18,6 +38,8 @@ describe('TelemetryCollector', () => {
     expect(fetchSpy).not.toHaveBeenCalled();
 
     fetchSpy.mockRestore();
+
+    process.env.CLERK_TELEMETRY_DISABLED = undefined;
   });
 
   test('does not send events when debug is enabled, logs them instead', async () => {
@@ -26,7 +48,7 @@ describe('TelemetryCollector', () => {
 
     const collector = new TelemetryCollector({
       debug: true,
-      publishableKey: 'pk_test_Zm9vLWJhci0xMy5jbGVyay5hY2NvdW50cy5kZXYk',
+      publishableKey: TEST_PK,
     });
 
     collector.record('TEST_EVENT', {});
@@ -55,11 +77,49 @@ describe('TelemetryCollector', () => {
     fetchSpy.mockRestore();
   });
 
+  test('enables debug via environment variable', async () => {
+    process.env.CLERK_TELEMETRY_DEBUG = '1';
+
+    const fetchSpy = jest.spyOn(global, 'fetch');
+    const consoleSpy = jest.spyOn(global.console, 'log');
+
+    const collector = new TelemetryCollector({
+      publishableKey: TEST_PK,
+    });
+
+    collector.record('TEST_EVENT', {});
+
+    jest.runAllTimers();
+
+    expect(fetchSpy).not.toHaveBeenCalled();
+
+    expect(consoleSpy.mock.calls).toMatchInlineSnapshot(`
+      [
+        [
+          {
+            "cv": "",
+            "event": "TEST_EVENT",
+            "it": "development",
+            "payload": {},
+            "pk": "pk_test_Zm9vLWJhci0xMy5jbGVyay5hY2NvdW50cy5kZXYk",
+            "sdk": undefined,
+            "sdkv": undefined,
+          },
+        ],
+      ]
+    `);
+
+    consoleSpy.mockRestore();
+    fetchSpy.mockRestore();
+
+    process.env.CLERK_TELEMETRY_DEBUG = undefined;
+  });
+
   test('sends events after a delay when buffer is not full', async () => {
     const fetchSpy = jest.spyOn(global, 'fetch');
 
     const collector = new TelemetryCollector({
-      publishableKey: 'pk_test_Zm9vLWJhci0xMy5jbGVyay5hY2NvdW50cy5kZXYk',
+      publishableKey: TEST_PK,
     });
 
     collector.record('TEST_EVENT', {});
@@ -76,7 +136,7 @@ describe('TelemetryCollector', () => {
 
     const collector = new TelemetryCollector({
       maxBufferSize: 2,
-      publishableKey: 'pk_test_Zm9vLWJhci0xMy5jbGVyay5hY2NvdW50cy5kZXYk',
+      publishableKey: TEST_PK,
     });
 
     collector.record('TEST_EVENT', {});

packages/shared/src/telemetry.ts

@@ -141,6 +141,10 @@ export class TelemetryCollector {
     return true;
   }
 
+  get isDebug(): boolean {
+    return this.#config.debug || (typeof process !== 'undefined' && isTruthy(process.env.CLERK_TELEMETRY_DEBUG));
+  }
+
   record(event: TelemetryEvent['event'], payload: TelemetryEvent['payload']) {
     const preparedPayload = this.#preparePayload(event, payload);
 
@@ -156,7 +160,7 @@ export class TelemetryCollector {
   }
 
   #shouldRecord(): boolean {
-    return this.isEnabled && !this.#config.debug && Math.random() <= this.#config.samplingRate;
+    return this.isEnabled && !this.isDebug && Math.random() <= this.#config.samplingRate;
   }
 
   #scheduleFlush(): void {
@@ -215,7 +219,7 @@ export class TelemetryCollector {
    * If running in debug mode, log the event and its payload to the console.
    */
   #logEvent(event: TelemetryEvent['event'], payload: Record<string, any>) {
-    if (!this.#config.debug) {
+    if (!this.isDebug) {
       return;
     }