feat: Allow for attaching metadata and pass it to the API and transports (#3177)

* feat: Allow for attaching metadata and pass it to the API and transports

Author: kamilogorek

packages/angular/src/errorhandler.ts

@@ -29,25 +29,6 @@ class SentryErrorHandler implements AngularErrorHandler {
       logErrors: true,
       ...options,
     };
-
-    Sentry.configureScope(scope => {
-      scope.addEventProcessor(event => {
-        event.sdk = {
-          ...event.sdk,
-          name: 'sentry.javascript.angular',
-          packages: [
-            ...((event.sdk && event.sdk.packages) || []),
-            {
-              name: 'npm:@sentry/angular',
-              version: Sentry.SDK_VERSION,
-            },
-          ],
-          version: Sentry.SDK_VERSION,
-        };
-
-        return event;
-      });
-    });
   }
 
   /**

packages/angular/src/index.ts

@@ -1,4 +1,6 @@
 export * from '@sentry/browser';
+
+export { init } from './sdk';
 export { createErrorHandler, ErrorHandlerOptions } from './errorhandler';
 export {
   getActiveTransaction,

packages/angular/src/sdk.ts

@@ -0,0 +1,19 @@
+import { BrowserOptions, init as browserInit, SDK_VERSION } from '@sentry/browser';
+
+/**
+ * Inits the Angular SDK
+ */
+export function init(options: BrowserOptions): void {
+  options._metadata = options._metadata || {};
+  options._metadata.sdk = {
+    name: 'sentry.javascript.angular',
+    packages: [
+      {
+        name: 'npm:@sentry/angular',
+        version: SDK_VERSION,
+      },
+    ],
+    version: SDK_VERSION,
+  };
+  browserInit(options);
+}

packages/browser/package.json

@@ -81,7 +81,6 @@
     "size:check": "run-p size:check:es5 size:check:es6",
     "size:check:es5": "cat build/bundle.min.js | gzip -9 | wc -c | awk '{$1=$1/1024; print \"ES5: \",$1,\"kB\";}'",
     "size:check:es6": "cat build/bundle.es6.min.js | gzip -9 | wc -c | awk '{$1=$1/1024; print \"ES6: \",$1,\"kB\";}'",
-    "version": "node ../../scripts/versionbump.js src/version.ts",
     "pack": "npm pack"
   },
   "volta": {

packages/browser/src/backend.ts

@@ -67,6 +67,7 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
     const transportOptions = {
       ...this._options.transportOptions,
       dsn: this._options.dsn,
+      _metadata: this._options._metadata,
     };
 
     if (this._options.transport) {

packages/browser/src/client.ts

@@ -5,7 +5,6 @@ import { getGlobalObject, logger } from '@sentry/utils';
 import { BrowserBackend, BrowserOptions } from './backend';
 import { injectReportDialog, ReportDialogOptions } from './helpers';
 import { Breadcrumbs } from './integrations';
-import { SDK_NAME, SDK_VERSION } from './version';
 
 /**
  * The Sentry Browser SDK Client.
@@ -51,19 +50,6 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
    */
   protected _prepareEvent(event: Event, scope?: Scope, hint?: EventHint): PromiseLike<Event | 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/exports.ts

@@ -28,6 +28,7 @@ export {
   makeMain,
   Scope,
   startTransaction,
+  SDK_VERSION,
   setContext,
   setExtra,
   setExtras,
@@ -42,4 +43,4 @@ export { BrowserClient } from './client';
 export { injectReportDialog, ReportDialogOptions } from './helpers';
 export { eventFromException, eventFromMessage } from './eventbuilder';
 export { defaultIntegrations, forceLoad, init, lastEventId, onLoad, showReportDialog, flush, close, wrap } from './sdk';
-export { SDK_NAME, SDK_VERSION } from './version';
+export { SDK_NAME } from './version';

packages/browser/src/sdk.ts

@@ -1,4 +1,4 @@
-import { getCurrentHub, initAndBind, Integrations as CoreIntegrations } from '@sentry/core';
+import { getCurrentHub, initAndBind, Integrations as CoreIntegrations, SDK_VERSION } from '@sentry/core';
 import { getGlobalObject, SyncPromise } from '@sentry/utils';
 
 import { BrowserOptions } from './backend';
@@ -88,6 +88,18 @@ export function init(options: BrowserOptions = {}): void {
     options.autoSessionTracking = false;
   }
 
+  options._metadata = options._metadata || {};
+  options._metadata.sdk = {
+    name: 'sentry.javascript.browser',
+    packages: [
+      {
+        name: 'npm:@sentry/browser',
+        version: SDK_VERSION,
+      },
+    ],
+    version: SDK_VERSION,
+  };
+
   initAndBind(BrowserClient, options);
 
   if (options.autoSessionTracking) {

packages/browser/src/transports/base.ts

@@ -26,7 +26,7 @@ export abstract class BaseTransport implements Transport {
   protected readonly _rateLimits: Record<string, Date> = {};
 
   public constructor(public options: TransportOptions) {
-    this._api = new API(this.options.dsn);
+    this._api = new API(options.dsn, options._metadata);
     // eslint-disable-next-line deprecation/deprecation
     this.url = this._api.getStoreEndpointWithUrlEncodedAuth();
   }

packages/browser/src/version.ts

@@ -1,2 +1,2 @@
+// TODO: Remove in the next major release and rely only on @sentry/core SDK_VERSION and SdkInfo metadata
 export const SDK_NAME = 'sentry.javascript.browser';
-export const SDK_VERSION = '5.30.0';