chore(browser): Export ipAddress helpers for use in other SDKs

Author: krystofwoldrich

packages/browser/src/client.ts

@@ -8,12 +8,12 @@ import type {
   ParameterizedString,
   Scope,
   SeverityLevel,
-  User,
 } from '@sentry/core';
 import { Client, applySdkMetadata, getSDKSource } from '@sentry/core';
 import { eventFromException, eventFromMessage } from './eventbuilder';
 import { WINDOW } from './helpers';
 import type { BrowserTransportOptions } from './transports/types';
+import { addAutoIpAddressToSession, addAutoIpAddressToUser } from './utils/ipAddress';
 
 /**
  * Configuration options for the Sentry Browser SDK.
@@ -84,22 +84,8 @@ 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);
-      }
-    });
+    this.on('postprocessEvent', addAutoIpAddressToUser);
+    this.on('beforeSendSession', addAutoIpAddressToSession);
   }
 
   /**
@@ -134,15 +120,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}}',
-    };
-  }
-}

packages/browser/src/exports.ts

@@ -99,3 +99,4 @@ export { linkedErrorsIntegration } from './integrations/linkederrors';
 export { browserApiErrorsIntegration } from './integrations/browserapierrors';
 
 export { lazyLoadIntegration } from './utils/lazyLoadIntegration';
+export { addAutoIpAddressToSession, addAutoIpAddressToUser } from './utils/ipAddress';

packages/browser/src/utils/ipAddress.ts

@@ -0,0 +1,34 @@
+import type { Session, SessionAggregates, User } from '@sentry/core';
+
+/**
+ * @internal
+ * 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
+ */
+export function addAutoIpAddressToUser(objWithMaybeUser: { user?: User | null }): void {
+  if (objWithMaybeUser.user?.ip_address === undefined) {
+    objWithMaybeUser.user = {
+      ...objWithMaybeUser.user,
+      ip_address: '{{auto}}',
+    };
+  }
+}
+
+/**
+ * @internal
+ * Adds the `ip_address` attribute to the session if it is not explicitly set to `null` or a value.
+ * @param session The session to add the `ip_address` attribute to.
+ */
+export function addAutoIpAddressToSession(session: Session | SessionAggregates): void {
+  if ('aggregates' in session) {
+    if (session.attrs?.['ip_address'] === undefined) {
+      session.attrs = {
+        ...session.attrs,
+        ip_address: '{{auto}}',
+      };
+    }
+  } else {
+    addAutoIpAddressToUser(session);
+  }
+}