getsentry · mydea · Jan 19, 2024 · Jan 18, 2024
diff --git a/packages/angular-ivy/src/sdk.ts b/packages/angular-ivy/src/sdk.ts
@@ -1,8 +1,7 @@
 import { VERSION } from '@angular/core';
 import type { BrowserOptions } from '@sentry/browser';
-import { getDefaultIntegrations } from '@sentry/browser';
-import { SDK_VERSION, init as browserInit, setContext } from '@sentry/browser';
-import type { SdkMetadata } from '@sentry/types';
+import { getDefaultIntegrations, init as browserInit, setContext } from '@sentry/browser';
+import { applySdkMetadata } from '@sentry/core';
 import { logger } from '@sentry/utils';
 
 import { IS_DEBUG_BUILD } from './flags';
@@ -12,7 +11,6 @@ import { IS_DEBUG_BUILD } from './flags';
  */
 export function init(options: BrowserOptions): void {
   const opts = {
-    _metadata: {} as SdkMetadata,
     // Filter out TryCatch integration as it interferes with our Angular `ErrorHandler`:
     // TryCatch would catch certain errors before they reach the `ErrorHandler` and thus provide a
     // lower fidelity error than what `SentryErrorHandler` (see errorhandler.ts) would provide.
@@ -25,16 +23,7 @@ export function init(options: BrowserOptions): void {
     ...options,
   };
 
-  opts._metadata.sdk = opts._metadata.sdk || {
-    name: 'sentry.javascript.angular-ivy',
-    packages: [
-      {
-        name: 'npm:@sentry/angular-ivy',
-        version: SDK_VERSION,
-      },
-    ],
-    version: SDK_VERSION,
-  };
+  applySdkMetadata(opts, 'angular-ivy');
 
   checkAndSetAngularVersion();
   browserInit(opts);

diff --git a/packages/angular/src/sdk.ts b/packages/angular/src/sdk.ts
@@ -1,8 +1,7 @@
 import { VERSION } from '@angular/core';
 import type { BrowserOptions } from '@sentry/browser';
-import { getDefaultIntegrations } from '@sentry/browser';
-import { SDK_VERSION, init as browserInit, setContext } from '@sentry/browser';
-import type { SdkMetadata } from '@sentry/types';
+import { getDefaultIntegrations, init as browserInit, setContext } from '@sentry/browser';
+import { applySdkMetadata } from '@sentry/core';
 import { logger } from '@sentry/utils';
 
 import { IS_DEBUG_BUILD } from './flags';
@@ -12,7 +11,6 @@ import { IS_DEBUG_BUILD } from './flags';
  */
 export function init(options: BrowserOptions): void {
   const opts = {
-    _metadata: {} as SdkMetadata,
     // Filter out TryCatch integration as it interferes with our Angular `ErrorHandler`:
     // TryCatch would catch certain errors before they reach the `ErrorHandler` and thus provide a
     // lower fidelity error than what `SentryErrorHandler` (see errorhandler.ts) would provide.
@@ -25,16 +23,7 @@ export function init(options: BrowserOptions): void {
     ...options,
   };
 
-  opts._metadata.sdk = opts._metadata.sdk || {
-    name: 'sentry.javascript.angular',
-    packages: [
-      {
-        name: 'npm:@sentry/angular',
-        version: SDK_VERSION,
-      },
-    ],
-    version: SDK_VERSION,
-  };
+  applySdkMetadata(opts, 'angular');
 
   checkAndSetAngularVersion();
   browserInit(opts);

diff --git a/packages/astro/src/client/sdk.ts b/packages/astro/src/client/sdk.ts
@@ -5,11 +5,9 @@ import {
   init as initBrowserSdk,
   setTag,
 } from '@sentry/browser';
-import { hasTracingEnabled } from '@sentry/core';
+import { applySdkMetadata, hasTracingEnabled } from '@sentry/core';
 import type { Integration } from '@sentry/types';
 
-import { applySdkMetadata } from '../common/metadata';
-
 // Treeshakable guard to remove all code related to tracing
 declare const __SENTRY_TRACING__: boolean;
 
@@ -24,7 +22,7 @@ export function init(options: BrowserOptions): void {
     ...options,
   };
 
-  applySdkMetadata(opts, ['astro', 'browser']);
+  applySdkMetadata(opts, 'astro', ['astro', 'browser']);
 
   initBrowserSdk(opts);
 

diff --git a/packages/astro/src/server/sdk.ts b/packages/astro/src/server/sdk.ts
@@ -1,14 +1,13 @@
+import { applySdkMetadata } from '@sentry/core';
 import type { NodeOptions } from '@sentry/node';
 import { init as initNodeSdk, setTag } from '@sentry/node';
 
-import { applySdkMetadata } from '../common/metadata';
-
 /**
  *
  * @param options
  */
 export function init(options: NodeOptions): void {
-  applySdkMetadata(options, ['astro', 'node']);
+  applySdkMetadata(options, 'astro', ['astro', 'node']);
 
   initNodeSdk(options);
 

diff --git a/packages/browser/src/client.ts b/packages/browser/src/client.ts
@@ -1,5 +1,6 @@
 import type { Scope } from '@sentry/core';
-import { BaseClient, SDK_VERSION } from '@sentry/core';
+import { applySdkMetadata } from '@sentry/core';
+import { BaseClient } from '@sentry/core';
 import type {
   BrowserClientProfilingOptions,
   BrowserClientReplayOptions,
@@ -50,18 +51,7 @@ export class BrowserClient extends BaseClient<BrowserClientOptions> {
    */
   public constructor(options: BrowserClientOptions) {
     const sdkSource = WINDOW.SENTRY_SDK_SOURCE || getSDKSource();
-
-    options._metadata = options._metadata || {};
-    options._metadata.sdk = options._metadata.sdk || {
-      name: 'sentry.javascript.browser',
-      packages: [
-        {
-          name: `${sdkSource}:@sentry/browser`,
-          version: SDK_VERSION,
-        },
-      ],
-      version: SDK_VERSION,
-    };
+    applySdkMetadata(options, 'browser', ['browser'], sdkSource);
 
     super(options);
 

diff --git a/packages/bun/src/client.ts b/packages/bun/src/client.ts
@@ -1,6 +1,7 @@
 import * as os from 'os';
 import type { ServerRuntimeClientOptions } from '@sentry/core';
-import { SDK_VERSION, ServerRuntimeClient } from '@sentry/core';
+import { applySdkMetadata } from '@sentry/core';
+import { ServerRuntimeClient } from '@sentry/core';
 
 import type { BunClientOptions } from './types';
 
@@ -16,17 +17,7 @@ export class BunClient extends ServerRuntimeClient<BunClientOptions> {
    * @param options Configuration options for this SDK.
    */
   public constructor(options: BunClientOptions) {
-    options._metadata = options._metadata || {};
-    options._metadata.sdk = options._metadata.sdk || {
-      name: 'sentry.javascript.bun',
-      packages: [
-        {
-          name: 'npm:@sentry/bun',
-          version: SDK_VERSION,
-        },
-      ],
-      version: SDK_VERSION,
-    };
+    applySdkMetadata(options, 'bun');
 
     const clientOptions: ServerRuntimeClientOptions = {
       ...options,

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -86,6 +86,7 @@ export {
   spanIsSampled,
 } from './utils/spanUtils';
 export { getRootSpan } from './utils/getRootSpan';
+export { applySdkMetadata } from './utils/sdkMetadata';
 export { DEFAULT_ENVIRONMENT } from './constants';
 /* eslint-disable deprecation/deprecation */
 export { ModuleMetadata } from './integrations/metadata';

diff --git a/packages/astro/src/common/metadata.ts → packages/core/src/utils/sdkMetadata.ts b/packages/astro/src/common/metadata.ts → packages/core/src/utils/sdkMetadata.ts
@@ -1,7 +1,5 @@
-import { SDK_VERSION } from '@sentry/core';
-import type { Options, SdkInfo } from '@sentry/types';
-
-const PACKAGE_NAME_PREFIX = 'npm:@sentry/';
+import type { Options } from '@sentry/types';
+import { SDK_VERSION } from '../version';
 
 /**
  * A builder for the SDK metadata in the options for the SDK initialization.
@@ -16,16 +14,19 @@ const PACKAGE_NAME_PREFIX = 'npm:@sentry/';
  * @param options SDK options object that gets mutated
  * @param names list of package names
  */
-export function applySdkMetadata(options: Options, names: string[]): void {
-  options._metadata = options._metadata || {};
-  options._metadata.sdk =
-    options._metadata.sdk ||
-    ({
-      name: 'sentry.javascript.astro',
+export function applySdkMetadata(options: Options, name: string, names = [name], source = 'npm'): void {
+  const metadata = options._metadata || {};
+
+  if (!metadata.sdk) {
+    metadata.sdk = {
+      name: `sentry.javascript.${name}`,
       packages: names.map(name => ({
-        name: `${PACKAGE_NAME_PREFIX}${name}`,
+        name: `${source}:@sentry/${name}`,
         version: SDK_VERSION,
       })),
       version: SDK_VERSION,
-    } as SdkInfo);
+    };
+  }
+
+  options._metadata = metadata;
 }
diff --git a/packages/ember/addon/index.ts b/packages/ember/addon/index.ts
@@ -5,7 +5,7 @@ import { getOwnConfig, isDevelopingApp, macroCondition } from '@embroider/macros
 import { startSpan } from '@sentry/browser';
 import type { BrowserOptions } from '@sentry/browser';
 import * as Sentry from '@sentry/browser';
-import { SDK_VERSION } from '@sentry/browser';
+import { applySdkMetadata } from '@sentry/core';
 import { GLOBAL_OBJ } from '@sentry/utils';
 import Ember from 'ember';
 
@@ -33,17 +33,7 @@ export function InitSentryForEmber(_runtimeConfig?: BrowserOptions): void {
   Object.assign(environmentConfig.sentry, _runtimeConfig || {});
   const initConfig = Object.assign({}, environmentConfig.sentry);
 
-  initConfig._metadata = initConfig._metadata || {};
-  initConfig._metadata.sdk = {
-    name: 'sentry.javascript.ember',
-    packages: [
-      {
-        name: 'npm:@sentry/ember',
-        version: SDK_VERSION,
-      },
-    ],
-    version: SDK_VERSION,
-  };
+  applySdkMetadata(initConfig, 'ember');
 
   // Persist Sentry init options so they are identical when performance initializers call init again.
   const sentryInitConfig = _getSentryInitConfig();

diff --git a/packages/gatsby/src/sdk.ts b/packages/gatsby/src/sdk.ts
@@ -1,4 +1,5 @@
-import { SDK_VERSION, init as reactInit } from '@sentry/react';
+import { applySdkMetadata } from '@sentry/core';
+import { init as reactInit } from '@sentry/react';
 
 import { getIntegrationsFromOptions } from './utils/integrations';
 import type { GatsbyOptions } from './utils/types';
@@ -7,18 +8,7 @@ import type { GatsbyOptions } from './utils/types';
  * Inits the Sentry Gatsby SDK.
  */
 export function init(options: GatsbyOptions): void {
-  options._metadata = options._metadata || {};
-  options._metadata.sdk = options._metadata.sdk || {
-    name: 'sentry.javascript.gatsby',
-    packages: [
-      {
-        name: 'npm:@sentry/gatsby',
-        version: SDK_VERSION,
-      },
-    ],
-    version: SDK_VERSION,
-  };
-
+  applySdkMetadata(options, 'gatsby');
   const integrations = getIntegrationsFromOptions(options);
   reactInit({
     ...options,

diff --git a/packages/nextjs/src/client/index.ts b/packages/nextjs/src/client/index.ts
@@ -1,4 +1,4 @@
-import { hasTracingEnabled } from '@sentry/core';
+import { applySdkMetadata, hasTracingEnabled } from '@sentry/core';
 import type { BrowserOptions } from '@sentry/react';
 import {
   Integrations as OriginalIntegrations,
@@ -10,7 +10,6 @@ import type { EventProcessor, Integration } from '@sentry/types';
 
 import { devErrorSymbolicationEventProcessor } from '../common/devErrorSymbolicationEventProcessor';
 import { getVercelEnv } from '../common/getVercelEnv';
-import { buildMetadata } from '../common/metadata';
 import { BrowserTracing } from './browserTracingIntegration';
 import { rewriteFramesIntegration } from './rewriteFramesIntegration';
 import { applyTunnelRouteOption } from './tunnelRoute';
@@ -50,7 +49,7 @@ export function init(options: BrowserOptions): void {
   fixBrowserTracingIntegration(opts);
 
   applyTunnelRouteOption(opts);
-  buildMetadata(opts, ['nextjs', 'react']);
+  applySdkMetadata(opts, 'nextjs', ['nextjs', 'react']);
 
   reactInit(opts);
 

diff --git a/packages/nextjs/src/common/metadata.ts b/packages/nextjs/src/common/metadata.ts
diff --git a/packages/nextjs/src/edge/index.ts b/packages/nextjs/src/edge/index.ts
@@ -1,5 +1,4 @@
-import { SDK_VERSION, addTracingExtensions } from '@sentry/core';
-import type { SdkMetadata } from '@sentry/types';
+import { addTracingExtensions, applySdkMetadata } from '@sentry/core';
 import type { VercelEdgeOptions } from '@sentry/vercel-edge';
 import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
 
@@ -21,21 +20,11 @@ export function init(options: VercelEdgeOptions = {}): void {
   const customDefaultIntegrations = [...getDefaultIntegrations(options), rewriteFramesIntegration()];
 
   const opts = {
-    _metadata: {} as SdkMetadata,
     defaultIntegrations: customDefaultIntegrations,
     ...options,
   };
 
-  opts._metadata.sdk = opts._metadata.sdk || {
-    name: 'sentry.javascript.nextjs',
-    packages: [
-      {
-        name: 'npm:@sentry/nextjs',
-        version: SDK_VERSION,
-      },
-    ],
-    version: SDK_VERSION,
-  };
+  applySdkMetadata(opts, 'nextjs');
 
   vercelEdgeInit(opts);
 }

diff --git a/packages/nextjs/src/server/index.ts b/packages/nextjs/src/server/index.ts
@@ -1,4 +1,4 @@
-import { addTracingExtensions, getClient } from '@sentry/core';
+import { addTracingExtensions, applySdkMetadata, getClient } from '@sentry/core';
 import type { NodeOptions } from '@sentry/node';
 import {
   Integrations as OriginalIntegrations,
@@ -12,7 +12,6 @@ import { logger } from '@sentry/utils';
 import { DEBUG_BUILD } from '../common/debug-build';
 import { devErrorSymbolicationEventProcessor } from '../common/devErrorSymbolicationEventProcessor';
 import { getVercelEnv } from '../common/getVercelEnv';
-import { buildMetadata } from '../common/metadata';
 import { isBuild } from '../common/utils/isBuild';
 import { Http } from './httpIntegration';
 import { OnUncaughtException } from './onUncaughtExceptionIntegration';
@@ -109,7 +108,7 @@ export function init(options: NodeOptions): void {
     return;
   }
 
-  buildMetadata(opts, ['nextjs', 'node']);
+  applySdkMetadata(opts, 'nextjs', ['nextjs', 'node']);
 
   nodeInit(opts);
 

diff --git a/packages/node-experimental/src/sdk/client.ts b/packages/node-experimental/src/sdk/client.ts
@@ -3,6 +3,7 @@ import { NodeClient, SDK_VERSION } from '@sentry/node';
 import type { Tracer } from '@opentelemetry/api';
 import { trace } from '@opentelemetry/api';
 import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
+import { applySdkMetadata } from '@sentry/core';
 import type { CaptureContext, Event, EventHint } from '@sentry/types';
 import { Scope, getIsolationScope } from './scope';
 
@@ -12,17 +13,7 @@ export class NodeExperimentalClient extends NodeClient {
   private _tracer: Tracer | undefined;
 
   public constructor(options: ConstructorParameters<typeof NodeClient>[0]) {
-    options._metadata = options._metadata || {};
-    options._metadata.sdk = options._metadata.sdk || {
-      name: 'sentry.javascript.node-experimental',
-      packages: [
-        {
-          name: 'npm:@sentry/node-experimental',
-          version: SDK_VERSION,
-        },
-      ],
-      version: SDK_VERSION,
-    };
+    applySdkMetadata(options, 'node-experimental');
 
     super(options);
   }