feat: Stop using dropUndefinedKeys (#15796)

This removes the last remaining usages of `dropUndefinedKeys` in the
SDK.

It also deprecates the export from `@sentry/core` for future removal.

Author: mydea

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<void> {

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',

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);
 

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,
-  });
+  };
 }

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,
   ];
 }

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,

packages/core/src/utils-hoist/object.ts

@@ -210,6 +210,8 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
  * Works recursively on objects and arrays.
  *
  * Attention: This function keeps circular references in the returned object.
+ *
+ * @deprecated This function is no longer used by the SDK and will be removed in a future major version.
  */
 export function dropUndefinedKeys<T>(inputValue: T): T {
   // This map keeps track of what already visited nodes map to.

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({

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,
-  });
+  };
 }
 
 /**

packages/core/src/utils/transactionEvent.ts

@@ -1,14 +1,13 @@
 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.
  */
 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);
 }