ref: Move SDKInformation integration into core prepareEvent method

Author: kamilogorek

CHANGELOG.md

@@ -9,6 +9,8 @@
 - [browser] fix: Array.from is not available in old mobile browsers
 - [browser] fix: Check for anonymous function before getting its name for mechanism
 - [browser] test: Add loader + integration tests
+- [core] ref: Move SDKInformation integration into core prepareEvent method
+- [core] ref: Move debug initialization as the first step
 
 ## 4.0.4
 

packages/browser/src/client.ts

@@ -2,6 +2,7 @@ import { API, BaseClient, Scope, SentryError } from '@sentry/core';
 import { DsnLike, SentryEvent, SentryEventHint } from '@sentry/types';
 import { getGlobalObject } from '@sentry/utils/misc';
 import { BrowserBackend, BrowserOptions } from './backend';
+import { SDK_NAME, SDK_VERSION } from './version';
 
 /**
  * All properties the report dialog supports
@@ -49,6 +50,19 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
    */
   protected async prepareEvent(event: SentryEvent, scope?: Scope, hint?: SentryEventHint): Promise<SentryEvent | null> {
     event.platform = event.platform || 'javascript';
+    event.sdk = {
+      ...event.sdk,
+      name: SDK_NAME,
+      packages: [
+        ...((event.sdk && event.sdk.packages) || []),
+        {
+          name: 'npm:@sentry/browser',
+          version: SDK_VERSION,
+        },
+      ],
+      version: SDK_VERSION,
+    };
+
     return super.prepareEvent(event, scope, hint);
   }
 

packages/browser/src/sdk.ts

@@ -3,18 +3,12 @@ import { DsnLike } from '@sentry/types';
 import { BrowserOptions } from './backend';
 import { BrowserClient } from './client';
 import { Breadcrumbs, GlobalHandlers, LinkedErrors, ReportingObserver, TryCatch, UserAgent } from './integrations';
-import { SDK_NAME, SDK_VERSION } from './version';
 
 export const defaultIntegrations = [
   // Common
   new CoreIntegrations.Dedupe(),
   new CoreIntegrations.InboundFilters(),
   new CoreIntegrations.FunctionToString(),
-  new CoreIntegrations.SDKInformation({
-    name: 'npm:@sentry/browser',
-    sdkName: SDK_NAME,
-    sdkVersion: SDK_VERSION,
-  }),
   // Native Wrappers
   new TryCatch(),
   new Breadcrumbs(),

packages/core/src/integrations/sdkinformation.ts

@@ -1,5 +1,10 @@
-import { configureScope } from '@sentry/minimal';
-import { Integration, SentryEvent } from '@sentry/types';
+import { Integration } from '@sentry/types';
+import { logger } from '../logger';
+
+/**
+ * @deprecated
+ * This file can be safely removed in the next major bump
+ */
 
 /** Adds SDK info to an event. */
 export class SDKInformation implements Integration {
@@ -8,36 +13,12 @@ export class SDKInformation implements Integration {
    */
   public name: string = 'SDKInformation';
 
-  /**
-   * @inheritDoc
-   */
-  public constructor(
-    private readonly config: {
-      name: string;
-      sdkName: string;
-      sdkVersion: string;
-    },
-  ) {}
-
   /**
    * @inheritDoc
    */
   public install(): void {
-    configureScope(scope => {
-      scope.addEventProcessor(async (event: SentryEvent) => ({
-        ...event,
-        sdk: {
-          name: this.config.sdkName,
-          packages: [
-            ...((event.sdk && event.sdk.packages) || []),
-            {
-              name: this.config.name,
-              version: this.config.sdkVersion,
-            },
-          ],
-          version: this.config.sdkVersion,
-        },
-      }));
-    });
+    logger.warn(
+      "SDKInformation Integration is deprecated and can be safely removed. It's functionality has been merged into the SDK's core.",
+    );
   }
 }

packages/node/src/client.ts

@@ -1,6 +1,7 @@
 import { BaseClient, Scope } from '@sentry/core';
 import { SentryEvent, SentryEventHint } from '@sentry/types';
 import { NodeBackend, NodeOptions } from './backend';
+import { SDK_NAME, SDK_VERSION } from './version';
 
 /**
  * The Sentry Node SDK Client.
@@ -22,9 +23,23 @@ export class NodeClient extends BaseClient<NodeBackend, NodeOptions> {
    */
   protected async prepareEvent(event: SentryEvent, scope?: Scope, hint?: SentryEventHint): Promise<SentryEvent | null> {
     event.platform = event.platform || 'node';
+    event.sdk = {
+      ...event.sdk,
+      name: SDK_NAME,
+      packages: [
+        ...((event.sdk && event.sdk.packages) || []),
+        {
+          name: 'npm:@sentry/node',
+          version: SDK_VERSION,
+        },
+      ],
+      version: SDK_VERSION,
+    };
+
     if (this.getOptions().serverName) {
       event.server_name = this.getOptions().serverName;
     }
+
     return super.prepareEvent(event, scope, hint);
   }
 }

packages/node/src/sdk.ts

@@ -2,18 +2,12 @@ import { initAndBind, Integrations as CoreIntegrations } from '@sentry/core';
 import { NodeOptions } from './backend';
 import { NodeClient } from './client';
 import { Console, Http, LinkedErrors, OnUncaughtException, OnUnhandledRejection } from './integrations';
-import { SDK_NAME, SDK_VERSION } from './version';
 
 export const defaultIntegrations = [
   // Common
   new CoreIntegrations.Dedupe(),
   new CoreIntegrations.InboundFilters(),
   new CoreIntegrations.FunctionToString(),
-  new CoreIntegrations.SDKInformation({
-    name: 'npm:@sentry/node',
-    sdkName: SDK_NAME,
-    sdkVersion: SDK_VERSION,
-  }),
   // Native Wrappers
   new Console(),
   new Http(),