Skip to content

feat: Stop using dropUndefinedKeys#15796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mydea merged 5 commits into from
Mar 25, 2025
Merged

feat: Stop using dropUndefinedKeys#15796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d2dffac
ref: Refactor some more `dropUndefinedKeys`
mydea Mar 24, 2025
3347fa5
avoid more work??
mydea Mar 24, 2025
0869503
fixes
mydea Mar 24, 2025
850f1bb
deprecate it..
mydea Mar 24, 2025
759bf76
small test fixes
mydea Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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> {
Expand Down
3 changes: 3 additions & 0 deletions packages/browser/test/tracing/browserTracingIntegration.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -728,6 +728,7 @@ describe('browserTracingIntegration', () => {
sampled: true,
sampleRand: expect.any(Number),
dsc: {
release: undefined,
environment: 'production',
public_key: 'examplePublicKey',
sample_rate: '1',
Expand DownExpand Up@@ -768,6 +769,7 @@ describe('browserTracingIntegration', () => {
sampled: false,
sampleRand: expect.any(Number),
dsc: {
release: undefined,
environment: 'production',
public_key: 'examplePublicKey',
sample_rate: '0',
Expand DownExpand Up@@ -892,6 +894,7 @@ describe('browserTracingIntegration', () => {

expect(dynamicSamplingContext).toBeDefined();
expect(dynamicSamplingContext).toStrictEqual({
release: undefined,
environment: 'production',
public_key: 'examplePublicKey',
sample_rate: '1',
Expand Down
8 changes: 5 additions & 3 deletions packages/core/src/tracing/dynamicSamplingContext.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand DownExpand Up@@ -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);

Expand Down
5 changes: 2 additions & 3 deletions packages/core/src/utils-hoist/anr.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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 = {
Expand DownExpand Up@@ -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,
});
};
}
5 changes: 2 additions & 3 deletions packages/core/src/utils-hoist/envelope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ import type {

import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { dropUndefinedKeys } from './object';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -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,
];
}
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/utils-hoist/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,6 +45,7 @@ export { normalize, normalizeToSize, normalizeUrlToBase } from './normalize';
export {
addNonEnumerableProperty,
convertToPlainObject,
// eslint-disable-next-line deprecation/deprecation
dropUndefinedKeys,
extractExceptionKeysForMessage,
fill,
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils-hoist/object.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down
5 changes: 2 additions & 3 deletions packages/core/src/utils/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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.
Expand DownExpand Up@@ -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({
Expand Down
10 changes: 5 additions & 5 deletions packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand All@@ -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,
Expand All@@ -51,7 +51,7 @@ export function spanToTransactionTraceContext(span: Span): TraceContext {
status,
origin,
links,
});
};
}

/**
Expand All@@ -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,
});
};
}

/**
Expand Down
9 changes: 3 additions & 6 deletions packages/core/src/utils/transactionEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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,
Expand All@@ -52,6 +51,4 @@ export function convertSpanJsonToTransactionEvent(span: SpanJSON): TransactionEv
},
measurements: span.measurements,
};

return dropUndefinedKeys(event);
}
4 changes: 4 additions & 0 deletions packages/core/test/lib/tracing/dynamicSamplingContext.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

expect(dynamicSamplingContext).toStrictEqual({
public_key: undefined,
release: '1.0.1',
environment: 'production',
sampled: 'true',
Expand All@@ -88,6 +89,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

expect(dynamicSamplingContext).toStrictEqual({
public_key: undefined,
release: '1.0.1',
environment: 'production',
sampled: 'true',
Expand All@@ -111,6 +113,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

expect(dynamicSamplingContext).toStrictEqual({
public_key: undefined,
release: '1.0.1',
environment: 'production',
sampled: 'true',
Expand DownExpand Up@@ -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}$/),
Expand Down
2 changes: 2 additions & 0 deletions packages/core/test/utils-hoist/object.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,7 @@ describe('extractExceptionKeysForMessage()', () => {
});
});

/* eslint-disable deprecation/deprecation */
describe('dropUndefinedKeys()', () => {
test('simple case', () => {
expect(
Expand DownExpand Up@@ -314,6 +315,7 @@ describe('dropUndefinedKeys()', () => {
expect(droppedChicken.lays[0] === droppedChicken).toBe(true);
});
});
/* eslint-enable deprecation/deprecation */

describe('objectify()', () => {
describe('stringifies nullish values', () => {
Expand Down
30 changes: 14 additions & 16 deletions packages/nuxt/src/runtime/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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';
Expand All@@ -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;
}

/**
Expand Down
4 changes: 2 additions & 2 deletions packages/replay-internal/src/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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,
Expand DownExpand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
const finalOptions: ReplayPluginOptions = {
sessionSampleRate: 0,
errorSampleRate: 0,
...dropUndefinedKeys(initialOptions),
...initialOptions,
};

const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down
3 changes: 1 addition & 2 deletions packages/sveltekit/src/vite/sentryVitePlugins.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { dropUndefinedKeys } from '@sentry/core';
import type { Plugin } from 'vite';
import type { AutoInstrumentSelection } from './autoInstrument';
import { makeAutoInstrumentationPlugin } from './autoInstrument';
Expand DownExpand Up@@ -104,5 +103,5 @@ export function generateVitePluginOptions(
}
}

return dropUndefinedKeys(sentryVitePluginsOptions);
return sentryVitePluginsOptions;
}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat: Stop using `dropUndefinedKeys` by mydea · Pull Request #15796 · getsentry/sentry-javascript · GitHub
Skip to content
feat: Stop using dropUndefinedKeys#15796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Mar 25, 2025
 Merged


feat: Stop using dropUndefinedKeys#15796
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d2dffac

ref: Refactor some more `dropUndefinedKeys`


mydea Mar 24, 2025
3347fa5

avoid more work??


mydea Mar 24, 2025
0869503

fixes


mydea Mar 24, 2025
850f1bb

deprecate it..


mydea Mar 24, 2025
759bf76

small test fixes


mydea Mar 24, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 13 additions & 15 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -728,6 +728,7 @@ describe('browserTracingIntegration', () => {
 sampled: true,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand DownExpand Up@@ -768,6 +769,7 @@ describe('browserTracingIntegration', () => {
 sampled: false,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '0',
Expand DownExpand Up@@ -892,6 +894,7 @@ describe('browserTracingIntegration', () => {

 expect(dynamicSamplingContext).toBeDefined();
 expect(dynamicSamplingContext).toStrictEqual({
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand Down

8 changes: 5 additions & 3 deletions
packages/core/src/tracing/dynamicSamplingContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand DownExpand Up@@ -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);

Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/anr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 = {
Expand DownExpand Up@@ -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,
 });
 };
}

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ import type {

import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { dropUndefinedKeys } from './object';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -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,
 ];
}
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,6 +45,7 @@ export { normalize, normalizeToSize, normalizeUrlToBase } from './normalize';
export {
 addNonEnumerableProperty,
 convertToPlainObject,
 // eslint-disable-next-line deprecation/deprecation
 dropUndefinedKeys,
 extractExceptionKeysForMessage,
 fill,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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.
Expand DownExpand Up@@ -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({
Expand Down

10 changes: 5 additions & 5 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand All@@ -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,
Expand All@@ -51,7 +51,7 @@ export function spanToTransactionTraceContext(span: Span): TraceContext {
 status,
 origin,
 links,
 });
 };
}

/**
Expand All@@ -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,
 });
 };
}

/**
Expand Down

9 changes: 3 additions & 6 deletions
packages/core/src/utils/transactionEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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,
Expand All@@ -52,6 +51,4 @@ export function convertSpanJsonToTransactionEvent(span: SpanJSON): TransactionEv
 },
 measurements: span.measurements,
 };

 return dropUndefinedKeys(event);
}

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -88,6 +89,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -111,6 +113,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand DownExpand Up@@ -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}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/test/utils-hoist/object.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,7 @@ describe('extractExceptionKeysForMessage()', () => {
 });
});

/* eslint-disable deprecation/deprecation */
describe('dropUndefinedKeys()', () => {
 test('simple case', () => {
 expect(
Expand DownExpand Up@@ -314,6 +315,7 @@ describe('dropUndefinedKeys()', () => {
 expect(droppedChicken.lays[0] === droppedChicken).toBe(true);
 });
});
/* eslint-enable deprecation/deprecation */

describe('objectify()', () => {
 describe('stringifies nullish values', () => {
Expand Down

30 changes: 14 additions & 16 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand All@@ -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;
}

/**
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay-internal/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand DownExpand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
 const finalOptions: ReplayPluginOptions = {
 sessionSampleRate: 0,
 errorSampleRate: 0,
 ...dropUndefinedKeys(initialOptions),
 ...initialOptions,
 };

 const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down

3 changes: 1 addition & 2 deletions
packages/sveltekit/src/vite/sentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { dropUndefinedKeys } from '@sentry/core';
import type { Plugin } from 'vite';
import type { AutoInstrumentSelection } from './autoInstrument';
import { makeAutoInstrumentationPlugin } from './autoInstrument';
Expand DownExpand Up@@ -104,5 +103,5 @@ export function generateVitePluginOptions(
 }
 }

 return dropUndefinedKeys(sentryVitePluginsOptions);
 return sentryVitePluginsOptions;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: Stop using `dropUndefinedKeys` by mydea · Pull Request #15796 · getsentry/sentry-javascript · GitHub
Skip to content
feat: Stop using dropUndefinedKeys#15796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Mar 25, 2025
 Merged


feat: Stop using dropUndefinedKeys#15796
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d2dffac

ref: Refactor some more `dropUndefinedKeys`


mydea Mar 24, 2025
3347fa5

avoid more work??


mydea Mar 24, 2025
0869503

fixes


mydea Mar 24, 2025
850f1bb

deprecate it..


mydea Mar 24, 2025
759bf76

small test fixes


mydea Mar 24, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 13 additions & 15 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -728,6 +728,7 @@ describe('browserTracingIntegration', () => {
 sampled: true,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand DownExpand Up@@ -768,6 +769,7 @@ describe('browserTracingIntegration', () => {
 sampled: false,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '0',
Expand DownExpand Up@@ -892,6 +894,7 @@ describe('browserTracingIntegration', () => {

 expect(dynamicSamplingContext).toBeDefined();
 expect(dynamicSamplingContext).toStrictEqual({
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand Down

8 changes: 5 additions & 3 deletions
packages/core/src/tracing/dynamicSamplingContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand DownExpand Up@@ -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);

Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/anr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 = {
Expand DownExpand Up@@ -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,
 });
 };
}

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ import type {

import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { dropUndefinedKeys } from './object';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -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,
 ];
}
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,6 +45,7 @@ export { normalize, normalizeToSize, normalizeUrlToBase } from './normalize';
export {
 addNonEnumerableProperty,
 convertToPlainObject,
 // eslint-disable-next-line deprecation/deprecation
 dropUndefinedKeys,
 extractExceptionKeysForMessage,
 fill,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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.
Expand DownExpand Up@@ -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({
Expand Down

10 changes: 5 additions & 5 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand All@@ -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,
Expand All@@ -51,7 +51,7 @@ export function spanToTransactionTraceContext(span: Span): TraceContext {
 status,
 origin,
 links,
 });
 };
}

/**
Expand All@@ -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,
 });
 };
}

/**
Expand Down

9 changes: 3 additions & 6 deletions
packages/core/src/utils/transactionEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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,
Expand All@@ -52,6 +51,4 @@ export function convertSpanJsonToTransactionEvent(span: SpanJSON): TransactionEv
 },
 measurements: span.measurements,
 };

 return dropUndefinedKeys(event);
}

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -88,6 +89,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -111,6 +113,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand DownExpand Up@@ -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}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/test/utils-hoist/object.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,7 @@ describe('extractExceptionKeysForMessage()', () => {
 });
});

/* eslint-disable deprecation/deprecation */
describe('dropUndefinedKeys()', () => {
 test('simple case', () => {
 expect(
Expand DownExpand Up@@ -314,6 +315,7 @@ describe('dropUndefinedKeys()', () => {
 expect(droppedChicken.lays[0] === droppedChicken).toBe(true);
 });
});
/* eslint-enable deprecation/deprecation */

describe('objectify()', () => {
 describe('stringifies nullish values', () => {
Expand Down

30 changes: 14 additions & 16 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand All@@ -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;
}

/**
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay-internal/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand DownExpand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
 const finalOptions: ReplayPluginOptions = {
 sessionSampleRate: 0,
 errorSampleRate: 0,
 ...dropUndefinedKeys(initialOptions),
 ...initialOptions,
 };

 const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down

3 changes: 1 addition & 2 deletions
packages/sveltekit/src/vite/sentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { dropUndefinedKeys } from '@sentry/core';
import type { Plugin } from 'vite';
import type { AutoInstrumentSelection } from './autoInstrument';
import { makeAutoInstrumentationPlugin } from './autoInstrument';
Expand DownExpand Up@@ -104,5 +103,5 @@ export function generateVitePluginOptions(
 }
 }

 return dropUndefinedKeys(sentryVitePluginsOptions);
 return sentryVitePluginsOptions;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: Stop using `dropUndefinedKeys` by mydea · Pull Request #15796 · getsentry/sentry-javascript · GitHub
Skip to content
feat: Stop using dropUndefinedKeys#15796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Mar 25, 2025
 Merged


feat: Stop using dropUndefinedKeys#15796
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d2dffac

ref: Refactor some more `dropUndefinedKeys`


mydea Mar 24, 2025
3347fa5

avoid more work??


mydea Mar 24, 2025
0869503

fixes


mydea Mar 24, 2025
850f1bb

deprecate it..


mydea Mar 24, 2025
759bf76

small test fixes


mydea Mar 24, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 13 additions & 15 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -728,6 +728,7 @@ describe('browserTracingIntegration', () => {
 sampled: true,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand DownExpand Up@@ -768,6 +769,7 @@ describe('browserTracingIntegration', () => {
 sampled: false,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '0',
Expand DownExpand Up@@ -892,6 +894,7 @@ describe('browserTracingIntegration', () => {

 expect(dynamicSamplingContext).toBeDefined();
 expect(dynamicSamplingContext).toStrictEqual({
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand Down

8 changes: 5 additions & 3 deletions
packages/core/src/tracing/dynamicSamplingContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand DownExpand Up@@ -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);

Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/anr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 = {
Expand DownExpand Up@@ -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,
 });
 };
}

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ import type {

import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { dropUndefinedKeys } from './object';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -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,
 ];
}
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,6 +45,7 @@ export { normalize, normalizeToSize, normalizeUrlToBase } from './normalize';
export {
 addNonEnumerableProperty,
 convertToPlainObject,
 // eslint-disable-next-line deprecation/deprecation
 dropUndefinedKeys,
 extractExceptionKeysForMessage,
 fill,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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.
Expand DownExpand Up@@ -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({
Expand Down

10 changes: 5 additions & 5 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand All@@ -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,
Expand All@@ -51,7 +51,7 @@ export function spanToTransactionTraceContext(span: Span): TraceContext {
 status,
 origin,
 links,
 });
 };
}

/**
Expand All@@ -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,
 });
 };
}

/**
Expand Down

9 changes: 3 additions & 6 deletions
packages/core/src/utils/transactionEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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,
Expand All@@ -52,6 +51,4 @@ export function convertSpanJsonToTransactionEvent(span: SpanJSON): TransactionEv
 },
 measurements: span.measurements,
 };

 return dropUndefinedKeys(event);
}

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -88,6 +89,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -111,6 +113,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand DownExpand Up@@ -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}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/test/utils-hoist/object.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,7 @@ describe('extractExceptionKeysForMessage()', () => {
 });
});

/* eslint-disable deprecation/deprecation */
describe('dropUndefinedKeys()', () => {
 test('simple case', () => {
 expect(
Expand DownExpand Up@@ -314,6 +315,7 @@ describe('dropUndefinedKeys()', () => {
 expect(droppedChicken.lays[0] === droppedChicken).toBe(true);
 });
});
/* eslint-enable deprecation/deprecation */

describe('objectify()', () => {
 describe('stringifies nullish values', () => {
Expand Down

30 changes: 14 additions & 16 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand All@@ -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;
}

/**
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay-internal/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand DownExpand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
 const finalOptions: ReplayPluginOptions = {
 sessionSampleRate: 0,
 errorSampleRate: 0,
 ...dropUndefinedKeys(initialOptions),
 ...initialOptions,
 };

 const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down

3 changes: 1 addition & 2 deletions
packages/sveltekit/src/vite/sentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { dropUndefinedKeys } from '@sentry/core';
import type { Plugin } from 'vite';
import type { AutoInstrumentSelection } from './autoInstrument';
import { makeAutoInstrumentationPlugin } from './autoInstrument';
Expand DownExpand Up@@ -104,5 +103,5 @@ export function generateVitePluginOptions(
 }
 }

 return dropUndefinedKeys(sentryVitePluginsOptions);
 return sentryVitePluginsOptions;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat: Stop using `dropUndefinedKeys` by mydea · Pull Request #15796 · getsentry/sentry-javascript · GitHub
Skip to content
feat: Stop using dropUndefinedKeys#15796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Mar 25, 2025
 Merged


feat: Stop using dropUndefinedKeys#15796
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d2dffac

ref: Refactor some more `dropUndefinedKeys`


mydea Mar 24, 2025
3347fa5

avoid more work??


mydea Mar 24, 2025
0869503

fixes


mydea Mar 24, 2025
850f1bb

deprecate it..


mydea Mar 24, 2025
759bf76

small test fixes


mydea Mar 24, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 13 additions & 15 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -728,6 +728,7 @@ describe('browserTracingIntegration', () => {
 sampled: true,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand DownExpand Up@@ -768,6 +769,7 @@ describe('browserTracingIntegration', () => {
 sampled: false,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '0',
Expand DownExpand Up@@ -892,6 +894,7 @@ describe('browserTracingIntegration', () => {

 expect(dynamicSamplingContext).toBeDefined();
 expect(dynamicSamplingContext).toStrictEqual({
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand Down

8 changes: 5 additions & 3 deletions
packages/core/src/tracing/dynamicSamplingContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand DownExpand Up@@ -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);

Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/anr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 = {
Expand DownExpand Up@@ -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,
 });
 };
}

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ import type {

import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { dropUndefinedKeys } from './object';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -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,
 ];
}
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,6 +45,7 @@ export { normalize, normalizeToSize, normalizeUrlToBase } from './normalize';
export {
 addNonEnumerableProperty,
 convertToPlainObject,
 // eslint-disable-next-line deprecation/deprecation
 dropUndefinedKeys,
 extractExceptionKeysForMessage,
 fill,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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.
Expand DownExpand Up@@ -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({
Expand Down

10 changes: 5 additions & 5 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand All@@ -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,
Expand All@@ -51,7 +51,7 @@ export function spanToTransactionTraceContext(span: Span): TraceContext {
 status,
 origin,
 links,
 });
 };
}

/**
Expand All@@ -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,
 });
 };
}

/**
Expand Down

9 changes: 3 additions & 6 deletions
packages/core/src/utils/transactionEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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,
Expand All@@ -52,6 +51,4 @@ export function convertSpanJsonToTransactionEvent(span: SpanJSON): TransactionEv
 },
 measurements: span.measurements,
 };

 return dropUndefinedKeys(event);
}

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -88,6 +89,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -111,6 +113,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand DownExpand Up@@ -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}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/test/utils-hoist/object.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,7 @@ describe('extractExceptionKeysForMessage()', () => {
 });
});

/* eslint-disable deprecation/deprecation */
describe('dropUndefinedKeys()', () => {
 test('simple case', () => {
 expect(
Expand DownExpand Up@@ -314,6 +315,7 @@ describe('dropUndefinedKeys()', () => {
 expect(droppedChicken.lays[0] === droppedChicken).toBe(true);
 });
});
/* eslint-enable deprecation/deprecation */

describe('objectify()', () => {
 describe('stringifies nullish values', () => {
Expand Down

30 changes: 14 additions & 16 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand All@@ -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;
}

/**
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay-internal/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand DownExpand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
 const finalOptions: ReplayPluginOptions = {
 sessionSampleRate: 0,
 errorSampleRate: 0,
 ...dropUndefinedKeys(initialOptions),
 ...initialOptions,
 };

 const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down

3 changes: 1 addition & 2 deletions
packages/sveltekit/src/vite/sentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { dropUndefinedKeys } from '@sentry/core';
import type { Plugin } from 'vite';
import type { AutoInstrumentSelection } from './autoInstrument';
import { makeAutoInstrumentationPlugin } from './autoInstrument';
Expand DownExpand Up@@ -104,5 +103,5 @@ export function generateVitePluginOptions(
 }
 }

 return dropUndefinedKeys(sentryVitePluginsOptions);
 return sentryVitePluginsOptions;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: Stop using `dropUndefinedKeys` by mydea · Pull Request #15796 · getsentry/sentry-javascript · GitHub
Skip to content
feat: Stop using dropUndefinedKeys#15796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Mar 25, 2025
 Merged


feat: Stop using dropUndefinedKeys#15796
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d2dffac

ref: Refactor some more `dropUndefinedKeys`


mydea Mar 24, 2025
3347fa5

avoid more work??


mydea Mar 24, 2025
0869503

fixes


mydea Mar 24, 2025
850f1bb

deprecate it..


mydea Mar 24, 2025
759bf76

small test fixes


mydea Mar 24, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 13 additions & 15 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -728,6 +728,7 @@ describe('browserTracingIntegration', () => {
 sampled: true,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand DownExpand Up@@ -768,6 +769,7 @@ describe('browserTracingIntegration', () => {
 sampled: false,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '0',
Expand DownExpand Up@@ -892,6 +894,7 @@ describe('browserTracingIntegration', () => {

 expect(dynamicSamplingContext).toBeDefined();
 expect(dynamicSamplingContext).toStrictEqual({
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand Down

8 changes: 5 additions & 3 deletions
packages/core/src/tracing/dynamicSamplingContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand DownExpand Up@@ -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);

Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/anr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 = {
Expand DownExpand Up@@ -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,
 });
 };
}

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ import type {

import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { dropUndefinedKeys } from './object';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -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,
 ];
}
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,6 +45,7 @@ export { normalize, normalizeToSize, normalizeUrlToBase } from './normalize';
export {
 addNonEnumerableProperty,
 convertToPlainObject,
 // eslint-disable-next-line deprecation/deprecation
 dropUndefinedKeys,
 extractExceptionKeysForMessage,
 fill,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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.
Expand DownExpand Up@@ -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({
Expand Down

10 changes: 5 additions & 5 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand All@@ -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,
Expand All@@ -51,7 +51,7 @@ export function spanToTransactionTraceContext(span: Span): TraceContext {
 status,
 origin,
 links,
 });
 };
}

/**
Expand All@@ -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,
 });
 };
}

/**
Expand Down

9 changes: 3 additions & 6 deletions
packages/core/src/utils/transactionEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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,
Expand All@@ -52,6 +51,4 @@ export function convertSpanJsonToTransactionEvent(span: SpanJSON): TransactionEv
 },
 measurements: span.measurements,
 };

 return dropUndefinedKeys(event);
}

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -88,6 +89,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -111,6 +113,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand DownExpand Up@@ -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}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/test/utils-hoist/object.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,7 @@ describe('extractExceptionKeysForMessage()', () => {
 });
});

/* eslint-disable deprecation/deprecation */
describe('dropUndefinedKeys()', () => {
 test('simple case', () => {
 expect(
Expand DownExpand Up@@ -314,6 +315,7 @@ describe('dropUndefinedKeys()', () => {
 expect(droppedChicken.lays[0] === droppedChicken).toBe(true);
 });
});
/* eslint-enable deprecation/deprecation */

describe('objectify()', () => {
 describe('stringifies nullish values', () => {
Expand Down

30 changes: 14 additions & 16 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand All@@ -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;
}

/**
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay-internal/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand DownExpand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
 const finalOptions: ReplayPluginOptions = {
 sessionSampleRate: 0,
 errorSampleRate: 0,
 ...dropUndefinedKeys(initialOptions),
 ...initialOptions,
 };

 const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down

3 changes: 1 addition & 2 deletions
packages/sveltekit/src/vite/sentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { dropUndefinedKeys } from '@sentry/core';
import type { Plugin } from 'vite';
import type { AutoInstrumentSelection } from './autoInstrument';
import { makeAutoInstrumentationPlugin } from './autoInstrument';
Expand DownExpand Up@@ -104,5 +103,5 @@ export function generateVitePluginOptions(
 }
 }

 return dropUndefinedKeys(sentryVitePluginsOptions);
 return sentryVitePluginsOptions;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: Stop using `dropUndefinedKeys` by mydea · Pull Request #15796 · getsentry/sentry-javascript · GitHub
Skip to content
feat: Stop using dropUndefinedKeys#15796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Mar 25, 2025
 Merged


feat: Stop using dropUndefinedKeys#15796
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d2dffac

ref: Refactor some more `dropUndefinedKeys`


mydea Mar 24, 2025
3347fa5

avoid more work??


mydea Mar 24, 2025
0869503

fixes


mydea Mar 24, 2025
850f1bb

deprecate it..


mydea Mar 24, 2025
759bf76

small test fixes


mydea Mar 24, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 13 additions & 15 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -728,6 +728,7 @@ describe('browserTracingIntegration', () => {
 sampled: true,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand DownExpand Up@@ -768,6 +769,7 @@ describe('browserTracingIntegration', () => {
 sampled: false,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '0',
Expand DownExpand Up@@ -892,6 +894,7 @@ describe('browserTracingIntegration', () => {

 expect(dynamicSamplingContext).toBeDefined();
 expect(dynamicSamplingContext).toStrictEqual({
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand Down

8 changes: 5 additions & 3 deletions
packages/core/src/tracing/dynamicSamplingContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand DownExpand Up@@ -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);

Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/anr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 = {
Expand DownExpand Up@@ -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,
 });
 };
}

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ import type {

import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { dropUndefinedKeys } from './object';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -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,
 ];
}
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,6 +45,7 @@ export { normalize, normalizeToSize, normalizeUrlToBase } from './normalize';
export {
 addNonEnumerableProperty,
 convertToPlainObject,
 // eslint-disable-next-line deprecation/deprecation
 dropUndefinedKeys,
 extractExceptionKeysForMessage,
 fill,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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.
Expand DownExpand Up@@ -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({
Expand Down

10 changes: 5 additions & 5 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand All@@ -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,
Expand All@@ -51,7 +51,7 @@ export function spanToTransactionTraceContext(span: Span): TraceContext {
 status,
 origin,
 links,
 });
 };
}

/**
Expand All@@ -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,
 });
 };
}

/**
Expand Down

9 changes: 3 additions & 6 deletions
packages/core/src/utils/transactionEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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,
Expand All@@ -52,6 +51,4 @@ export function convertSpanJsonToTransactionEvent(span: SpanJSON): TransactionEv
 },
 measurements: span.measurements,
 };

 return dropUndefinedKeys(event);
}

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -88,6 +89,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -111,6 +113,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand DownExpand Up@@ -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}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/test/utils-hoist/object.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,7 @@ describe('extractExceptionKeysForMessage()', () => {
 });
});

/* eslint-disable deprecation/deprecation */
describe('dropUndefinedKeys()', () => {
 test('simple case', () => {
 expect(
Expand DownExpand Up@@ -314,6 +315,7 @@ describe('dropUndefinedKeys()', () => {
 expect(droppedChicken.lays[0] === droppedChicken).toBe(true);
 });
});
/* eslint-enable deprecation/deprecation */

describe('objectify()', () => {
 describe('stringifies nullish values', () => {
Expand Down

30 changes: 14 additions & 16 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand All@@ -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;
}

/**
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay-internal/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand DownExpand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
 const finalOptions: ReplayPluginOptions = {
 sessionSampleRate: 0,
 errorSampleRate: 0,
 ...dropUndefinedKeys(initialOptions),
 ...initialOptions,
 };

 const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down

3 changes: 1 addition & 2 deletions
packages/sveltekit/src/vite/sentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { dropUndefinedKeys } from '@sentry/core';
import type { Plugin } from 'vite';
import type { AutoInstrumentSelection } from './autoInstrument';
import { makeAutoInstrumentationPlugin } from './autoInstrument';
Expand DownExpand Up@@ -104,5 +103,5 @@ export function generateVitePluginOptions(
 }
 }

 return dropUndefinedKeys(sentryVitePluginsOptions);
 return sentryVitePluginsOptions;
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat: Stop using `dropUndefinedKeys` by mydea · Pull Request #15796 · getsentry/sentry-javascript · GitHub
Skip to content
feat: Stop using dropUndefinedKeys#15796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 5 commits into

from

Mar 25, 2025
 Merged


feat: Stop using dropUndefinedKeys#15796
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d2dffac

ref: Refactor some more `dropUndefinedKeys`


mydea Mar 24, 2025
3347fa5

avoid more work??


mydea Mar 24, 2025
0869503

fixes


mydea Mar 24, 2025
850f1bb

deprecate it..


mydea Mar 24, 2025
759bf76

small test fixes


mydea Mar 24, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


28 changes: 13 additions & 15 deletions
dev-packages/e2e-tests/test-applications/nuxt-3/server/plugins/customNitroErrorHandler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand DownExpand Up@@ -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> {
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -728,6 +728,7 @@ describe('browserTracingIntegration', () => {
 sampled: true,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand DownExpand Up@@ -768,6 +769,7 @@ describe('browserTracingIntegration', () => {
 sampled: false,
 sampleRand: expect.any(Number),
 dsc: {
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '0',
Expand DownExpand Up@@ -892,6 +894,7 @@ describe('browserTracingIntegration', () => {

 expect(dynamicSamplingContext).toBeDefined();
 expect(dynamicSamplingContext).toStrictEqual({
 release: undefined,
 environment: 'production',
 public_key: 'examplePublicKey',
 sample_rate: '1',
Expand Down

8 changes: 5 additions & 3 deletions
packages/core/src/tracing/dynamicSamplingContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand DownExpand Up@@ -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);

Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/anr.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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 = {
Expand DownExpand Up@@ -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,
 });
 };
}

5 changes: 2 additions & 3 deletions
packages/core/src/utils-hoist/envelope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ import type {

import { dsnToString } from './dsn';
import { normalize } from './normalize';
import { dropUndefinedKeys } from './object';
import { GLOBAL_OBJ } from './worldwide';

/**
Expand DownExpand Up@@ -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,
 ];
}
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,6 +45,7 @@ export { normalize, normalizeToSize, normalizeUrlToBase } from './normalize';
export {
 addNonEnumerableProperty,
 convertToPlainObject,
 // eslint-disable-next-line deprecation/deprecation
 dropUndefinedKeys,
 extractExceptionKeysForMessage,
 fill,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils-hoist/object.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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.
Expand Down

5 changes: 2 additions & 3 deletions
packages/core/src/utils/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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.
Expand DownExpand Up@@ -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({
Expand Down

10 changes: 5 additions & 5 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand All@@ -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,
Expand All@@ -51,7 +51,7 @@ export function spanToTransactionTraceContext(span: Span): TraceContext {
 status,
 origin,
 links,
 });
 };
}

/**
Expand All@@ -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,
 });
 };
}

/**
Expand Down

9 changes: 3 additions & 6 deletions
packages/core/src/utils/transactionEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand All@@ -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,
Expand All@@ -52,6 +51,4 @@ export function convertSpanJsonToTransactionEvent(span: SpanJSON): TransactionEv
 },
 measurements: span.measurements,
 };

 return dropUndefinedKeys(event);
}

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -88,6 +89,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand All@@ -111,6 +113,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
 const dynamicSamplingContext = getDynamicSamplingContextFromSpan(rootSpan);

 expect(dynamicSamplingContext).toStrictEqual({
 public_key: undefined,
 release: '1.0.1',
 environment: 'production',
 sampled: 'true',
Expand DownExpand Up@@ -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}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/test/utils-hoist/object.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,7 @@ describe('extractExceptionKeysForMessage()', () => {
 });
});

/* eslint-disable deprecation/deprecation */
describe('dropUndefinedKeys()', () => {
 test('simple case', () => {
 expect(
Expand DownExpand Up@@ -314,6 +315,7 @@ describe('dropUndefinedKeys()', () => {
 expect(droppedChicken.lays[0] === droppedChicken).toBe(true);
 });
});
/* eslint-enable deprecation/deprecation */

describe('objectify()', () => {
 describe('stringifies nullish values', () => {
Expand Down

30 changes: 14 additions & 16 deletions
packages/nuxt/src/runtime/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand All@@ -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;
}

/**
Expand Down

4 changes: 2 additions & 2 deletions
packages/replay-internal/src/integration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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,
Expand DownExpand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
 const finalOptions: ReplayPluginOptions = {
 sessionSampleRate: 0,
 errorSampleRate: 0,
 ...dropUndefinedKeys(initialOptions),
 ...initialOptions,
 };

 const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down

3 changes: 1 addition & 2 deletions
packages/sveltekit/src/vite/sentryVitePlugins.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { dropUndefinedKeys } from '@sentry/core';
import type { Plugin } from 'vite';
import type { AutoInstrumentSelection } from './autoInstrument';
import { makeAutoInstrumentationPlugin } from './autoInstrument';
Expand DownExpand Up@@ -104,5 +103,5 @@ export function generateVitePluginOptions(
 }
 }

 return dropUndefinedKeys(sentryVitePluginsOptions);
 return sentryVitePluginsOptions;
}