ref: Introduce buildMetadata function

packages/angular/src/sdk.ts

@@ -1,19 +1,11 @@
-import { BrowserOptions, init as browserInit, SDK_VERSION } from '@sentry/browser';
+import { BrowserOptions, buildMetadata, init as browserInit } from '@sentry/browser';
+
+const PACKAGE_NAME = 'angular';
 
 /**
  * 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,
-  };
+  buildMetadata(options, PACKAGE_NAME);
   browserInit(options);
 }

packages/browser/src/client.ts

@@ -1,8 +1,9 @@
-import { BaseClient, Scope, SDK_VERSION } from '@sentry/core';
+import { BaseClient, buildMetadata, Scope } from '@sentry/core';
 import { Event, EventHint } from '@sentry/types';
 import { getGlobalObject, logger } from '@sentry/utils';
 
 import { BrowserBackend, BrowserOptions } from './backend';
+import { PACKAGE_NAME } from './constants';
 import { injectReportDialog, ReportDialogOptions } from './helpers';
 import { Breadcrumbs } from './integrations';
 
@@ -19,17 +20,7 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
    * @param options Configuration options for this SDK.
    */
   public constructor(options: BrowserOptions = {}) {
-    options._metadata = options._metadata || {};
-    options._metadata.sdk = options._metadata.sdk || {
-      name: 'sentry.javascript.browser',
-      packages: [
-        {
-          name: 'npm:@sentry/browser',
-          version: SDK_VERSION,
-        },
-      ],
-      version: SDK_VERSION,
-    };
+    buildMetadata(options, PACKAGE_NAME);
 
     super(BrowserBackend, options);
   }

packages/browser/src/constants.ts

@@ -0,0 +1 @@
+export const PACKAGE_NAME = 'browser';

packages/browser/src/exports.ts

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

packages/core/src/index.ts

@@ -21,6 +21,7 @@ export { eventToSentryRequest, sessionToSentryRequest } from './request';
 export { initAndBind, ClientClass } from './sdk';
 export { NoopTransport } from './transports/noop';
 export { SDK_VERSION } from './version';
+export { buildMetadata } from './metadata';
 
 import * as Integrations from './integrations';
 

packages/core/src/metadata.ts

@@ -0,0 +1,28 @@
+import { Options, SdkInfo } from '@sentry/types';
+
+import { SDK_VERSION } from './version';
+
+const SDK_NAME_PREFIX = 'sentry.javascript';
+const PACKAGE_NAME_PREFIX = 'npm:@sentry/';
+
+/** */
+export function buildMetadata(
+  options: Options,
+  name: string,
+  extraPackageNames: string[] = [],
+  integrations?: SdkInfo['integrations'],
+): void {
+  const packageNames = [name, ...extraPackageNames];
+  options._metadata = options._metadata || {};
+  options._metadata.sdk =
+    options._metadata.sdk ||
+    ({
+      name: `${SDK_NAME_PREFIX}.${name}`,
+      packages: packageNames.map(name => ({
+        name: `${PACKAGE_NAME_PREFIX}/${name}`,
+        version: SDK_VERSION,
+      })),
+      integrations,
+      version: SDK_VERSION,
+    } as SdkInfo);
+}

packages/ember/addon/index.ts

@@ -1,5 +1,5 @@
 import * as Sentry from '@sentry/browser';
-import { SDK_VERSION, BrowserOptions } from '@sentry/browser';
+import { BrowserOptions, buildMetadata } from '@sentry/browser';
 import { macroCondition, isDevelopingApp, getOwnConfig } from '@embroider/macros';
 import { next } from '@ember/runloop';
 import { assert, warn } from '@ember/debug';
@@ -8,6 +8,8 @@ import { timestampWithMs } from '@sentry/utils';
 import { GlobalConfig, OwnConfig } from './types';
 import { getGlobalObject } from '@sentry/utils';
 
