Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 21 additions & 18 deletions packages/core/src/tracing/sentrySpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -223,24 +223,27 @@ export class SentrySpan implements Span {
* use `spanToJSON(span)` instead.
*/
public getSpanJSON(): SpanJSON {
return dropUndefinedKeys({
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
});
return dropUndefinedKeys(
{
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
},
1,
);
}

/** @inheritdoc */
Expand Down
11 changes: 8 additions & 3 deletions packages/core/src/utils-hoist/object.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,17 +211,22 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
*
* Attention: This function keeps circular references in the returned object.
*/
export function dropUndefinedKeys<T>(inputValue: T): T {
export function dropUndefinedKeys<T>(inputValue: T, depth = Infinity): T {
// This map keeps track of what already visited nodes map to.
// Our Set - based memoBuilder doesn't work here because we want to the output object to have the same circular
// references as the input object.
const memoizationMap = new Map<unknown, unknown>();

// This function just proxies `_dropUndefinedKeys` to keep the `memoBuilder` out of this function's API
return _dropUndefinedKeys(inputValue, memoizationMap);
return _dropUndefinedKeys(inputValue, memoizationMap, depth);
}

function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>): T {
function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>, depth: number): T {
// If the max. depth is reached, return the input value as is
if (!depth) {
return inputValue;
}

// Early return for primitive values
if (inputValue === null || typeof inputValue !== 'object') {
return inputValue;
Expand Down
19 changes: 11 additions & 8 deletions packages/core/src/utils/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,14 +91,17 @@ 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({
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
});
return dropUndefinedKeys(
{
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
},
1,
);
}

function getAbsoluteUrl({
Expand Down
54 changes: 30 additions & 24 deletions packages/core/src/utils/spanUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,19 @@ 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({
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
});
return dropUndefinedKeys(
{
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
},
1,
);
}

/**
Expand DownExpand Up@@ -147,20 +150,23 @@ export function spanToJSON(span: Span): SpanJSON {
if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
const { attributes, startTime, name, endTime, parentSpanId, status, links } = span;

return dropUndefinedKeys({
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
});
return dropUndefinedKeys(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need to call dropUndefinedKeys here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I extracted this out here: #15792 - I think you are right 🤔

{
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
},
1,
);
}

// Finally, at least we have `spanContext()`....
Expand Down
86 changes: 86 additions & 0 deletions packages/core/test/utils-hoist/object.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -208,6 +208,33 @@ describe('dropUndefinedKeys()', () => {
});
});

test('arrays with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
},
1,
),
).toStrictEqual({
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
});
});

test('nested objects', () => {
expect(
dropUndefinedKeys({
Expand All@@ -232,6 +259,65 @@ describe('dropUndefinedKeys()', () => {
});
});

test('nested objects with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
1,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
});
});

test('nested objects with depth=2', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
2,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
e: {
f: 3,
g: undefined,
},
},
});
});

describe('class instances', () => {
class MyClass {
public a = 'foo';
Expand Down
2 changes: 1 addition & 1 deletion packages/replay-internal/src/integration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
const finalOptions: ReplayPluginOptions = {
sessionSampleRate: 0,
errorSampleRate: 0,
...dropUndefinedKeys(initialOptions),
...dropUndefinedKeys(initialOptions, 1),
};

const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down
, '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(core): Allow to specify depth to `dropUndefinedKeys` by mydea · Pull Request #15783 · getsentry/sentry-javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 21 additions & 18 deletions packages/core/src/tracing/sentrySpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -223,24 +223,27 @@ export class SentrySpan implements Span {
* use `spanToJSON(span)` instead.
*/
public getSpanJSON(): SpanJSON {
return dropUndefinedKeys({
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
});
return dropUndefinedKeys(
{
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
},
1,
);
}

/** @inheritdoc */
Expand Down
11 changes: 8 additions & 3 deletions packages/core/src/utils-hoist/object.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,17 +211,22 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
*
* Attention: This function keeps circular references in the returned object.
*/
export function dropUndefinedKeys<T>(inputValue: T): T {
export function dropUndefinedKeys<T>(inputValue: T, depth = Infinity): T {
// This map keeps track of what already visited nodes map to.
// Our Set - based memoBuilder doesn't work here because we want to the output object to have the same circular
// references as the input object.
const memoizationMap = new Map<unknown, unknown>();

// This function just proxies `_dropUndefinedKeys` to keep the `memoBuilder` out of this function's API
return _dropUndefinedKeys(inputValue, memoizationMap);
return _dropUndefinedKeys(inputValue, memoizationMap, depth);
}

function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>): T {
function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>, depth: number): T {
// If the max. depth is reached, return the input value as is
if (!depth) {
return inputValue;
}

// Early return for primitive values
if (inputValue === null || typeof inputValue !== 'object') {
return inputValue;
Expand Down
19 changes: 11 additions & 8 deletions packages/core/src/utils/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,14 +91,17 @@ 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({
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
});
return dropUndefinedKeys(
{
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
},
1,
);
}

function getAbsoluteUrl({
Expand Down
54 changes: 30 additions & 24 deletions packages/core/src/utils/spanUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,19 @@ 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({
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
});
return dropUndefinedKeys(
{
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
},
1,
);
}

/**
Expand DownExpand Up@@ -147,20 +150,23 @@ export function spanToJSON(span: Span): SpanJSON {
if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
const { attributes, startTime, name, endTime, parentSpanId, status, links } = span;

return dropUndefinedKeys({
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
});
return dropUndefinedKeys(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need to call dropUndefinedKeys here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I extracted this out here: #15792 - I think you are right 🤔

{
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
},
1,
);
}

// Finally, at least we have `spanContext()`....
Expand Down
86 changes: 86 additions & 0 deletions packages/core/test/utils-hoist/object.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -208,6 +208,33 @@ describe('dropUndefinedKeys()', () => {
});
});

test('arrays with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
},
1,
),
).toStrictEqual({
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
});
});

test('nested objects', () => {
expect(
dropUndefinedKeys({
Expand All@@ -232,6 +259,65 @@ describe('dropUndefinedKeys()', () => {
});
});

test('nested objects with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
1,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
});
});

test('nested objects with depth=2', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
2,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
e: {
f: 3,
g: undefined,
},
},
});
});

describe('class instances', () => {
class MyClass {
public a = 'foo';
Expand Down
2 changes: 1 addition & 1 deletion packages/replay-internal/src/integration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
const finalOptions: ReplayPluginOptions = {
sessionSampleRate: 0,
errorSampleRate: 0,
...dropUndefinedKeys(initialOptions),
...dropUndefinedKeys(initialOptions, 1),
};

const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down
, '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(core): Allow to specify depth to `dropUndefinedKeys` by mydea · Pull Request #15783 · getsentry/sentry-javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 21 additions & 18 deletions packages/core/src/tracing/sentrySpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -223,24 +223,27 @@ export class SentrySpan implements Span {
* use `spanToJSON(span)` instead.
*/
public getSpanJSON(): SpanJSON {
return dropUndefinedKeys({
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
});
return dropUndefinedKeys(
{
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
},
1,
);
}

/** @inheritdoc */
Expand Down
11 changes: 8 additions & 3 deletions packages/core/src/utils-hoist/object.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,17 +211,22 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
*
* Attention: This function keeps circular references in the returned object.
*/
export function dropUndefinedKeys<T>(inputValue: T): T {
export function dropUndefinedKeys<T>(inputValue: T, depth = Infinity): T {
// This map keeps track of what already visited nodes map to.
// Our Set - based memoBuilder doesn't work here because we want to the output object to have the same circular
// references as the input object.
const memoizationMap = new Map<unknown, unknown>();

// This function just proxies `_dropUndefinedKeys` to keep the `memoBuilder` out of this function's API
return _dropUndefinedKeys(inputValue, memoizationMap);
return _dropUndefinedKeys(inputValue, memoizationMap, depth);
}

function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>): T {
function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>, depth: number): T {
// If the max. depth is reached, return the input value as is
if (!depth) {
return inputValue;
}

// Early return for primitive values
if (inputValue === null || typeof inputValue !== 'object') {
return inputValue;
Expand Down
19 changes: 11 additions & 8 deletions packages/core/src/utils/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,14 +91,17 @@ 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({
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
});
return dropUndefinedKeys(
{
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
},
1,
);
}

function getAbsoluteUrl({
Expand Down
54 changes: 30 additions & 24 deletions packages/core/src/utils/spanUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,19 @@ 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({
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
});
return dropUndefinedKeys(
{
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
},
1,
);
}

/**
Expand DownExpand Up@@ -147,20 +150,23 @@ export function spanToJSON(span: Span): SpanJSON {
if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
const { attributes, startTime, name, endTime, parentSpanId, status, links } = span;

return dropUndefinedKeys({
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
});
return dropUndefinedKeys(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need to call dropUndefinedKeys here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I extracted this out here: #15792 - I think you are right 🤔

{
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
},
1,
);
}

// Finally, at least we have `spanContext()`....
Expand Down
86 changes: 86 additions & 0 deletions packages/core/test/utils-hoist/object.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -208,6 +208,33 @@ describe('dropUndefinedKeys()', () => {
});
});

test('arrays with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
},
1,
),
).toStrictEqual({
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
});
});

test('nested objects', () => {
expect(
dropUndefinedKeys({
Expand All@@ -232,6 +259,65 @@ describe('dropUndefinedKeys()', () => {
});
});

test('nested objects with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
1,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
});
});

test('nested objects with depth=2', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
2,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
e: {
f: 3,
g: undefined,
},
},
});
});

describe('class instances', () => {
class MyClass {
public a = 'foo';
Expand Down
2 changes: 1 addition & 1 deletion packages/replay-internal/src/integration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
const finalOptions: ReplayPluginOptions = {
sessionSampleRate: 0,
errorSampleRate: 0,
...dropUndefinedKeys(initialOptions),
...dropUndefinedKeys(initialOptions, 1),
};

const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down
, '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(core): Allow to specify depth to `dropUndefinedKeys` by mydea · Pull Request #15783 · getsentry/sentry-javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 21 additions & 18 deletions packages/core/src/tracing/sentrySpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -223,24 +223,27 @@ export class SentrySpan implements Span {
* use `spanToJSON(span)` instead.
*/
public getSpanJSON(): SpanJSON {
return dropUndefinedKeys({
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
});
return dropUndefinedKeys(
{
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
},
1,
);
}

/** @inheritdoc */
Expand Down
11 changes: 8 additions & 3 deletions packages/core/src/utils-hoist/object.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,17 +211,22 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
*
* Attention: This function keeps circular references in the returned object.
*/
export function dropUndefinedKeys<T>(inputValue: T): T {
export function dropUndefinedKeys<T>(inputValue: T, depth = Infinity): T {
// This map keeps track of what already visited nodes map to.
// Our Set - based memoBuilder doesn't work here because we want to the output object to have the same circular
// references as the input object.
const memoizationMap = new Map<unknown, unknown>();

// This function just proxies `_dropUndefinedKeys` to keep the `memoBuilder` out of this function's API
return _dropUndefinedKeys(inputValue, memoizationMap);
return _dropUndefinedKeys(inputValue, memoizationMap, depth);
}

function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>): T {
function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>, depth: number): T {
// If the max. depth is reached, return the input value as is
if (!depth) {
return inputValue;
}

// Early return for primitive values
if (inputValue === null || typeof inputValue !== 'object') {
return inputValue;
Expand Down
19 changes: 11 additions & 8 deletions packages/core/src/utils/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,14 +91,17 @@ 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({
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
});
return dropUndefinedKeys(
{
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
},
1,
);
}

function getAbsoluteUrl({
Expand Down
54 changes: 30 additions & 24 deletions packages/core/src/utils/spanUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,19 @@ 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({
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
});
return dropUndefinedKeys(
{
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
},
1,
);
}

/**
Expand DownExpand Up@@ -147,20 +150,23 @@ export function spanToJSON(span: Span): SpanJSON {
if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
const { attributes, startTime, name, endTime, parentSpanId, status, links } = span;

return dropUndefinedKeys({
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
});
return dropUndefinedKeys(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need to call dropUndefinedKeys here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I extracted this out here: #15792 - I think you are right 🤔

{
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
},
1,
);
}

// Finally, at least we have `spanContext()`....
Expand Down
86 changes: 86 additions & 0 deletions packages/core/test/utils-hoist/object.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -208,6 +208,33 @@ describe('dropUndefinedKeys()', () => {
});
});

test('arrays with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
},
1,
),
).toStrictEqual({
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
});
});

test('nested objects', () => {
expect(
dropUndefinedKeys({
Expand All@@ -232,6 +259,65 @@ describe('dropUndefinedKeys()', () => {
});
});

test('nested objects with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
1,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
});
});

test('nested objects with depth=2', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
2,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
e: {
f: 3,
g: undefined,
},
},
});
});

describe('class instances', () => {
class MyClass {
public a = 'foo';
Expand Down
2 changes: 1 addition & 1 deletion packages/replay-internal/src/integration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
const finalOptions: ReplayPluginOptions = {
sessionSampleRate: 0,
errorSampleRate: 0,
...dropUndefinedKeys(initialOptions),
...dropUndefinedKeys(initialOptions, 1),
};

const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down
, '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(core): Allow to specify depth to `dropUndefinedKeys` by mydea · Pull Request #15783 · getsentry/sentry-javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 21 additions & 18 deletions packages/core/src/tracing/sentrySpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -223,24 +223,27 @@ export class SentrySpan implements Span {
* use `spanToJSON(span)` instead.
*/
public getSpanJSON(): SpanJSON {
return dropUndefinedKeys({
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
});
return dropUndefinedKeys(
{
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
},
1,
);
}

/** @inheritdoc */
Expand Down
11 changes: 8 additions & 3 deletions packages/core/src/utils-hoist/object.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,17 +211,22 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
*
* Attention: This function keeps circular references in the returned object.
*/
export function dropUndefinedKeys<T>(inputValue: T): T {
export function dropUndefinedKeys<T>(inputValue: T, depth = Infinity): T {
// This map keeps track of what already visited nodes map to.
// Our Set - based memoBuilder doesn't work here because we want to the output object to have the same circular
// references as the input object.
const memoizationMap = new Map<unknown, unknown>();

// This function just proxies `_dropUndefinedKeys` to keep the `memoBuilder` out of this function's API
return _dropUndefinedKeys(inputValue, memoizationMap);
return _dropUndefinedKeys(inputValue, memoizationMap, depth);
}

function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>): T {
function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>, depth: number): T {
// If the max. depth is reached, return the input value as is
if (!depth) {
return inputValue;
}

// Early return for primitive values
if (inputValue === null || typeof inputValue !== 'object') {
return inputValue;
Expand Down
19 changes: 11 additions & 8 deletions packages/core/src/utils/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,14 +91,17 @@ 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({
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
});
return dropUndefinedKeys(
{
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
},
1,
);
}

function getAbsoluteUrl({
Expand Down
54 changes: 30 additions & 24 deletions packages/core/src/utils/spanUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,19 @@ 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({
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
});
return dropUndefinedKeys(
{
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
},
1,
);
}

/**
Expand DownExpand Up@@ -147,20 +150,23 @@ export function spanToJSON(span: Span): SpanJSON {
if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
const { attributes, startTime, name, endTime, parentSpanId, status, links } = span;

return dropUndefinedKeys({
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
});
return dropUndefinedKeys(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need to call dropUndefinedKeys here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I extracted this out here: #15792 - I think you are right 🤔

{
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
},
1,
);
}

// Finally, at least we have `spanContext()`....
Expand Down
86 changes: 86 additions & 0 deletions packages/core/test/utils-hoist/object.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -208,6 +208,33 @@ describe('dropUndefinedKeys()', () => {
});
});

test('arrays with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
},
1,
),
).toStrictEqual({
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
});
});

test('nested objects', () => {
expect(
dropUndefinedKeys({
Expand All@@ -232,6 +259,65 @@ describe('dropUndefinedKeys()', () => {
});
});

test('nested objects with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
1,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
});
});

test('nested objects with depth=2', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
2,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
e: {
f: 3,
g: undefined,
},
},
});
});

describe('class instances', () => {
class MyClass {
public a = 'foo';
Expand Down
2 changes: 1 addition & 1 deletion packages/replay-internal/src/integration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
const finalOptions: ReplayPluginOptions = {
sessionSampleRate: 0,
errorSampleRate: 0,
...dropUndefinedKeys(initialOptions),
...dropUndefinedKeys(initialOptions, 1),
};

const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down
, '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(core): Allow to specify depth to `dropUndefinedKeys` by mydea · Pull Request #15783 · getsentry/sentry-javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 21 additions & 18 deletions packages/core/src/tracing/sentrySpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -223,24 +223,27 @@ export class SentrySpan implements Span {
* use `spanToJSON(span)` instead.
*/
public getSpanJSON(): SpanJSON {
return dropUndefinedKeys({
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
});
return dropUndefinedKeys(
{
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
},
1,
);
}

/** @inheritdoc */
Expand Down
11 changes: 8 additions & 3 deletions packages/core/src/utils-hoist/object.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,17 +211,22 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
*
* Attention: This function keeps circular references in the returned object.
*/
export function dropUndefinedKeys<T>(inputValue: T): T {
export function dropUndefinedKeys<T>(inputValue: T, depth = Infinity): T {
// This map keeps track of what already visited nodes map to.
// Our Set - based memoBuilder doesn't work here because we want to the output object to have the same circular
// references as the input object.
const memoizationMap = new Map<unknown, unknown>();

// This function just proxies `_dropUndefinedKeys` to keep the `memoBuilder` out of this function's API
return _dropUndefinedKeys(inputValue, memoizationMap);
return _dropUndefinedKeys(inputValue, memoizationMap, depth);
}

function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>): T {
function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>, depth: number): T {
// If the max. depth is reached, return the input value as is
if (!depth) {
return inputValue;
}

// Early return for primitive values
if (inputValue === null || typeof inputValue !== 'object') {
return inputValue;
Expand Down
19 changes: 11 additions & 8 deletions packages/core/src/utils/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,14 +91,17 @@ 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({
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
});
return dropUndefinedKeys(
{
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
},
1,
);
}

function getAbsoluteUrl({
Expand Down
54 changes: 30 additions & 24 deletions packages/core/src/utils/spanUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,19 @@ 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({
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
});
return dropUndefinedKeys(
{
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
},
1,
);
}

/**
Expand DownExpand Up@@ -147,20 +150,23 @@ export function spanToJSON(span: Span): SpanJSON {
if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
const { attributes, startTime, name, endTime, parentSpanId, status, links } = span;

return dropUndefinedKeys({
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
});
return dropUndefinedKeys(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need to call dropUndefinedKeys here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I extracted this out here: #15792 - I think you are right 🤔

{
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
},
1,
);
}

// Finally, at least we have `spanContext()`....
Expand Down
86 changes: 86 additions & 0 deletions packages/core/test/utils-hoist/object.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -208,6 +208,33 @@ describe('dropUndefinedKeys()', () => {
});
});

test('arrays with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
},
1,
),
).toStrictEqual({
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
});
});

test('nested objects', () => {
expect(
dropUndefinedKeys({
Expand All@@ -232,6 +259,65 @@ describe('dropUndefinedKeys()', () => {
});
});

test('nested objects with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
1,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
});
});

test('nested objects with depth=2', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
2,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
e: {
f: 3,
g: undefined,
},
},
});
});

describe('class instances', () => {
class MyClass {
public a = 'foo';
Expand Down
2 changes: 1 addition & 1 deletion packages/replay-internal/src/integration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
const finalOptions: ReplayPluginOptions = {
sessionSampleRate: 0,
errorSampleRate: 0,
...dropUndefinedKeys(initialOptions),
...dropUndefinedKeys(initialOptions, 1),
};

const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down
, '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(core): Allow to specify depth to `dropUndefinedKeys` by mydea · Pull Request #15783 · getsentry/sentry-javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 21 additions & 18 deletions packages/core/src/tracing/sentrySpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -223,24 +223,27 @@ export class SentrySpan implements Span {
* use `spanToJSON(span)` instead.
*/
public getSpanJSON(): SpanJSON {
return dropUndefinedKeys({
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
});
return dropUndefinedKeys(
{
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
},
1,
);
}

/** @inheritdoc */
Expand Down
11 changes: 8 additions & 3 deletions packages/core/src/utils-hoist/object.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,17 +211,22 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
*
* Attention: This function keeps circular references in the returned object.
*/
export function dropUndefinedKeys<T>(inputValue: T): T {
export function dropUndefinedKeys<T>(inputValue: T, depth = Infinity): T {
// This map keeps track of what already visited nodes map to.
// Our Set - based memoBuilder doesn't work here because we want to the output object to have the same circular
// references as the input object.
const memoizationMap = new Map<unknown, unknown>();

// This function just proxies `_dropUndefinedKeys` to keep the `memoBuilder` out of this function's API
return _dropUndefinedKeys(inputValue, memoizationMap);
return _dropUndefinedKeys(inputValue, memoizationMap, depth);
}

function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>): T {
function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>, depth: number): T {
// If the max. depth is reached, return the input value as is
if (!depth) {
return inputValue;
}

// Early return for primitive values
if (inputValue === null || typeof inputValue !== 'object') {
return inputValue;
Expand Down
19 changes: 11 additions & 8 deletions packages/core/src/utils/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,14 +91,17 @@ 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({
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
});
return dropUndefinedKeys(
{
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
},
1,
);
}

function getAbsoluteUrl({
Expand Down
54 changes: 30 additions & 24 deletions packages/core/src/utils/spanUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,19 @@ 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({
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
});
return dropUndefinedKeys(
{
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
},
1,
);
}

/**
Expand DownExpand Up@@ -147,20 +150,23 @@ export function spanToJSON(span: Span): SpanJSON {
if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
const { attributes, startTime, name, endTime, parentSpanId, status, links } = span;

return dropUndefinedKeys({
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
});
return dropUndefinedKeys(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need to call dropUndefinedKeys here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I extracted this out here: #15792 - I think you are right 🤔

{
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
},
1,
);
}

// Finally, at least we have `spanContext()`....
Expand Down
86 changes: 86 additions & 0 deletions packages/core/test/utils-hoist/object.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -208,6 +208,33 @@ describe('dropUndefinedKeys()', () => {
});
});

test('arrays with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
},
1,
),
).toStrictEqual({
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
});
});

test('nested objects', () => {
expect(
dropUndefinedKeys({
Expand All@@ -232,6 +259,65 @@ describe('dropUndefinedKeys()', () => {
});
});

test('nested objects with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
1,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
});
});

test('nested objects with depth=2', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
2,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
e: {
f: 3,
g: undefined,
},
},
});
});

describe('class instances', () => {
class MyClass {
public a = 'foo';
Expand Down
2 changes: 1 addition & 1 deletion packages/replay-internal/src/integration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
const finalOptions: ReplayPluginOptions = {
sessionSampleRate: 0,
errorSampleRate: 0,
...dropUndefinedKeys(initialOptions),
...dropUndefinedKeys(initialOptions, 1),
};

const replaysSessionSampleRate = parseSampleRate(opt.replaysSessionSampleRate);
Expand Down
, '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(core): Allow to specify depth to `dropUndefinedKeys` by mydea · Pull Request #15783 · getsentry/sentry-javascript · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 21 additions & 18 deletions packages/core/src/tracing/sentrySpan.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -223,24 +223,27 @@ export class SentrySpan implements Span {
* use `spanToJSON(span)` instead.
*/
public getSpanJSON(): SpanJSON {
return dropUndefinedKeys({
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
});
return dropUndefinedKeys(
{
data: this._attributes,
description: this._name,
op: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
parent_span_id: this._parentSpanId,
span_id: this._spanId,
start_timestamp: this._startTime,
status: getStatusMessage(this._status),
timestamp: this._endTime,
trace_id: this._traceId,
origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
profile_id: this._attributes[SEMANTIC_ATTRIBUTE_PROFILE_ID] as string | undefined,
exclusive_time: this._attributes[SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME] as number | undefined,
measurements: timedEventsToMeasurements(this._events),
is_segment: (this._isStandaloneSpan && getRootSpan(this) === this) || undefined,
segment_id: this._isStandaloneSpan ? getRootSpan(this).spanContext().spanId : undefined,
links: convertSpanLinksForEnvelope(this._links),
},
1,
);
}

/** @inheritdoc */
Expand Down
11 changes: 8 additions & 3 deletions packages/core/src/utils-hoist/object.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,17 +211,22 @@ export function extractExceptionKeysForMessage(exception: Record<string, unknown
*
* Attention: This function keeps circular references in the returned object.
*/
export function dropUndefinedKeys<T>(inputValue: T): T {
export function dropUndefinedKeys<T>(inputValue: T, depth = Infinity): T {
// This map keeps track of what already visited nodes map to.
// Our Set - based memoBuilder doesn't work here because we want to the output object to have the same circular
// references as the input object.
const memoizationMap = new Map<unknown, unknown>();

// This function just proxies `_dropUndefinedKeys` to keep the `memoBuilder` out of this function's API
return _dropUndefinedKeys(inputValue, memoizationMap);
return _dropUndefinedKeys(inputValue, memoizationMap, depth);
}

function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>): T {
function _dropUndefinedKeys<T>(inputValue: T, memoizationMap: Map<unknown, unknown>, depth: number): T {
// If the max. depth is reached, return the input value as is
if (!depth) {
return inputValue;
}

// Early return for primitive values
if (inputValue === null || typeof inputValue !== 'object') {
return inputValue;
Expand Down
19 changes: 11 additions & 8 deletions packages/core/src/utils/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,14 +91,17 @@ 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({
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
});
return dropUndefinedKeys(
{
url: absoluteUrl,
method: request.method,
query_string: extractQueryParamsFromUrl(url),
headers: headersToDict(headers),
cookies,
data,
},
1,
);
}

function getAbsoluteUrl({
Expand Down
54 changes: 30 additions & 24 deletions packages/core/src/utils/spanUtils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,16 +42,19 @@ 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({
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
});
return dropUndefinedKeys(
{
parent_span_id,
span_id,
trace_id,
data,
op,
status,
origin,
links,
},
1,
);
}

/**
Expand DownExpand Up@@ -147,20 +150,23 @@ export function spanToJSON(span: Span): SpanJSON {
if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
const { attributes, startTime, name, endTime, parentSpanId, status, links } = span;

return dropUndefinedKeys({
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
});
return dropUndefinedKeys(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need to call dropUndefinedKeys here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I extracted this out here: #15792 - I think you are right 🤔

{
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
links: convertSpanLinksForEnvelope(links),
},
1,
);
}

// Finally, at least we have `spanContext()`....
Expand Down
86 changes: 86 additions & 0 deletions packages/core/test/utils-hoist/object.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -208,6 +208,33 @@ describe('dropUndefinedKeys()', () => {
});
});

test('arrays with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
},
1,
),
).toStrictEqual({
a: [
1,
undefined,
{
a: 1,
b: undefined,
},
],
});
});

test('nested objects', () => {
expect(
dropUndefinedKeys({
Expand All@@ -232,6 +259,65 @@ describe('dropUndefinedKeys()', () => {
});
});

test('nested objects with depth=1', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
1,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
});
});

test('nested objects with depth=2', () => {
expect(
dropUndefinedKeys(
{
a: 1,
b: {
c: 2,
d: undefined,
e: {
f: 3,
g: undefined,
},
},
c: undefined,
},
2,
),
).toStrictEqual({
a: 1,
b: {
c: 2,
e: {
f: 3,
g: undefined,
},
},
});
});

describe('class instances', () => {
class MyClass {
public a = 'foo';
Expand Down
2 changes: 1 addition & 1 deletion packages/replay-internal/src/integration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -356,7 +356,7 @@ function loadReplayOptionsFromClient(initialOptions: InitialReplayPluginOptions,
const finalOptions: ReplayPluginOptions = {
sessionSampleRate: 0,
errorSampleRate: 0,
...dropUndefinedKeys(initialOptions),
...dropUndefinedKeys(initialOptions, 1),
};

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