[v7] Move SdkMetadata to options._internal and use SdkInfo type directly instead

kamilogorek · kamilogorek · commit ba701d16bbd8 · 2021-03-26T15:30:31.000+01:00
diff --git a/packages/angular/src/sdk.ts b/packages/angular/src/sdk.ts
@@ -5,8 +5,8 @@ import { ClientLike } from '@sentry/types';
  * Inits the Angular SDK
  */
 export function init(options: BrowserOptions): ClientLike {
-  options._metadata = options._metadata || {};
-  options._metadata.sdk = {
+  options._internal = options._internal || {};
+  options._internal.sdk = {
     name: 'sentry.javascript.angular',
     packages: [
       {
diff --git a/packages/browser/src/client.ts b/packages/browser/src/client.ts
@@ -42,8 +42,8 @@ export class BrowserClient extends BaseClient<BrowserOptions> {
    * @param options Configuration options for this SDK.
    */
   public constructor(options: BrowserOptions = {}) {
-    options._metadata = options._metadata || {};
-    options._metadata.sdk = options._metadata.sdk || {
+    options._internal = options._internal || {};
+    options._internal.sdk = options._internal.sdk || {
       name: 'sentry.javascript.browser',
       packages: [
         {
diff --git a/packages/core/src/baseclient.ts b/packages/core/src/baseclient.ts
@@ -352,8 +352,8 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {
   }
 
   protected _applySdkMetadata(event: SentryEvent): void {
-    if (this.options._metadata?.sdk) {
-      const { name, version, integrations, packages } = this.options._metadata?.sdk;
+    if (this.options._internal?.sdk) {
+      const { name, version, integrations, packages } = this.options._internal?.sdk;
 
       event.sdk = event.sdk ?? {
         name,
diff --git a/packages/ember/addon/index.ts b/packages/ember/addon/index.ts
@@ -20,8 +20,8 @@ export function InitSentryForEmber(_runtimeConfig: BrowserOptions | undefined) {
 
   const initConfig = Object.assign({}, config.sentry, _runtimeConfig || {});
 
-  initConfig._metadata = initConfig._metadata || {};
-  initConfig._metadata.sdk = {
+  initConfig._internal = initConfig._internal || {};
+  initConfig._internal.sdk = {
     name: 'sentry.javascript.ember',
     packages: [
       {
@@ -66,15 +66,25 @@ export const instrumentRoutePerformance = (BaseRoute: any) => {
   return {
     [BaseRoute.name]: class extends BaseRoute {
       beforeModel(...args: any[]) {
-        return instrumentFunction('ember.route.beforeModel', (<any>this).fullRouteName, super.beforeModel.bind(this), args);
+        return instrumentFunction(
+          'ember.route.beforeModel',
+          (<any>this).fullRouteName,
+          super.beforeModel.bind(this),
+          args,
+        );
       }
 
       async model(...args: any[]) {
         return instrumentFunction('ember.route.model', (<any>this).fullRouteName, super.model.bind(this), args);
       }
 
       async afterModel(...args: any[]) {
-        return instrumentFunction('ember.route.afterModel', (<any>this).fullRouteName, super.afterModel.bind(this), args);
+        return instrumentFunction(
+          'ember.route.afterModel',
+          (<any>this).fullRouteName,
+          super.afterModel.bind(this),
+          args,
+        );
       }
 
       async setupController(...args: any[]) {
diff --git a/packages/node/src/client.ts b/packages/node/src/client.ts
@@ -44,8 +44,8 @@ export class NodeClient extends BaseClient<NodeOptions> {
    * @param options Configuration options for this SDK.
    */
   public constructor(options: NodeOptions) {
-    options._metadata = options._metadata || {};
-    options._metadata.sdk = options._metadata.sdk || {
+    options._internal = options._internal || {};
+    options._internal.sdk = options._internal.sdk || {
       name: 'sentry.javascript.node',
       packages: [
         {
diff --git a/packages/react/src/sdk.ts b/packages/react/src/sdk.ts
@@ -5,19 +5,17 @@ import { ClientLike } from '@sentry/types';
  * Inits the React SDK
  */
 export function init(options: BrowserOptions): ClientLike {
-  options._metadata = options._metadata || {};
-  if (options._metadata.sdk === undefined) {
-    options._metadata.sdk = {
-      name: 'sentry.javascript.react',
-      packages: [
-        {
-          name: 'npm:@sentry/react',
-          version: SDK_VERSION,
-        },
-      ],
-      version: SDK_VERSION,
-    };
-  }
+  options._internal = options._internal || {};
+  options._internal.sdk = options._internal.sdk || {
+    name: 'sentry.javascript.react',
+    packages: [
+      {
+        name: 'npm:@sentry/react',
+        version: SDK_VERSION,
+      },
+    ],
+    version: SDK_VERSION,
+  };
 
   return browserInit(options);
 }
diff --git a/packages/serverless/src/awslambda.ts b/packages/serverless/src/awslambda.ts
@@ -52,9 +52,7 @@ export const getDefaultIntegrations = (): Integration[] => [
 export function init(options: Sentry.NodeOptions = {}): ClientLike {
   options._internal = options._internal || {};
   options._internal.defaultIntegrations = getDefaultIntegrations();
-
-  options._metadata = options._metadata || {};
-  options._metadata.sdk = {
+  options._internal.sdk = {
     name: 'sentry.javascript.serverless',
     integrations: ['AWSLambda'],
     packages: [
diff --git a/packages/serverless/src/gcpfunction/index.ts b/packages/serverless/src/gcpfunction/index.ts
@@ -21,9 +21,7 @@ export const getDefaultIntegrations = (): Integration[] => [
 export function init(options: Sentry.NodeOptions = {}): ClientLike {
   options._internal = options._internal || {};
   options._internal.defaultIntegrations = getDefaultIntegrations();
-
-  options._metadata = options._metadata || {};
-  options._metadata.sdk = {
+  options._internal.sdk = {
     name: 'sentry.javascript.serverless',
     integrations: ['GCPFunction'],
     packages: [
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -20,7 +20,6 @@ export { Response } from './response';
 export { Runtime } from './runtime';
 export { ScopeLike, ScopeContext } from './scope';
 export { SdkInfo } from './sdkinfo';
-export { SdkMetadata } from './sdkmetadata';
 export { Session, SessionContext, SessionStatus } from './session';
 export { Severity } from './severity';
 export { Span, SpanContext } from './span';
diff --git a/packages/types/src/options.ts b/packages/types/src/options.ts
@@ -2,7 +2,7 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 import { SentryEvent, EventHint } from './event';
 import { Integration } from './integration';
 import { LogLevel } from './loglevel';
-import { SdkMetadata } from './sdkmetadata';
+import { SdkInfo } from './sdkinfo';
 import { SamplingContext } from './transaction';
 import { Transport, TransportOptions } from './transport';
 
@@ -121,12 +121,6 @@ export interface Options {
    */
   tracesSampleRate?: number;
 
-  /**
-   * Set of metadata about the SDK that can be internally used to enhance envelopes and events,
-   * and provide additional data about every request.
-   * */
-  _metadata?: SdkMetadata;
-
   /**
    * Options which are in beta, or otherwise not guaranteed to be stable.
    */
@@ -135,6 +129,7 @@ export interface Options {
   };
 
   _internal?: {
+    sdk?: SdkInfo;
     defaultIntegrations?: Integration[];
     discoveredIntegrations?: Integration[];
   };
diff --git a/packages/types/src/sdkmetadata.ts b/packages/types/src/sdkmetadata.ts
diff --git a/packages/vue/src/sdk.ts b/packages/vue/src/sdk.ts
@@ -141,8 +141,8 @@ export function init(
     },
   } as VueOptions;
 
-  finalOptions._metadata = finalOptions._metadata || {};
-  finalOptions._metadata.sdk = {
+  finalOptions._internal = finalOptions._internal || {};
+  finalOptions._internal.sdk = {
     name: 'sentry.javascript.vue',
     packages: [
       {

Original file line number	Diff line number	Diff line change
`@@ -352,8 +352,8 @@ export abstract class BaseClient<O extends Options> implements ClientLike<O> {`
`352`	`352`	`}`
`353`	`353`
`354`	`354`	`protected _applySdkMetadata(event: SentryEvent): void {`
`355`		`- if (this.options._metadata?.sdk) {`
`356`		`- const { name, version, integrations, packages } = this.options._metadata?.sdk;`
	`355`	`+ if (this.options._internal?.sdk) {`
	`356`	`+ const { name, version, integrations, packages } = this.options._internal?.sdk;`
`357`	`357`
`358`	`358`	`event.sdk = event.sdk ?? {`
`359`	`359`	`name,`