fix & tests

Author: mydea

dev-packages/browser-integration-tests/suites/feedback/attachTo/test.ts

@@ -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),

dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts

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

dev-packages/browser-integration-tests/suites/feedback/captureFeedbackCsp/test.ts

@@ -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__');

dev-packages/browser-integration-tests/suites/manual-client/browser-context/test.ts

@@ -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',

dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/subject.js

@@ -0,0 +1,6 @@
+Sentry.setUser({
+  id: 'foo',
+  ip_address: null,
+});
+
+Sentry.captureMessage('first_user');

dev-packages/browser-integration-tests/suites/public-api/setUser/ip_address_null/test.ts

@@ -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,
+  });
+});

dev-packages/browser-integration-tests/suites/public-api/setUser/unset_user/test.ts

@@ -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}}',
+  });
 });

dev-packages/browser-integration-tests/suites/public-api/setUser/update_user/test.ts

@@ -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}}',
   });
 });

dev-packages/browser-integration-tests/suites/public-api/withScope/nested_scopes/test.ts

@@ -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' });
   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' });
   expect(eventData[1].tags).toMatchObject({ foo: false });
 
   expect(eventData[2].message).toBe('inner');
   expect(eventData[2].user).toBeUndefined();
   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' });
   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' });
   expect(eventData[4].tags).toBeUndefined();
 });

packages/browser/src/client.ts

@@ -113,14 +113,22 @@ export class BrowserClient extends Client<BrowserClientOptions> {
   ): PromiseLike<Event | null> {
     event.platform = event.platform || 'javascript';
 
-    // By default, we want to infer the IP address, unless this is explicitly set to `null`
-    if (typeof event.user?.ip_address === 'undefined') {
-      event.user = {
-        ...event.user,
-        ip_address: '{{auto}}',
-      };
-    }
+    return super._prepareEvent(event, hint, currentScope, isolationScope).then(prepared => {
+      if (!prepared) {
+        return prepared;
+      }
+
+      // 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
+      if (prepared.user?.ip_address === undefined) {
+        prepared.user = {
+          ...prepared.user,
+          ip_address: '{{auto}}',
+        };
+      }
 
-    return super._prepareEvent(event, hint, currentScope, isolationScope);
+      return prepared;
+    });
   }
 }