ref: Refactor some more dropUndefinedKeys

Author: mydea

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,21 @@ 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;
+  };
+
+  if (!dsc.release) {
+    delete dsc.release;
+  }
+  if (!dsc.public_key) {
+    delete dsc.public_key;
+  }
 
   client.emit('createDsc', dsc);
 

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

@@ -17,7 +17,7 @@ import type { SpanJSON } from './span';
 // Based on https://github.com/getsentry/relay/blob/b23b8d3b2360a54aaa4d19ecae0231201f31df5e/relay-sampling/src/lib.rs#L685-L707
 export type DynamicSamplingContext = {
   trace_id: string;
-  public_key: DsnComponents['publicKey'];
+  public_key?: DsnComponents['publicKey'];
   sample_rate?: string;
   release?: string;
   environment?: string;

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

@@ -81,12 +81,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

@@ -196,13 +196,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/request.ts

@@ -91,14 +91,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

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

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';
@@ -10,24 +10,15 @@ import type { ComponentPublicInstance } from 'vue';
  *  and created a structured context object.
  */
 export function extractErrorContext(errorContext: CapturedErrorContext): Context {
-  const structuredContext: Context = {
-    method: undefined,
-    path: undefined,
-    tags: undefined,
-  };
-
-  if (errorContext) {
-    if (errorContext.event) {
-      structuredContext.method = errorContext.event._method || undefined;
-      structuredContext.path = errorContext.event._path || undefined;
-    }
-
-    if (Array.isArray(errorContext.tags)) {
-      structuredContext.tags = errorContext.tags || undefined;
-    }
+  if (!errorContext.event) {
+    return {};
   }
 
-  return dropUndefinedKeys(structuredContext);
+  return {
+    method: errorContext.event._method,
+    path: errorContext.event._path,
+    tags: Array.isArray(errorContext.tags) ? errorContext.tags : undefined,
+  };
 }
 
 /**

packages/replay-internal/src/integration.ts

@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
   const finalOptions: ReplayPluginOptions = {
     sessionSampleRate: 0,
     errorSampleRate: 0,
-    ...dropUndefinedKeys(initialOptions),
+    ...initialOptions,
   };
 
   const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);

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