fix: Refresh and update all relevant tests

Author: kamilogorek

packages/browser/test/unit/index.test.ts

@@ -190,7 +190,7 @@ describe('SentryBrowser initialization', () => {
       init({ dsn });
 
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const sdkData = (getCurrentHub().getClient() as any)._backend._transport._api.metadata?.sdk;
+      const sdkData = (getCurrentHub().getClient() as any)._backend._transport._api.sdkInfo;
 
       expect(sdkData.name).to.equal('sentry.javascript.browser');
       expect(sdkData.packages[0].name).to.equal('npm:@sentry/browser');
@@ -202,7 +202,7 @@ describe('SentryBrowser initialization', () => {
       const client = new BrowserClient({ dsn });
 
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const sdkData = (client as any)._backend._transport._api.metadata?.sdk;
+      const sdkData = (client as any)._backend._transport._api.sdkInfo;
 
       expect(sdkData.name).to.equal('sentry.javascript.browser');
       expect(sdkData.packages[0].name).to.equal('npm:@sentry/browser');
@@ -216,7 +216,7 @@ describe('SentryBrowser initialization', () => {
       init({
         dsn,
         // this would normally be set by the wrapper SDK in init()
-        _metadata: {
+        _internal: {
           sdk: {
             name: 'sentry.javascript.angular',
             packages: [
@@ -231,7 +231,7 @@ describe('SentryBrowser initialization', () => {
       });
 
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const sdkData = (getCurrentHub().getClient() as any)._backend._transport._api.metadata?.sdk;
+      const sdkData = (getCurrentHub().getClient() as any)._backend._transport._api.sdkInfo;
 
       expect(sdkData.name).to.equal('sentry.javascript.angular');
       expect(sdkData.packages[0].name).to.equal('npm:@sentry/angular');

packages/core/src/baseclient.ts

@@ -87,6 +87,15 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
   protected constructor(backendClass: BackendClass<B, O>, options: O) {
     this._backend = new backendClass(options);
     this._options = options;
+    this._options._internal = this._options._internal || {};
+
+    // Both `defaultIntegrations` and `discoverIntegrations` should be `boolean`, but we are stuck with this type
+    // for backwards compatibility at the momement.
+    if (options.defaultIntegrations !== false) {
+      this._options._internal.defaultIntegrations = Array.isArray(this._options.defaultIntegrations)
+        ? this._options.defaultIntegrations
+        : [];
+    }
 
     if (options.dsn) {
       this._dsn = new Dsn(options.dsn);

packages/core/src/integration.ts

@@ -10,26 +10,37 @@ export interface IntegrationIndex {
 }
 
 /** Gets integration to install */
-export function getIntegrationsToSetup(options: Options): Integration[] {
-  const defaultIntegrations = options._internal?.defaultIntegrations || [];
-  const discoveredIntegrations = options._internal?.discoveredIntegrations || [];
-  const userIntegrations = options.integrations || [];
+export function getIntegrationsToSetup(integrations: {
+  defaultIntegrations?: Integration[];
+  discoveredIntegrations?: Integration[];
+  userIntegrations?: Integration[] | ((integrations: Integration[]) => Integration[]);
+}): Integration[] {
+  const { discoveredIntegrations = [], userIntegrations = [] } = integrations;
+  let { defaultIntegrations = [] } = integrations;
+
+  // And filter out duplicated default integrations
+  defaultIntegrations = defaultIntegrations.reduce((acc, defaultIntegration) => {
+    if (acc.every(accIntegration => defaultIntegration.name !== accIntegration.name)) {
+      acc.push(defaultIntegration);
+    }
+    return acc;
+  }, [] as Integration[]);
 
   // Filter out default integrations that are also discovered
-  let integrations: Integration[] = [
+  let processedIntegrations: Integration[] = [
     ...defaultIntegrations.filter(defaultIntegration =>
       discoveredIntegrations.every(discoveredIntegration => discoveredIntegration.name !== defaultIntegration.name),
     ),
     ...discoveredIntegrations,
   ];
 
   if (Array.isArray(userIntegrations)) {
-    // Filter out integrations that are also included in user options
-    integrations = [
-      ...integrations.filter(integrations =>
-        userIntegrations.every(userIntegration => userIntegration.name !== integrations.name),
+    // Filter out integrations that are also included in user integrations
+    processedIntegrations = [
+      ...processedIntegrations.filter(integrations =>
+        (userIntegrations as Integration[]).every(userIntegration => userIntegration.name !== integrations.name),
       ),
-      // And filter out duplicated user options integrations
+      // And filter out duplicated user integrations
       ...userIntegrations.reduce((acc, userIntegration) => {
         if (acc.every(accIntegration => userIntegration.name !== accIntegration.name)) {
           acc.push(userIntegration);
@@ -38,11 +49,11 @@ export function getIntegrationsToSetup(options: Options): Integration[] {
       }, [] as Integration[]),
     ];
   } else if (typeof userIntegrations === 'function') {
-    integrations = userIntegrations(integrations);
-    integrations = Array.isArray(integrations) ? integrations : [integrations];
+    processedIntegrations = userIntegrations(processedIntegrations);
+    processedIntegrations = Array.isArray(processedIntegrations) ? processedIntegrations : [processedIntegrations];
   }
 
-  return integrations;
+  return processedIntegrations;
 }
 
 /** Setup given integration */
@@ -63,7 +74,11 @@ export function setupIntegration(integration: Integration): void {
  */
 export function setupIntegrations(options: Options): IntegrationIndex {
   const integrations: IntegrationIndex = {};
-  getIntegrationsToSetup(options).forEach(integration => {
+  getIntegrationsToSetup({
+    defaultIntegrations: options._internal?.defaultIntegrations || [],
+    discoveredIntegrations: options._internal?.discoveredIntegrations || [],
+    userIntegrations: options.integrations || [],
+  }).forEach(integration => {
     integrations[integration.name] = integration;
     setupIntegration(integration);
   });

packages/core/src/request.ts

@@ -2,15 +2,6 @@ import { Event, SdkInfo, SentryRequest, Session } from '@sentry/types';
 
 import { API } from './api';
 
-/** Extract sdk info from from the API metadata */
-function getSdkInfoForEnvelopeHeader(api: API): SdkInfo | undefined {
-  if (!api.sdkInfo) {
-    return;
-  }
-  const { name, version } = api.sdkInfo;
-  return { name, version };
-}
-
 /**
  * Apply SdkInfo (name, version, packages, integrations) to the corresponding event key.
  * Merge with existing data if any.
@@ -29,10 +20,9 @@ function enhanceEventWithSdkInfo(event: Event, sdkInfo?: SdkInfo): Event {
 
 /** Creates a SentryRequest from a Session. */
 export function sessionToSentryRequest(session: Session, api: API): SentryRequest {
-  const sdkInfo = getSdkInfoForEnvelopeHeader(api);
   const envelopeHeaders = JSON.stringify({
     sent_at: new Date().toISOString(),
-    ...(sdkInfo && { sdk: sdkInfo }),
+    ...(api.sdkInfo && { sdk: api.sdkInfo }),
   });
   const itemHeaders = JSON.stringify({
     type: 'session',
@@ -47,7 +37,6 @@ export function sessionToSentryRequest(session: Session, api: API): SentryReques
 
 /** Creates a SentryRequest from an event. */
 export function eventToSentryRequest(event: Event, api: API): SentryRequest {
-  const sdkInfo = getSdkInfoForEnvelopeHeader(api);
   const eventType = event.type || 'event';
   const useEnvelope = eventType === 'transaction';
 
@@ -60,7 +49,7 @@ export function eventToSentryRequest(event: Event, api: API): SentryRequest {
   }
 
   const req: SentryRequest = {
-    body: JSON.stringify(sdkInfo ? enhanceEventWithSdkInfo(event, sdkInfo) : event),
+    body: JSON.stringify(api.sdkInfo ? enhanceEventWithSdkInfo(event, api.sdkInfo) : event),
     type: eventType,
     url: useEnvelope ? api.getEnvelopeEndpointWithUrlEncodedAuth() : api.getStoreEndpointWithUrlEncodedAuth(),
   };
@@ -75,7 +64,12 @@ export function eventToSentryRequest(event: Event, api: API): SentryRequest {
     const envelopeHeaders = JSON.stringify({
       event_id: event.event_id,
       sent_at: new Date().toISOString(),
-      ...(sdkInfo && { sdk: sdkInfo }),
+      ...(api.sdkInfo && {
+        sdk: {
+          name: api.sdkInfo.name,
+          version: api.sdkInfo.version,
+        },
+      }),
     });
     const itemHeaders = JSON.stringify({
       type: event.type,

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

@@ -18,31 +18,31 @@ class MockIntegration implements Integration {
 describe('getIntegrationsToSetup', () => {
   it('works with empty array', () => {
     const integrations = getIntegrationsToSetup({
-      integrations: [],
+      userIntegrations: [],
     });
 
     expect(integrations.map(i => i.name)).toEqual([]);
   });
 
   it('works with single item', () => {
     const integrations = getIntegrationsToSetup({
-      integrations: [new MockIntegration('foo')],
+      userIntegrations: [new MockIntegration('foo')],
     });
 
     expect(integrations.map(i => i.name)).toEqual(['foo']);
   });
 
   it('works with multiple items', () => {
     const integrations = getIntegrationsToSetup({
-      integrations: [new MockIntegration('foo'), new MockIntegration('bar')],
+      userIntegrations: [new MockIntegration('foo'), new MockIntegration('bar')],
     });
 
     expect(integrations.map(i => i.name)).toEqual(['foo', 'bar']);
   });
 
   it('filter duplicated items', () => {
     const integrations = getIntegrationsToSetup({
-      integrations: [new MockIntegration('foo'), new MockIntegration('foo'), new MockIntegration('bar')],
+      userIntegrations: [new MockIntegration('foo'), new MockIntegration('foo'), new MockIntegration('bar')],
     });
 
     expect(integrations.map(i => i.name)).toEqual(['foo', 'bar']);
@@ -55,7 +55,7 @@ describe('getIntegrationsToSetup', () => {
     (second as any).order = 'second';
 
     const integrations = getIntegrationsToSetup({
-      integrations: [first, second, new MockIntegration('bar')],
+      userIntegrations: [first, second, new MockIntegration('bar')],
     });
 
     expect(integrations.map(i => i.name)).toEqual(['foo', 'bar']);
@@ -89,7 +89,7 @@ describe('getIntegrationsToSetup', () => {
   it('work with user integrations and defaults and pick defaults first', () => {
     const integrations = getIntegrationsToSetup({
       defaultIntegrations: [new MockIntegration('foo')],
-      integrations: [new MockIntegration('bar')],
+      userIntegrations: [new MockIntegration('bar')],
     });
 
     expect(integrations.map(i => i.name)).toEqual(['foo', 'bar']);
@@ -98,7 +98,7 @@ describe('getIntegrationsToSetup', () => {
   it('work with user integrations and defaults and filter duplicates', () => {
     const integrations = getIntegrationsToSetup({
       defaultIntegrations: [new MockIntegration('foo'), new MockIntegration('foo')],
-      integrations: [new MockIntegration('bar'), new MockIntegration('bar')],
+      userIntegrations: [new MockIntegration('bar'), new MockIntegration('bar')],
     });
 
     expect(integrations.map(i => i.name)).toEqual(['foo', 'bar']);
@@ -116,34 +116,11 @@ describe('getIntegrationsToSetup', () => {
 
     const integrations = getIntegrationsToSetup({
       defaultIntegrations: [firstDefault, secondDefault],
-      integrations: [firstUser, secondUser],
+      userIntegrations: [firstUser, secondUser],
     });
 
     expect(integrations.map(i => i.name)).toEqual(['foo', 'bar']);
     expect((integrations[0] as any).order).toEqual('firstUser');
     expect((integrations[1] as any).order).toEqual('secondUser');
   });
-
-  it('always moves Debug integration to the end of the list', () => {
-    let integrations = getIntegrationsToSetup({
-      defaultIntegrations: [new MockIntegration('Debug'), new MockIntegration('foo')],
-      integrations: [new MockIntegration('bar')],
-    });
-
-    expect(integrations.map(i => i.name)).toEqual(['foo', 'bar', 'Debug']);
-
-    integrations = getIntegrationsToSetup({
-      defaultIntegrations: [new MockIntegration('foo')],
-      integrations: [new MockIntegration('Debug'), new MockIntegration('bar')],
-    });
-
-    expect(integrations.map(i => i.name)).toEqual(['foo', 'bar', 'Debug']);
-
-    integrations = getIntegrationsToSetup({
-      defaultIntegrations: [new MockIntegration('Debug')],
-      integrations: [new MockIntegration('foo')],
-    });
-
-    expect(integrations.map(i => i.name)).toEqual(['foo', 'Debug']);
-  });
 });

packages/core/test/lib/request.test.ts

@@ -15,12 +15,10 @@ describe('eventToSentryRequest', () => {
   }
 
   const api = new API('https://[email protected]/12312012', {
-    sdk: {
-      integrations: ['AWSLambda'],
-      name: 'sentry.javascript.browser',
-      version: `12.31.12`,
-      packages: [{ name: 'npm:@sentry/browser', version: `12.31.12` }],
-    },
+    integrations: ['AWSLambda'],
+    name: 'sentry.javascript.browser',
+    version: `12.31.12`,
+    packages: [{ name: 'npm:@sentry/browser', version: `12.31.12` }],
   });
   let event: Event;
 

packages/gatsby/test/gatsby-browser.test.ts

@@ -47,7 +47,7 @@ describe('onClientEntry', () => {
       integrations: [],
       release: (global as any).__SENTRY_RELEASE__,
       autoSessionTracking: true,
-      _metadata: {
+      _internal: {
         sdk: {
           name: 'sentry.javascript.gatsby',
           packages: [