From 73bd1501716f99806442b94c729250ca6c55cc57 Mon Sep 17 00:00:00 2001 From: Lukas Stracke Date: Fri, 10 Mar 2023 10:38:12 +0100 Subject: [PATCH] ref(nextjs/remix): Use `buildMetadata` from core SDK --- packages/nextjs/src/client/index.ts | 5 ++--- packages/nextjs/src/common/metadata.ts | 23 ----------------------- packages/nextjs/src/server/index.ts | 5 ++--- packages/remix/src/index.client.tsx | 4 ++-- packages/remix/src/index.server.ts | 4 ++-- packages/remix/src/utils/metadata.ts | 23 ----------------------- 6 files changed, 8 insertions(+), 56 deletions(-) delete mode 100644 packages/nextjs/src/common/metadata.ts delete mode 100644 packages/remix/src/utils/metadata.ts diff --git a/packages/nextjs/src/client/index.ts b/packages/nextjs/src/client/index.ts index 550daf53cf55..a6f3b1ea0995 100644 --- a/packages/nextjs/src/client/index.ts +++ b/packages/nextjs/src/client/index.ts @@ -1,4 +1,4 @@ -import { hasTracingEnabled } from '@sentry/core'; +import { buildMetadata, hasTracingEnabled } from '@sentry/core'; import { RewriteFrames } from '@sentry/integrations'; import type { BrowserOptions } from '@sentry/react'; import { configureScope, init as reactInit, Integrations } from '@sentry/react'; @@ -7,7 +7,6 @@ import type { EventProcessor } from '@sentry/types'; import { devErrorSymbolicationEventProcessor } from '../common/devErrorSymbolicationEventProcessor'; import { getVercelEnv } from '../common/getVercelEnv'; -import { buildMetadata } from '../common/metadata'; import { addOrUpdateIntegration } from '../common/userIntegrations'; import { nextRouterInstrumentation } from './performance'; import { applyTunnelRouteOption } from './tunnelRoute'; @@ -40,7 +39,7 @@ const globalWithInjectedValues = global as typeof global & { /** Inits the Sentry NextJS SDK on the browser with the React SDK. */ export function init(options: BrowserOptions): void { applyTunnelRouteOption(options); - buildMetadata(options, ['nextjs', 'react']); + buildMetadata(options, 'nextjs', ['nextjs', 'react']); options.environment = options.environment || getVercelEnv(true) || process.env.NODE_ENV; diff --git a/packages/nextjs/src/common/metadata.ts b/packages/nextjs/src/common/metadata.ts deleted file mode 100644 index 9216c6eaec07..000000000000 --- a/packages/nextjs/src/common/metadata.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { SDK_VERSION } from '@sentry/core'; -import type { Options, SdkInfo } from '@sentry/types'; - -const PACKAGE_NAME_PREFIX = 'npm:@sentry/'; - -/** - * A builder for the SDK metadata in the options for the SDK initialization. - * @param options sdk options object that gets mutated - * @param names list of package names - */ -export function buildMetadata(options: Options, names: string[]): void { - options._metadata = options._metadata || {}; - options._metadata.sdk = - options._metadata.sdk || - ({ - name: 'sentry.javascript.nextjs', - packages: names.map(name => ({ - name: `${PACKAGE_NAME_PREFIX}${name}`, - version: SDK_VERSION, - })), - version: SDK_VERSION, - } as SdkInfo); -} diff --git a/packages/nextjs/src/server/index.ts b/packages/nextjs/src/server/index.ts index b38ee49946f2..9d21c695ed2c 100644 --- a/packages/nextjs/src/server/index.ts +++ b/packages/nextjs/src/server/index.ts @@ -1,5 +1,5 @@ import type { Carrier } from '@sentry/core'; -import { getHubFromCarrier, getMainCarrier, hasTracingEnabled } from '@sentry/core'; +import { buildMetadata, getHubFromCarrier, getMainCarrier, hasTracingEnabled } from '@sentry/core'; import { RewriteFrames } from '@sentry/integrations'; import type { NodeOptions } from '@sentry/node'; import { configureScope, getCurrentHub, init as nodeInit, Integrations } from '@sentry/node'; @@ -10,7 +10,6 @@ import * as path from 'path'; import { devErrorSymbolicationEventProcessor } from '../common/devErrorSymbolicationEventProcessor'; import { getVercelEnv } from '../common/getVercelEnv'; -import { buildMetadata } from '../common/metadata'; import type { IntegrationWithExclusionOption } from '../common/userIntegrations'; import { addOrUpdateIntegration } from '../common/userIntegrations'; import { isBuild } from './utils/isBuild'; @@ -79,7 +78,7 @@ export function init(options: NodeOptions): void { return; } - buildMetadata(options, ['nextjs', 'node']); + buildMetadata(options, 'nextjs', ['nextjs', 'node']); options.environment = options.environment || process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV; diff --git a/packages/remix/src/index.client.tsx b/packages/remix/src/index.client.tsx index 22d9ce73fe82..86f955c60f9b 100644 --- a/packages/remix/src/index.client.tsx +++ b/packages/remix/src/index.client.tsx @@ -1,7 +1,7 @@ /* eslint-disable import/export */ +import { buildMetadata } from '@sentry/core'; import { configureScope, init as reactInit, Integrations } from '@sentry/react'; -import { buildMetadata } from './utils/metadata'; import type { RemixOptions } from './utils/remixOptions'; export { remixRouterInstrumentation, withSentry } from './performance/client'; export { BrowserTracing } from '@sentry/tracing'; @@ -10,7 +10,7 @@ export * from '@sentry/react'; export { Integrations }; export function init(options: RemixOptions): void { - buildMetadata(options, ['remix', 'react']); + buildMetadata(options, 'remix', ['remix', 'react']); options.environment = options.environment || process.env.NODE_ENV; reactInit(options); diff --git a/packages/remix/src/index.server.ts b/packages/remix/src/index.server.ts index b2ad73866fde..1efe4e603f6b 100644 --- a/packages/remix/src/index.server.ts +++ b/packages/remix/src/index.server.ts @@ -1,9 +1,9 @@ /* eslint-disable import/export */ +import { buildMetadata } from '@sentry/core'; import { configureScope, getCurrentHub, init as nodeInit } from '@sentry/node'; import { logger } from '@sentry/utils'; import { instrumentServer } from './utils/instrumentServer'; -import { buildMetadata } from './utils/metadata'; import type { RemixOptions } from './utils/remixOptions'; export { ErrorBoundary, withErrorBoundary } from '@sentry/react'; @@ -19,7 +19,7 @@ function sdkAlreadyInitialized(): boolean { /** Initializes Sentry Remix SDK on Node. */ export function init(options: RemixOptions): void { - buildMetadata(options, ['remix', 'node']); + buildMetadata(options, 'remix', ['remix', 'node']); if (sdkAlreadyInitialized()) { __DEBUG_BUILD__ && logger.log('SDK already initialized'); diff --git a/packages/remix/src/utils/metadata.ts b/packages/remix/src/utils/metadata.ts deleted file mode 100644 index 382eff9c3e26..000000000000 --- a/packages/remix/src/utils/metadata.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { SDK_VERSION } from '@sentry/core'; -import type { Options, SdkInfo } from '@sentry/types'; - -const PACKAGE_NAME_PREFIX = 'npm:@sentry/'; - -/** - * A builder for the SDK metadata in the options for the SDK initialization. - * @param options sdk options object that gets mutated - * @param names list of package names - */ -export function buildMetadata(options: Options, names: string[]): void { - options._metadata = options._metadata || {}; - options._metadata.sdk = - options._metadata.sdk || - ({ - name: 'sentry.javascript.remix', - packages: names.map(name => ({ - name: `${PACKAGE_NAME_PREFIX}${name}`, - version: SDK_VERSION, - })), - version: SDK_VERSION, - } as SdkInfo); -}