feat(browser): Set user.ip_address explicitly to {{auto}}#15008

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 6 commits into from
Jan 20, 2025
Merged

feat(browser): Set user.ip_address explicitly to {{auto}}#15008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fbe91bb
feat(browser): Set `user.ip_address` explicitly to `{{auto}}`
mydea Jan 14, 2025
d704c9e
fix & tests
mydea Jan 15, 2025
225a71d
also do for replay
mydea Jan 15, 2025
1d35352
fix tests
mydea Jan 15, 2025
a0bbfff
fix it better??
mydea Jan 15, 2025
a8293ad
fix tests
mydea Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ sentryTest('should capture feedback with custom button', async ({ getLocalTestUr
event_id: expect.stringMatching(/\w{32}/),
environment: 'production',
tags: {},
user: {
ip_address: '{{auto}}',
},
sdk: {
integrations: expect.arrayContaining(['Feedback']),
version: expect.any(String),
Expand Down
3 changes: 3 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
'User-Agent': expect.stringContaining(''),
},
},
user: {
ip_address: '{{auto}}',
},
platform: 'javascript',
});
});
3 changes: 3 additions & 0 deletions ...es/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/hasSampling/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest('should capture feedback', async ({ forceFlushReplay, getLocalTestUrl
'User-Agent': expect.stringContaining(''),
},
},
user: {
ip_address: '{{auto}}',
},
platform: 'javascript',
});
});
3 changes: 3 additions & 0 deletions dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
'User-Agent': expect.stringContaining(''),
},
},
user: {
ip_address: '{{auto}}',
},
platform: 'javascript',
});
const cspViolation = await page.evaluate<boolean>('window.__CSPVIOLATION__');
Expand Down
3 changes: 3 additions & 0 deletions dev-packages/browser-integration-tests/suites/manual-client/browser-context/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,9 @@ sentryTest('allows to setup a client manually & capture exceptions', async ({ ge
'User-Agent': expect.any(String),
}),
},
user: {
ip_address: '{{auto}}',
},
timestamp: expect.any(Number),
environment: 'local',
release: '0.0.1',
Expand Down
6 changes: 6 additions & 0 deletions dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
Sentry.setUser({
id: 'foo',
ip_address: null,
});

Sentry.captureMessage('first_user');
17 changes: 17 additions & 0 deletions dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should allow to set ip_address to null', async ({ getLocalTestUrl, page }) => {
const url = await getLocalTestUrl({ testDir: __dirname });

const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

