import { SEMATTRS_HTTP_TARGET, ATTR_URL_QUERY, SEMATTRS_HTTP_METHOD, ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions'; import { GLOBAL_OBJ, debug, applySdkMetadata, getGlobalScope, extractTraceparentData, SEMANTIC_ATTRIBUTE_SENTRY_OP, stripUrlQueryAndFragment, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, getClient } from '@sentry/core'; import { getDefaultIntegrations, httpIntegration, init as init$1 } from '@sentry/node'; export * from '@sentry/node'; import { DEBUG_BUILD } from '../common/debug-build.js'; import { devErrorSymbolicationEventProcessor } from '../common/devErrorSymbolicationEventProcessor.js'; import { getVercelEnv } from '../common/getVercelEnv.js'; import { ATTR_NEXT_SPAN_TYPE, ATTR_NEXT_ROUTE, ATTR_NEXT_SPAN_NAME } from '../common/nextSpanAttributes.js'; import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION, TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL, TRANSACTION_ATTR_SENTRY_ROUTE_BACKFILL } from '../common/span-attributes-with-logic-attached.js'; import { isBuild } from '../common/utils/isBuild.js'; import { isCloudflareWaitUntilAvailable } from '../common/utils/responseEnd.js'; import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata.js'; import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration.js'; import { handleOnSpanStart } from './handleOnSpanStart.js'; import { prepareSafeIdGeneratorContext } from './prepareSafeIdGeneratorContext.js'; import { maybeCompleteCronCheckIn } from './vercelCronsMonitoring.js'; export { captureUnderscoreErrorException } from '../common/pages-router-instrumentation/_error.js'; export { startInactiveSpan, startSpan, startSpanManual } from '../common/utils/nextSpan.js'; export { wrapGetStaticPropsWithSentry } from '../common/pages-router-instrumentation/wrapGetStaticPropsWithSentry.js'; export { wrapGetInitialPropsWithSentry } from '../common/pages-router-instrumentation/wrapGetInitialPropsWithSentry.js'; export { wrapAppGetInitialPropsWithSentry } from '../common/pages-router-instrumentation/wrapAppGetInitialPropsWithSentry.js'; export { wrapDocumentGetInitialPropsWithSentry } from '../common/pages-router-instrumentation/wrapDocumentGetInitialPropsWithSentry.js'; export { wrapErrorGetInitialPropsWithSentry } from '../common/pages-router-instrumentation/wrapErrorGetInitialPropsWithSentry.js'; export { wrapGetServerSidePropsWithSentry } from '../common/pages-router-instrumentation/wrapGetServerSidePropsWithSentry.js'; export { wrapServerComponentWithSentry } from '../common/wrapServerComponentWithSentry.js'; export { wrapRouteHandlerWithSentry } from '../common/wrapRouteHandlerWithSentry.js'; export { wrapApiHandlerWithSentryVercelCrons } from '../common/pages-router-instrumentation/wrapApiHandlerWithSentryVercelCrons.js'; export { wrapMiddlewareWithSentry } from '../common/wrapMiddlewareWithSentry.js'; export { wrapPageComponentWithSentry } from '../common/pages-router-instrumentation/wrapPageComponentWithSentry.js'; export { wrapGenerationFunctionWithSentry } from '../common/wrapGenerationFunctionWithSentry.js'; export { withServerActionInstrumentation } from '../common/withServerActionInstrumentation.js'; export { captureRequestError } from '../common/captureRequestError.js'; export { wrapApiHandlerWithSentry } from '../common/pages-router-instrumentation/wrapApiHandlerWithSentry.js'; // import/export got a false positive, and affects most of our index barrel files // can be removed once following issue is fixed: https://github.com/import-js/eslint-plugin-import/issues/703 /* eslint-disable import/export */ const globalWithInjectedValues = GLOBAL_OBJ ; /** * A passthrough error boundary for the server that doesn't depend on any react. Error boundaries don't catch SSR errors * so they should simply be a passthrough. */ const ErrorBoundary = (props) => { if (!props.children) { return null; } if (typeof props.children === 'function') { return (props.children )(); } // since Next.js >= 10 requires React ^16.6.0 we are allowed to return children like this here return props.children ; }; /** * A passthrough redux enhancer for the server that doesn't depend on anything from the `@sentry/react` package. */ function createReduxEnhancer() { return (createStore) => createStore; } /** * A passthrough error boundary wrapper for the server that doesn't depend on any react. Error boundaries don't catch * SSR errors so they should simply be a passthrough. */ // eslint-disable-next-line @typescript-eslint/no-explicit-any function withErrorBoundary( WrappedComponent, ) { return WrappedComponent ; } /** * Just a passthrough since we're on the server and showing the report dialog on the server doesn't make any sense. */ function showReportDialog() { return; } /** * Returns the runtime configuration for the SDK based on the environment. * When running on OpenNext/Cloudflare, returns cloudflare runtime config. */ function getCloudflareRuntimeConfig() { if (isCloudflareWaitUntilAvailable()) { // todo: add version information? return { runtime: { name: 'cloudflare' } }; } return undefined; } /** Inits the Sentry NextJS SDK on node. */ function init(options) { prepareSafeIdGeneratorContext(); if (isBuild()) { return; } if (!DEBUG_BUILD && options.debug) { // eslint-disable-next-line no-console console.warn( '[@sentry/nextjs] You have enabled `debug: true`, but Sentry debug logging was removed from your bundle (likely via `withSentryConfig({ disableLogger: true })` / `webpack.treeshake.removeDebugLogging: true`). Set that option to `false` to see Sentry debug output.', ); } const customDefaultIntegrations = getDefaultIntegrations(options) .filter(integration => integration.name !== 'Http') .concat( // We are using the HTTP integration without instrumenting incoming HTTP requests because Next.js does that by itself. httpIntegration({ disableIncomingRequestSpans: true, }), ); // Turn off Next.js' own fetch instrumentation (only when we manage OTEL) // https://github.com/lforst/nextjs-fork/blob/1994fd186defda77ad971c36dc3163db263c993f/packages/next/src/server/lib/patch-fetch.ts#L245 // Enable with custom OTel setup: https://github.com/getsentry/sentry-javascript/issues/17581 if (!options.skipOpenTelemetrySetup) { process.env.NEXT_OTEL_FETCH_DISABLED = '1'; } // This value is injected at build time, based on the output directory specified in the build config. Though a default // is set there, we set it here as well, just in case something has gone wrong with the injection. const distDirName = process.env._sentryRewriteFramesDistDir || globalWithInjectedValues._sentryRewriteFramesDistDir; if (distDirName) { customDefaultIntegrations.push(distDirRewriteFramesIntegration({ distDirName })); } // Detect if running on OpenNext/Cloudflare and get runtime config const cloudflareConfig = getCloudflareRuntimeConfig(); const opts = { environment: process.env.SENTRY_ENVIRONMENT || getVercelEnv(false) || process.env.NODE_ENV, release: process.env._sentryRelease || globalWithInjectedValues._sentryRelease, defaultIntegrations: customDefaultIntegrations, ...options, // Override runtime to 'cloudflare' when running on OpenNext/Cloudflare ...cloudflareConfig, }; if (DEBUG_BUILD && opts.debug) { debug.enable(); } DEBUG_BUILD && debug.log('Initializing SDK...'); if (sdkAlreadyInitialized()) { DEBUG_BUILD && debug.log('SDK already initialized'); return; } // Use appropriate SDK metadata based on the runtime environment applySdkMetadata(opts, 'nextjs', ['nextjs', cloudflareConfig ? 'cloudflare' : 'node']); const client = init$1(opts); client?.on('beforeSampling', ({ spanAttributes }, samplingDecision) => { // There are situations where the Next.js Node.js server forwards requests for the Edge Runtime server (e.g. in // middleware) and this causes spans for Sentry ingest requests to be created. These are not exempt from our tracing // because we didn't get the chance to do `suppressTracing`, since this happens outside of userland. // We need to drop these spans. if ( // eslint-disable-next-line deprecation/deprecation (typeof spanAttributes[SEMATTRS_HTTP_TARGET] === 'string' && // eslint-disable-next-line deprecation/deprecation spanAttributes[SEMATTRS_HTTP_TARGET].includes('sentry_key') && // eslint-disable-next-line deprecation/deprecation spanAttributes[SEMATTRS_HTTP_TARGET].includes('sentry_client')) || (typeof spanAttributes[ATTR_URL_QUERY] === 'string' && spanAttributes[ATTR_URL_QUERY].includes('sentry_key') && spanAttributes[ATTR_URL_QUERY].includes('sentry_client')) ) { samplingDecision.decision = false; } }); client?.on('spanStart', handleOnSpanStart); client?.on('spanEnd', maybeCompleteCronCheckIn); getGlobalScope().addEventProcessor( Object.assign( (event => { if (event.type === 'transaction') { // Filter out transactions for static assets // This regex matches the default path to the static assets (`_next/static`) and could potentially filter out too many transactions. // We match `/_next/static/` anywhere in the transaction name because its location may change with the basePath setting. if (event.transaction?.match(/^GET (\/.*)?\/_next\/static\//)) { return null; } // Filter out transactions for requests to the tunnel route if ( (globalWithInjectedValues._sentryRewritesTunnelPath && event.transaction === `POST ${globalWithInjectedValues._sentryRewritesTunnelPath}`) || (process.env._sentryRewritesTunnelPath && event.transaction === `POST ${process.env._sentryRewritesTunnelPath}`) ) { return null; } // Filter out requests to resolve source maps for stack frames in dev mode if (event.transaction?.match(/\/__nextjs_original-stack-frame/)) { return null; } // Filter out /404 transactions which seem to be created excessively if ( // Pages router event.transaction === '/404' || // App router (could be "GET /404", "POST /404", ...) event.transaction?.match(/^(GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH) \/(404|_not-found)$/) ) { return null; } // Filter transactions that we explicitly want to drop. if (event.contexts?.trace?.data?.[TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION]) { return null; } // Next.js 13 sometimes names the root transactions like this containing useless tracing. if (event.transaction === 'NextServer.getRequestHandler') { return null; } // Next.js 13 is not correctly picking up tracing data for trace propagation so we use a back-fill strategy if (typeof event.contexts?.trace?.data?.[TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL] === 'string') { const traceparentData = extractTraceparentData( event.contexts.trace.data[TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL], ); if (traceparentData?.parentSampled === false) { return null; } } return event; } else { return event; } }) , { id: 'NextLowQualityTransactionsFilter' }, ), ); getGlobalScope().addEventProcessor( Object.assign( ((event, hint) => { if (event.type !== undefined) { return event; } const originalException = hint.originalException; const isPostponeError = typeof originalException === 'object' && originalException !== null && '$$typeof' in originalException && originalException.$$typeof === Symbol.for('react.postpone'); if (isPostponeError) { // Postpone errors are used for partial-pre-rendering (PPR) return null; } // We don't want to capture suspense errors as they are simply used by React/Next.js for control flow const exceptionMessage = event.exception?.values?.[0]?.value; if ( exceptionMessage?.includes('Suspense Exception: This is not a real error!') || exceptionMessage?.includes('Suspense Exception: This is not a real error, and should not leak') ) { return null; } return event; }) , { id: 'DropReactControlFlowErrors' }, ), ); // Use the preprocessEvent hook instead of an event processor, so that the users event processors receive the most // up-to-date value, but also so that the logic that detects changes to the transaction names to set the source to // "custom", doesn't trigger. client?.on('preprocessEvent', event => { // Enhance route handler transactions if ( event.type === 'transaction' && event.contexts?.trace?.data?.[ATTR_NEXT_SPAN_TYPE] === 'BaseServer.handleRequest' ) { event.contexts.trace.data[SEMANTIC_ATTRIBUTE_SENTRY_OP] = 'http.server'; event.contexts.trace.op = 'http.server'; if (event.transaction) { event.transaction = stripUrlQueryAndFragment(event.transaction); } // eslint-disable-next-line deprecation/deprecation const method = event.contexts.trace.data[SEMATTRS_HTTP_METHOD]; // eslint-disable-next-line deprecation/deprecation const target = event.contexts?.trace?.data?.[SEMATTRS_HTTP_TARGET]; const route = event.contexts.trace.data[ATTR_HTTP_ROUTE] || event.contexts.trace.data[ATTR_NEXT_ROUTE]; const spanName = event.contexts.trace.data[ATTR_NEXT_SPAN_NAME]; if (typeof method === 'string' && typeof route === 'string' && !route.startsWith('middleware')) { const cleanRoute = route.replace(/\/route$/, ''); event.transaction = `${method} ${cleanRoute}`; event.contexts.trace.data[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route'; // Preserve next.route in case it did not get hoisted event.contexts.trace.data[ATTR_NEXT_ROUTE] = cleanRoute; } // backfill transaction name for pages that would otherwise contain unparameterized routes if (event.contexts.trace.data[TRANSACTION_ATTR_SENTRY_ROUTE_BACKFILL] && event.transaction !== 'GET /_app') { event.transaction = `${method} ${event.contexts.trace.data[TRANSACTION_ATTR_SENTRY_ROUTE_BACKFILL]}`; } const middlewareMatch = typeof spanName === 'string' && spanName.match(/^middleware (GET|POST|PUT|DELETE|PATCH|HEAD|OPTIONS)/); if (middlewareMatch) { const normalizedName = `middleware ${middlewareMatch[1]}`; event.transaction = normalizedName; event.contexts.trace.op = 'http.server.middleware'; } // Next.js overrides transaction names for page loads that throw an error // but we want to keep the original target name if (event.transaction === 'GET /_error' && target) { event.transaction = `${method ? `${method} ` : ''}${target}`; } } // Next.js 13 is not correctly picking up tracing data for trace propagation so we use a back-fill strategy if ( event.type === 'transaction' && typeof event.contexts?.trace?.data?.[TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL] === 'string' ) { const traceparentData = extractTraceparentData(event.contexts.trace.data[TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL]); if (traceparentData?.traceId) { event.contexts.trace.trace_id = traceparentData.traceId; } if (traceparentData?.parentSpanId) { event.contexts.trace.parent_span_id = traceparentData.parentSpanId; } } setUrlProcessingMetadata(event); }); if (process.env.NODE_ENV === 'development') { getGlobalScope().addEventProcessor(devErrorSymbolicationEventProcessor); } try { // @ts-expect-error `process.turbopack` is a magic string that will be replaced by Next.js if (process.turbopack) { getGlobalScope().setTag('turbopack', true); } } catch { // Noop // The statement above can throw because process is not defined on the client } DEBUG_BUILD && debug.log('SDK successfully initialized'); return client; } function sdkAlreadyInitialized() { return !!getClient(); } export { ErrorBoundary, createReduxEnhancer, init, showReportDialog, withErrorBoundary }; //# sourceMappingURL=index.js.map