feat(core): Add addIntegration utility

To make it easier to async add integrations later, which is useful e.g. for replay but also for other cases.

Author: mydea

packages/browser/src/exports.ts

@@ -23,6 +23,7 @@ export type { ReportDialogOptions } from './helpers';
 export {
   addGlobalEventProcessor,
   addBreadcrumb,
+  addIntegration,
   captureException,
   captureEvent,
   captureMessage,

packages/bun/src/index.ts

@@ -26,6 +26,7 @@ export type { BunOptions } from './types';
 export {
   addGlobalEventProcessor,
   addBreadcrumb,
+  addIntegration,
   captureException,
   captureEvent,
   captureMessage,

packages/core/src/index.ts

@@ -46,7 +46,7 @@ export { createTransport } from './transports/base';
 export { makeOfflineTransport } from './transports/offline';
 export { makeMultiplexedTransport } from './transports/multiplexed';
 export { SDK_VERSION } from './version';
-export { getIntegrationsToSetup } from './integration';
+export { getIntegrationsToSetup, addIntegration } from './integration';
 export { FunctionToString, InboundFilters } from './integrations';
 export { prepareEvent } from './utils/prepareEvent';
 export { createCheckInEnvelope } from './checkin';

packages/core/src/integration.ts

@@ -124,6 +124,18 @@ export function setupIntegration(client: Client, integration: Integration, integ
   __DEBUG_BUILD__ && logger.log(`Integration installed: ${integration.name}`);
 }
 
+/** Add an integration to the current hub's client. */
+export function addIntegration(integration: Integration): void {
+  const client = getCurrentHub().getClient();
+
+  if (!client || !client.addIntegration) {
+    __DEBUG_BUILD__ && logger.warn(`Cannot add integration "${integration.name}" because no SDK Client is available.`);
+    return;
+  }
+
+  client.addIntegration(integration);
+}
+
 // Polyfill for Array.findIndex(), which is not supported in ES5
 function findIndex<T>(arr: T[], callback: (item: T) => boolean): number {
   for (let i = 0; i < arr.length; i++) {

packages/core/test/lib/base.test.ts

@@ -78,6 +78,9 @@ describe('BaseClient', () => {
     });
 
     test('handles being passed an invalid Dsn', () => {
+      // Hide warning logs in the test
+      jest.spyOn(console, 'error').mockImplementation(() => {});
+
       const options = getDefaultTestClientOptions({ dsn: 'abc' });
       const client = new TestClient(options);
 

packages/core/test/lib/integration.test.ts

@@ -1,6 +1,8 @@
 import type { Integration, Options } from '@sentry/types';
+import { logger } from '@sentry/utils';
 
-import { getIntegrationsToSetup, installedIntegrations, setupIntegration } from '../../src/integration';
+import { Hub, makeMain } from '../../src/hub';
+import { addIntegration, getIntegrationsToSetup, installedIntegrations, setupIntegration } from '../../src/integration';
 import { getDefaultTestClientOptions, TestClient } from '../mocks/client';
 
 function getTestClient(): TestClient {
@@ -559,3 +561,51 @@ describe('setupIntegration', () => {
     expect(sendEvent).not.toHaveBeenCalled();
   });
 });
+
+describe('addIntegration', () => {
+  beforeEach(function () {
+    // Reset the (global!) list of installed integrations
+    installedIntegrations.splice(0, installedIntegrations.length);
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('works with a client setup', () => {
+    const warnings = jest.spyOn(logger, 'warn');
+
+    class CustomIntegration implements Integration {
+      name = 'test';
+      setupOnce = jest.fn();
+    }
+
+    const client = getTestClient();
+    const hub = new Hub(client);
+    makeMain(hub);
+
+    const integration = new CustomIntegration();
+    addIntegration(integration);
+
+    expect(integration.setupOnce).toHaveBeenCalledTimes(1);
+    expect(warnings).not.toHaveBeenCalled();
+  });
+
+  it('works without a client setup', () => {
+    const warnings = jest.spyOn(logger, 'warn');
+    class CustomIntegration implements Integration {
+      name = 'test';
+      setupOnce = jest.fn();
+    }
+
+    const hub = new Hub();
+    makeMain(hub);
+
+    const integration = new CustomIntegration();
+    addIntegration(integration);
+
+    expect(integration.setupOnce).not.toHaveBeenCalled();
+    expect(warnings).toHaveBeenCalledTimes(1);
+    expect(warnings).toHaveBeenCalledWith('Cannot add integration "test" because no SDK Client is available.');
+  });
+});

packages/core/test/lib/transports/multiplexed.test.ts

@@ -88,6 +88,9 @@ describe('makeMultiplexedTransport', () => {
   });
 
   it('Falls back to options DSN when a matched DSN is invalid', async () => {
+    // Hide warning logs in the test
+    jest.spyOn(console, 'error').mockImplementation(() => {});
+
     expect.assertions(1);
 
     const makeTransport = makeMultiplexedTransport(
@@ -99,6 +102,8 @@ describe('makeMultiplexedTransport', () => {
 
     const transport = makeTransport({ url: DSN1_URL, ...transportOptions });
     await transport.send(ERROR_ENVELOPE);
+
+    jest.clearAllMocks();
   });
 
   it('DSN can be overridden via match callback', async () => {

packages/node/src/index.ts

@@ -26,6 +26,7 @@ export type { NodeOptions } from './types';
 export {
   addGlobalEventProcessor,
   addBreadcrumb,
+  addIntegration,
   captureException,
   captureEvent,
   captureMessage,

packages/serverless/src/index.ts

@@ -15,6 +15,7 @@ export {
   Scope,
   addBreadcrumb,
   addGlobalEventProcessor,
+  addIntegration,
   autoDiscoverNodePerformanceMonitoringIntegrations,
   captureEvent,
   captureException,

packages/sveltekit/src/server/index.ts

@@ -6,6 +6,7 @@
 export {
   addGlobalEventProcessor,
   addBreadcrumb,
+  addIntegration,
   captureException,
   captureEvent,
   captureMessage,