expect(eventData.message).toBe('first_user');
expect(eventData.user).toEqual({
id: 'foo',
ip_address: null,
});
});
8 changes: 5 additions & 3 deletions dev-packages/browser-integration-tests/suites/public-api/setUser/unset_user/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,17 @@ sentryTest('should unset user', async ({ getLocalTestUrl, page }) => {
const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 3, { url });

expect(eventData[0].message).toBe('no_user');
expect(eventData[0].user).toBeUndefined();
expect(eventData[0].user).toEqual({ ip_address: '{{auto}}' });

expect(eventData[1].message).toBe('user');
expect(eventData[1].user).toMatchObject({
expect(eventData[1].user).toEqual({
id: 'foo',
ip_address: 'bar',
other_key: 'baz',
});

expect(eventData[2].message).toBe('unset_user');
expect(eventData[2].user).toBeUndefined();
expect(eventData[2].user).toEqual({
ip_address: '{{auto}}',
});
});
5 changes: 3 additions & 2 deletions dev-packages/browser-integration-tests/suites/public-api/setUser/update_user/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@ sentryTest('should update user', async ({ getLocalTestUrl, page }) => {
const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 2, { url });

expect(eventData[0].message).toBe('first_user');
expect(eventData[0].user).toMatchObject({
expect(eventData[0].user).toEqual({
id: 'foo',
ip_address: 'bar',
});

expect(eventData[1].message).toBe('second_user');
expect(eventData[1].user).toMatchObject({
expect(eventData[1].user).toEqual({
id: 'baz',
ip_address: '{{auto}}',
});
});
3 changes: 3 additions & 0 deletions ...rowser-integration-tests/suites/public-api/startSpan/standalone-mixed-transaction/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest(
headers: expect.any(Object),
url: expect.any(String),
},
user: {
ip_address: '{{auto}}',
},
sdk: expect.any(Object),
spans: [
{
Expand Down
10 changes: 5 additions & 5 deletions dev-packages/browser-integration-tests/suites/public-api/withScope/nested_scopes/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ sentryTest('should allow nested scoping', async ({ getLocalTestUrl, page }) => {
const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 5, { url });

expect(eventData[0].message).toBe('root_before');
expect(eventData[0].user).toMatchObject({ id: 'qux' });
expect(eventData[0].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
expect(eventData[0].tags).toBeUndefined();

expect(eventData[1].message).toBe('outer_before');
expect(eventData[1].user).toMatchObject({ id: 'qux' });
expect(eventData[1].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
expect(eventData[1].tags).toMatchObject({ foo: false });

expect(eventData[2].message).toBe('inner');
expect(eventData[2].user).toBeUndefined();
expect(eventData[2].user).toEqual({ ip_address: '{{auto}}' });
expect(eventData[2].tags).toMatchObject({ foo: false, bar: 10 });

expect(eventData[3].message).toBe('outer_after');
expect(eventData[3].user).toMatchObject({ id: 'baz' });
expect(eventData[3].user).toEqual({ id: 'baz', ip_address: '{{auto}}' });
expect(eventData[3].tags).toMatchObject({ foo: false });

expect(eventData[4].message).toBe('root_after');
expect(eventData[4].user).toMatchObject({ id: 'qux' });
expect(eventData[4].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
expect(eventData[4].tags).toBeUndefined();
});
6 changes: 6 additions & 0 deletions dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
'User-Agent': expect.stringContaining(''),
},
},
user: {
ip_address: '{{auto}}',
},
platform: 'javascript',
});

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
'User-Agent': expect.stringContaining(''),
},
},
user: {
ip_address: '{{auto}}',
},
platform: 'javascript',
});
});
6 changes: 6 additions & 0 deletions dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
'User-Agent': expect.stringContaining(''),
},
},
user: {
ip_address: '{{auto}}',
},
platform: 'javascript',
});

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
'User-Agent': expect.stringContaining(''),
},
},
user: {
ip_address: '{{auto}}',
},
platform: 'javascript',
});
});
4 changes: 4 additions & 0 deletions .../browser-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('captures a "GOOD" CLS vital with its source as a standalone span', a
transaction: expect.stringContaining('index.html'),
'user_agent.original': expect.stringContaining('Chrome'),
'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
'client.address': '{{auto}}',
},
description: expect.stringContaining('body > div#content > p'),
exclusive_time: 0,
Expand DownExpand Up@@ -137,6 +138,7 @@ sentryTest('captures a "MEH" CLS vital with its source as a standalone span', as
transaction: expect.stringContaining('index.html'),
'user_agent.original': expect.stringContaining('Chrome'),
'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
'client.address': '{{auto}}',
},
description: expect.stringContaining('body > div#content > p'),
exclusive_time: 0,
Expand DownExpand Up@@ -203,6 +205,7 @@ sentryTest('captures a "POOR" CLS vital with its source as a standalone span.',
transaction: expect.stringContaining('index.html'),
'user_agent.original': expect.stringContaining('Chrome'),
'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
'client.address': '{{auto}}',
},
description: expect.stringContaining('body > div#content > p'),
exclusive_time: 0,
Expand DownExpand Up@@ -270,6 +273,7 @@ sentryTest(
transaction: expect.stringContaining('index.html'),
'user_agent.original': expect.stringContaining('Chrome'),
'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
'client.address': '{{auto}}',
},
description: 'Layout shift',
exclusive_time: 0,
Expand Down
1 change: 1 addition & 0 deletions dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-late/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ sentryTest('should capture an INP click event span after pageload', async ({ bro
'sentry.source': 'custom',
transaction: 'test-url',
'user_agent.original': expect.stringContaining('Chrome'),
'client.address': '{{auto}}',
},
measurements: {
inp: {
Expand Down
1 change: 1 addition & 0 deletions ...browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized-late/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ sentryTest(
'sentry.source': 'custom',
transaction: 'test-route',
'user_agent.original': expect.stringContaining('Chrome'),
'client.address': '{{auto}}',
},
measurements: {
inp: {
Expand Down
1 change: 1 addition & 0 deletions ...ages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ sentryTest(
'sentry.origin': 'auto.http.browser.inp',
transaction: 'test-route',
'user_agent.original': expect.stringContaining('Chrome'),
'client.address': '{{auto}}',
},
measurements: {
inp: {
Expand Down
1 change: 1 addition & 0 deletions dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('should capture an INP click event span during pageload', async ({ br
'sentry.origin': 'auto.http.browser.inp',
transaction: 'test-url',
'user_agent.original': expect.stringContaining('Chrome'),
'client.address': '{{auto}}',
},
measurements: {
inp: {
Expand Down
3 changes: 3 additions & 0 deletions dev-packages/browser-integration-tests/utils/replayEventTemplates.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,9 @@ const DEFAULT_REPLAY_EVENT = {
'User-Agent': expect.any(String),
},
},
user: {
ip_address: '{{auto}}',
},
platform: 'javascript',
};

Expand Down
1 change: 1 addition & 0 deletions dev-packages/e2e-tests/test-applications/react-17/tests/transactions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
'sentry.exclusive_time': expect.any(Number),
replay_id: expect.any(String),
'user_agent.original': expect.stringContaining('Chrome'),
'client.address': '{{auto}}',
},
description: 'body > div#root > input#exception-button[type="button"]',
op: 'ui.interaction.click',
Expand Down
1 change: 1 addition & 0 deletions dev-packages/e2e-tests/test-applications/react-router-6/tests/transactions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
'sentry.exclusive_time': expect.any(Number),
replay_id: expect.any(String),
'user_agent.original': expect.stringContaining('Chrome'),
'client.address': '{{auto}}',
},
description: 'body > div#root > input#exception-button[type="button"]',
op: 'ui.interaction.click',
Expand Down
1 change: 1 addition & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-spa/tests/transactions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
'sentry.exclusive_time': expect.any(Number),
replay_id: expect.any(String),
'user_agent.original': expect.stringContaining('Chrome'),
'client.address': '{{auto}}',
},
description: 'body > div#root > input#exception-button[type="button"]',
op: 'ui.interaction.click',
Expand Down
3 changes: 3 additions & 0 deletions packages/browser-utils/src/metrics/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,6 +108,9 @@ export function startStandaloneWebVitalSpan(options: StandaloneWebVitalSpanOptio
// For example: Chrome vs. Chrome Mobile
'user_agent.original': WINDOW.navigator?.userAgent,

// This tells Sentry to infer the IP address from the request
'client.address': '{{auto}}',

...passedAttributes,
};

Expand Down
31 changes: 31 additions & 0 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type {
ParameterizedString,
Scope,
SeverityLevel,
User,
} from '@sentry/core';
import { Client, applySdkMetadata, getSDKSource } from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
Expand DownExpand Up@@ -82,6 +83,23 @@ export class BrowserClient extends Client<BrowserClientOptions> {
}
});
}

this.on('postprocessEvent', event => {
addAutoIpAddressToUser(event);
});

this.on('beforeSendSession', session => {
if ('aggregates' in session) {
if (session.attrs?.['ip_address'] === undefined) {
session.attrs = {
...session.attrs,
ip_address: '{{auto}}',
};
}
} else {
addAutoIpAddressToUser(session);
}
});
}

/**
Expand DownExpand Up@@ -112,6 +130,19 @@ export class BrowserClient extends Client<BrowserClientOptions> {
isolationScope: Scope,
): PromiseLike<Event | null> {
event.platform = event.platform || 'javascript';

return super._prepareEvent(event, hint, currentScope, isolationScope);
}
}

// By default, we want to infer the IP address, unless this is explicitly set to `null`
// We do this after all other processing is done
// If `ip_address` is explicitly set to `null` or a value, we leave it as is
function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null }): void {
if (objWithMaybeUser.user?.ip_address === undefined) {
objWithMaybeUser.user = {
...objWithMaybeUser.user,
ip_address: '{{auto}}',
};
}
}
Loading
, '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(browser): Set user.ip_address explicitly to {{auto}}#15008

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

from

Jan 20, 2025
 Merged


feat(browser): Set user.ip_address explicitly to {{auto}}#15008
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fbe91bb

feat(browser): Set `user.ip_address` explicitly to `{{auto}}`


mydea Jan 14, 2025
d704c9e

fix & tests


mydea Jan 15, 2025
225a71d

also do for replay


mydea Jan 15, 2025
1d35352

fix tests


mydea Jan 15, 2025
a0bbfff

fix it better??


mydea Jan 15, 2025
a8293ad

fix tests


mydea Jan 17, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ sentryTest('should capture feedback with custom button', async ({ getLocalTestUr
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 user: {
 ip_address: '{{auto}}',
 },
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
...es/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/hasSampling/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest('should capture feedback', async ({ forceFlushReplay, getLocalTestUrl
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
 const cspViolation = await page.evaluate<boolean>('window.__CSPVIOLATION__');
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/manual-client/browser-context/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,9 @@ sentryTest('allows to setup a client manually & capture exceptions', async ({ ge
 'User-Agent': expect.any(String),
 }),
 },
 user: {
 ip_address: '{{auto}}',
 },
 timestamp: expect.any(Number),
 environment: 'local',
 release: '0.0.1',
Expand Down

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
Sentry.setUser({
 id: 'foo',
 ip_address: null,
});

Sentry.captureMessage('first_user');

17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should allow to set ip_address to null', async ({ getLocalTestUrl, page }) => {
 const url = await getLocalTestUrl({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.message).toBe('first_user');
 expect(eventData.user).toEqual({
 id: 'foo',
 ip_address: null,
 });
});

8 changes: 5 additions & 3 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/unset_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,17 @@ sentryTest('should unset user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 3, { url });

 expect(eventData[0].message).toBe('no_user');
 expect(eventData[0].user).toBeUndefined();
 expect(eventData[0].user).toEqual({ ip_address: '{{auto}}' });

 expect(eventData[1].message).toBe('user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 other_key: 'baz',
 });

 expect(eventData[2].message).toBe('unset_user');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({
 ip_address: '{{auto}}',
 });
});

5 changes: 3 additions & 2 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/update_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@ sentryTest('should update user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 2, { url });

 expect(eventData[0].message).toBe('first_user');
 expect(eventData[0].user).toMatchObject({
 expect(eventData[0].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 });

 expect(eventData[1].message).toBe('second_user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'baz',
 ip_address: '{{auto}}',
 });
});

3 changes: 3 additions & 0 deletions
...rowser-integration-tests/suites/public-api/startSpan/standalone-mixed-transaction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest(
 headers: expect.any(Object),
 url: expect.any(String),
 },
 user: {
 ip_address: '{{auto}}',
 },
 sdk: expect.any(Object),
 spans: [
 {
Expand Down

10 changes: 5 additions & 5 deletions
dev-packages/browser-integration-tests/suites/public-api/withScope/nested_scopes/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ sentryTest('should allow nested scoping', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 5, { url });

 expect(eventData[0].message).toBe('root_before');
 expect(eventData[0].user).toMatchObject({ id: 'qux' });
 expect(eventData[0].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[0].tags).toBeUndefined();

 expect(eventData[1].message).toBe('outer_before');
 expect(eventData[1].user).toMatchObject({ id: 'qux' });
 expect(eventData[1].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[1].tags).toMatchObject({ foo: false });

 expect(eventData[2].message).toBe('inner');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({ ip_address: '{{auto}}' });
 expect(eventData[2].tags).toMatchObject({ foo: false, bar: 10 });

 expect(eventData[3].message).toBe('outer_after');
 expect(eventData[3].user).toMatchObject({ id: 'baz' });
 expect(eventData[3].user).toEqual({ id: 'baz', ip_address: '{{auto}}' });
 expect(eventData[3].tags).toMatchObject({ foo: false });

 expect(eventData[4].message).toBe('root_after');
 expect(eventData[4].user).toMatchObject({ id: 'qux' });
 expect(eventData[4].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[4].tags).toBeUndefined();
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

4 changes: 4 additions & 0 deletions
.../browser-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('captures a "GOOD" CLS vital with its source as a standalone span', a
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -137,6 +138,7 @@ sentryTest('captures a "MEH" CLS vital with its source as a standalone span', as
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -203,6 +205,7 @@ sentryTest('captures a "POOR" CLS vital with its source as a standalone span.',
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -270,6 +273,7 @@ sentryTest(
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: 'Layout shift',
 exclusive_time: 0,
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ sentryTest('should capture an INP click event span after pageload', async ({ bro
 'sentry.source': 'custom',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ sentryTest(
 'sentry.source': 'custom',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...ages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ sentryTest(
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('should capture an INP click event span during pageload', async ({ br
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,9 @@ const DEFAULT_REPLAY_EVENT = {
 'User-Agent': expect.any(String),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
};

Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-17/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-7-spa/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,6 +108,9 @@ export function startStandaloneWebVitalSpan(options: StandaloneWebVitalSpanOptio
 // For example: Chrome vs. Chrome Mobile
 'user_agent.original': WINDOW.navigator?.userAgent,

 // This tells Sentry to infer the IP address from the request
 'client.address': '{{auto}}',

 ...passedAttributes,
 };

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type {
 ParameterizedString,
 Scope,
 SeverityLevel,
 User,
} from '@sentry/core';
import { Client, applySdkMetadata, getSDKSource } from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
Expand DownExpand Up@@ -82,6 +83,23 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 }
 });
 }

 this.on('postprocessEvent', event => {
 addAutoIpAddressToUser(event);
 });

 this.on('beforeSendSession', session => {
 if ('aggregates' in session) {
 if (session.attrs?.['ip_address'] === undefined) {
 session.attrs = {
 ...session.attrs,
 ip_address: '{{auto}}',
 };
 }
 } else {
 addAutoIpAddressToUser(session);
 }
 });
 }

 /**
Expand DownExpand Up@@ -112,6 +130,19 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 isolationScope: Scope,
 ): PromiseLike<Event | null> {
 event.platform = event.platform || 'javascript';

 return super._prepareEvent(event, hint, currentScope, isolationScope);
 }
}

// By default, we want to infer the IP address, unless this is explicitly set to `null`
// We do this after all other processing is done
// If `ip_address` is explicitly set to `null` or a value, we leave it as is
function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null }): void {
 if (objWithMaybeUser.user?.ip_address === undefined) {
 objWithMaybeUser.user = {
 ...objWithMaybeUser.user,
 ip_address: '{{auto}}',
 };
 }
}
Loading

, '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(browser): Set user.ip_address explicitly to {{auto}}#15008

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

from

Jan 20, 2025
 Merged


feat(browser): Set user.ip_address explicitly to {{auto}}#15008
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fbe91bb

feat(browser): Set `user.ip_address` explicitly to `{{auto}}`


mydea Jan 14, 2025
d704c9e

fix & tests


mydea Jan 15, 2025
225a71d

also do for replay


mydea Jan 15, 2025
1d35352

fix tests


mydea Jan 15, 2025
a0bbfff

fix it better??


mydea Jan 15, 2025
a8293ad

fix tests


mydea Jan 17, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ sentryTest('should capture feedback with custom button', async ({ getLocalTestUr
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 user: {
 ip_address: '{{auto}}',
 },
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
...es/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/hasSampling/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest('should capture feedback', async ({ forceFlushReplay, getLocalTestUrl
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
 const cspViolation = await page.evaluate<boolean>('window.__CSPVIOLATION__');
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/manual-client/browser-context/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,9 @@ sentryTest('allows to setup a client manually & capture exceptions', async ({ ge
 'User-Agent': expect.any(String),
 }),
 },
 user: {
 ip_address: '{{auto}}',
 },
 timestamp: expect.any(Number),
 environment: 'local',
 release: '0.0.1',
Expand Down

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
Sentry.setUser({
 id: 'foo',
 ip_address: null,
});

Sentry.captureMessage('first_user');

17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should allow to set ip_address to null', async ({ getLocalTestUrl, page }) => {
 const url = await getLocalTestUrl({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.message).toBe('first_user');
 expect(eventData.user).toEqual({
 id: 'foo',
 ip_address: null,
 });
});

8 changes: 5 additions & 3 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/unset_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,17 @@ sentryTest('should unset user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 3, { url });

 expect(eventData[0].message).toBe('no_user');
 expect(eventData[0].user).toBeUndefined();
 expect(eventData[0].user).toEqual({ ip_address: '{{auto}}' });

 expect(eventData[1].message).toBe('user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 other_key: 'baz',
 });

 expect(eventData[2].message).toBe('unset_user');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({
 ip_address: '{{auto}}',
 });
});

5 changes: 3 additions & 2 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/update_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@ sentryTest('should update user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 2, { url });

 expect(eventData[0].message).toBe('first_user');
 expect(eventData[0].user).toMatchObject({
 expect(eventData[0].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 });

 expect(eventData[1].message).toBe('second_user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'baz',
 ip_address: '{{auto}}',
 });
});

3 changes: 3 additions & 0 deletions
...rowser-integration-tests/suites/public-api/startSpan/standalone-mixed-transaction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest(
 headers: expect.any(Object),
 url: expect.any(String),
 },
 user: {
 ip_address: '{{auto}}',
 },
 sdk: expect.any(Object),
 spans: [
 {
Expand Down

10 changes: 5 additions & 5 deletions
dev-packages/browser-integration-tests/suites/public-api/withScope/nested_scopes/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ sentryTest('should allow nested scoping', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 5, { url });

 expect(eventData[0].message).toBe('root_before');
 expect(eventData[0].user).toMatchObject({ id: 'qux' });
 expect(eventData[0].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[0].tags).toBeUndefined();

 expect(eventData[1].message).toBe('outer_before');
 expect(eventData[1].user).toMatchObject({ id: 'qux' });
 expect(eventData[1].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[1].tags).toMatchObject({ foo: false });

 expect(eventData[2].message).toBe('inner');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({ ip_address: '{{auto}}' });
 expect(eventData[2].tags).toMatchObject({ foo: false, bar: 10 });

 expect(eventData[3].message).toBe('outer_after');
 expect(eventData[3].user).toMatchObject({ id: 'baz' });
 expect(eventData[3].user).toEqual({ id: 'baz', ip_address: '{{auto}}' });
 expect(eventData[3].tags).toMatchObject({ foo: false });

 expect(eventData[4].message).toBe('root_after');
 expect(eventData[4].user).toMatchObject({ id: 'qux' });
 expect(eventData[4].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[4].tags).toBeUndefined();
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

4 changes: 4 additions & 0 deletions
.../browser-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('captures a "GOOD" CLS vital with its source as a standalone span', a
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -137,6 +138,7 @@ sentryTest('captures a "MEH" CLS vital with its source as a standalone span', as
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -203,6 +205,7 @@ sentryTest('captures a "POOR" CLS vital with its source as a standalone span.',
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -270,6 +273,7 @@ sentryTest(
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: 'Layout shift',
 exclusive_time: 0,
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ sentryTest('should capture an INP click event span after pageload', async ({ bro
 'sentry.source': 'custom',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ sentryTest(
 'sentry.source': 'custom',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...ages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ sentryTest(
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('should capture an INP click event span during pageload', async ({ br
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,9 @@ const DEFAULT_REPLAY_EVENT = {
 'User-Agent': expect.any(String),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
};

Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-17/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-7-spa/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,6 +108,9 @@ export function startStandaloneWebVitalSpan(options: StandaloneWebVitalSpanOptio
 // For example: Chrome vs. Chrome Mobile
 'user_agent.original': WINDOW.navigator?.userAgent,

 // This tells Sentry to infer the IP address from the request
 'client.address': '{{auto}}',

 ...passedAttributes,
 };

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type {
 ParameterizedString,
 Scope,
 SeverityLevel,
 User,
} from '@sentry/core';
import { Client, applySdkMetadata, getSDKSource } from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
Expand DownExpand Up@@ -82,6 +83,23 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 }
 });
 }

 this.on('postprocessEvent', event => {
 addAutoIpAddressToUser(event);
 });

 this.on('beforeSendSession', session => {
 if ('aggregates' in session) {
 if (session.attrs?.['ip_address'] === undefined) {
 session.attrs = {
 ...session.attrs,
 ip_address: '{{auto}}',
 };
 }
 } else {
 addAutoIpAddressToUser(session);
 }
 });
 }

 /**
Expand DownExpand Up@@ -112,6 +130,19 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 isolationScope: Scope,
 ): PromiseLike<Event | null> {
 event.platform = event.platform || 'javascript';

 return super._prepareEvent(event, hint, currentScope, isolationScope);
 }
}

// By default, we want to infer the IP address, unless this is explicitly set to `null`
// We do this after all other processing is done
// If `ip_address` is explicitly set to `null` or a value, we leave it as is
function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null }): void {
 if (objWithMaybeUser.user?.ip_address === undefined) {
 objWithMaybeUser.user = {
 ...objWithMaybeUser.user,
 ip_address: '{{auto}}',
 };
 }
}
Loading

, '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(browser): Set user.ip_address explicitly to {{auto}}#15008

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

from

Jan 20, 2025
 Merged


feat(browser): Set user.ip_address explicitly to {{auto}}#15008
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fbe91bb

feat(browser): Set `user.ip_address` explicitly to `{{auto}}`


mydea Jan 14, 2025
d704c9e

fix & tests


mydea Jan 15, 2025
225a71d

also do for replay


mydea Jan 15, 2025
1d35352

fix tests


mydea Jan 15, 2025
a0bbfff

fix it better??


mydea Jan 15, 2025
a8293ad

fix tests


mydea Jan 17, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ sentryTest('should capture feedback with custom button', async ({ getLocalTestUr
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 user: {
 ip_address: '{{auto}}',
 },
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
...es/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/hasSampling/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest('should capture feedback', async ({ forceFlushReplay, getLocalTestUrl
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
 const cspViolation = await page.evaluate<boolean>('window.__CSPVIOLATION__');
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/manual-client/browser-context/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,9 @@ sentryTest('allows to setup a client manually & capture exceptions', async ({ ge
 'User-Agent': expect.any(String),
 }),
 },
 user: {
 ip_address: '{{auto}}',
 },
 timestamp: expect.any(Number),
 environment: 'local',
 release: '0.0.1',
Expand Down

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
Sentry.setUser({
 id: 'foo',
 ip_address: null,
});

Sentry.captureMessage('first_user');

17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should allow to set ip_address to null', async ({ getLocalTestUrl, page }) => {
 const url = await getLocalTestUrl({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.message).toBe('first_user');
 expect(eventData.user).toEqual({
 id: 'foo',
 ip_address: null,
 });
});

8 changes: 5 additions & 3 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/unset_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,17 @@ sentryTest('should unset user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 3, { url });

 expect(eventData[0].message).toBe('no_user');
 expect(eventData[0].user).toBeUndefined();
 expect(eventData[0].user).toEqual({ ip_address: '{{auto}}' });

 expect(eventData[1].message).toBe('user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 other_key: 'baz',
 });

 expect(eventData[2].message).toBe('unset_user');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({
 ip_address: '{{auto}}',
 });
});

5 changes: 3 additions & 2 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/update_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@ sentryTest('should update user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 2, { url });

 expect(eventData[0].message).toBe('first_user');
 expect(eventData[0].user).toMatchObject({
 expect(eventData[0].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 });

 expect(eventData[1].message).toBe('second_user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'baz',
 ip_address: '{{auto}}',
 });
});

3 changes: 3 additions & 0 deletions
...rowser-integration-tests/suites/public-api/startSpan/standalone-mixed-transaction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest(
 headers: expect.any(Object),
 url: expect.any(String),
 },
 user: {
 ip_address: '{{auto}}',
 },
 sdk: expect.any(Object),
 spans: [
 {
Expand Down

10 changes: 5 additions & 5 deletions
dev-packages/browser-integration-tests/suites/public-api/withScope/nested_scopes/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ sentryTest('should allow nested scoping', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 5, { url });

 expect(eventData[0].message).toBe('root_before');
 expect(eventData[0].user).toMatchObject({ id: 'qux' });
 expect(eventData[0].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[0].tags).toBeUndefined();

 expect(eventData[1].message).toBe('outer_before');
 expect(eventData[1].user).toMatchObject({ id: 'qux' });
 expect(eventData[1].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[1].tags).toMatchObject({ foo: false });

 expect(eventData[2].message).toBe('inner');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({ ip_address: '{{auto}}' });
 expect(eventData[2].tags).toMatchObject({ foo: false, bar: 10 });

 expect(eventData[3].message).toBe('outer_after');
 expect(eventData[3].user).toMatchObject({ id: 'baz' });
 expect(eventData[3].user).toEqual({ id: 'baz', ip_address: '{{auto}}' });
 expect(eventData[3].tags).toMatchObject({ foo: false });

 expect(eventData[4].message).toBe('root_after');
 expect(eventData[4].user).toMatchObject({ id: 'qux' });
 expect(eventData[4].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[4].tags).toBeUndefined();
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

4 changes: 4 additions & 0 deletions
.../browser-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('captures a "GOOD" CLS vital with its source as a standalone span', a
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -137,6 +138,7 @@ sentryTest('captures a "MEH" CLS vital with its source as a standalone span', as
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -203,6 +205,7 @@ sentryTest('captures a "POOR" CLS vital with its source as a standalone span.',
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -270,6 +273,7 @@ sentryTest(
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: 'Layout shift',
 exclusive_time: 0,
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ sentryTest('should capture an INP click event span after pageload', async ({ bro
 'sentry.source': 'custom',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ sentryTest(
 'sentry.source': 'custom',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...ages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ sentryTest(
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('should capture an INP click event span during pageload', async ({ br
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,9 @@ const DEFAULT_REPLAY_EVENT = {
 'User-Agent': expect.any(String),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
};

Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-17/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-7-spa/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,6 +108,9 @@ export function startStandaloneWebVitalSpan(options: StandaloneWebVitalSpanOptio
 // For example: Chrome vs. Chrome Mobile
 'user_agent.original': WINDOW.navigator?.userAgent,

 // This tells Sentry to infer the IP address from the request
 'client.address': '{{auto}}',

 ...passedAttributes,
 };

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type {
 ParameterizedString,
 Scope,
 SeverityLevel,
 User,
} from '@sentry/core';
import { Client, applySdkMetadata, getSDKSource } from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
Expand DownExpand Up@@ -82,6 +83,23 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 }
 });
 }

 this.on('postprocessEvent', event => {
 addAutoIpAddressToUser(event);
 });

 this.on('beforeSendSession', session => {
 if ('aggregates' in session) {
 if (session.attrs?.['ip_address'] === undefined) {
 session.attrs = {
 ...session.attrs,
 ip_address: '{{auto}}',
 };
 }
 } else {
 addAutoIpAddressToUser(session);
 }
 });
 }

 /**
Expand DownExpand Up@@ -112,6 +130,19 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 isolationScope: Scope,
 ): PromiseLike<Event | null> {
 event.platform = event.platform || 'javascript';

 return super._prepareEvent(event, hint, currentScope, isolationScope);
 }
}

// By default, we want to infer the IP address, unless this is explicitly set to `null`
// We do this after all other processing is done
// If `ip_address` is explicitly set to `null` or a value, we leave it as is
function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null }): void {
 if (objWithMaybeUser.user?.ip_address === undefined) {
 objWithMaybeUser.user = {
 ...objWithMaybeUser.user,
 ip_address: '{{auto}}',
 };
 }
}
Loading

, '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(browser): Set user.ip_address explicitly to {{auto}}#15008

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

from

Jan 20, 2025
 Merged


feat(browser): Set user.ip_address explicitly to {{auto}}#15008
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fbe91bb

feat(browser): Set `user.ip_address` explicitly to `{{auto}}`


mydea Jan 14, 2025
d704c9e

fix & tests


mydea Jan 15, 2025
225a71d

also do for replay


mydea Jan 15, 2025
1d35352

fix tests


mydea Jan 15, 2025
a0bbfff

fix it better??


mydea Jan 15, 2025
a8293ad

fix tests


mydea Jan 17, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ sentryTest('should capture feedback with custom button', async ({ getLocalTestUr
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 user: {
 ip_address: '{{auto}}',
 },
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
...es/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/hasSampling/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest('should capture feedback', async ({ forceFlushReplay, getLocalTestUrl
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
 const cspViolation = await page.evaluate<boolean>('window.__CSPVIOLATION__');
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/manual-client/browser-context/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,9 @@ sentryTest('allows to setup a client manually & capture exceptions', async ({ ge
 'User-Agent': expect.any(String),
 }),
 },
 user: {
 ip_address: '{{auto}}',
 },
 timestamp: expect.any(Number),
 environment: 'local',
 release: '0.0.1',
Expand Down

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
Sentry.setUser({
 id: 'foo',
 ip_address: null,
});

Sentry.captureMessage('first_user');

17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should allow to set ip_address to null', async ({ getLocalTestUrl, page }) => {
 const url = await getLocalTestUrl({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.message).toBe('first_user');
 expect(eventData.user).toEqual({
 id: 'foo',
 ip_address: null,
 });
});

8 changes: 5 additions & 3 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/unset_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,17 @@ sentryTest('should unset user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 3, { url });

 expect(eventData[0].message).toBe('no_user');
 expect(eventData[0].user).toBeUndefined();
 expect(eventData[0].user).toEqual({ ip_address: '{{auto}}' });

 expect(eventData[1].message).toBe('user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 other_key: 'baz',
 });

 expect(eventData[2].message).toBe('unset_user');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({
 ip_address: '{{auto}}',
 });
});

5 changes: 3 additions & 2 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/update_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@ sentryTest('should update user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 2, { url });

 expect(eventData[0].message).toBe('first_user');
 expect(eventData[0].user).toMatchObject({
 expect(eventData[0].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 });

 expect(eventData[1].message).toBe('second_user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'baz',
 ip_address: '{{auto}}',
 });
});

3 changes: 3 additions & 0 deletions
...rowser-integration-tests/suites/public-api/startSpan/standalone-mixed-transaction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest(
 headers: expect.any(Object),
 url: expect.any(String),
 },
 user: {
 ip_address: '{{auto}}',
 },
 sdk: expect.any(Object),
 spans: [
 {
Expand Down

10 changes: 5 additions & 5 deletions
dev-packages/browser-integration-tests/suites/public-api/withScope/nested_scopes/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ sentryTest('should allow nested scoping', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 5, { url });

 expect(eventData[0].message).toBe('root_before');
 expect(eventData[0].user).toMatchObject({ id: 'qux' });
 expect(eventData[0].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[0].tags).toBeUndefined();

 expect(eventData[1].message).toBe('outer_before');
 expect(eventData[1].user).toMatchObject({ id: 'qux' });
 expect(eventData[1].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[1].tags).toMatchObject({ foo: false });

 expect(eventData[2].message).toBe('inner');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({ ip_address: '{{auto}}' });
 expect(eventData[2].tags).toMatchObject({ foo: false, bar: 10 });

 expect(eventData[3].message).toBe('outer_after');
 expect(eventData[3].user).toMatchObject({ id: 'baz' });
 expect(eventData[3].user).toEqual({ id: 'baz', ip_address: '{{auto}}' });
 expect(eventData[3].tags).toMatchObject({ foo: false });

 expect(eventData[4].message).toBe('root_after');
 expect(eventData[4].user).toMatchObject({ id: 'qux' });
 expect(eventData[4].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[4].tags).toBeUndefined();
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

4 changes: 4 additions & 0 deletions
.../browser-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('captures a "GOOD" CLS vital with its source as a standalone span', a
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -137,6 +138,7 @@ sentryTest('captures a "MEH" CLS vital with its source as a standalone span', as
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -203,6 +205,7 @@ sentryTest('captures a "POOR" CLS vital with its source as a standalone span.',
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -270,6 +273,7 @@ sentryTest(
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: 'Layout shift',
 exclusive_time: 0,
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ sentryTest('should capture an INP click event span after pageload', async ({ bro
 'sentry.source': 'custom',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ sentryTest(
 'sentry.source': 'custom',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...ages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ sentryTest(
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('should capture an INP click event span during pageload', async ({ br
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,9 @@ const DEFAULT_REPLAY_EVENT = {
 'User-Agent': expect.any(String),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
};

Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-17/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-7-spa/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,6 +108,9 @@ export function startStandaloneWebVitalSpan(options: StandaloneWebVitalSpanOptio
 // For example: Chrome vs. Chrome Mobile
 'user_agent.original': WINDOW.navigator?.userAgent,

 // This tells Sentry to infer the IP address from the request
 'client.address': '{{auto}}',

 ...passedAttributes,
 };

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type {
 ParameterizedString,
 Scope,
 SeverityLevel,
 User,
} from '@sentry/core';
import { Client, applySdkMetadata, getSDKSource } from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
Expand DownExpand Up@@ -82,6 +83,23 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 }
 });
 }

 this.on('postprocessEvent', event => {
 addAutoIpAddressToUser(event);
 });

 this.on('beforeSendSession', session => {
 if ('aggregates' in session) {
 if (session.attrs?.['ip_address'] === undefined) {
 session.attrs = {
 ...session.attrs,
 ip_address: '{{auto}}',
 };
 }
 } else {
 addAutoIpAddressToUser(session);
 }
 });
 }

 /**
Expand DownExpand Up@@ -112,6 +130,19 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 isolationScope: Scope,
 ): PromiseLike<Event | null> {
 event.platform = event.platform || 'javascript';

 return super._prepareEvent(event, hint, currentScope, isolationScope);
 }
}

// By default, we want to infer the IP address, unless this is explicitly set to `null`
// We do this after all other processing is done
// If `ip_address` is explicitly set to `null` or a value, we leave it as is
function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null }): void {
 if (objWithMaybeUser.user?.ip_address === undefined) {
 objWithMaybeUser.user = {
 ...objWithMaybeUser.user,
 ip_address: '{{auto}}',
 };
 }
}
Loading

, '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(browser): Set user.ip_address explicitly to {{auto}}#15008

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

from

Jan 20, 2025
 Merged


feat(browser): Set user.ip_address explicitly to {{auto}}#15008
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fbe91bb

feat(browser): Set `user.ip_address` explicitly to `{{auto}}`


mydea Jan 14, 2025
d704c9e

fix & tests


mydea Jan 15, 2025
225a71d

also do for replay


mydea Jan 15, 2025
1d35352

fix tests


mydea Jan 15, 2025
a0bbfff

fix it better??


mydea Jan 15, 2025
a8293ad

fix tests


mydea Jan 17, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ sentryTest('should capture feedback with custom button', async ({ getLocalTestUr
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 user: {
 ip_address: '{{auto}}',
 },
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
...es/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/hasSampling/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest('should capture feedback', async ({ forceFlushReplay, getLocalTestUrl
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
 const cspViolation = await page.evaluate<boolean>('window.__CSPVIOLATION__');
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/manual-client/browser-context/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,9 @@ sentryTest('allows to setup a client manually & capture exceptions', async ({ ge
 'User-Agent': expect.any(String),
 }),
 },
 user: {
 ip_address: '{{auto}}',
 },
 timestamp: expect.any(Number),
 environment: 'local',
 release: '0.0.1',
Expand Down

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
Sentry.setUser({
 id: 'foo',
 ip_address: null,
});

Sentry.captureMessage('first_user');

17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should allow to set ip_address to null', async ({ getLocalTestUrl, page }) => {
 const url = await getLocalTestUrl({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.message).toBe('first_user');
 expect(eventData.user).toEqual({
 id: 'foo',
 ip_address: null,
 });
});

8 changes: 5 additions & 3 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/unset_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,17 @@ sentryTest('should unset user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 3, { url });

 expect(eventData[0].message).toBe('no_user');
 expect(eventData[0].user).toBeUndefined();
 expect(eventData[0].user).toEqual({ ip_address: '{{auto}}' });

 expect(eventData[1].message).toBe('user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 other_key: 'baz',
 });

 expect(eventData[2].message).toBe('unset_user');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({
 ip_address: '{{auto}}',
 });
});

5 changes: 3 additions & 2 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/update_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@ sentryTest('should update user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 2, { url });

 expect(eventData[0].message).toBe('first_user');
 expect(eventData[0].user).toMatchObject({
 expect(eventData[0].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 });

 expect(eventData[1].message).toBe('second_user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'baz',
 ip_address: '{{auto}}',
 });
});

3 changes: 3 additions & 0 deletions
...rowser-integration-tests/suites/public-api/startSpan/standalone-mixed-transaction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest(
 headers: expect.any(Object),
 url: expect.any(String),
 },
 user: {
 ip_address: '{{auto}}',
 },
 sdk: expect.any(Object),
 spans: [
 {
Expand Down

10 changes: 5 additions & 5 deletions
dev-packages/browser-integration-tests/suites/public-api/withScope/nested_scopes/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ sentryTest('should allow nested scoping', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 5, { url });

 expect(eventData[0].message).toBe('root_before');
 expect(eventData[0].user).toMatchObject({ id: 'qux' });
 expect(eventData[0].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[0].tags).toBeUndefined();

 expect(eventData[1].message).toBe('outer_before');
 expect(eventData[1].user).toMatchObject({ id: 'qux' });
 expect(eventData[1].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[1].tags).toMatchObject({ foo: false });

 expect(eventData[2].message).toBe('inner');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({ ip_address: '{{auto}}' });
 expect(eventData[2].tags).toMatchObject({ foo: false, bar: 10 });

 expect(eventData[3].message).toBe('outer_after');
 expect(eventData[3].user).toMatchObject({ id: 'baz' });
 expect(eventData[3].user).toEqual({ id: 'baz', ip_address: '{{auto}}' });
 expect(eventData[3].tags).toMatchObject({ foo: false });

 expect(eventData[4].message).toBe('root_after');
 expect(eventData[4].user).toMatchObject({ id: 'qux' });
 expect(eventData[4].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[4].tags).toBeUndefined();
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

4 changes: 4 additions & 0 deletions
.../browser-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('captures a "GOOD" CLS vital with its source as a standalone span', a
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -137,6 +138,7 @@ sentryTest('captures a "MEH" CLS vital with its source as a standalone span', as
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -203,6 +205,7 @@ sentryTest('captures a "POOR" CLS vital with its source as a standalone span.',
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -270,6 +273,7 @@ sentryTest(
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: 'Layout shift',
 exclusive_time: 0,
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ sentryTest('should capture an INP click event span after pageload', async ({ bro
 'sentry.source': 'custom',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ sentryTest(
 'sentry.source': 'custom',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...ages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ sentryTest(
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('should capture an INP click event span during pageload', async ({ br
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,9 @@ const DEFAULT_REPLAY_EVENT = {
 'User-Agent': expect.any(String),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
};

Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-17/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-7-spa/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,6 +108,9 @@ export function startStandaloneWebVitalSpan(options: StandaloneWebVitalSpanOptio
 // For example: Chrome vs. Chrome Mobile
 'user_agent.original': WINDOW.navigator?.userAgent,

 // This tells Sentry to infer the IP address from the request
 'client.address': '{{auto}}',

 ...passedAttributes,
 };

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type {
 ParameterizedString,
 Scope,
 SeverityLevel,
 User,
} from '@sentry/core';
import { Client, applySdkMetadata, getSDKSource } from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
Expand DownExpand Up@@ -82,6 +83,23 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 }
 });
 }

 this.on('postprocessEvent', event => {
 addAutoIpAddressToUser(event);
 });

 this.on('beforeSendSession', session => {
 if ('aggregates' in session) {
 if (session.attrs?.['ip_address'] === undefined) {
 session.attrs = {
 ...session.attrs,
 ip_address: '{{auto}}',
 };
 }
 } else {
 addAutoIpAddressToUser(session);
 }
 });
 }

 /**
Expand DownExpand Up@@ -112,6 +130,19 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 isolationScope: Scope,
 ): PromiseLike<Event | null> {
 event.platform = event.platform || 'javascript';

 return super._prepareEvent(event, hint, currentScope, isolationScope);
 }
}

// By default, we want to infer the IP address, unless this is explicitly set to `null`
// We do this after all other processing is done
// If `ip_address` is explicitly set to `null` or a value, we leave it as is
function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null }): void {
 if (objWithMaybeUser.user?.ip_address === undefined) {
 objWithMaybeUser.user = {
 ...objWithMaybeUser.user,
 ip_address: '{{auto}}',
 };
 }
}
Loading

, '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(browser): Set user.ip_address explicitly to {{auto}}#15008

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

from

Jan 20, 2025
 Merged


feat(browser): Set user.ip_address explicitly to {{auto}}#15008
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fbe91bb

feat(browser): Set `user.ip_address` explicitly to `{{auto}}`


mydea Jan 14, 2025
d704c9e

fix & tests


mydea Jan 15, 2025
225a71d

also do for replay


mydea Jan 15, 2025
1d35352

fix tests


mydea Jan 15, 2025
a0bbfff

fix it better??


mydea Jan 15, 2025
a8293ad

fix tests


mydea Jan 17, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ sentryTest('should capture feedback with custom button', async ({ getLocalTestUr
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 user: {
 ip_address: '{{auto}}',
 },
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
...es/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/hasSampling/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest('should capture feedback', async ({ forceFlushReplay, getLocalTestUrl
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
 const cspViolation = await page.evaluate<boolean>('window.__CSPVIOLATION__');
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/manual-client/browser-context/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,9 @@ sentryTest('allows to setup a client manually & capture exceptions', async ({ ge
 'User-Agent': expect.any(String),
 }),
 },
 user: {
 ip_address: '{{auto}}',
 },
 timestamp: expect.any(Number),
 environment: 'local',
 release: '0.0.1',
Expand Down

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
Sentry.setUser({
 id: 'foo',
 ip_address: null,
});

Sentry.captureMessage('first_user');

17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should allow to set ip_address to null', async ({ getLocalTestUrl, page }) => {
 const url = await getLocalTestUrl({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.message).toBe('first_user');
 expect(eventData.user).toEqual({
 id: 'foo',
 ip_address: null,
 });
});

8 changes: 5 additions & 3 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/unset_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,17 @@ sentryTest('should unset user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 3, { url });

 expect(eventData[0].message).toBe('no_user');
 expect(eventData[0].user).toBeUndefined();
 expect(eventData[0].user).toEqual({ ip_address: '{{auto}}' });

 expect(eventData[1].message).toBe('user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 other_key: 'baz',
 });

 expect(eventData[2].message).toBe('unset_user');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({
 ip_address: '{{auto}}',
 });
});

5 changes: 3 additions & 2 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/update_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@ sentryTest('should update user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 2, { url });

 expect(eventData[0].message).toBe('first_user');
 expect(eventData[0].user).toMatchObject({
 expect(eventData[0].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 });

 expect(eventData[1].message).toBe('second_user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'baz',
 ip_address: '{{auto}}',
 });
});

3 changes: 3 additions & 0 deletions
...rowser-integration-tests/suites/public-api/startSpan/standalone-mixed-transaction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest(
 headers: expect.any(Object),
 url: expect.any(String),
 },
 user: {
 ip_address: '{{auto}}',
 },
 sdk: expect.any(Object),
 spans: [
 {
Expand Down

10 changes: 5 additions & 5 deletions
dev-packages/browser-integration-tests/suites/public-api/withScope/nested_scopes/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ sentryTest('should allow nested scoping', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 5, { url });

 expect(eventData[0].message).toBe('root_before');
 expect(eventData[0].user).toMatchObject({ id: 'qux' });
 expect(eventData[0].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[0].tags).toBeUndefined();

 expect(eventData[1].message).toBe('outer_before');
 expect(eventData[1].user).toMatchObject({ id: 'qux' });
 expect(eventData[1].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[1].tags).toMatchObject({ foo: false });

 expect(eventData[2].message).toBe('inner');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({ ip_address: '{{auto}}' });
 expect(eventData[2].tags).toMatchObject({ foo: false, bar: 10 });

 expect(eventData[3].message).toBe('outer_after');
 expect(eventData[3].user).toMatchObject({ id: 'baz' });
 expect(eventData[3].user).toEqual({ id: 'baz', ip_address: '{{auto}}' });
 expect(eventData[3].tags).toMatchObject({ foo: false });

 expect(eventData[4].message).toBe('root_after');
 expect(eventData[4].user).toMatchObject({ id: 'qux' });
 expect(eventData[4].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[4].tags).toBeUndefined();
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

4 changes: 4 additions & 0 deletions
.../browser-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('captures a "GOOD" CLS vital with its source as a standalone span', a
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -137,6 +138,7 @@ sentryTest('captures a "MEH" CLS vital with its source as a standalone span', as
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -203,6 +205,7 @@ sentryTest('captures a "POOR" CLS vital with its source as a standalone span.',
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -270,6 +273,7 @@ sentryTest(
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: 'Layout shift',
 exclusive_time: 0,
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ sentryTest('should capture an INP click event span after pageload', async ({ bro
 'sentry.source': 'custom',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ sentryTest(
 'sentry.source': 'custom',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...ages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ sentryTest(
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('should capture an INP click event span during pageload', async ({ br
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,9 @@ const DEFAULT_REPLAY_EVENT = {
 'User-Agent': expect.any(String),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
};

Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-17/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-7-spa/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,6 +108,9 @@ export function startStandaloneWebVitalSpan(options: StandaloneWebVitalSpanOptio
 // For example: Chrome vs. Chrome Mobile
 'user_agent.original': WINDOW.navigator?.userAgent,

 // This tells Sentry to infer the IP address from the request
 'client.address': '{{auto}}',

 ...passedAttributes,
 };

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type {
 ParameterizedString,
 Scope,
 SeverityLevel,
 User,
} from '@sentry/core';
import { Client, applySdkMetadata, getSDKSource } from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
Expand DownExpand Up@@ -82,6 +83,23 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 }
 });
 }

 this.on('postprocessEvent', event => {
 addAutoIpAddressToUser(event);
 });

 this.on('beforeSendSession', session => {
 if ('aggregates' in session) {
 if (session.attrs?.['ip_address'] === undefined) {
 session.attrs = {
 ...session.attrs,
 ip_address: '{{auto}}',
 };
 }
 } else {
 addAutoIpAddressToUser(session);
 }
 });
 }

 /**
Expand DownExpand Up@@ -112,6 +130,19 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 isolationScope: Scope,
 ): PromiseLike<Event | null> {
 event.platform = event.platform || 'javascript';

 return super._prepareEvent(event, hint, currentScope, isolationScope);
 }
}

// By default, we want to infer the IP address, unless this is explicitly set to `null`
// We do this after all other processing is done
// If `ip_address` is explicitly set to `null` or a value, we leave it as is
function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null }): void {
 if (objWithMaybeUser.user?.ip_address === undefined) {
 objWithMaybeUser.user = {
 ...objWithMaybeUser.user,
 ip_address: '{{auto}}',
 };
 }
}
Loading

, '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(browser): Set user.ip_address explicitly to {{auto}}#15008

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

from

Jan 20, 2025
 Merged


feat(browser): Set user.ip_address explicitly to {{auto}}#15008
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fbe91bb

feat(browser): Set `user.ip_address` explicitly to `{{auto}}`


mydea Jan 14, 2025
d704c9e

fix & tests


mydea Jan 15, 2025
225a71d

also do for replay


mydea Jan 15, 2025
1d35352

fix tests


mydea Jan 15, 2025
a0bbfff

fix it better??


mydea Jan 15, 2025
a8293ad

fix tests


mydea Jan 17, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,9 @@ sentryTest('should capture feedback with custom button', async ({ getLocalTestUr
 event_id: expect.stringMatching(/\w{32}/),
 environment: 'production',
 tags: {},
 user: {
 ip_address: '{{auto}}',
 },
 sdk: {
 integrations: expect.arrayContaining(['Feedback']),
 version: expect.any(String),
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
...es/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/hasSampling/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest('should capture feedback', async ({ forceFlushReplay, getLocalTestUrl
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,9 @@ sentryTest('should capture feedback', async ({ getLocalTestUrl, page }) => {
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
 const cspViolation = await page.evaluate<boolean>('window.__CSPVIOLATION__');
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/suites/manual-client/browser-context/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,9 @@ sentryTest('allows to setup a client manually & capture exceptions', async ({ ge
 'User-Agent': expect.any(String),
 }),
 },
 user: {
 ip_address: '{{auto}}',
 },
 timestamp: expect.any(Number),
 environment: 'local',
 release: '0.0.1',
Expand Down

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/subject.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
Sentry.setUser({
 id: 'foo',
 ip_address: null,
});

Sentry.captureMessage('first_user');

17 changes: 17 additions & 0 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';

import { sentryTest } from '../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';

sentryTest('should allow to set ip_address to null', async ({ getLocalTestUrl, page }) => {
 const url = await getLocalTestUrl({ testDir: __dirname });

 const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

 expect(eventData.message).toBe('first_user');
 expect(eventData.user).toEqual({
 id: 'foo',
 ip_address: null,
 });
});

8 changes: 5 additions & 3 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/unset_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,15 +10,17 @@ sentryTest('should unset user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 3, { url });

 expect(eventData[0].message).toBe('no_user');
 expect(eventData[0].user).toBeUndefined();
 expect(eventData[0].user).toEqual({ ip_address: '{{auto}}' });

 expect(eventData[1].message).toBe('user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 other_key: 'baz',
 });

 expect(eventData[2].message).toBe('unset_user');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({
 ip_address: '{{auto}}',
 });
});

5 changes: 3 additions & 2 deletions
dev-packages/browser-integration-tests/suites/public-api/setUser/update_user/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@ sentryTest('should update user', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 2, { url });

 expect(eventData[0].message).toBe('first_user');
 expect(eventData[0].user).toMatchObject({
 expect(eventData[0].user).toEqual({
 id: 'foo',
 ip_address: 'bar',
 });

 expect(eventData[1].message).toBe('second_user');
 expect(eventData[1].user).toMatchObject({
 expect(eventData[1].user).toEqual({
 id: 'baz',
 ip_address: '{{auto}}',
 });
});

3 changes: 3 additions & 0 deletions
...rowser-integration-tests/suites/public-api/startSpan/standalone-mixed-transaction/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,9 @@ sentryTest(
 headers: expect.any(Object),
 url: expect.any(String),
 },
 user: {
 ip_address: '{{auto}}',
 },
 sdk: expect.any(Object),
 spans: [
 {
Expand Down

10 changes: 5 additions & 5 deletions
dev-packages/browser-integration-tests/suites/public-api/withScope/nested_scopes/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,22 +10,22 @@ sentryTest('should allow nested scoping', async ({ getLocalTestUrl, page }) => {
 const eventData = await getMultipleSentryEnvelopeRequests<Event>(page, 5, { url });

 expect(eventData[0].message).toBe('root_before');
 expect(eventData[0].user).toMatchObject({ id: 'qux' });
 expect(eventData[0].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[0].tags).toBeUndefined();

 expect(eventData[1].message).toBe('outer_before');
 expect(eventData[1].user).toMatchObject({ id: 'qux' });
 expect(eventData[1].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[1].tags).toMatchObject({ foo: false });

 expect(eventData[2].message).toBe('inner');
 expect(eventData[2].user).toBeUndefined();
 expect(eventData[2].user).toEqual({ ip_address: '{{auto}}' });
 expect(eventData[2].tags).toMatchObject({ foo: false, bar: 10 });

 expect(eventData[3].message).toBe('outer_after');
 expect(eventData[3].user).toMatchObject({ id: 'baz' });
 expect(eventData[3].user).toEqual({ id: 'baz', ip_address: '{{auto}}' });
 expect(eventData[3].tags).toMatchObject({ foo: false });

 expect(eventData[4].message).toBe('root_after');
 expect(eventData[4].user).toMatchObject({ id: 'qux' });
 expect(eventData[4].user).toEqual({ id: 'qux', ip_address: '{{auto}}' });
 expect(eventData[4].tags).toBeUndefined();
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplay/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry/browser export)', async ({ getLocalT
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

6 changes: 6 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/captureReplayFromReplayPackage/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });

Expand DownExpand Up@@ -93,6 +96,9 @@ sentryTest('should capture replays (@sentry-internal/replay export)', async ({ g
 'User-Agent': expect.stringContaining(''),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
 });
});

4 changes: 4 additions & 0 deletions
.../browser-integration-tests/suites/tracing/metrics/web-vitals-cls-standalone-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('captures a "GOOD" CLS vital with its source as a standalone span', a
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -137,6 +138,7 @@ sentryTest('captures a "MEH" CLS vital with its source as a standalone span', as
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -203,6 +205,7 @@ sentryTest('captures a "POOR" CLS vital with its source as a standalone span.',
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: expect.stringContaining('body > div#content > p'),
 exclusive_time: 0,
Expand DownExpand Up@@ -270,6 +273,7 @@ sentryTest(
 transaction: expect.stringContaining('index.html'),
 'user_agent.original': expect.stringContaining('Chrome'),
 'sentry.pageload.span_id': expect.stringMatching(/[a-f0-9]{16}/),
 'client.address': '{{auto}}',
 },
 description: 'Layout shift',
 exclusive_time: 0,
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,7 @@ sentryTest('should capture an INP click event span after pageload', async ({ bro
 'sentry.source': 'custom',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized-late/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ sentryTest(
 'sentry.source': 'custom',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
...ages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp-parametrized/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,7 @@ sentryTest(
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-route',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/browser-integration-tests/suites/tracing/metrics/web-vitals-inp/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,7 @@ sentryTest('should capture an INP click event span during pageload', async ({ br
 'sentry.origin': 'auto.http.browser.inp',
 transaction: 'test-url',
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 measurements: {
 inp: {
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/browser-integration-tests/utils/replayEventTemplates.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,9 @@ const DEFAULT_REPLAY_EVENT = {
 'User-Agent': expect.any(String),
 },
 },
 user: {
 ip_address: '{{auto}}',
 },
 platform: 'javascript',
};

Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-17/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

1 change: 1 addition & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-7-spa/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ test('sends an INP span', async ({ page }) => {
 'sentry.exclusive_time': expect.any(Number),
 replay_id: expect.any(String),
 'user_agent.original': expect.stringContaining('Chrome'),
 'client.address': '{{auto}}',
 },
 description: 'body > div#root > input#exception-button[type="button"]',
 op: 'ui.interaction.click',
Expand Down

3 changes: 3 additions & 0 deletions
packages/browser-utils/src/metrics/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -108,6 +108,9 @@ export function startStandaloneWebVitalSpan(options: StandaloneWebVitalSpanOptio
 // For example: Chrome vs. Chrome Mobile
 'user_agent.original': WINDOW.navigator?.userAgent,

 // This tells Sentry to infer the IP address from the request
 'client.address': '{{auto}}',

 ...passedAttributes,
 };

Expand Down

31 changes: 31 additions & 0 deletions
packages/browser/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import type {
 ParameterizedString,
 Scope,
 SeverityLevel,
 User,
} from '@sentry/core';
import { Client, applySdkMetadata, getSDKSource } from '@sentry/core';
import { eventFromException, eventFromMessage } from './eventbuilder';
Expand DownExpand Up@@ -82,6 +83,23 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 }
 });
 }

 this.on('postprocessEvent', event => {
 addAutoIpAddressToUser(event);
 });

 this.on('beforeSendSession', session => {
 if ('aggregates' in session) {
 if (session.attrs?.['ip_address'] === undefined) {
 session.attrs = {
 ...session.attrs,
 ip_address: '{{auto}}',
 };
 }
 } else {
 addAutoIpAddressToUser(session);
 }
 });
 }

 /**
Expand DownExpand Up@@ -112,6 +130,19 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 isolationScope: Scope,
 ): PromiseLike<Event | null> {
 event.platform = event.platform || 'javascript';

 return super._prepareEvent(event, hint, currentScope, isolationScope);
 }
}

// By default, we want to infer the IP address, unless this is explicitly set to `null`
// We do this after all other processing is done
// If `ip_address` is explicitly set to `null` or a value, we leave it as is
function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null }): void {
 if (objWithMaybeUser.user?.ip_address === undefined) {
 objWithMaybeUser.user = {
 ...objWithMaybeUser.user,
 ip_address: '{{auto}}',
 };
 }
}
Loading