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

Part of getsentry/team-sdks#118

This is so far inferred at relay-side, which is pretty intransparent and
potentially confusing.
So instead, we want to explicitly set this in the SDK. If this is set to
`null` it will not be inferred (which is kind of intransparent too,
but...)

This is set for:

* error events (as `user.ip_address`)
* transactions (as `user.ip_address`)
* replay events (as `user.ip_address`)
* profiles (as `user.ip_address`)
* sessions (as `user.ip_address`)
* session aggregates: as `attr.ip_address: '{{auto}}'`
* standalone spans (not by default, but added to all standalone web
vitals spans we emit, as `'client.address': '{{auto}}'` attribute)

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/captureFeedbackAndReplay/hasSampling/test.ts

@@ -103,6 +103,9 @@ sentryTest('should capture feedback', async ({ forceFlushReplay, getLocalTestUrl
         '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/startSpan/standalone-mixed-transaction/test.ts

@@ -103,6 +103,9 @@ sentryTest(
         headers: expect.any(Object),
         url: expect.any(String),
       },
+      user: {
+        ip_address: '{{auto}}',
+      },
       sdk: expect.any(Object),
       spans: [
         {