fix: Only set ip.address: '{{auto}}' when sendDefaultPii: true (#…

…1079)
getsentry · Feb 14, 2025 · 9175622 · 9175622
1 parent 0e13866
commit 9175622
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 2 deletions.
diff --git a/src/main/sdk.ts b/src/main/sdk.ts
@@ -182,8 +182,10 @@ export function init(userOptions: ElectronMainOptions): void {
 
   const client = new NodeClient(options);
 
-  client.on('postprocessEvent', addAutoIpAddressToUser);
-  client.on('beforeSendSession', addAutoIpAddressToSession);
+  if (options.sendDefaultPii === true) {
+    client.on('postprocessEvent', addAutoIpAddressToUser);
+    client.on('beforeSendSession', addAutoIpAddressToSession);
+  }
 
   scope.setClient(client);
   client.init();

diff --git a/test/e2e/test-apps/other/no-pii/events.ts b/test/e2e/test-apps/other/no-pii/events.ts
@@ -0,0 +1,12 @@
+import { Event } from '@sentry/core';
+import { expect } from 'vitest';
+
+import { TestServerEvent } from '../../../server';
+
+export async function execute(events: TestServerEvent<Event>[]): Promise<void> {
+  expect(events.length).greaterThanOrEqual(1);
+
+  for (const event of events) {
+    expect(event.data.user?.ip_address).toBeUndefined();
+  }
+}
diff --git a/test/e2e/test-apps/other/no-pii/package.json b/test/e2e/test-apps/other/no-pii/package.json
@@ -0,0 +1,8 @@
+{
+  "name": "javascript-no-pii",
+  "version": "1.0.0",
+  "main": "src/main.js",
+  "dependencies": {
+    "@sentry/electron": "5.6.0"
+  }
+}
diff --git a/test/e2e/test-apps/other/no-pii/recipe.yml b/test/e2e/test-apps/other/no-pii/recipe.yml
@@ -0,0 +1,3 @@
+description: No PII
+category: JavaScript
+command: yarn
diff --git a/test/e2e/test-apps/other/no-pii/src/index.html b/test/e2e/test-apps/other/no-pii/src/index.html
@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8" />
+  </head>
+  <body>
+    <script>
+      const { init } = require('@sentry/electron/renderer');
+
+      init({
+        debug: true,
+      });
+
+      setTimeout(() => {
+        throw new Error('Some renderer error');
+      }, 500);
+    </script>
+  </body>
+</html>
diff --git a/test/e2e/test-apps/other/no-pii/src/main.js b/test/e2e/test-apps/other/no-pii/src/main.js
@@ -0,0 +1,23 @@
+const path = require('path');
+
+const { app, BrowserWindow } = require('electron');
+const { init } = require('@sentry/electron/main');
+
+init({
+  dsn: '__DSN__',
+  debug: true,
+  integrations: (integrations) => integrations.filter((i) => i.name !== 'MainProcessSession'),
+  onFatalError: () => {},
+});
+
+app.on('ready', () => {
+  const mainWindow = new BrowserWindow({
+    show: false,
+    webPreferences: {
+      nodeIntegration: true,
+      contextIsolation: false,
+    },
+  });
+
+  mainWindow.loadFile(path.join(__dirname, 'index.html'));
+});