test(integrations): Add unit tests for Debug

Author: Luca Forstner

packages/integrations/src/debug.ts

@@ -1,13 +1,17 @@
 import { Event, EventHint, EventProcessor, Hub, Integration } from '@sentry/types';
 import { consoleSandbox } from '@sentry/utils';
 
-/** JSDoc */
 interface DebugOptions {
+  /** Controls whether console output created by this integration should be stringified. Default: `false` */
   stringify?: boolean;
+  /** Controls whether a debugger should be launched before an event is sent. Default: `false` */
   debugger?: boolean;
 }
 
-/** JSDoc */
+/**
+ * Integration to debug sent Sentry events.
+ * This integration should not be used in production
+ */
 export class Debug implements Integration {
   /**
    * @inheritDoc
@@ -19,12 +23,8 @@ export class Debug implements Integration {
    */
   public name: string = Debug.id;
 
-  /** JSDoc */
   private readonly _options: DebugOptions;
 
-  /**
-   * @inheritDoc
-   */
   public constructor(options?: DebugOptions) {
     this._options = {
       debugger: false,

packages/integrations/test/debug.test.ts

@@ -0,0 +1,78 @@
+import { EventProcessor, Integration } from '@sentry/types';
+
+import { Debug } from '../src/debug';
+
+const mockGetCurrentHub = (getIntegrationResult: Integration) => ({
+  getIntegration: jest.fn(() => getIntegrationResult),
+});
+
+// Replace console log with a mock so we can check for invocations
+const mockConsoleLog = jest.fn();
+const originalConsoleLog = global.console.log;
+global.console.log = mockConsoleLog;
+
+describe('Debug integration setup should register an event processor that', () => {
+  afterAll(() => {
+    // Reset mocked console log to original one
+    global.console.log = originalConsoleLog;
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('logs an event', () => {
+    const debugIntegration = new Debug();
+
+    const captureEventProcessor = (eventProcessor: EventProcessor) => {
+      const testEvent = { event_id: 'some event' };
+      void eventProcessor(testEvent);
+      expect(mockConsoleLog).toHaveBeenCalledTimes(1);
+      expect(mockConsoleLog).toBeCalledWith(testEvent);
+    };
+
+    debugIntegration.setupOnce(captureEventProcessor, () => mockGetCurrentHub(debugIntegration) as any);
+  });
+
+  it('logs an event hint if available', () => {
+    const debugIntegration = new Debug();
+
+    const captureEventProcessor = (eventProcessor: EventProcessor) => {
+      const testEvent = { event_id: 'some event' };
+      const testEventHint = { event_id: 'some event hint' };
+      void eventProcessor(testEvent, testEventHint);
+      expect(mockConsoleLog).toHaveBeenCalledTimes(2);
+      expect(mockConsoleLog).toBeCalledWith(testEvent);
+      expect(mockConsoleLog).toBeCalledWith(testEventHint);
+    };
+
+    debugIntegration.setupOnce(captureEventProcessor, () => mockGetCurrentHub(debugIntegration) as any);
+  });
+
+  it('logs events in stringified format when `stringify` option was set', () => {
+    const debugIntegration = new Debug({ stringify: true });
+
+    const captureEventProcessor = (eventProcessor: EventProcessor) => {
+      const testEvent = { event_id: 'some event' };
+      void eventProcessor(testEvent);
+      expect(mockConsoleLog).toHaveBeenCalledTimes(1);
+      expect(mockConsoleLog).toBeCalledWith(JSON.stringify(testEvent, null, 2));
+    };
+
+    debugIntegration.setupOnce(captureEventProcessor, () => mockGetCurrentHub(debugIntegration) as any);
+  });
+
+  it('logs event hints in stringified format when `stringify` option was set', () => {
+    const debugIntegration = new Debug({ stringify: true });
+
+    const captureEventProcessor = (eventProcessor: EventProcessor) => {
+      const testEvent = { event_id: 'some event' };
+      const testEventHint = { event_id: 'some event hint' };
+      void eventProcessor(testEvent, testEventHint);
+      expect(mockConsoleLog).toHaveBeenCalledTimes(2);
+      expect(mockConsoleLog).toBeCalledWith(JSON.stringify(testEventHint, null, 2));
+    };
+
+    debugIntegration.setupOnce(captureEventProcessor, () => mockGetCurrentHub(debugIntegration) as any);
+  });
+});