diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts b/dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts index 2d9258936169..9ca836610f2f 100644 --- a/dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts +++ b/dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts @@ -1,4 +1,4 @@ -import { Context, GLOBAL_OBJ, dropUndefinedKeys, flush, logger, vercelWaitUntil } from '@sentry/core'; +import { Context, GLOBAL_OBJ, flush, logger, vercelWaitUntil } from '@sentry/core'; import * as SentryNode from '@sentry/node'; import { H3Error } from 'h3'; import type { CapturedErrorContext } from 'nitropack'; @@ -36,24 +36,22 @@ export default defineNitroPlugin(nitroApp => { }); function extractErrorContext(errorContext: CapturedErrorContext): Context { - const structuredContext: Context = { - method: undefined, - path: undefined, - tags: undefined, - }; + const ctx: Context = {}; - if (errorContext) { - if (errorContext.event) { - structuredContext.method = errorContext.event._method || undefined; - structuredContext.path = errorContext.event._path || undefined; - } + if (!errorContext) { + return ctx; + } - if (Array.isArray(errorContext.tags)) { - structuredContext.tags = errorContext.tags || undefined; - } + if (errorContext.event) { + ctx.method = errorContext.event._method; + ctx.path = errorContext.event._path; + } + + if (Array.isArray(errorContext.tags)) { + ctx.tags = errorContext.tags; } - return dropUndefinedKeys(structuredContext); + return ctx; } async function flushIfServerless(): Promise { diff --git a/packages/browser/test/tracing/browserTracingIntegration.test.ts b/packages/browser/test/tracing/browserTracingIntegration.test.ts index ee43935cd531..fe9005d47215 100644 --- a/packages/browser/test/tracing/browserTracingIntegration.test.ts +++ b/packages/browser/test/tracing/browserTracingIntegration.test.ts @@ -728,6 +728,7 @@ describe('browserTracingIntegration', () => { sampled: true, sampleRand: expect.any(Number), dsc: { + release: undefined, environment: 'production', public_key: 'examplePublicKey', sample_rate: '1', @@ -768,6 +769,7 @@ describe('browserTracingIntegration', () => { sampled: false, sampleRand: expect.any(Number), dsc: { + release: undefined, environment: 'production', public_key: 'examplePublicKey', sample_rate: '0', @@ -892,6 +894,7 @@ describe('browserTracingIntegration', () => { expect(dynamicSamplingContext).toBeDefined(); expect(dynamicSamplingContext).toStrictEqual({ + release: undefined, environment: 'production', public_key: 'examplePublicKey', sample_rate: '1', diff --git a/packages/core/src/tracing/dynamicSamplingContext.ts b/packages/core/src/tracing/dynamicSamplingContext.ts index 706684ffecab..12cf4ca11ca6 100644 --- a/packages/core/src/tracing/dynamicSamplingContext.ts +++ b/packages/core/src/tracing/dynamicSamplingContext.ts @@ -8,7 +8,7 @@ import { baggageHeaderToDynamicSamplingContext, dynamicSamplingContextToSentryBaggageHeader, } from '../utils-hoist/baggage'; -import { addNonEnumerableProperty, dropUndefinedKeys } from '../utils-hoist/object'; +import { addNonEnumerableProperty } from '../utils-hoist/object'; import { hasSpansEnabled } from '../utils/hasSpansEnabled'; import { getRootSpan, spanIsSampled, spanToJSON } from '../utils/spanUtils'; import { getCapturedScopesOnSpan } from './utils'; @@ -41,12 +41,14 @@ export function getDynamicSamplingContextFromClient(trace_id: string, client: Cl const { publicKey: public_key } = client.getDsn() || {}; - const dsc = dropUndefinedKeys({ + // Instead of conditionally adding non-undefined values, we add them and then remove them if needed + // otherwise, the order of baggage entries changes, which "breaks" a bunch of tests etc. + const dsc: DynamicSamplingContext = { environment: options.environment || DEFAULT_ENVIRONMENT, release: options.release, public_key, trace_id, - }) satisfies DynamicSamplingContext; + }; client.emit('createDsc', dsc); diff --git a/packages/core/src/utils-hoist/anr.ts b/packages/core/src/utils-hoist/anr.ts index 0602321117bf..84cce09bb030 100644 --- a/packages/core/src/utils-hoist/anr.ts +++ b/packages/core/src/utils-hoist/anr.ts @@ -1,6 +1,5 @@ import type { StackFrame } from '../types-hoist'; import { filenameIsInApp } from './node-stack-trace'; -import { dropUndefinedKeys } from './object'; import { UNKNOWN_FUNCTION } from './stacktrace'; type WatchdogReturn = { @@ -81,12 +80,12 @@ export function callFrameToStackFrame( const colno = frame.location.columnNumber ? frame.location.columnNumber + 1 : undefined; const lineno = frame.location.lineNumber ? frame.location.lineNumber + 1 : undefined; - return dropUndefinedKeys({ + return { filename, module: getModuleFromFilename(filename), function: frame.functionName || UNKNOWN_FUNCTION, colno, lineno, in_app: filename ? filenameIsInApp(filename) : undefined, - }); + }; } diff --git a/packages/core/src/utils-hoist/envelope.ts b/packages/core/src/utils-hoist/envelope.ts index 2593079d5db6..450706fb9c2e 100644 --- a/packages/core/src/utils-hoist/envelope.ts +++ b/packages/core/src/utils-hoist/envelope.ts @@ -18,7 +18,6 @@ import type { import { dsnToString } from './dsn'; import { normalize } from './normalize'; -import { dropUndefinedKeys } from './object'; import { GLOBAL_OBJ } from './worldwide'; /** @@ -196,13 +195,13 @@ export function createAttachmentEnvelopeItem(attachment: Attachment): Attachment const buffer = typeof attachment.data === 'string' ? encodeUTF8(attachment.data) : attachment.data; return [ - dropUndefinedKeys({ + { type: 'attachment', length: buffer.length, filename: attachment.filename, content_type: attachment.contentType, attachment_type: attachment.attachmentType, - }), + }, buffer, ]; } diff --git a/packages/core/src/utils-hoist/index.ts b/packages/core/src/utils-hoist/index.ts index 4f22928eff86..4786147c686b 100644 --- a/packages/core/src/utils-hoist/index.ts +++ b/packages/core/src/utils-hoist/index.ts @@ -45,6 +45,7 @@ export { normalize, normalizeToSize, normalizeUrlToBase } from './normalize'; export { addNonEnumerableProperty, convertToPlainObject, + // eslint-disable-next-line deprecation/deprecation dropUndefinedKeys, extractExceptionKeysForMessage, fill, diff --git a/packages/core/src/utils-hoist/object.ts b/packages/core/src/utils-hoist/object.ts index 7826e960d982..d1a1ba82aa99 100644 --- a/packages/core/src/utils-hoist/object.ts +++ b/packages/core/src/utils-hoist/object.ts @@ -210,6 +210,8 @@ export function extractExceptionKeysForMessage(exception: Record(inputValue: T): T { // This map keeps track of what already visited nodes map to. diff --git a/packages/core/src/utils/request.ts b/packages/core/src/utils/request.ts index 07907d8b9b4f..91a965484d8c 100644 --- a/packages/core/src/utils/request.ts +++ b/packages/core/src/utils/request.ts @@ -1,6 +1,5 @@ import type { PolymorphicRequest, RequestEventData } from '../types-hoist'; import type { WebFetchHeaders, WebFetchRequest } from '../types-hoist/webfetchapi'; -import { dropUndefinedKeys } from '../utils-hoist/object'; /** * Transforms a `Headers` object that implements the `Web Fetch API` (https://developer.mozilla.org/en-US/docs/Web/API/Headers) into a simple key-value dict. @@ -91,14 +90,14 @@ export function httpRequestToRequestData(request: { // This is non-standard, but may be set on e.g. Next.js or Express requests const cookies = (request as PolymorphicRequest).cookies; - return dropUndefinedKeys({ + return { url: absoluteUrl, method: request.method, query_string: extractQueryParamsFromUrl(url), headers: headersToDict(headers), cookies, data, - }); + }; } function getAbsoluteUrl({ diff --git a/packages/core/src/utils/spanUtils.ts b/packages/core/src/utils/spanUtils.ts index 0a46ba600e0c..cbfcde2a2576 100644 --- a/packages/core/src/utils/spanUtils.ts +++ b/packages/core/src/utils/spanUtils.ts @@ -21,7 +21,7 @@ import type { } from '../types-hoist'; import type { SpanLink, SpanLinkJSON } from '../types-hoist/link'; import { consoleSandbox } from '../utils-hoist/logger'; -import { addNonEnumerableProperty, dropUndefinedKeys } from '../utils-hoist/object'; +import { addNonEnumerableProperty } from '../utils-hoist/object'; import { generateSpanId } from '../utils-hoist/propagationContext'; import { timestampInSeconds } from '../utils-hoist/time'; import { generateSentryTraceHeader } from '../utils-hoist/tracing'; @@ -42,7 +42,7 @@ export function spanToTransactionTraceContext(span: Span): TraceContext { const { spanId: span_id, traceId: trace_id } = span.spanContext(); const { data, op, parent_span_id, status, origin, links } = spanToJSON(span); - return dropUndefinedKeys({ + return { parent_span_id, span_id, trace_id, @@ -51,7 +51,7 @@ export function spanToTransactionTraceContext(span: Span): TraceContext { status, origin, links, - }); + }; } /** @@ -67,11 +67,11 @@ export function spanToTraceContext(span: Span): TraceContext { const span_id = isRemote ? scope?.getPropagationContext().propagationSpanId || generateSpanId() : spanId; - return dropUndefinedKeys({ + return { parent_span_id, span_id, trace_id, - }); + }; } /** diff --git a/packages/core/src/utils/transactionEvent.ts b/packages/core/src/utils/transactionEvent.ts index 9ec233b4f078..195c31a66966 100644 --- a/packages/core/src/utils/transactionEvent.ts +++ b/packages/core/src/utils/transactionEvent.ts @@ -1,6 +1,5 @@ import { SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME, SEMANTIC_ATTRIBUTE_PROFILE_ID } from '../semanticAttributes'; import type { SpanJSON, TransactionEvent } from '../types-hoist'; -import { dropUndefinedKeys } from '../utils-hoist'; /** * Converts a transaction event to a span JSON object. @@ -8,7 +7,7 @@ import { dropUndefinedKeys } from '../utils-hoist'; export function convertTransactionEventToSpanJson(event: TransactionEvent): SpanJSON { const { trace_id, parent_span_id, span_id, status, origin, data, op } = event.contexts?.trace ?? {}; - return dropUndefinedKeys({ + return { data: data ?? {}, description: event.transaction, op, @@ -23,14 +22,14 @@ export function convertTransactionEventToSpanJson(event: TransactionEvent): Span exclusive_time: data?.[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined, measurements: event.measurements, is_segment: true, - }); + }; } /** * Converts a span JSON object to a transaction event. */ export function convertSpanJsonToTransactionEvent(span: SpanJSON): TransactionEvent { - const event: TransactionEvent = { + return { type: 'transaction', timestamp: span.timestamp, start_timestamp: span.start_timestamp, @@ -52,6 +51,4 @@ export function convertSpanJsonToTransactionEvent(span: SpanJSON): TransactionEv }, measurements: span.measurements, }; - - return dropUndefinedKeys(event); } diff --git a/packages/core/test/lib/tracing/dynamicSamplingContext.test.ts b/packages/core/test/lib/tracing/dynamicSamplingContext.test.ts index 23406908037c..2b7a030734bb 100644 --- a/packages/core/test/lib/tracing/dynamicSamplingContext.test.ts +++ b/packages/core/test/lib/tracing/dynamicSamplingContext.test.ts @@ -70,6 +70,7 @@ describe('getDynamicSamplingContextFromSpan', () => { const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan); expect(dynamicSamplingContext).toStrictEqual({ + public_key: undefined, release: '1.0.1', environment: 'production', sampled: 'true', @@ -88,6 +89,7 @@ describe('getDynamicSamplingContextFromSpan', () => { const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan); expect(dynamicSamplingContext).toStrictEqual({ + public_key: undefined, release: '1.0.1', environment: 'production', sampled: 'true', @@ -111,6 +113,7 @@ describe('getDynamicSamplingContextFromSpan', () => { const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan); expect(dynamicSamplingContext).toStrictEqual({ + public_key: undefined, release: '1.0.1', environment: 'production', sampled: 'true', @@ -166,6 +169,7 @@ describe('getDynamicSamplingContextFromSpan', () => { const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan); expect(dynamicSamplingContext).toStrictEqual({ + public_key: undefined, release: '1.0.1', environment: 'production', trace_id: expect.stringMatching(/^[a-f0-9]{32}$/), diff --git a/packages/core/test/utils-hoist/object.test.ts b/packages/core/test/utils-hoist/object.test.ts index e1c32f163193..a563c1298ccb 100644 --- a/packages/core/test/utils-hoist/object.test.ts +++ b/packages/core/test/utils-hoist/object.test.ts @@ -169,6 +169,7 @@ describe('extractExceptionKeysForMessage()', () => { }); }); +/* eslint-disable deprecation/deprecation */ describe('dropUndefinedKeys()', () => { test('simple case', () => { expect( @@ -314,6 +315,7 @@ describe('dropUndefinedKeys()', () => { expect(droppedChicken.lays[0] === droppedChicken).toBe(true); }); }); +/* eslint-enable deprecation/deprecation */ describe('objectify()', () => { describe('stringifies nullish values', () => { diff --git a/packages/nuxt/src/runtime/utils.ts b/packages/nuxt/src/runtime/utils.ts index 23bac2486b74..c6eb59807764 100644 --- a/packages/nuxt/src/runtime/utils.ts +++ b/packages/nuxt/src/runtime/utils.ts @@ -1,5 +1,5 @@ import type { ClientOptions, Context } from '@sentry/core'; -import { captureException, dropUndefinedKeys, getClient, getTraceMetaTags } from '@sentry/core'; +import { captureException, getClient, getTraceMetaTags } from '@sentry/core'; import type { VueOptions } from '@sentry/vue/src/types'; import type { CapturedErrorContext } from 'nitropack'; import type { NuxtRenderHTMLContext } from 'nuxt/app'; @@ -9,25 +9,23 @@ import type { ComponentPublicInstance } from 'vue'; * Extracts the relevant context information from the error context (H3Event in Nitro Error) * and created a structured context object. */ -export function extractErrorContext(errorContext: CapturedErrorContext): Context { - const structuredContext: Context = { - method: undefined, - path: undefined, - tags: undefined, - }; +export function extractErrorContext(errorContext: CapturedErrorContext | undefined): Context { + const ctx: Context = {}; - if (errorContext) { - if (errorContext.event) { - structuredContext.method = errorContext.event._method || undefined; - structuredContext.path = errorContext.event._path || undefined; - } + if (!errorContext) { + return ctx; + } - if (Array.isArray(errorContext.tags)) { - structuredContext.tags = errorContext.tags || undefined; - } + if (errorContext.event) { + ctx.method = errorContext.event._method; + ctx.path = errorContext.event._path; + } + + if (Array.isArray(errorContext.tags)) { + ctx.tags = errorContext.tags; } - return dropUndefinedKeys(structuredContext); + return ctx; } /** diff --git a/packages/replay-internal/src/integration.ts b/packages/replay-internal/src/integration.ts index 4ec1a357eac4..bc916ba591a8 100644 --- a/packages/replay-internal/src/integration.ts +++ b/packages/replay-internal/src/integration.ts @@ -1,5 +1,5 @@ import type { BrowserClientReplayOptions, Client, Integration, IntegrationFn, ReplayRecordingMode } from '@sentry/core'; -import { consoleSandbox, dropUndefinedKeys, isBrowser, parseSampleRate } from '@sentry/core'; +import { consoleSandbox, isBrowser, parseSampleRate } from '@sentry/core'; import { DEFAULT_FLUSH_MAX_DELAY, DEFAULT_FLUSH_MIN_DELAY, @@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions, const finalOptions: ReplayPluginOptions = { sessionSampleRate: 0, errorSampleRate: 0, - ...dropUndefinedKeys(initialOptions), + ...initialOptions, }; const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate); diff --git a/packages/sveltekit/src/vite/sentryVitePlugins.ts b/packages/sveltekit/src/vite/sentryVitePlugins.ts index 60258f653400..4444ba9a6ab7 100644 --- a/packages/sveltekit/src/vite/sentryVitePlugins.ts +++ b/packages/sveltekit/src/vite/sentryVitePlugins.ts @@ -1,4 +1,3 @@ -import { dropUndefinedKeys } from '@sentry/core'; import type { Plugin } from 'vite'; import type { AutoInstrumentSelection } from './autoInstrument'; import { makeAutoInstrumentationPlugin } from './autoInstrument'; @@ -104,5 +103,5 @@ export function generateVitePluginOptions( } } - return dropUndefinedKeys(sentryVitePluginsOptions); + return sentryVitePluginsOptions; }