Add tests

dev-packages/browser-integration-tests/suites/public-api/sendDefaultPii/errors/subject.js

@@ -0,0 +1 @@
+Sentry.captureException(new Error('woot'));

dev-packages/browser-integration-tests/suites/public-api/sendDefaultPii/errors/test.ts

@@ -0,0 +1,11 @@
+import { expect } from '@playwright/test';
+import type { Event } from '@sentry/core';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';
+
+sentryTest('should default user to {{auto}} on errors when sendDefaultPii: true', async ({ getLocalTestUrl, page }) => {
+  const url = await getLocalTestUrl({ testDir: __dirname });
+  const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);
+  expect(eventData.user?.ip_address).toBe('{{auto}}');
+});

dev-packages/browser-integration-tests/suites/public-api/sendDefaultPii/init.js

@@ -0,0 +1,9 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  tracesSampleRate: 1,
+  sendDefaultPii: true,
+});

dev-packages/browser-integration-tests/suites/public-api/sendDefaultPii/performance/subject.js

@@ -0,0 +1 @@
+Sentry.startSpan({ name: 'woot' }, () => undefined);

dev-packages/browser-integration-tests/suites/public-api/sendDefaultPii/performance/test.ts

@@ -0,0 +1,21 @@
+import { expect } from '@playwright/test';
+import { sentryTest } from '../../../../utils/fixtures';
+import {
+  envelopeRequestParser,
+  shouldSkipTracingTest,
+  waitForTransactionRequestOnUrl,
+} from '../../../../utils/helpers';
+
+sentryTest(
+  'should default user to {{auto}} on transactions when sendDefaultPii: true',
+  async ({ getLocalTestUrl, page }) => {
+    if (shouldSkipTracingTest()) {
+      sentryTest.skip();
+    }
+
+    const url = await getLocalTestUrl({ testDir: __dirname });
+    const req = await waitForTransactionRequestOnUrl(page, url);
+    const transaction = envelopeRequestParser(req);
+    expect(transaction.user?.ip_address).toBe('{{auto}}');
+  },
+);

dev-packages/browser-integration-tests/suites/public-api/sendDefaultPii/replay/init.js

@@ -0,0 +1,20 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+window.Replay = Sentry.replayIntegration({
+  flushMinDelay: 200,
+  flushMaxDelay: 200,
+  minReplayDuration: 0,
+  useCompression: false,
+  blockAllMedia: false,
+  unmask: ['.sentry-unmask, [data-sentry-unmask]'],
+});
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  replaysSessionSampleRate: 1.0,
+  replaysOnErrorSampleRate: 0.0,
+  integrations: [window.Replay],
+  sendDefaultPii: true,
+});

dev-packages/browser-integration-tests/suites/public-api/sendDefaultPii/replay/test.ts

@@ -0,0 +1,24 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getReplayEvent, shouldSkipReplayTest, waitForReplayRequest } from '../../../../utils/replayHelpers';
+
+sentryTest(
+  'replay recording should contain default performance spans',
+  async ({ getLocalTestUrl, page, browserName }) => {
+    // We only test this against the NPM package and replay bundles
+    // and only on chromium as most performance entries are only available in chromium
+    if (shouldSkipReplayTest() || browserName !== 'chromium') {
+      sentryTest.skip();
+    }
+
+    const reqPromise0 = waitForReplayRequest(page, 0);
+
+    const url = await getLocalTestUrl({ testDir: __dirname });
+
+    await page.goto(url);
+    const replayEvent = getReplayEvent(await reqPromise0);
+
+    expect(replayEvent.user?.ip_address).toBe('{{auto}}');
+  },
+);

dev-packages/browser-integration-tests/suites/public-api/sendDefaultPii/sessions/init.js

@@ -0,0 +1,9 @@
+import * as Sentry from '@sentry/browser';
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  sendDefaultPii: true,
+  release: '1.0',
+});

dev-packages/browser-integration-tests/suites/public-api/sendDefaultPii/sessions/test.ts

@@ -0,0 +1,13 @@
+import { expect } from '@playwright/test';
+
+import { sentryTest } from '../../../../utils/fixtures';
+import { getFirstSentryEnvelopeRequest } from '../../../../utils/helpers';
+
+sentryTest(
+  'should default user to {{auto}} on sessions when sendDefaultPii: true',
+  async ({ getLocalTestUrl, page }) => {
+    const url = await getLocalTestUrl({ testDir: __dirname });
+    const session = await getFirstSentryEnvelopeRequest(page, url);
+    expect((session as any).attrs.ip_address).toBe('{{auto}}');
+  },
+);

packages/browser/src/client.ts

@@ -86,7 +86,12 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 
     if (this._options.sendDefaultPii) {
       this.on('postprocessEvent', event => {
-        addAutoIpAddressToUser(event);
+        if (event.user?.ip_address === undefined) {
+          event.user = {
+            ...event.user,
+            ip_address: '{{auto}}',
+          };
+        }
       });
 
       this.on('beforeSendSession', session => {
@@ -98,7 +103,9 @@ export class BrowserClient extends Client<BrowserClientOptions> {
             };
           }
         } else {
-          addAutoIpAddressToUser(session);
+          if (session.ipAddress === undefined) {
+            session.ipAddress = '{{auto}}';
+          }
         }
       });
     }
@@ -136,15 +143,3 @@ export class BrowserClient extends Client<BrowserClientOptions> {
     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}}',
-    };
-  }
-}