feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged#14315

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 10 commits into from
Nov 19, 2024
Merged

feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged #14315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
64e6c7a
fix(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is m…
mydea Nov 15, 2024
fc21920
fix circular dependency
mydea Nov 15, 2024
99ee12f
expose proper util to set normalized request
mydea Nov 15, 2024
196460f
bump size limit :(
mydea Nov 15, 2024
c3f785e
fix body setting
mydea Nov 15, 2024
2b537af
rename to `setRequestEventData`
mydea Nov 15, 2024
15961cd
fix linting
mydea Nov 18, 2024
cd577f3
use generic merge instead
mydea Nov 18, 2024
2880f72
small fixes and tests
mydea Nov 19, 2024
003f261
fix test
mydea Nov 19, 2024
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
4 changes: 2 additions & 2 deletions .size-limit.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'feedbackAsyncIntegration'),
gzip: true,
limit: '33 KB',
limit: '34 KB',
},
// React SDK (ESM)
{
Expand DownExpand Up@@ -160,7 +160,7 @@ module.exports = [
name: 'CDN Bundle (incl. Tracing)',
path: createCDNPath('bundle.tracing.min.js'),
gzip: true,
limit: '38 KB',
limit: '39 KB',
},
{
name: 'CDN Bundle (incl. Tracing, Replay)',
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/scope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import type {
import { dateTimestampInSeconds, generatePropagationContext, isPlainObject, logger, uuid4 } from '@sentry/utils';

import { updateSession } from './session';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';

/**
Expand DownExpand Up@@ -479,8 +480,7 @@ class ScopeClass implements ScopeInterface {
* @inheritDoc
*/
public setSDKProcessingMetadata(newData: { [key: string]: unknown }): this {
this._sdkProcessingMetadata = { ...this._sdkProcessingMetadata, ...newData };

this._sdkProcessingMetadata = merge(this._sdkProcessingMetadata, newData, 2);
return this;
}

Expand Down
14 changes: 4 additions & 10 deletions packages/core/src/utils/applyScopeDataToEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Breadcrumb, Event, ScopeData, Span } from '@sentry/types';
import { arrayify, dropUndefinedKeys } from '@sentry/utils';
import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
import { merge } from './merge';
import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';

/**
Expand DownExpand Up@@ -46,7 +47,8 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
mergeAndOverwriteScopeData(data, 'tags', tags);
mergeAndOverwriteScopeData(data, 'user', user);
mergeAndOverwriteScopeData(data, 'contexts', contexts);
mergeAndOverwriteScopeData(data, 'sdkProcessingMetadata', sdkProcessingMetadata);

data.sdkProcessingMetadata = merge(data.sdkProcessingMetadata, sdkProcessingMetadata, 2);

if (level) {
data.level = level;
Expand DownExpand Up@@ -87,15 +89,7 @@ export function mergeAndOverwriteScopeData<
Prop extends 'extra' | 'tags' | 'user' | 'contexts' | 'sdkProcessingMetadata',
Data extends ScopeData,
>(data: Data, prop: Prop, mergeVal: Data[Prop]): void {
if (mergeVal && Object.keys(mergeVal).length) {
// Clone object
data[prop] = { ...data[prop] };
for (const key in mergeVal) {
if (Object.prototype.hasOwnProperty.call(mergeVal, key)) {
data[prop][key] = mergeVal[key];
}
}
}
data[prop] = merge(data[prop], mergeVal, 1);
}

/** Exported only for tests */
Expand Down
31 changes: 31 additions & 0 deletions packages/core/src/utils/merge.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
/**
* Shallow merge two objects.
* Does not mutate the passed in objects.
* Undefined/empty values in the merge object will overwrite existing values.
*
* By default, this merges 2 levels deep.
*/
export function merge<T>(initialObj: T, mergeObj: T, levels = 2): T {
// If the merge value is not an object, or we have no merge levels left,
// we just set the value to the merge value
if (!mergeObj || typeof mergeObj !== 'object' || levels <= 0) {
return mergeObj;
}

// If the merge object is an empty object, and the initial object is not undefined, we return the initial object
if (initialObj && mergeObj && Object.keys(mergeObj).length === 0) {
return initialObj;
}

// Clone object
const output = { ...initialObj };

// Merge values into output, resursively
for (const key in mergeObj) {
if (Object.prototype.hasOwnProperty.call(mergeObj, key)) {
output[key] = merge(output[key], mergeObj[key], levels - 1);
}
}

return output;
}
25 changes: 21 additions & 4 deletions packages/core/test/lib/scope.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -204,10 +204,27 @@ describe('Scope', () => {
expect(scope['_user']).toEqual({});
});

test('setProcessingMetadata', () => {
const scope = new Scope();
scope.setSDKProcessingMetadata({ dogs: 'are great!' });
expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
describe('setProcessingMetadata', () => {
test('it works with no initial data', () => {
const scope = new Scope();
scope.setSDKProcessingMetadata({ dogs: 'are great!' });
expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
});

test('it overwrites data', () => {
const scope = new Scope();
scope.setSDKProcessingMetadata({ dogs: 'are great!' });
scope.setSDKProcessingMetadata({ dogs: 'are really great!' });
scope.setSDKProcessingMetadata({ cats: 'are also great!' });
scope.setSDKProcessingMetadata({ obj: { nested1: 'value1', nested: 'value1' } });
scope.setSDKProcessingMetadata({ obj: { nested2: 'value2', nested: 'value2' } });

expect(scope['_sdkProcessingMetadata']).toEqual({
dogs: 'are really great!',
cats: 'are also great!',
obj: { nested2: 'value2', nested: 'value2', nested1: 'value1' },
});
});
});

test('set and get propagation context', () => {
Expand Down
32 changes: 29 additions & 3 deletions packages/core/test/lib/utils/applyScopeDataToEvent.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ describe('mergeScopeData', () => {
contexts: { os: { name: 'os1' }, culture: { display_name: 'name1' } },
attachments: [attachment1],
propagationContext: { spanId: '1', traceId: '1' },
sdkProcessingMetadata: { aa: 'aa', bb: 'aa' },
sdkProcessingMetadata: {
aa: 'aa',
bb: 'aa',
obj: { key: 'value' },
normalizedRequest: {
url: 'oldUrl',
method: 'oldMethod',
},
},
fingerprint: ['aa', 'bb'],
};
const data2: ScopeData = {
Expand All@@ -146,7 +154,15 @@ describe('mergeScopeData', () => {
contexts: { os: { name: 'os2' } },
attachments: [attachment2, attachment3],
propagationContext: { spanId: '2', traceId: '2' },
sdkProcessingMetadata: { bb: 'bb', cc: 'bb' },
sdkProcessingMetadata: {
bb: 'bb',
cc: 'bb',
obj: { key2: 'value2' },
normalizedRequest: {
url: 'newUrl',
headers: {},
},
},
fingerprint: ['cc'],
};
mergeScopeData(data1, data2);
Expand All@@ -159,7 +175,17 @@ describe('mergeScopeData', () => {
contexts: { os: { name: 'os2' }, culture: { display_name: 'name1' } },
attachments: [attachment1, attachment2, attachment3],
propagationContext: { spanId: '2', traceId: '2' },
sdkProcessingMetadata: { aa: 'aa', bb: 'bb', cc: 'bb' },
sdkProcessingMetadata: {
aa: 'aa',
bb: 'bb',
cc: 'bb',
obj: { key: 'value', key2: 'value2' },
normalizedRequest: {
url: 'newUrl',
method: 'oldMethod',
headers: {},
},
},
fingerprint: ['aa', 'bb', 'cc'],
});
});
Expand Down
75 changes: 75 additions & 0 deletions packages/core/test/lib/utils/merge.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { merge } from '../../../src/utils/merge';

describe('merge', () => {
it('works with empty objects', () => {
const oldData = {};
const newData = {};

const actual = merge(oldData, newData);

expect(actual).toEqual({});
expect(actual).toBe(oldData);
expect(actual).not.toBe(newData);
});

it('works with empty merge object', () => {
const oldData = { aa: 'aha' };
const newData = {};

const actual = merge(oldData, newData);

expect(actual).toEqual({ aa: 'aha' });
expect(actual).toBe(oldData);
expect(actual).not.toBe(newData);
});

it('works with arbitrary data', () => {
const oldData = {
old1: 'old1',
old2: 'old2',
obj: { key: 'value1', key1: 'value1', deep: { key: 'value' } },
} as any;
const newData = {
new1: 'new1',
old2: 'new2',
obj: { key2: 'value2', key: 'value2', deep: { key2: 'value2' } },
} as any;

const actual = merge(oldData, newData);

expect(actual).toEqual({
old1: 'old1',
old2: 'new2',
new1: 'new1',
obj: {
key2: 'value2',
key: 'value2',
key1: 'value1',
deep: { key2: 'value2' },
},
});
expect(actual).not.toBe(oldData);
expect(actual).not.toBe(newData);
});

it.each([
[undefined, { a: 'aa' }, { a: 'aa' }],
[{ a: 'aa' }, undefined, undefined],
[{ a: 'aa' }, null, null],
[{ a: 'aa' }, { a: undefined }, { a: undefined }],
[{ a: 'aa' }, { a: null }, { a: null }],
[{ a: 'aa' }, { a: '' }, { a: '' }],
[
{ a0: { a1: { a2: { a3: { a4: 'a4a' }, a3a: 'a3a' }, a2a: 'a2a' }, a1a: 'a1a' }, a0a: 'a0a' },
{ a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b' }, a0b: 'a0b' },
{
a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b', a1a: 'a1a' },
a0b: 'a0b',
a0a: 'a0a',
},
],
])('works with %p and %p', (oldData, newData, expected) => {
const actual = merge(oldData, newData as any);
expect(actual).toEqual(expected);
});
});
16 changes: 10 additions & 6 deletions packages/node/src/integrations/http/SentryHttpInstrumentation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData } from '@sentry/types';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData, Scope } from '@sentry/types';
import {
getBreadcrumbLogLevelFromHttpStatusCode,
getSanitizedUrlString,
Expand DownExpand Up@@ -150,10 +150,14 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
cookies,
};

patchRequestToCaptureBody(request, normalizedRequest);
patchRequestToCaptureBody(request, isolationScope);

// Update the isolation scope, isolate this request
isolationScope.setSDKProcessingMetadata({ request, normalizedRequest });
// TODO(v9): Stop setting `request`, we only rely on normalizedRequest anymore
isolationScope.setSDKProcessingMetadata({
request,
normalizedRequest,
});

const client = getClient<NodeClient>();
if (client && client.getOptions().autoSessionTracking) {
Expand DownExpand Up@@ -347,7 +351,7 @@ function getBreadcrumbData(request: http.ClientRequest): Partial<SanitizedReques
* we monkey patch `req.on('data')` to intercept the body chunks.
* This way, we only read the body if the user also consumes the body, ensuring we do not change any behavior in unexpected ways.
*/
function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: RequestEventData): void {
function patchRequestToCaptureBody(req: IncomingMessage, isolationScope: Scope): void {
const chunks: Buffer[] = [];

function getChunksSize(): number {
Expand DownExpand Up@@ -396,9 +400,9 @@ function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: Requ
try {
const body = Buffer.concat(chunks).toString('utf-8');

// We mutate the passed in normalizedRequest and add the body to it
if (body) {
normalizedRequest.data = body;
const normalizedRequest = { data: body } satisfies RequestEventData;
isolationScope.setSDKProcessingMetadata({ normalizedRequest });
}
} catch {
// ignore errors here
Expand Down
4 changes: 3 additions & 1 deletion packages/types/src/scope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -217,7 +217,9 @@ export interface Scope {
clearAttachments(): this;

/**
* Add data which will be accessible during event processing but won't get sent to Sentry
* Add data which will be accessible during event processing but won't get sent to Sentry.
*
* TODO(v9): We should type this stricter, so that e.g. `normalizedRequest` is strictly typed.
*/
setSDKProcessingMetadata(newData: { [key: string]: unknown }): this;

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged#14315

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 10 commits into

from

Nov 19, 2024
 Merged


feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged
#14315
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
64e6c7a

fix(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is m…


mydea Nov 15, 2024
fc21920

fix circular dependency


mydea Nov 15, 2024
99ee12f

expose proper util to set normalized request


mydea Nov 15, 2024
196460f

bump size limit :(


mydea Nov 15, 2024
c3f785e

fix body setting


mydea Nov 15, 2024
2b537af

rename to `setRequestEventData`


mydea Nov 15, 2024
15961cd

fix linting


mydea Nov 18, 2024
cd577f3

use generic merge instead


mydea Nov 18, 2024
2880f72

small fixes and tests


mydea Nov 19, 2024
003f261

fix test


mydea Nov 19, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'feedbackAsyncIntegration'),
 gzip: true,
 limit: '33 KB',
 limit: '34 KB',
 },
 // React SDK (ESM)
 {
Expand DownExpand Up@@ -160,7 +160,7 @@ module.exports = [
 name: 'CDN Bundle (incl. Tracing)',
 path: createCDNPath('bundle.tracing.min.js'),
 gzip: true,
 limit: '38 KB',
 limit: '39 KB',
 },
 {
 name: 'CDN Bundle (incl. Tracing, Replay)',
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import type {
import { dateTimestampInSeconds, generatePropagationContext, isPlainObject, logger, uuid4 } from '@sentry/utils';

import { updateSession } from './session';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';

/**
Expand DownExpand Up@@ -479,8 +480,7 @@ class ScopeClass implements ScopeInterface {
 * @inheritDoc
 */
 public setSDKProcessingMetadata(newData: { [key: string]: unknown }): this {
 this._sdkProcessingMetadata = { ...this._sdkProcessingMetadata, ...newData };

 this._sdkProcessingMetadata = merge(this._sdkProcessingMetadata, newData, 2);
 return this;
 }

Expand Down

14 changes: 4 additions & 10 deletions
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Breadcrumb, Event, ScopeData, Span } from '@sentry/types';
import { arrayify, dropUndefinedKeys } from '@sentry/utils';
import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
import { merge } from './merge';
import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';

/**
Expand DownExpand Up@@ -46,7 +47,8 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 mergeAndOverwriteScopeData(data, 'tags', tags);
 mergeAndOverwriteScopeData(data, 'user', user);
 mergeAndOverwriteScopeData(data, 'contexts', contexts);
 mergeAndOverwriteScopeData(data, 'sdkProcessingMetadata', sdkProcessingMetadata);

 data.sdkProcessingMetadata = merge(data.sdkProcessingMetadata, sdkProcessingMetadata, 2);

 if (level) {
 data.level = level;
Expand DownExpand Up@@ -87,15 +89,7 @@ export function mergeAndOverwriteScopeData<
 Prop extends 'extra' | 'tags' | 'user' | 'contexts' | 'sdkProcessingMetadata',
 Data extends ScopeData,
>(data: Data, prop: Prop, mergeVal: Data[Prop]): void {
 if (mergeVal && Object.keys(mergeVal).length) {
 // Clone object
 data[prop] = { ...data[prop] };
 for (const key in mergeVal) {
 if (Object.prototype.hasOwnProperty.call(mergeVal, key)) {
 data[prop][key] = mergeVal[key];
 }
 }
 }
 data[prop] = merge(data[prop], mergeVal, 1);
}

/** Exported only for tests */
Expand Down

31 changes: 31 additions & 0 deletions
packages/core/src/utils/merge.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
/**
 * Shallow merge two objects.
 * Does not mutate the passed in objects.
 * Undefined/empty values in the merge object will overwrite existing values.
 *
 * By default, this merges 2 levels deep.
 */
export function merge<T>(initialObj: T, mergeObj: T, levels = 2): T {
 // If the merge value is not an object, or we have no merge levels left,
 // we just set the value to the merge value
 if (!mergeObj || typeof mergeObj !== 'object' || levels <= 0) {
 return mergeObj;
 }

 // If the merge object is an empty object, and the initial object is not undefined, we return the initial object
 if (initialObj && mergeObj && Object.keys(mergeObj).length === 0) {
 return initialObj;
 }

 // Clone object
 const output = { ...initialObj };

 // Merge values into output, resursively
 for (const key in mergeObj) {
 if (Object.prototype.hasOwnProperty.call(mergeObj, key)) {
 output[key] = merge(output[key], mergeObj[key], levels - 1);
 }
 }

 return output;
}

25 changes: 21 additions & 4 deletions
packages/core/test/lib/scope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -204,10 +204,27 @@ describe('Scope', () => {
 expect(scope['_user']).toEqual({});
 });

 test('setProcessingMetadata', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 describe('setProcessingMetadata', () => {
 test('it works with no initial data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 });

 test('it overwrites data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 scope.setSDKProcessingMetadata({ dogs: 'are really great!' });
 scope.setSDKProcessingMetadata({ cats: 'are also great!' });
 scope.setSDKProcessingMetadata({ obj: { nested1: 'value1', nested: 'value1' } });
 scope.setSDKProcessingMetadata({ obj: { nested2: 'value2', nested: 'value2' } });

 expect(scope['_sdkProcessingMetadata']).toEqual({
 dogs: 'are really great!',
 cats: 'are also great!',
 obj: { nested2: 'value2', nested: 'value2', nested1: 'value1' },
 });
 });
 });

 test('set and get propagation context', () => {
Expand Down

32 changes: 29 additions & 3 deletions
packages/core/test/lib/utils/applyScopeDataToEvent.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os1' }, culture: { display_name: 'name1' } },
 attachments: [attachment1],
 propagationContext: { spanId: '1', traceId: '1' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'aa' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'aa',
 obj: { key: 'value' },
 normalizedRequest: {
 url: 'oldUrl',
 method: 'oldMethod',
 },
 },
 fingerprint: ['aa', 'bb'],
 };
 const data2: ScopeData = {
Expand All@@ -146,7 +154,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' } },
 attachments: [attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 bb: 'bb',
 cc: 'bb',
 obj: { key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 headers: {},
 },
 },
 fingerprint: ['cc'],
 };
 mergeScopeData(data1, data2);
Expand All@@ -159,7 +175,17 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' }, culture: { display_name: 'name1' } },
 attachments: [attachment1, attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'bb',
 cc: 'bb',
 obj: { key: 'value', key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 method: 'oldMethod',
 headers: {},
 },
 },
 fingerprint: ['aa', 'bb', 'cc'],
 });
 });
Expand Down

75 changes: 75 additions & 0 deletions
packages/core/test/lib/utils/merge.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { merge } from '../../../src/utils/merge';

describe('merge', () => {
 it('works with empty objects', () => {
 const oldData = {};
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({});
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with empty merge object', () => {
 const oldData = { aa: 'aha' };
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({ aa: 'aha' });
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with arbitrary data', () => {
 const oldData = {
 old1: 'old1',
 old2: 'old2',
 obj: { key: 'value1', key1: 'value1', deep: { key: 'value' } },
 } as any;
 const newData = {
 new1: 'new1',
 old2: 'new2',
 obj: { key2: 'value2', key: 'value2', deep: { key2: 'value2' } },
 } as any;

 const actual = merge(oldData, newData);

 expect(actual).toEqual({
 old1: 'old1',
 old2: 'new2',
 new1: 'new1',
 obj: {
 key2: 'value2',
 key: 'value2',
 key1: 'value1',
 deep: { key2: 'value2' },
 },
 });
 expect(actual).not.toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it.each([
 [undefined, { a: 'aa' }, { a: 'aa' }],
 [{ a: 'aa' }, undefined, undefined],
 [{ a: 'aa' }, null, null],
 [{ a: 'aa' }, { a: undefined }, { a: undefined }],
 [{ a: 'aa' }, { a: null }, { a: null }],
 [{ a: 'aa' }, { a: '' }, { a: '' }],
 [
 { a0: { a1: { a2: { a3: { a4: 'a4a' }, a3a: 'a3a' }, a2a: 'a2a' }, a1a: 'a1a' }, a0a: 'a0a' },
 { a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b' }, a0b: 'a0b' },
 {
 a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b', a1a: 'a1a' },
 a0b: 'a0b',
 a0a: 'a0a',
 },
 ],
 ])('works with %p and %p', (oldData, newData, expected) => {
 const actual = merge(oldData, newData as any);
 expect(actual).toEqual(expected);
 });
});

16 changes: 10 additions & 6 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData } from '@sentry/types';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData, Scope } from '@sentry/types';
import {
 getBreadcrumbLogLevelFromHttpStatusCode,
 getSanitizedUrlString,
Expand DownExpand Up@@ -150,10 +150,14 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 cookies,
 };

 patchRequestToCaptureBody(request, normalizedRequest);
 patchRequestToCaptureBody(request, isolationScope);

 // Update the isolation scope, isolate this request
 isolationScope.setSDKProcessingMetadata({ request, normalizedRequest });
 // TODO(v9): Stop setting `request`, we only rely on normalizedRequest anymore
 isolationScope.setSDKProcessingMetadata({
 request,
 normalizedRequest,
 });

 const client = getClient<NodeClient>();
 if (client && client.getOptions().autoSessionTracking) {
Expand DownExpand Up@@ -347,7 +351,7 @@ function getBreadcrumbData(request: http.ClientRequest): Partial<SanitizedReques
 * we monkey patch `req.on('data')` to intercept the body chunks.
 * This way, we only read the body if the user also consumes the body, ensuring we do not change any behavior in unexpected ways.
 */
function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: RequestEventData): void {
function patchRequestToCaptureBody(req: IncomingMessage, isolationScope: Scope): void {
 const chunks: Buffer[] = [];

 function getChunksSize(): number {
Expand DownExpand Up@@ -396,9 +400,9 @@ function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: Requ
 try {
 const body = Buffer.concat(chunks).toString('utf-8');

 // We mutate the passed in normalizedRequest and add the body to it
 if (body) {
 normalizedRequest.data = body;
 const normalizedRequest = { data: body } satisfies RequestEventData;
 isolationScope.setSDKProcessingMetadata({ normalizedRequest });
 }
 } catch {
 // ignore errors here
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,7 +217,9 @@ export interface Scope {
 clearAttachments(): this;

 /**
 * Add data which will be accessible during event processing but won't get sent to Sentry
 * Add data which will be accessible during event processing but won't get sent to Sentry.
 *
 * TODO(v9): We should type this stricter, so that e.g. `normalizedRequest` is strictly typed.
 */
 setSDKProcessingMetadata(newData: { [key: string]: unknown }): this;

Expand Down

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

Skip to content
feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged#14315

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 10 commits into

from

Nov 19, 2024
 Merged


feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged
#14315
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
64e6c7a

fix(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is m…


mydea Nov 15, 2024
fc21920

fix circular dependency


mydea Nov 15, 2024
99ee12f

expose proper util to set normalized request


mydea Nov 15, 2024
196460f

bump size limit :(


mydea Nov 15, 2024
c3f785e

fix body setting


mydea Nov 15, 2024
2b537af

rename to `setRequestEventData`


mydea Nov 15, 2024
15961cd

fix linting


mydea Nov 18, 2024
cd577f3

use generic merge instead


mydea Nov 18, 2024
2880f72

small fixes and tests


mydea Nov 19, 2024
003f261

fix test


mydea Nov 19, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'feedbackAsyncIntegration'),
 gzip: true,
 limit: '33 KB',
 limit: '34 KB',
 },
 // React SDK (ESM)
 {
Expand DownExpand Up@@ -160,7 +160,7 @@ module.exports = [
 name: 'CDN Bundle (incl. Tracing)',
 path: createCDNPath('bundle.tracing.min.js'),
 gzip: true,
 limit: '38 KB',
 limit: '39 KB',
 },
 {
 name: 'CDN Bundle (incl. Tracing, Replay)',
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import type {
import { dateTimestampInSeconds, generatePropagationContext, isPlainObject, logger, uuid4 } from '@sentry/utils';

import { updateSession } from './session';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';

/**
Expand DownExpand Up@@ -479,8 +480,7 @@ class ScopeClass implements ScopeInterface {
 * @inheritDoc
 */
 public setSDKProcessingMetadata(newData: { [key: string]: unknown }): this {
 this._sdkProcessingMetadata = { ...this._sdkProcessingMetadata, ...newData };

 this._sdkProcessingMetadata = merge(this._sdkProcessingMetadata, newData, 2);
 return this;
 }

Expand Down

14 changes: 4 additions & 10 deletions
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Breadcrumb, Event, ScopeData, Span } from '@sentry/types';
import { arrayify, dropUndefinedKeys } from '@sentry/utils';
import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
import { merge } from './merge';
import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';

/**
Expand DownExpand Up@@ -46,7 +47,8 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 mergeAndOverwriteScopeData(data, 'tags', tags);
 mergeAndOverwriteScopeData(data, 'user', user);
 mergeAndOverwriteScopeData(data, 'contexts', contexts);
 mergeAndOverwriteScopeData(data, 'sdkProcessingMetadata', sdkProcessingMetadata);

 data.sdkProcessingMetadata = merge(data.sdkProcessingMetadata, sdkProcessingMetadata, 2);

 if (level) {
 data.level = level;
Expand DownExpand Up@@ -87,15 +89,7 @@ export function mergeAndOverwriteScopeData<
 Prop extends 'extra' | 'tags' | 'user' | 'contexts' | 'sdkProcessingMetadata',
 Data extends ScopeData,
>(data: Data, prop: Prop, mergeVal: Data[Prop]): void {
 if (mergeVal && Object.keys(mergeVal).length) {
 // Clone object
 data[prop] = { ...data[prop] };
 for (const key in mergeVal) {
 if (Object.prototype.hasOwnProperty.call(mergeVal, key)) {
 data[prop][key] = mergeVal[key];
 }
 }
 }
 data[prop] = merge(data[prop], mergeVal, 1);
}

/** Exported only for tests */
Expand Down

31 changes: 31 additions & 0 deletions
packages/core/src/utils/merge.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
/**
 * Shallow merge two objects.
 * Does not mutate the passed in objects.
 * Undefined/empty values in the merge object will overwrite existing values.
 *
 * By default, this merges 2 levels deep.
 */
export function merge<T>(initialObj: T, mergeObj: T, levels = 2): T {
 // If the merge value is not an object, or we have no merge levels left,
 // we just set the value to the merge value
 if (!mergeObj || typeof mergeObj !== 'object' || levels <= 0) {
 return mergeObj;
 }

 // If the merge object is an empty object, and the initial object is not undefined, we return the initial object
 if (initialObj && mergeObj && Object.keys(mergeObj).length === 0) {
 return initialObj;
 }

 // Clone object
 const output = { ...initialObj };

 // Merge values into output, resursively
 for (const key in mergeObj) {
 if (Object.prototype.hasOwnProperty.call(mergeObj, key)) {
 output[key] = merge(output[key], mergeObj[key], levels - 1);
 }
 }

 return output;
}

25 changes: 21 additions & 4 deletions
packages/core/test/lib/scope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -204,10 +204,27 @@ describe('Scope', () => {
 expect(scope['_user']).toEqual({});
 });

 test('setProcessingMetadata', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 describe('setProcessingMetadata', () => {
 test('it works with no initial data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 });

 test('it overwrites data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 scope.setSDKProcessingMetadata({ dogs: 'are really great!' });
 scope.setSDKProcessingMetadata({ cats: 'are also great!' });
 scope.setSDKProcessingMetadata({ obj: { nested1: 'value1', nested: 'value1' } });
 scope.setSDKProcessingMetadata({ obj: { nested2: 'value2', nested: 'value2' } });

 expect(scope['_sdkProcessingMetadata']).toEqual({
 dogs: 'are really great!',
 cats: 'are also great!',
 obj: { nested2: 'value2', nested: 'value2', nested1: 'value1' },
 });
 });
 });

 test('set and get propagation context', () => {
Expand Down

32 changes: 29 additions & 3 deletions
packages/core/test/lib/utils/applyScopeDataToEvent.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os1' }, culture: { display_name: 'name1' } },
 attachments: [attachment1],
 propagationContext: { spanId: '1', traceId: '1' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'aa' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'aa',
 obj: { key: 'value' },
 normalizedRequest: {
 url: 'oldUrl',
 method: 'oldMethod',
 },
 },
 fingerprint: ['aa', 'bb'],
 };
 const data2: ScopeData = {
Expand All@@ -146,7 +154,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' } },
 attachments: [attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 bb: 'bb',
 cc: 'bb',
 obj: { key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 headers: {},
 },
 },
 fingerprint: ['cc'],
 };
 mergeScopeData(data1, data2);
Expand All@@ -159,7 +175,17 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' }, culture: { display_name: 'name1' } },
 attachments: [attachment1, attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'bb',
 cc: 'bb',
 obj: { key: 'value', key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 method: 'oldMethod',
 headers: {},
 },
 },
 fingerprint: ['aa', 'bb', 'cc'],
 });
 });
Expand Down

75 changes: 75 additions & 0 deletions
packages/core/test/lib/utils/merge.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { merge } from '../../../src/utils/merge';

describe('merge', () => {
 it('works with empty objects', () => {
 const oldData = {};
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({});
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with empty merge object', () => {
 const oldData = { aa: 'aha' };
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({ aa: 'aha' });
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with arbitrary data', () => {
 const oldData = {
 old1: 'old1',
 old2: 'old2',
 obj: { key: 'value1', key1: 'value1', deep: { key: 'value' } },
 } as any;
 const newData = {
 new1: 'new1',
 old2: 'new2',
 obj: { key2: 'value2', key: 'value2', deep: { key2: 'value2' } },
 } as any;

 const actual = merge(oldData, newData);

 expect(actual).toEqual({
 old1: 'old1',
 old2: 'new2',
 new1: 'new1',
 obj: {
 key2: 'value2',
 key: 'value2',
 key1: 'value1',
 deep: { key2: 'value2' },
 },
 });
 expect(actual).not.toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it.each([
 [undefined, { a: 'aa' }, { a: 'aa' }],
 [{ a: 'aa' }, undefined, undefined],
 [{ a: 'aa' }, null, null],
 [{ a: 'aa' }, { a: undefined }, { a: undefined }],
 [{ a: 'aa' }, { a: null }, { a: null }],
 [{ a: 'aa' }, { a: '' }, { a: '' }],
 [
 { a0: { a1: { a2: { a3: { a4: 'a4a' }, a3a: 'a3a' }, a2a: 'a2a' }, a1a: 'a1a' }, a0a: 'a0a' },
 { a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b' }, a0b: 'a0b' },
 {
 a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b', a1a: 'a1a' },
 a0b: 'a0b',
 a0a: 'a0a',
 },
 ],
 ])('works with %p and %p', (oldData, newData, expected) => {
 const actual = merge(oldData, newData as any);
 expect(actual).toEqual(expected);
 });
});

16 changes: 10 additions & 6 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData } from '@sentry/types';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData, Scope } from '@sentry/types';
import {
 getBreadcrumbLogLevelFromHttpStatusCode,
 getSanitizedUrlString,
Expand DownExpand Up@@ -150,10 +150,14 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 cookies,
 };

 patchRequestToCaptureBody(request, normalizedRequest);
 patchRequestToCaptureBody(request, isolationScope);

 // Update the isolation scope, isolate this request
 isolationScope.setSDKProcessingMetadata({ request, normalizedRequest });
 // TODO(v9): Stop setting `request`, we only rely on normalizedRequest anymore
 isolationScope.setSDKProcessingMetadata({
 request,
 normalizedRequest,
 });

 const client = getClient<NodeClient>();
 if (client && client.getOptions().autoSessionTracking) {
Expand DownExpand Up@@ -347,7 +351,7 @@ function getBreadcrumbData(request: http.ClientRequest): Partial<SanitizedReques
 * we monkey patch `req.on('data')` to intercept the body chunks.
 * This way, we only read the body if the user also consumes the body, ensuring we do not change any behavior in unexpected ways.
 */
function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: RequestEventData): void {
function patchRequestToCaptureBody(req: IncomingMessage, isolationScope: Scope): void {
 const chunks: Buffer[] = [];

 function getChunksSize(): number {
Expand DownExpand Up@@ -396,9 +400,9 @@ function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: Requ
 try {
 const body = Buffer.concat(chunks).toString('utf-8');

 // We mutate the passed in normalizedRequest and add the body to it
 if (body) {
 normalizedRequest.data = body;
 const normalizedRequest = { data: body } satisfies RequestEventData;
 isolationScope.setSDKProcessingMetadata({ normalizedRequest });
 }
 } catch {
 // ignore errors here
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,7 +217,9 @@ export interface Scope {
 clearAttachments(): this;

 /**
 * Add data which will be accessible during event processing but won't get sent to Sentry
 * Add data which will be accessible during event processing but won't get sent to Sentry.
 *
 * TODO(v9): We should type this stricter, so that e.g. `normalizedRequest` is strictly typed.
 */
 setSDKProcessingMetadata(newData: { [key: string]: unknown }): this;

Expand Down

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

Skip to content
feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged#14315

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 10 commits into

from

Nov 19, 2024
 Merged


feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged
#14315
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
64e6c7a

fix(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is m…


mydea Nov 15, 2024
fc21920

fix circular dependency


mydea Nov 15, 2024
99ee12f

expose proper util to set normalized request


mydea Nov 15, 2024
196460f

bump size limit :(


mydea Nov 15, 2024
c3f785e

fix body setting


mydea Nov 15, 2024
2b537af

rename to `setRequestEventData`


mydea Nov 15, 2024
15961cd

fix linting


mydea Nov 18, 2024
cd577f3

use generic merge instead


mydea Nov 18, 2024
2880f72

small fixes and tests


mydea Nov 19, 2024
003f261

fix test


mydea Nov 19, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'feedbackAsyncIntegration'),
 gzip: true,
 limit: '33 KB',
 limit: '34 KB',
 },
 // React SDK (ESM)
 {
Expand DownExpand Up@@ -160,7 +160,7 @@ module.exports = [
 name: 'CDN Bundle (incl. Tracing)',
 path: createCDNPath('bundle.tracing.min.js'),
 gzip: true,
 limit: '38 KB',
 limit: '39 KB',
 },
 {
 name: 'CDN Bundle (incl. Tracing, Replay)',
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import type {
import { dateTimestampInSeconds, generatePropagationContext, isPlainObject, logger, uuid4 } from '@sentry/utils';

import { updateSession } from './session';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';

/**
Expand DownExpand Up@@ -479,8 +480,7 @@ class ScopeClass implements ScopeInterface {
 * @inheritDoc
 */
 public setSDKProcessingMetadata(newData: { [key: string]: unknown }): this {
 this._sdkProcessingMetadata = { ...this._sdkProcessingMetadata, ...newData };

 this._sdkProcessingMetadata = merge(this._sdkProcessingMetadata, newData, 2);
 return this;
 }

Expand Down

14 changes: 4 additions & 10 deletions
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Breadcrumb, Event, ScopeData, Span } from '@sentry/types';
import { arrayify, dropUndefinedKeys } from '@sentry/utils';
import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
import { merge } from './merge';
import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';

/**
Expand DownExpand Up@@ -46,7 +47,8 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 mergeAndOverwriteScopeData(data, 'tags', tags);
 mergeAndOverwriteScopeData(data, 'user', user);
 mergeAndOverwriteScopeData(data, 'contexts', contexts);
 mergeAndOverwriteScopeData(data, 'sdkProcessingMetadata', sdkProcessingMetadata);

 data.sdkProcessingMetadata = merge(data.sdkProcessingMetadata, sdkProcessingMetadata, 2);

 if (level) {
 data.level = level;
Expand DownExpand Up@@ -87,15 +89,7 @@ export function mergeAndOverwriteScopeData<
 Prop extends 'extra' | 'tags' | 'user' | 'contexts' | 'sdkProcessingMetadata',
 Data extends ScopeData,
>(data: Data, prop: Prop, mergeVal: Data[Prop]): void {
 if (mergeVal && Object.keys(mergeVal).length) {
 // Clone object
 data[prop] = { ...data[prop] };
 for (const key in mergeVal) {
 if (Object.prototype.hasOwnProperty.call(mergeVal, key)) {
 data[prop][key] = mergeVal[key];
 }
 }
 }
 data[prop] = merge(data[prop], mergeVal, 1);
}

/** Exported only for tests */
Expand Down

31 changes: 31 additions & 0 deletions
packages/core/src/utils/merge.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
/**
 * Shallow merge two objects.
 * Does not mutate the passed in objects.
 * Undefined/empty values in the merge object will overwrite existing values.
 *
 * By default, this merges 2 levels deep.
 */
export function merge<T>(initialObj: T, mergeObj: T, levels = 2): T {
 // If the merge value is not an object, or we have no merge levels left,
 // we just set the value to the merge value
 if (!mergeObj || typeof mergeObj !== 'object' || levels <= 0) {
 return mergeObj;
 }

 // If the merge object is an empty object, and the initial object is not undefined, we return the initial object
 if (initialObj && mergeObj && Object.keys(mergeObj).length === 0) {
 return initialObj;
 }

 // Clone object
 const output = { ...initialObj };

 // Merge values into output, resursively
 for (const key in mergeObj) {
 if (Object.prototype.hasOwnProperty.call(mergeObj, key)) {
 output[key] = merge(output[key], mergeObj[key], levels - 1);
 }
 }

 return output;
}

25 changes: 21 additions & 4 deletions
packages/core/test/lib/scope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -204,10 +204,27 @@ describe('Scope', () => {
 expect(scope['_user']).toEqual({});
 });

 test('setProcessingMetadata', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 describe('setProcessingMetadata', () => {
 test('it works with no initial data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 });

 test('it overwrites data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 scope.setSDKProcessingMetadata({ dogs: 'are really great!' });
 scope.setSDKProcessingMetadata({ cats: 'are also great!' });
 scope.setSDKProcessingMetadata({ obj: { nested1: 'value1', nested: 'value1' } });
 scope.setSDKProcessingMetadata({ obj: { nested2: 'value2', nested: 'value2' } });

 expect(scope['_sdkProcessingMetadata']).toEqual({
 dogs: 'are really great!',
 cats: 'are also great!',
 obj: { nested2: 'value2', nested: 'value2', nested1: 'value1' },
 });
 });
 });

 test('set and get propagation context', () => {
Expand Down

32 changes: 29 additions & 3 deletions
packages/core/test/lib/utils/applyScopeDataToEvent.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os1' }, culture: { display_name: 'name1' } },
 attachments: [attachment1],
 propagationContext: { spanId: '1', traceId: '1' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'aa' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'aa',
 obj: { key: 'value' },
 normalizedRequest: {
 url: 'oldUrl',
 method: 'oldMethod',
 },
 },
 fingerprint: ['aa', 'bb'],
 };
 const data2: ScopeData = {
Expand All@@ -146,7 +154,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' } },
 attachments: [attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 bb: 'bb',
 cc: 'bb',
 obj: { key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 headers: {},
 },
 },
 fingerprint: ['cc'],
 };
 mergeScopeData(data1, data2);
Expand All@@ -159,7 +175,17 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' }, culture: { display_name: 'name1' } },
 attachments: [attachment1, attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'bb',
 cc: 'bb',
 obj: { key: 'value', key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 method: 'oldMethod',
 headers: {},
 },
 },
 fingerprint: ['aa', 'bb', 'cc'],
 });
 });
Expand Down

75 changes: 75 additions & 0 deletions
packages/core/test/lib/utils/merge.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { merge } from '../../../src/utils/merge';

describe('merge', () => {
 it('works with empty objects', () => {
 const oldData = {};
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({});
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with empty merge object', () => {
 const oldData = { aa: 'aha' };
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({ aa: 'aha' });
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with arbitrary data', () => {
 const oldData = {
 old1: 'old1',
 old2: 'old2',
 obj: { key: 'value1', key1: 'value1', deep: { key: 'value' } },
 } as any;
 const newData = {
 new1: 'new1',
 old2: 'new2',
 obj: { key2: 'value2', key: 'value2', deep: { key2: 'value2' } },
 } as any;

 const actual = merge(oldData, newData);

 expect(actual).toEqual({
 old1: 'old1',
 old2: 'new2',
 new1: 'new1',
 obj: {
 key2: 'value2',
 key: 'value2',
 key1: 'value1',
 deep: { key2: 'value2' },
 },
 });
 expect(actual).not.toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it.each([
 [undefined, { a: 'aa' }, { a: 'aa' }],
 [{ a: 'aa' }, undefined, undefined],
 [{ a: 'aa' }, null, null],
 [{ a: 'aa' }, { a: undefined }, { a: undefined }],
 [{ a: 'aa' }, { a: null }, { a: null }],
 [{ a: 'aa' }, { a: '' }, { a: '' }],
 [
 { a0: { a1: { a2: { a3: { a4: 'a4a' }, a3a: 'a3a' }, a2a: 'a2a' }, a1a: 'a1a' }, a0a: 'a0a' },
 { a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b' }, a0b: 'a0b' },
 {
 a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b', a1a: 'a1a' },
 a0b: 'a0b',
 a0a: 'a0a',
 },
 ],
 ])('works with %p and %p', (oldData, newData, expected) => {
 const actual = merge(oldData, newData as any);
 expect(actual).toEqual(expected);
 });
});

16 changes: 10 additions & 6 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData } from '@sentry/types';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData, Scope } from '@sentry/types';
import {
 getBreadcrumbLogLevelFromHttpStatusCode,
 getSanitizedUrlString,
Expand DownExpand Up@@ -150,10 +150,14 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 cookies,
 };

 patchRequestToCaptureBody(request, normalizedRequest);
 patchRequestToCaptureBody(request, isolationScope);

 // Update the isolation scope, isolate this request
 isolationScope.setSDKProcessingMetadata({ request, normalizedRequest });
 // TODO(v9): Stop setting `request`, we only rely on normalizedRequest anymore
 isolationScope.setSDKProcessingMetadata({
 request,
 normalizedRequest,
 });

 const client = getClient<NodeClient>();
 if (client && client.getOptions().autoSessionTracking) {
Expand DownExpand Up@@ -347,7 +351,7 @@ function getBreadcrumbData(request: http.ClientRequest): Partial<SanitizedReques
 * we monkey patch `req.on('data')` to intercept the body chunks.
 * This way, we only read the body if the user also consumes the body, ensuring we do not change any behavior in unexpected ways.
 */
function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: RequestEventData): void {
function patchRequestToCaptureBody(req: IncomingMessage, isolationScope: Scope): void {
 const chunks: Buffer[] = [];

 function getChunksSize(): number {
Expand DownExpand Up@@ -396,9 +400,9 @@ function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: Requ
 try {
 const body = Buffer.concat(chunks).toString('utf-8');

 // We mutate the passed in normalizedRequest and add the body to it
 if (body) {
 normalizedRequest.data = body;
 const normalizedRequest = { data: body } satisfies RequestEventData;
 isolationScope.setSDKProcessingMetadata({ normalizedRequest });
 }
 } catch {
 // ignore errors here
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,7 +217,9 @@ export interface Scope {
 clearAttachments(): this;

 /**
 * Add data which will be accessible during event processing but won't get sent to Sentry
 * Add data which will be accessible during event processing but won't get sent to Sentry.
 *
 * TODO(v9): We should type this stricter, so that e.g. `normalizedRequest` is strictly typed.
 */
 setSDKProcessingMetadata(newData: { [key: string]: unknown }): this;

Expand Down

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

Skip to content
feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged#14315

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 10 commits into

from

Nov 19, 2024
 Merged


feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged
#14315
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
64e6c7a

fix(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is m…


mydea Nov 15, 2024
fc21920

fix circular dependency


mydea Nov 15, 2024
99ee12f

expose proper util to set normalized request


mydea Nov 15, 2024
196460f

bump size limit :(


mydea Nov 15, 2024
c3f785e

fix body setting


mydea Nov 15, 2024
2b537af

rename to `setRequestEventData`


mydea Nov 15, 2024
15961cd

fix linting


mydea Nov 18, 2024
cd577f3

use generic merge instead


mydea Nov 18, 2024
2880f72

small fixes and tests


mydea Nov 19, 2024
003f261

fix test


mydea Nov 19, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'feedbackAsyncIntegration'),
 gzip: true,
 limit: '33 KB',
 limit: '34 KB',
 },
 // React SDK (ESM)
 {
Expand DownExpand Up@@ -160,7 +160,7 @@ module.exports = [
 name: 'CDN Bundle (incl. Tracing)',
 path: createCDNPath('bundle.tracing.min.js'),
 gzip: true,
 limit: '38 KB',
 limit: '39 KB',
 },
 {
 name: 'CDN Bundle (incl. Tracing, Replay)',
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import type {
import { dateTimestampInSeconds, generatePropagationContext, isPlainObject, logger, uuid4 } from '@sentry/utils';

import { updateSession } from './session';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';

/**
Expand DownExpand Up@@ -479,8 +480,7 @@ class ScopeClass implements ScopeInterface {
 * @inheritDoc
 */
 public setSDKProcessingMetadata(newData: { [key: string]: unknown }): this {
 this._sdkProcessingMetadata = { ...this._sdkProcessingMetadata, ...newData };

 this._sdkProcessingMetadata = merge(this._sdkProcessingMetadata, newData, 2);
 return this;
 }

Expand Down

14 changes: 4 additions & 10 deletions
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Breadcrumb, Event, ScopeData, Span } from '@sentry/types';
import { arrayify, dropUndefinedKeys } from '@sentry/utils';
import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
import { merge } from './merge';
import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';

/**
Expand DownExpand Up@@ -46,7 +47,8 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 mergeAndOverwriteScopeData(data, 'tags', tags);
 mergeAndOverwriteScopeData(data, 'user', user);
 mergeAndOverwriteScopeData(data, 'contexts', contexts);
 mergeAndOverwriteScopeData(data, 'sdkProcessingMetadata', sdkProcessingMetadata);

 data.sdkProcessingMetadata = merge(data.sdkProcessingMetadata, sdkProcessingMetadata, 2);

 if (level) {
 data.level = level;
Expand DownExpand Up@@ -87,15 +89,7 @@ export function mergeAndOverwriteScopeData<
 Prop extends 'extra' | 'tags' | 'user' | 'contexts' | 'sdkProcessingMetadata',
 Data extends ScopeData,
>(data: Data, prop: Prop, mergeVal: Data[Prop]): void {
 if (mergeVal && Object.keys(mergeVal).length) {
 // Clone object
 data[prop] = { ...data[prop] };
 for (const key in mergeVal) {
 if (Object.prototype.hasOwnProperty.call(mergeVal, key)) {
 data[prop][key] = mergeVal[key];
 }
 }
 }
 data[prop] = merge(data[prop], mergeVal, 1);
}

/** Exported only for tests */
Expand Down

31 changes: 31 additions & 0 deletions
packages/core/src/utils/merge.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
/**
 * Shallow merge two objects.
 * Does not mutate the passed in objects.
 * Undefined/empty values in the merge object will overwrite existing values.
 *
 * By default, this merges 2 levels deep.
 */
export function merge<T>(initialObj: T, mergeObj: T, levels = 2): T {
 // If the merge value is not an object, or we have no merge levels left,
 // we just set the value to the merge value
 if (!mergeObj || typeof mergeObj !== 'object' || levels <= 0) {
 return mergeObj;
 }

 // If the merge object is an empty object, and the initial object is not undefined, we return the initial object
 if (initialObj && mergeObj && Object.keys(mergeObj).length === 0) {
 return initialObj;
 }

 // Clone object
 const output = { ...initialObj };

 // Merge values into output, resursively
 for (const key in mergeObj) {
 if (Object.prototype.hasOwnProperty.call(mergeObj, key)) {
 output[key] = merge(output[key], mergeObj[key], levels - 1);
 }
 }

 return output;
}

25 changes: 21 additions & 4 deletions
packages/core/test/lib/scope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -204,10 +204,27 @@ describe('Scope', () => {
 expect(scope['_user']).toEqual({});
 });

 test('setProcessingMetadata', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 describe('setProcessingMetadata', () => {
 test('it works with no initial data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 });

 test('it overwrites data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 scope.setSDKProcessingMetadata({ dogs: 'are really great!' });
 scope.setSDKProcessingMetadata({ cats: 'are also great!' });
 scope.setSDKProcessingMetadata({ obj: { nested1: 'value1', nested: 'value1' } });
 scope.setSDKProcessingMetadata({ obj: { nested2: 'value2', nested: 'value2' } });

 expect(scope['_sdkProcessingMetadata']).toEqual({
 dogs: 'are really great!',
 cats: 'are also great!',
 obj: { nested2: 'value2', nested: 'value2', nested1: 'value1' },
 });
 });
 });

 test('set and get propagation context', () => {
Expand Down

32 changes: 29 additions & 3 deletions
packages/core/test/lib/utils/applyScopeDataToEvent.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os1' }, culture: { display_name: 'name1' } },
 attachments: [attachment1],
 propagationContext: { spanId: '1', traceId: '1' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'aa' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'aa',
 obj: { key: 'value' },
 normalizedRequest: {
 url: 'oldUrl',
 method: 'oldMethod',
 },
 },
 fingerprint: ['aa', 'bb'],
 };
 const data2: ScopeData = {
Expand All@@ -146,7 +154,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' } },
 attachments: [attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 bb: 'bb',
 cc: 'bb',
 obj: { key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 headers: {},
 },
 },
 fingerprint: ['cc'],
 };
 mergeScopeData(data1, data2);
Expand All@@ -159,7 +175,17 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' }, culture: { display_name: 'name1' } },
 attachments: [attachment1, attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'bb',
 cc: 'bb',
 obj: { key: 'value', key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 method: 'oldMethod',
 headers: {},
 },
 },
 fingerprint: ['aa', 'bb', 'cc'],
 });
 });
Expand Down

75 changes: 75 additions & 0 deletions
packages/core/test/lib/utils/merge.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { merge } from '../../../src/utils/merge';

describe('merge', () => {
 it('works with empty objects', () => {
 const oldData = {};
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({});
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with empty merge object', () => {
 const oldData = { aa: 'aha' };
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({ aa: 'aha' });
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with arbitrary data', () => {
 const oldData = {
 old1: 'old1',
 old2: 'old2',
 obj: { key: 'value1', key1: 'value1', deep: { key: 'value' } },
 } as any;
 const newData = {
 new1: 'new1',
 old2: 'new2',
 obj: { key2: 'value2', key: 'value2', deep: { key2: 'value2' } },
 } as any;

 const actual = merge(oldData, newData);

 expect(actual).toEqual({
 old1: 'old1',
 old2: 'new2',
 new1: 'new1',
 obj: {
 key2: 'value2',
 key: 'value2',
 key1: 'value1',
 deep: { key2: 'value2' },
 },
 });
 expect(actual).not.toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it.each([
 [undefined, { a: 'aa' }, { a: 'aa' }],
 [{ a: 'aa' }, undefined, undefined],
 [{ a: 'aa' }, null, null],
 [{ a: 'aa' }, { a: undefined }, { a: undefined }],
 [{ a: 'aa' }, { a: null }, { a: null }],
 [{ a: 'aa' }, { a: '' }, { a: '' }],
 [
 { a0: { a1: { a2: { a3: { a4: 'a4a' }, a3a: 'a3a' }, a2a: 'a2a' }, a1a: 'a1a' }, a0a: 'a0a' },
 { a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b' }, a0b: 'a0b' },
 {
 a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b', a1a: 'a1a' },
 a0b: 'a0b',
 a0a: 'a0a',
 },
 ],
 ])('works with %p and %p', (oldData, newData, expected) => {
 const actual = merge(oldData, newData as any);
 expect(actual).toEqual(expected);
 });
});

16 changes: 10 additions & 6 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData } from '@sentry/types';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData, Scope } from '@sentry/types';
import {
 getBreadcrumbLogLevelFromHttpStatusCode,
 getSanitizedUrlString,
Expand DownExpand Up@@ -150,10 +150,14 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 cookies,
 };

 patchRequestToCaptureBody(request, normalizedRequest);
 patchRequestToCaptureBody(request, isolationScope);

 // Update the isolation scope, isolate this request
 isolationScope.setSDKProcessingMetadata({ request, normalizedRequest });
 // TODO(v9): Stop setting `request`, we only rely on normalizedRequest anymore
 isolationScope.setSDKProcessingMetadata({
 request,
 normalizedRequest,
 });

 const client = getClient<NodeClient>();
 if (client && client.getOptions().autoSessionTracking) {
Expand DownExpand Up@@ -347,7 +351,7 @@ function getBreadcrumbData(request: http.ClientRequest): Partial<SanitizedReques
 * we monkey patch `req.on('data')` to intercept the body chunks.
 * This way, we only read the body if the user also consumes the body, ensuring we do not change any behavior in unexpected ways.
 */
function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: RequestEventData): void {
function patchRequestToCaptureBody(req: IncomingMessage, isolationScope: Scope): void {
 const chunks: Buffer[] = [];

 function getChunksSize(): number {
Expand DownExpand Up@@ -396,9 +400,9 @@ function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: Requ
 try {
 const body = Buffer.concat(chunks).toString('utf-8');

 // We mutate the passed in normalizedRequest and add the body to it
 if (body) {
 normalizedRequest.data = body;
 const normalizedRequest = { data: body } satisfies RequestEventData;
 isolationScope.setSDKProcessingMetadata({ normalizedRequest });
 }
 } catch {
 // ignore errors here
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,7 +217,9 @@ export interface Scope {
 clearAttachments(): this;

 /**
 * Add data which will be accessible during event processing but won't get sent to Sentry
 * Add data which will be accessible during event processing but won't get sent to Sentry.
 *
 * TODO(v9): We should type this stricter, so that e.g. `normalizedRequest` is strictly typed.
 */
 setSDKProcessingMetadata(newData: { [key: string]: unknown }): this;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged#14315

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 10 commits into

from

Nov 19, 2024
 Merged


feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged
#14315
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
64e6c7a

fix(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is m…


mydea Nov 15, 2024
fc21920

fix circular dependency


mydea Nov 15, 2024
99ee12f

expose proper util to set normalized request


mydea Nov 15, 2024
196460f

bump size limit :(


mydea Nov 15, 2024
c3f785e

fix body setting


mydea Nov 15, 2024
2b537af

rename to `setRequestEventData`


mydea Nov 15, 2024
15961cd

fix linting


mydea Nov 18, 2024
cd577f3

use generic merge instead


mydea Nov 18, 2024
2880f72

small fixes and tests


mydea Nov 19, 2024
003f261

fix test


mydea Nov 19, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'feedbackAsyncIntegration'),
 gzip: true,
 limit: '33 KB',
 limit: '34 KB',
 },
 // React SDK (ESM)
 {
Expand DownExpand Up@@ -160,7 +160,7 @@ module.exports = [
 name: 'CDN Bundle (incl. Tracing)',
 path: createCDNPath('bundle.tracing.min.js'),
 gzip: true,
 limit: '38 KB',
 limit: '39 KB',
 },
 {
 name: 'CDN Bundle (incl. Tracing, Replay)',
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import type {
import { dateTimestampInSeconds, generatePropagationContext, isPlainObject, logger, uuid4 } from '@sentry/utils';

import { updateSession } from './session';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';

/**
Expand DownExpand Up@@ -479,8 +480,7 @@ class ScopeClass implements ScopeInterface {
 * @inheritDoc
 */
 public setSDKProcessingMetadata(newData: { [key: string]: unknown }): this {
 this._sdkProcessingMetadata = { ...this._sdkProcessingMetadata, ...newData };

 this._sdkProcessingMetadata = merge(this._sdkProcessingMetadata, newData, 2);
 return this;
 }

Expand Down

14 changes: 4 additions & 10 deletions
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Breadcrumb, Event, ScopeData, Span } from '@sentry/types';
import { arrayify, dropUndefinedKeys } from '@sentry/utils';
import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
import { merge } from './merge';
import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';

/**
Expand DownExpand Up@@ -46,7 +47,8 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 mergeAndOverwriteScopeData(data, 'tags', tags);
 mergeAndOverwriteScopeData(data, 'user', user);
 mergeAndOverwriteScopeData(data, 'contexts', contexts);
 mergeAndOverwriteScopeData(data, 'sdkProcessingMetadata', sdkProcessingMetadata);

 data.sdkProcessingMetadata = merge(data.sdkProcessingMetadata, sdkProcessingMetadata, 2);

 if (level) {
 data.level = level;
Expand DownExpand Up@@ -87,15 +89,7 @@ export function mergeAndOverwriteScopeData<
 Prop extends 'extra' | 'tags' | 'user' | 'contexts' | 'sdkProcessingMetadata',
 Data extends ScopeData,
>(data: Data, prop: Prop, mergeVal: Data[Prop]): void {
 if (mergeVal && Object.keys(mergeVal).length) {
 // Clone object
 data[prop] = { ...data[prop] };
 for (const key in mergeVal) {
 if (Object.prototype.hasOwnProperty.call(mergeVal, key)) {
 data[prop][key] = mergeVal[key];
 }
 }
 }
 data[prop] = merge(data[prop], mergeVal, 1);
}

/** Exported only for tests */
Expand Down

31 changes: 31 additions & 0 deletions
packages/core/src/utils/merge.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
/**
 * Shallow merge two objects.
 * Does not mutate the passed in objects.
 * Undefined/empty values in the merge object will overwrite existing values.
 *
 * By default, this merges 2 levels deep.
 */
export function merge<T>(initialObj: T, mergeObj: T, levels = 2): T {
 // If the merge value is not an object, or we have no merge levels left,
 // we just set the value to the merge value
 if (!mergeObj || typeof mergeObj !== 'object' || levels <= 0) {
 return mergeObj;
 }

 // If the merge object is an empty object, and the initial object is not undefined, we return the initial object
 if (initialObj && mergeObj && Object.keys(mergeObj).length === 0) {
 return initialObj;
 }

 // Clone object
 const output = { ...initialObj };

 // Merge values into output, resursively
 for (const key in mergeObj) {
 if (Object.prototype.hasOwnProperty.call(mergeObj, key)) {
 output[key] = merge(output[key], mergeObj[key], levels - 1);
 }
 }

 return output;
}

25 changes: 21 additions & 4 deletions
packages/core/test/lib/scope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -204,10 +204,27 @@ describe('Scope', () => {
 expect(scope['_user']).toEqual({});
 });

 test('setProcessingMetadata', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 describe('setProcessingMetadata', () => {
 test('it works with no initial data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 });

 test('it overwrites data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 scope.setSDKProcessingMetadata({ dogs: 'are really great!' });
 scope.setSDKProcessingMetadata({ cats: 'are also great!' });
 scope.setSDKProcessingMetadata({ obj: { nested1: 'value1', nested: 'value1' } });
 scope.setSDKProcessingMetadata({ obj: { nested2: 'value2', nested: 'value2' } });

 expect(scope['_sdkProcessingMetadata']).toEqual({
 dogs: 'are really great!',
 cats: 'are also great!',
 obj: { nested2: 'value2', nested: 'value2', nested1: 'value1' },
 });
 });
 });

 test('set and get propagation context', () => {
Expand Down

32 changes: 29 additions & 3 deletions
packages/core/test/lib/utils/applyScopeDataToEvent.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os1' }, culture: { display_name: 'name1' } },
 attachments: [attachment1],
 propagationContext: { spanId: '1', traceId: '1' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'aa' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'aa',
 obj: { key: 'value' },
 normalizedRequest: {
 url: 'oldUrl',
 method: 'oldMethod',
 },
 },
 fingerprint: ['aa', 'bb'],
 };
 const data2: ScopeData = {
Expand All@@ -146,7 +154,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' } },
 attachments: [attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 bb: 'bb',
 cc: 'bb',
 obj: { key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 headers: {},
 },
 },
 fingerprint: ['cc'],
 };
 mergeScopeData(data1, data2);
Expand All@@ -159,7 +175,17 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' }, culture: { display_name: 'name1' } },
 attachments: [attachment1, attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'bb',
 cc: 'bb',
 obj: { key: 'value', key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 method: 'oldMethod',
 headers: {},
 },
 },
 fingerprint: ['aa', 'bb', 'cc'],
 });
 });
Expand Down

75 changes: 75 additions & 0 deletions
packages/core/test/lib/utils/merge.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { merge } from '../../../src/utils/merge';

describe('merge', () => {
 it('works with empty objects', () => {
 const oldData = {};
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({});
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with empty merge object', () => {
 const oldData = { aa: 'aha' };
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({ aa: 'aha' });
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with arbitrary data', () => {
 const oldData = {
 old1: 'old1',
 old2: 'old2',
 obj: { key: 'value1', key1: 'value1', deep: { key: 'value' } },
 } as any;
 const newData = {
 new1: 'new1',
 old2: 'new2',
 obj: { key2: 'value2', key: 'value2', deep: { key2: 'value2' } },
 } as any;

 const actual = merge(oldData, newData);

 expect(actual).toEqual({
 old1: 'old1',
 old2: 'new2',
 new1: 'new1',
 obj: {
 key2: 'value2',
 key: 'value2',
 key1: 'value1',
 deep: { key2: 'value2' },
 },
 });
 expect(actual).not.toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it.each([
 [undefined, { a: 'aa' }, { a: 'aa' }],
 [{ a: 'aa' }, undefined, undefined],
 [{ a: 'aa' }, null, null],
 [{ a: 'aa' }, { a: undefined }, { a: undefined }],
 [{ a: 'aa' }, { a: null }, { a: null }],
 [{ a: 'aa' }, { a: '' }, { a: '' }],
 [
 { a0: { a1: { a2: { a3: { a4: 'a4a' }, a3a: 'a3a' }, a2a: 'a2a' }, a1a: 'a1a' }, a0a: 'a0a' },
 { a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b' }, a0b: 'a0b' },
 {
 a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b', a1a: 'a1a' },
 a0b: 'a0b',
 a0a: 'a0a',
 },
 ],
 ])('works with %p and %p', (oldData, newData, expected) => {
 const actual = merge(oldData, newData as any);
 expect(actual).toEqual(expected);
 });
});

16 changes: 10 additions & 6 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData } from '@sentry/types';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData, Scope } from '@sentry/types';
import {
 getBreadcrumbLogLevelFromHttpStatusCode,
 getSanitizedUrlString,
Expand DownExpand Up@@ -150,10 +150,14 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 cookies,
 };

 patchRequestToCaptureBody(request, normalizedRequest);
 patchRequestToCaptureBody(request, isolationScope);

 // Update the isolation scope, isolate this request
 isolationScope.setSDKProcessingMetadata({ request, normalizedRequest });
 // TODO(v9): Stop setting `request`, we only rely on normalizedRequest anymore
 isolationScope.setSDKProcessingMetadata({
 request,
 normalizedRequest,
 });

 const client = getClient<NodeClient>();
 if (client && client.getOptions().autoSessionTracking) {
Expand DownExpand Up@@ -347,7 +351,7 @@ function getBreadcrumbData(request: http.ClientRequest): Partial<SanitizedReques
 * we monkey patch `req.on('data')` to intercept the body chunks.
 * This way, we only read the body if the user also consumes the body, ensuring we do not change any behavior in unexpected ways.
 */
function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: RequestEventData): void {
function patchRequestToCaptureBody(req: IncomingMessage, isolationScope: Scope): void {
 const chunks: Buffer[] = [];

 function getChunksSize(): number {
Expand DownExpand Up@@ -396,9 +400,9 @@ function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: Requ
 try {
 const body = Buffer.concat(chunks).toString('utf-8');

 // We mutate the passed in normalizedRequest and add the body to it
 if (body) {
 normalizedRequest.data = body;
 const normalizedRequest = { data: body } satisfies RequestEventData;
 isolationScope.setSDKProcessingMetadata({ normalizedRequest });
 }
 } catch {
 // ignore errors here
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,7 +217,9 @@ export interface Scope {
 clearAttachments(): this;

 /**
 * Add data which will be accessible during event processing but won't get sent to Sentry
 * Add data which will be accessible during event processing but won't get sent to Sentry.
 *
 * TODO(v9): We should type this stricter, so that e.g. `normalizedRequest` is strictly typed.
 */
 setSDKProcessingMetadata(newData: { [key: string]: unknown }): this;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged#14315

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 10 commits into

from

Nov 19, 2024
 Merged


feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged
#14315
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
64e6c7a

fix(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is m…


mydea Nov 15, 2024
fc21920

fix circular dependency


mydea Nov 15, 2024
99ee12f

expose proper util to set normalized request


mydea Nov 15, 2024
196460f

bump size limit :(


mydea Nov 15, 2024
c3f785e

fix body setting


mydea Nov 15, 2024
2b537af

rename to `setRequestEventData`


mydea Nov 15, 2024
15961cd

fix linting


mydea Nov 18, 2024
cd577f3

use generic merge instead


mydea Nov 18, 2024
2880f72

small fixes and tests


mydea Nov 19, 2024
003f261

fix test


mydea Nov 19, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'feedbackAsyncIntegration'),
 gzip: true,
 limit: '33 KB',
 limit: '34 KB',
 },
 // React SDK (ESM)
 {
Expand DownExpand Up@@ -160,7 +160,7 @@ module.exports = [
 name: 'CDN Bundle (incl. Tracing)',
 path: createCDNPath('bundle.tracing.min.js'),
 gzip: true,
 limit: '38 KB',
 limit: '39 KB',
 },
 {
 name: 'CDN Bundle (incl. Tracing, Replay)',
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import type {
import { dateTimestampInSeconds, generatePropagationContext, isPlainObject, logger, uuid4 } from '@sentry/utils';

import { updateSession } from './session';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';

/**
Expand DownExpand Up@@ -479,8 +480,7 @@ class ScopeClass implements ScopeInterface {
 * @inheritDoc
 */
 public setSDKProcessingMetadata(newData: { [key: string]: unknown }): this {
 this._sdkProcessingMetadata = { ...this._sdkProcessingMetadata, ...newData };

 this._sdkProcessingMetadata = merge(this._sdkProcessingMetadata, newData, 2);
 return this;
 }

Expand Down

14 changes: 4 additions & 10 deletions
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Breadcrumb, Event, ScopeData, Span } from '@sentry/types';
import { arrayify, dropUndefinedKeys } from '@sentry/utils';
import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
import { merge } from './merge';
import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';

/**
Expand DownExpand Up@@ -46,7 +47,8 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 mergeAndOverwriteScopeData(data, 'tags', tags);
 mergeAndOverwriteScopeData(data, 'user', user);
 mergeAndOverwriteScopeData(data, 'contexts', contexts);
 mergeAndOverwriteScopeData(data, 'sdkProcessingMetadata', sdkProcessingMetadata);

 data.sdkProcessingMetadata = merge(data.sdkProcessingMetadata, sdkProcessingMetadata, 2);

 if (level) {
 data.level = level;
Expand DownExpand Up@@ -87,15 +89,7 @@ export function mergeAndOverwriteScopeData<
 Prop extends 'extra' | 'tags' | 'user' | 'contexts' | 'sdkProcessingMetadata',
 Data extends ScopeData,
>(data: Data, prop: Prop, mergeVal: Data[Prop]): void {
 if (mergeVal && Object.keys(mergeVal).length) {
 // Clone object
 data[prop] = { ...data[prop] };
 for (const key in mergeVal) {
 if (Object.prototype.hasOwnProperty.call(mergeVal, key)) {
 data[prop][key] = mergeVal[key];
 }
 }
 }
 data[prop] = merge(data[prop], mergeVal, 1);
}

/** Exported only for tests */
Expand Down

31 changes: 31 additions & 0 deletions
packages/core/src/utils/merge.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
/**
 * Shallow merge two objects.
 * Does not mutate the passed in objects.
 * Undefined/empty values in the merge object will overwrite existing values.
 *
 * By default, this merges 2 levels deep.
 */
export function merge<T>(initialObj: T, mergeObj: T, levels = 2): T {
 // If the merge value is not an object, or we have no merge levels left,
 // we just set the value to the merge value
 if (!mergeObj || typeof mergeObj !== 'object' || levels <= 0) {
 return mergeObj;
 }

 // If the merge object is an empty object, and the initial object is not undefined, we return the initial object
 if (initialObj && mergeObj && Object.keys(mergeObj).length === 0) {
 return initialObj;
 }

 // Clone object
 const output = { ...initialObj };

 // Merge values into output, resursively
 for (const key in mergeObj) {
 if (Object.prototype.hasOwnProperty.call(mergeObj, key)) {
 output[key] = merge(output[key], mergeObj[key], levels - 1);
 }
 }

 return output;
}

25 changes: 21 additions & 4 deletions
packages/core/test/lib/scope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -204,10 +204,27 @@ describe('Scope', () => {
 expect(scope['_user']).toEqual({});
 });

 test('setProcessingMetadata', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 describe('setProcessingMetadata', () => {
 test('it works with no initial data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 });

 test('it overwrites data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 scope.setSDKProcessingMetadata({ dogs: 'are really great!' });
 scope.setSDKProcessingMetadata({ cats: 'are also great!' });
 scope.setSDKProcessingMetadata({ obj: { nested1: 'value1', nested: 'value1' } });
 scope.setSDKProcessingMetadata({ obj: { nested2: 'value2', nested: 'value2' } });

 expect(scope['_sdkProcessingMetadata']).toEqual({
 dogs: 'are really great!',
 cats: 'are also great!',
 obj: { nested2: 'value2', nested: 'value2', nested1: 'value1' },
 });
 });
 });

 test('set and get propagation context', () => {
Expand Down

32 changes: 29 additions & 3 deletions
packages/core/test/lib/utils/applyScopeDataToEvent.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os1' }, culture: { display_name: 'name1' } },
 attachments: [attachment1],
 propagationContext: { spanId: '1', traceId: '1' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'aa' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'aa',
 obj: { key: 'value' },
 normalizedRequest: {
 url: 'oldUrl',
 method: 'oldMethod',
 },
 },
 fingerprint: ['aa', 'bb'],
 };
 const data2: ScopeData = {
Expand All@@ -146,7 +154,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' } },
 attachments: [attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 bb: 'bb',
 cc: 'bb',
 obj: { key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 headers: {},
 },
 },
 fingerprint: ['cc'],
 };
 mergeScopeData(data1, data2);
Expand All@@ -159,7 +175,17 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' }, culture: { display_name: 'name1' } },
 attachments: [attachment1, attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'bb',
 cc: 'bb',
 obj: { key: 'value', key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 method: 'oldMethod',
 headers: {},
 },
 },
 fingerprint: ['aa', 'bb', 'cc'],
 });
 });
Expand Down

75 changes: 75 additions & 0 deletions
packages/core/test/lib/utils/merge.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { merge } from '../../../src/utils/merge';

describe('merge', () => {
 it('works with empty objects', () => {
 const oldData = {};
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({});
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with empty merge object', () => {
 const oldData = { aa: 'aha' };
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({ aa: 'aha' });
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with arbitrary data', () => {
 const oldData = {
 old1: 'old1',
 old2: 'old2',
 obj: { key: 'value1', key1: 'value1', deep: { key: 'value' } },
 } as any;
 const newData = {
 new1: 'new1',
 old2: 'new2',
 obj: { key2: 'value2', key: 'value2', deep: { key2: 'value2' } },
 } as any;

 const actual = merge(oldData, newData);

 expect(actual).toEqual({
 old1: 'old1',
 old2: 'new2',
 new1: 'new1',
 obj: {
 key2: 'value2',
 key: 'value2',
 key1: 'value1',
 deep: { key2: 'value2' },
 },
 });
 expect(actual).not.toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it.each([
 [undefined, { a: 'aa' }, { a: 'aa' }],
 [{ a: 'aa' }, undefined, undefined],
 [{ a: 'aa' }, null, null],
 [{ a: 'aa' }, { a: undefined }, { a: undefined }],
 [{ a: 'aa' }, { a: null }, { a: null }],
 [{ a: 'aa' }, { a: '' }, { a: '' }],
 [
 { a0: { a1: { a2: { a3: { a4: 'a4a' }, a3a: 'a3a' }, a2a: 'a2a' }, a1a: 'a1a' }, a0a: 'a0a' },
 { a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b' }, a0b: 'a0b' },
 {
 a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b', a1a: 'a1a' },
 a0b: 'a0b',
 a0a: 'a0a',
 },
 ],
 ])('works with %p and %p', (oldData, newData, expected) => {
 const actual = merge(oldData, newData as any);
 expect(actual).toEqual(expected);
 });
});

16 changes: 10 additions & 6 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData } from '@sentry/types';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData, Scope } from '@sentry/types';
import {
 getBreadcrumbLogLevelFromHttpStatusCode,
 getSanitizedUrlString,
Expand DownExpand Up@@ -150,10 +150,14 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 cookies,
 };

 patchRequestToCaptureBody(request, normalizedRequest);
 patchRequestToCaptureBody(request, isolationScope);

 // Update the isolation scope, isolate this request
 isolationScope.setSDKProcessingMetadata({ request, normalizedRequest });
 // TODO(v9): Stop setting `request`, we only rely on normalizedRequest anymore
 isolationScope.setSDKProcessingMetadata({
 request,
 normalizedRequest,
 });

 const client = getClient<NodeClient>();
 if (client && client.getOptions().autoSessionTracking) {
Expand DownExpand Up@@ -347,7 +351,7 @@ function getBreadcrumbData(request: http.ClientRequest): Partial<SanitizedReques
 * we monkey patch `req.on('data')` to intercept the body chunks.
 * This way, we only read the body if the user also consumes the body, ensuring we do not change any behavior in unexpected ways.
 */
function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: RequestEventData): void {
function patchRequestToCaptureBody(req: IncomingMessage, isolationScope: Scope): void {
 const chunks: Buffer[] = [];

 function getChunksSize(): number {
Expand DownExpand Up@@ -396,9 +400,9 @@ function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: Requ
 try {
 const body = Buffer.concat(chunks).toString('utf-8');

 // We mutate the passed in normalizedRequest and add the body to it
 if (body) {
 normalizedRequest.data = body;
 const normalizedRequest = { data: body } satisfies RequestEventData;
 isolationScope.setSDKProcessingMetadata({ normalizedRequest });
 }
 } catch {
 // ignore errors here
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,7 +217,9 @@ export interface Scope {
 clearAttachments(): this;

 /**
 * Add data which will be accessible during event processing but won't get sent to Sentry
 * Add data which will be accessible during event processing but won't get sent to Sentry.
 *
 * TODO(v9): We should type this stricter, so that e.g. `normalizedRequest` is strictly typed.
 */
 setSDKProcessingMetadata(newData: { [key: string]: unknown }): this;

Expand Down

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

Skip to content
feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged#14315

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 10 commits into

from

Nov 19, 2024
 Merged


feat(core): Ensure normalizedRequest on sdkProcessingMetadata is merged
#14315
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
64e6c7a

fix(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is m…


mydea Nov 15, 2024
fc21920

fix circular dependency


mydea Nov 15, 2024
99ee12f

expose proper util to set normalized request


mydea Nov 15, 2024
196460f

bump size limit :(


mydea Nov 15, 2024
c3f785e

fix body setting


mydea Nov 15, 2024
2b537af

rename to `setRequestEventData`


mydea Nov 15, 2024
15961cd

fix linting


mydea Nov 18, 2024
cd577f3

use generic merge instead


mydea Nov 18, 2024
2880f72

small fixes and tests


mydea Nov 19, 2024
003f261

fix test


mydea Nov 19, 2024

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


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,7 @@ module.exports = [
 path: 'packages/browser/build/npm/esm/index.js',
 import: createImport('init', 'feedbackAsyncIntegration'),
 gzip: true,
 limit: '33 KB',
 limit: '34 KB',
 },
 // React SDK (ESM)
 {
Expand DownExpand Up@@ -160,7 +160,7 @@ module.exports = [
 name: 'CDN Bundle (incl. Tracing)',
 path: createCDNPath('bundle.tracing.min.js'),
 gzip: true,
 limit: '38 KB',
 limit: '39 KB',
 },
 {
 name: 'CDN Bundle (incl. Tracing, Replay)',
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ import type {
import { dateTimestampInSeconds, generatePropagationContext, isPlainObject, logger, uuid4 } from '@sentry/utils';

import { updateSession } from './session';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';

/**
Expand DownExpand Up@@ -479,8 +480,7 @@ class ScopeClass implements ScopeInterface {
 * @inheritDoc
 */
 public setSDKProcessingMetadata(newData: { [key: string]: unknown }): this {
 this._sdkProcessingMetadata = { ...this._sdkProcessingMetadata, ...newData };

 this._sdkProcessingMetadata = merge(this._sdkProcessingMetadata, newData, 2);
 return this;
 }

Expand Down

14 changes: 4 additions & 10 deletions
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { Breadcrumb, Event, ScopeData, Span } from '@sentry/types';
import { arrayify, dropUndefinedKeys } from '@sentry/utils';
import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
import { merge } from './merge';
import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';

/**
Expand DownExpand Up@@ -46,7 +47,8 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 mergeAndOverwriteScopeData(data, 'tags', tags);
 mergeAndOverwriteScopeData(data, 'user', user);
 mergeAndOverwriteScopeData(data, 'contexts', contexts);
 mergeAndOverwriteScopeData(data, 'sdkProcessingMetadata', sdkProcessingMetadata);

 data.sdkProcessingMetadata = merge(data.sdkProcessingMetadata, sdkProcessingMetadata, 2);

 if (level) {
 data.level = level;
Expand DownExpand Up@@ -87,15 +89,7 @@ export function mergeAndOverwriteScopeData<
 Prop extends 'extra' | 'tags' | 'user' | 'contexts' | 'sdkProcessingMetadata',
 Data extends ScopeData,
>(data: Data, prop: Prop, mergeVal: Data[Prop]): void {
 if (mergeVal && Object.keys(mergeVal).length) {
 // Clone object
 data[prop] = { ...data[prop] };
 for (const key in mergeVal) {
 if (Object.prototype.hasOwnProperty.call(mergeVal, key)) {
 data[prop][key] = mergeVal[key];
 }
 }
 }
 data[prop] = merge(data[prop], mergeVal, 1);
}

/** Exported only for tests */
Expand Down

31 changes: 31 additions & 0 deletions
packages/core/src/utils/merge.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
/**
 * Shallow merge two objects.
 * Does not mutate the passed in objects.
 * Undefined/empty values in the merge object will overwrite existing values.
 *
 * By default, this merges 2 levels deep.
 */
export function merge<T>(initialObj: T, mergeObj: T, levels = 2): T {
 // If the merge value is not an object, or we have no merge levels left,
 // we just set the value to the merge value
 if (!mergeObj || typeof mergeObj !== 'object' || levels <= 0) {
 return mergeObj;
 }

 // If the merge object is an empty object, and the initial object is not undefined, we return the initial object
 if (initialObj && mergeObj && Object.keys(mergeObj).length === 0) {
 return initialObj;
 }

 // Clone object
 const output = { ...initialObj };

 // Merge values into output, resursively
 for (const key in mergeObj) {
 if (Object.prototype.hasOwnProperty.call(mergeObj, key)) {
 output[key] = merge(output[key], mergeObj[key], levels - 1);
 }
 }

 return output;
}

25 changes: 21 additions & 4 deletions
packages/core/test/lib/scope.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -204,10 +204,27 @@ describe('Scope', () => {
 expect(scope['_user']).toEqual({});
 });

 test('setProcessingMetadata', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 describe('setProcessingMetadata', () => {
 test('it works with no initial data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
 });

 test('it overwrites data', () => {
 const scope = new Scope();
 scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 scope.setSDKProcessingMetadata({ dogs: 'are really great!' });
 scope.setSDKProcessingMetadata({ cats: 'are also great!' });
 scope.setSDKProcessingMetadata({ obj: { nested1: 'value1', nested: 'value1' } });
 scope.setSDKProcessingMetadata({ obj: { nested2: 'value2', nested: 'value2' } });

 expect(scope['_sdkProcessingMetadata']).toEqual({
 dogs: 'are really great!',
 cats: 'are also great!',
 obj: { nested2: 'value2', nested: 'value2', nested1: 'value1' },
 });
 });
 });

 test('set and get propagation context', () => {
Expand Down

32 changes: 29 additions & 3 deletions
packages/core/test/lib/utils/applyScopeDataToEvent.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os1' }, culture: { display_name: 'name1' } },
 attachments: [attachment1],
 propagationContext: { spanId: '1', traceId: '1' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'aa' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'aa',
 obj: { key: 'value' },
 normalizedRequest: {
 url: 'oldUrl',
 method: 'oldMethod',
 },
 },
 fingerprint: ['aa', 'bb'],
 };
 const data2: ScopeData = {
Expand All@@ -146,7 +154,15 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' } },
 attachments: [attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 bb: 'bb',
 cc: 'bb',
 obj: { key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 headers: {},
 },
 },
 fingerprint: ['cc'],
 };
 mergeScopeData(data1, data2);
Expand All@@ -159,7 +175,17 @@ describe('mergeScopeData', () => {
 contexts: { os: { name: 'os2' }, culture: { display_name: 'name1' } },
 attachments: [attachment1, attachment2, attachment3],
 propagationContext: { spanId: '2', traceId: '2' },
 sdkProcessingMetadata: { aa: 'aa', bb: 'bb', cc: 'bb' },
 sdkProcessingMetadata: {
 aa: 'aa',
 bb: 'bb',
 cc: 'bb',
 obj: { key: 'value', key2: 'value2' },
 normalizedRequest: {
 url: 'newUrl',
 method: 'oldMethod',
 headers: {},
 },
 },
 fingerprint: ['aa', 'bb', 'cc'],
 });
 });
Expand Down

75 changes: 75 additions & 0 deletions
packages/core/test/lib/utils/merge.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { merge } from '../../../src/utils/merge';

describe('merge', () => {
 it('works with empty objects', () => {
 const oldData = {};
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({});
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with empty merge object', () => {
 const oldData = { aa: 'aha' };
 const newData = {};

 const actual = merge(oldData, newData);

 expect(actual).toEqual({ aa: 'aha' });
 expect(actual).toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it('works with arbitrary data', () => {
 const oldData = {
 old1: 'old1',
 old2: 'old2',
 obj: { key: 'value1', key1: 'value1', deep: { key: 'value' } },
 } as any;
 const newData = {
 new1: 'new1',
 old2: 'new2',
 obj: { key2: 'value2', key: 'value2', deep: { key2: 'value2' } },
 } as any;

 const actual = merge(oldData, newData);

 expect(actual).toEqual({
 old1: 'old1',
 old2: 'new2',
 new1: 'new1',
 obj: {
 key2: 'value2',
 key: 'value2',
 key1: 'value1',
 deep: { key2: 'value2' },
 },
 });
 expect(actual).not.toBe(oldData);
 expect(actual).not.toBe(newData);
 });

 it.each([
 [undefined, { a: 'aa' }, { a: 'aa' }],
 [{ a: 'aa' }, undefined, undefined],
 [{ a: 'aa' }, null, null],
 [{ a: 'aa' }, { a: undefined }, { a: undefined }],
 [{ a: 'aa' }, { a: null }, { a: null }],
 [{ a: 'aa' }, { a: '' }, { a: '' }],
 [
 { a0: { a1: { a2: { a3: { a4: 'a4a' }, a3a: 'a3a' }, a2a: 'a2a' }, a1a: 'a1a' }, a0a: 'a0a' },
 { a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b' }, a0b: 'a0b' },
 {
 a0: { a1: { a2: { a3: { a4: 'a4b' }, a3b: 'a3b' }, a2b: 'a2b' }, a1b: 'a1b', a1a: 'a1a' },
 a0b: 'a0b',
 a0a: 'a0a',
 },
 ],
 ])('works with %p and %p', (oldData, newData, expected) => {
 const actual = merge(oldData, newData as any);
 expect(actual).toEqual(expected);
 });
});

16 changes: 10 additions & 6 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData } from '@sentry/types';
import type { PolymorphicRequest, RequestEventData, SanitizedRequestData, Scope } from '@sentry/types';
import {
 getBreadcrumbLogLevelFromHttpStatusCode,
 getSanitizedUrlString,
Expand DownExpand Up@@ -150,10 +150,14 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 cookies,
 };

 patchRequestToCaptureBody(request, normalizedRequest);
 patchRequestToCaptureBody(request, isolationScope);

 // Update the isolation scope, isolate this request
 isolationScope.setSDKProcessingMetadata({ request, normalizedRequest });
 // TODO(v9): Stop setting `request`, we only rely on normalizedRequest anymore
 isolationScope.setSDKProcessingMetadata({
 request,
 normalizedRequest,
 });

 const client = getClient<NodeClient>();
 if (client && client.getOptions().autoSessionTracking) {
Expand DownExpand Up@@ -347,7 +351,7 @@ function getBreadcrumbData(request: http.ClientRequest): Partial<SanitizedReques
 * we monkey patch `req.on('data')` to intercept the body chunks.
 * This way, we only read the body if the user also consumes the body, ensuring we do not change any behavior in unexpected ways.
 */
function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: RequestEventData): void {
function patchRequestToCaptureBody(req: IncomingMessage, isolationScope: Scope): void {
 const chunks: Buffer[] = [];

 function getChunksSize(): number {
Expand DownExpand Up@@ -396,9 +400,9 @@ function patchRequestToCaptureBody(req: IncomingMessage, normalizedRequest: Requ
 try {
 const body = Buffer.concat(chunks).toString('utf-8');

 // We mutate the passed in normalizedRequest and add the body to it
 if (body) {
 normalizedRequest.data = body;
 const normalizedRequest = { data: body } satisfies RequestEventData;
 isolationScope.setSDKProcessingMetadata({ normalizedRequest });
 }
 } catch {
 // ignore errors here
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,7 +217,9 @@ export interface Scope {
 clearAttachments(): this;

 /**
 * Add data which will be accessible during event processing but won't get sent to Sentry
 * Add data which will be accessible during event processing but won't get sent to Sentry.
 *
 * TODO(v9): We should type this stricter, so that e.g. `normalizedRequest` is strictly typed.
 */
 setSDKProcessingMetadata(newData: { [key: string]: unknown }): this;

Expand Down