ref: Avoid some usage of dropUndefinedKeys() (#15757)

This gets rid of some unnecessary invocations of `dropUndefinedKeys()`
that we have.

Author: mydea

packages/browser-utils/src/metrics/cls.ts

@@ -10,7 +10,7 @@ import {
   getRootSpan,
   spanToJSON,
 } from '@sentry/core';
-import { browserPerformanceTimeOrigin, dropUndefinedKeys, htmlTreeAsString, logger } from '@sentry/core';
+import { browserPerformanceTimeOrigin, htmlTreeAsString, logger } from '@sentry/core';
 import type { SpanAttributes } from '@sentry/core';
 import { DEBUG_BUILD } from '../debug-build';
 import { addClsInstrumentationHandler } from './instrument';
@@ -95,13 +95,13 @@ function sendStandaloneClsSpan(clsValue: number, entry: LayoutShift | undefined,
 
   const name = entry ? htmlTreeAsString(entry.sources[0]?.node) : 'Layout shift';
 
-  const attributes: SpanAttributes = dropUndefinedKeys({
+  const attributes: SpanAttributes = {
     [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.browser.cls',
     [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'ui.webvital.cls',
     [SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME]: entry?.duration || 0,
     // attach the pageload span id to the CLS span so that we can link them in the UI
     'sentry.pageload.span_id': pageloadSpanId,
-  });
+  };
 
   const span = startStandaloneWebVitalSpan({
     name,

packages/core/src/currentScopes.ts

@@ -4,7 +4,6 @@ import type { Client } from './client';
 import { Scope } from './scope';
 import type { TraceContext } from './types-hoist';
 import { generateSpanId } from './utils-hoist';
-import { dropUndefinedKeys } from './utils-hoist/object';
 
 /**
  * Get the currently active scope.
@@ -130,11 +129,14 @@ export function getTraceContextFromScope(scope: Scope): TraceContext {
 
   const { traceId, parentSpanId, propagationSpanId } = propagationContext;
 
-  const traceContext: TraceContext = dropUndefinedKeys({
+  const traceContext: TraceContext = {
     trace_id: traceId,
     span_id: propagationSpanId || generateSpanId(),
-    parent_span_id: parentSpanId,
-  });
+  };
+
+  if (parentSpanId) {
+    traceContext.parent_span_id = parentSpanId;
+  }
 
   return traceContext;
 }

packages/core/src/tracing/sentrySpan.ts

@@ -373,9 +373,7 @@ export class SentrySpan implements Span {
       sdkProcessingMetadata: {
         capturedSpanScope,
         capturedSpanIsolationScope,
-        ...dropUndefinedKeys({
-          dynamicSamplingContext: getDynamicSamplingContextFromSpan(this),
-        }),
+        dynamicSamplingContext: getDynamicSamplingContextFromSpan(this),
       },
       ...(source && {
         transaction_info: {

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

@@ -259,7 +259,7 @@ export function createEventEnvelopeHeaders(
     ...(sdkInfo && { sdk: sdkInfo }),
     ...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
     ...(dynamicSamplingContext && {
-      trace: dropUndefinedKeys({ ...dynamicSamplingContext }),
+      trace: dynamicSamplingContext,
     }),
   };
 }

packages/core/src/utils/applyScopeDataToEvent.ts

@@ -1,7 +1,6 @@
 import type { ScopeData } from '../scope';
 import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
 import type { Breadcrumb, Event, Span } from '../types-hoist';
-import { dropUndefinedKeys } from '../utils-hoist/object';
 import { merge } from './merge';
 import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';
 
@@ -113,24 +112,20 @@ export function mergeArray<Prop extends 'breadcrumbs' | 'fingerprint'>(
 function applyDataToEvent(event: Event, data: ScopeData): void {
   const { extra, tags, user, contexts, level, transactionName } = data;
 
-  const cleanedExtra = dropUndefinedKeys(extra);
-  if (Object.keys(cleanedExtra).length) {
-    event.extra = { ...cleanedExtra, ...event.extra };
+  if (Object.keys(extra).length) {
+    event.extra = { ...extra, ...event.extra };
   }
 
-  const cleanedTags = dropUndefinedKeys(tags);
-  if (Object.keys(cleanedTags).length) {
-    event.tags = { ...cleanedTags, ...event.tags };
+  if (Object.keys(tags).length) {
+    event.tags = { ...tags, ...event.tags };
   }
 
-  const cleanedUser = dropUndefinedKeys(user);
-  if (Object.keys(cleanedUser).length) {
-    event.user = { ...cleanedUser, ...event.user };
+  if (Object.keys(user).length) {
+    event.user = { ...user, ...event.user };
   }
 
-  const cleanedContexts = dropUndefinedKeys(contexts);
-  if (Object.keys(cleanedContexts).length) {
-    event.contexts = { ...cleanedContexts, ...event.contexts };
+  if (Object.keys(contexts).length) {
+    event.contexts = { ...contexts, ...event.contexts };
   }
 
   if (level) {

packages/core/test/lib/utils/applyScopeDataToEvent.test.ts

@@ -194,6 +194,54 @@ describe('mergeScopeData', () => {
 });
 
 describe('applyScopeDataToEvent', () => {
+  it('should correctly merge nested event and scope data with undefined values', () => {
+    const eventData: Event = {
+      user: {
+        name: 'John',
+        age: undefined,
+        location: 'New York',
+        newThing: undefined,
+      },
+      extra: {},
+    };
+
+    const scopeData: ScopeData = {
+      eventProcessors: [],
+      breadcrumbs: [],
+      user: {
+        name: 'John',
+        age: 30,
+        location: 'Vienna',
+        role: 'developer',
+        thing: undefined,
+      },
+      tags: {},
+      extra: {},
+      contexts: {},
+      attachments: [],
+      propagationContext: { traceId: '1', sampleRand: 0.42 },
+      sdkProcessingMetadata: {},
+      fingerprint: [],
+    };
+
+    applyScopeDataToEvent(eventData, scopeData);
+
+    // Verify merged data structure
+    expect(eventData).toEqual({
+      user: {
+        name: 'John',
+        age: undefined,
+        location: 'New York',
+        role: 'developer',
+        thing: undefined,
+        newThing: undefined,
+      },
+      extra: {},
+      breadcrumbs: undefined,
+      sdkProcessingMetadata: {},
+    });
+  });
+
   it("doesn't apply scope.transactionName to transaction events", () => {
     const data: ScopeData = {
       eventProcessors: [],

packages/opentelemetry/src/spanExporter.ts

@@ -239,14 +239,14 @@ export function createTransactionForOtelSpan(span: ReadableSpan): TransactionEve
 
   const sampleRate = span.attributes[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE] as number | undefined;
 
-  const attributes: SpanAttributes = dropUndefinedKeys({
+  const attributes: SpanAttributes = {
     [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
     [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: sampleRate,
     [SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,
     [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: origin,
     ...data,
     ...removeSentryAttributes(span.attributes),
-  });
+  };
 
   const { links } = span;
   const { traceId: trace_id, spanId: span_id } = span.spanContext();
@@ -260,7 +260,7 @@ export function createTransactionForOtelSpan(span: ReadableSpan): TransactionEve
 
   const status = mapStatus(span);
 
-  const traceContext: TraceContext = dropUndefinedKeys({
+  const traceContext: TraceContext = {
     parent_span_id,
     span_id,
     trace_id,
@@ -269,7 +269,7 @@ export function createTransactionForOtelSpan(span: ReadableSpan): TransactionEve
     op,
     status: getStatusMessage(status), // As per protocol, span status is allowed to be undefined
     links: convertSpanLinksForEnvelope(links),
-  });
+  };
 
   const statusCode = attributes[ATTR_HTTP_RESPONSE_STATUS_CODE];
   const responseContext = typeof statusCode === 'number' ? { response: { status_code: statusCode } } : undefined;
@@ -288,12 +288,10 @@ export function createTransactionForOtelSpan(span: ReadableSpan): TransactionEve
     transaction: description,
     type: 'transaction',
     sdkProcessingMetadata: {
-      ...dropUndefinedKeys({
-        capturedSpanScope: capturedSpanScopes.scope,
-        capturedSpanIsolationScope: capturedSpanScopes.isolationScope,
-        sampleRate,
-        dynamicSamplingContext: getDynamicSamplingContextFromSpan(span as unknown as Span),
-      }),
+      capturedSpanScope: capturedSpanScopes.scope,
+      capturedSpanIsolationScope: capturedSpanScopes.isolationScope,
+      sampleRate,
+      dynamicSamplingContext: getDynamicSamplingContextFromSpan(span as unknown as Span),
     },
     ...(source && {
       transaction_info: {
@@ -328,12 +326,12 @@ function createAndFinishSpanForOtelSpan(node: SpanNode, spans: SpanJSON[], sentS
   const { attributes, startTime, endTime, parentSpanId, links } = span;
 
   const { op, description, data, origin = 'manual' } = getSpanData(span);
-  const allData = dropUndefinedKeys({
+  const allData = {
     [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: origin,
     [SEMANTIC_ATTRIBUTE_SENTRY_OP]: op,
     ...removeSentryAttributes(attributes),
     ...data,
-  });
+  };
 
   const status = mapStatus(span);