+const PACKAGE_NAME = 'ember';
+
 function _getSentryInitConfig() {
   const _global = getGlobalObject<GlobalConfig>();
   _global.__sentryEmberConfig = _global.__sentryEmberConfig ?? {};
@@ -27,25 +29,14 @@ export function InitSentryForEmber(_runtimeConfig?: BrowserOptions) {
 
   // Merge runtime config into environment config, preferring runtime.
   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,
-  };
+  const options = Object.assign({}, environmentConfig.sentry);
+  buildMetadata(options, PACKAGE_NAME);
 
   // Persist Sentry init options so they are identical when performance initializers call init again.
   const sentryInitConfig = _getSentryInitConfig();
-  Object.assign(sentryInitConfig, initConfig);
+  Object.assign(sentryInitConfig, options);
 
-  Sentry.init(initConfig);
+  Sentry.init(options);
 
   if (macroCondition(isDevelopingApp())) {
     if (environmentConfig.ignoreEmberOnErrorWarning) {

packages/gatsby/src/sdk.ts

@@ -1,23 +1,15 @@
-import { init as reactInit, SDK_VERSION } from '@sentry/react';
+import { buildMetadata, init as reactInit } from '@sentry/react';
 
 import { getIntegrationsFromOptions } from './utils/integrations';
 import { GatsbyOptions } from './utils/types';
 
+const PACKAGE_NAME = 'gatsby';
+
 /**
  * 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,
-  };
+  buildMetadata(options, PACKAGE_NAME);
 
   const integrations = getIntegrationsFromOptions(options);
   reactInit({

packages/nextjs/src/constants.ts

@@ -0,0 +1,5 @@
+export const NEXTJS_PACKAGE_NAME = 'nextjs';
+
+export const REACT_PACKAGE_NAME = 'react';
+
+export const NODE_PACKAGE_NAME = 'node';

packages/nextjs/src/index.client.ts

@@ -1,8 +1,8 @@
-import { configureScope, init as reactInit, Integrations as BrowserIntegrations } from '@sentry/react';
+import { buildMetadata, configureScope, init as reactInit, Integrations as BrowserIntegrations } from '@sentry/react';
 import { defaultRequestInstrumentationOptions, Integrations as TracingIntegrations } from '@sentry/tracing';
 
+import { NEXTJS_PACKAGE_NAME, REACT_PACKAGE_NAME } from './constants';
 import { nextRouterInstrumentation } from './performance/client';
-import { MetadataBuilder } from './utils/metadataBuilder';
 import { NextjsOptions } from './utils/nextjsOptions';
 import { addIntegration, UserIntegrations } from './utils/userIntegrations';
 
@@ -14,8 +14,7 @@ export const Integrations = { ...BrowserIntegrations, BrowserTracing };
 
 /** Inits the Sentry NextJS SDK on the browser with the React SDK. */
 export function init(options: NextjsOptions): void {
-  const metadataBuilder = new MetadataBuilder(options, ['nextjs', 'react']);
-  metadataBuilder.addSdkMetadata();
+  buildMetadata(options, NEXTJS_PACKAGE_NAME, [NEXTJS_PACKAGE_NAME, REACT_PACKAGE_NAME]);
   options.environment = options.environment || process.env.NODE_ENV;
 
   // Only add BrowserTracing if a tracesSampleRate or tracesSampler is set

packages/nextjs/src/index.server.ts

@@ -1,13 +1,13 @@
 import { Carrier, getHubFromCarrier, getMainCarrier } from '@sentry/hub';
 import { RewriteFrames } from '@sentry/integrations';
-import { configureScope, getCurrentHub, init as nodeInit, Integrations } from '@sentry/node';
+import { buildMetadata, configureScope, getCurrentHub, init as nodeInit, Integrations } from '@sentry/node';
 import { Event } from '@sentry/types';
 import { escapeStringForRegex, logger } from '@sentry/utils';
 import * as domainModule from 'domain';
 import * as path from 'path';
 
+import { NEXTJS_PACKAGE_NAME, NODE_PACKAGE_NAME } from './constants';
 import { instrumentServer } from './utils/instrumentServer';
-import { MetadataBuilder } from './utils/metadataBuilder';
 import { NextjsOptions } from './utils/nextjsOptions';
 import { addIntegration } from './utils/userIntegrations';
 
@@ -33,8 +33,7 @@ export function init(options: NextjsOptions): void {
     return;
   }
 
-  const metadataBuilder = new MetadataBuilder(options, ['nextjs', 'node']);
-  metadataBuilder.addSdkMetadata();
+  buildMetadata(options, NEXTJS_PACKAGE_NAME, [NEXTJS_PACKAGE_NAME, NODE_PACKAGE_NAME]);
   options.environment = options.environment || process.env.NODE_ENV;
   addServerIntegrations(options);
   // Right now we only capture frontend sessions for Next.js

packages/node/src/client.ts

@@ -1,9 +1,10 @@
-import { BaseClient, Scope, SDK_VERSION } from '@sentry/core';
+import { BaseClient, buildMetadata, Scope } from '@sentry/core';
 import { SessionFlusher } from '@sentry/hub';
 import { Event, EventHint, RequestSessionStatus } from '@sentry/types';
 import { logger } from '@sentry/utils';
 
 import { NodeBackend } from './backend';
+import { PACKAGE_NAME } from './constants';
 import { NodeOptions } from './types';
 
 /**
@@ -20,18 +21,7 @@ export class NodeClient extends BaseClient<NodeBackend, NodeOptions> {
    * @param options Configuration options for this SDK.
    */
   public constructor(options: NodeOptions) {
-    options._metadata = options._metadata || {};
-    options._metadata.sdk = options._metadata.sdk || {
-      name: 'sentry.javascript.node',
-      packages: [
-        {
-          name: 'npm:@sentry/node',
-          version: SDK_VERSION,
-        },
-      ],
-      version: SDK_VERSION,
-    };
-
+    buildMetadata(options, PACKAGE_NAME);
     super(NodeBackend, options);
   }
 

packages/node/src/constants.ts

@@ -0,0 +1 @@
+export const PACKAGE_NAME = 'node';

packages/node/src/index.ts

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

packages/react/src/sdk.ts

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