Send user.ip_address = {{auto}} when sendDefaultPii is true

CHANGELOG.md

@@ -12,6 +12,7 @@
 * Fix: Initialize Logback after context refreshes (#1129)
 * Ref: Return NoOpTransaction instead of null (#1126)
 * Fix: Do not crash when passing null values to @Nullable methods, eg User and Scope
+* Enhancement: Send user.ip_address = {{ auto }} when sendDefaultPii is true
 * Fix: Resolving dashed properties from external configuration
 * Feat: Read `uncaught.handler.enabled` property from the external configuration 
 

sentry/src/main/java/io/sentry/MainEventProcessor.java

@@ -1,6 +1,7 @@
 package io.sentry;
 
 import io.sentry.protocol.SentryException;
+import io.sentry.protocol.User;
 import io.sentry.util.ApplyScopeUtils;
 import io.sentry.util.Objects;
 import java.util.ArrayList;
@@ -19,6 +20,12 @@ public final class MainEventProcessor implements EventProcessor {
    */
   private static final String DEFAULT_ENVIRONMENT = "production";
 
+  /**
+   * Default value for {@link User#getIpAddress()} set when event does not have user and ip address
+   * set and when {@link SentryOptions#isSendDefaultPii()} is set to true.
+   */
+  private static final String DEFAULT_IP_ADDRESS = "{{auto}}";
+
   private final @NotNull SentryOptions options;
   private final @NotNull SentryThreadFactory sentryThreadFactory;
   private final @NotNull SentryExceptionFactory sentryExceptionFactory;
@@ -123,5 +130,14 @@ private void processNonCachedEvent(final @NotNull SentryEvent event) {
         event.setThreads(sentryThreadFactory.getCurrentThread());
       }
     }
+    if (options.isSendDefaultPii()) {
+      if (event.getUser() == null) {
+        final User user = new User();
+        user.setIpAddress(DEFAULT_IP_ADDRESS);
+        event.setUser(user);
+      } else if (event.getUser().getIpAddress() == null) {
+        event.getUser().setIpAddress(DEFAULT_IP_ADDRESS);
+      }
+    }
   }
 }

sentry/src/test/java/io/sentry/MainEventProcessorTest.kt

@@ -4,6 +4,7 @@ import com.nhaarman.mockitokotlin2.mock
 import io.sentry.hints.ApplyScopeData
 import io.sentry.hints.Cached
 import io.sentry.protocol.SdkVersion
+import io.sentry.protocol.User
 import java.lang.RuntimeException
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -25,10 +26,13 @@ class MainEventProcessorTest {
                 version = "1.2.3"
             }
         }
-        fun getSut(attachThreads: Boolean = true, attachStackTrace: Boolean = true, environment: String? = "environment", tags: Map<String, String> = emptyMap()): MainEventProcessor {
+        fun getSut(attachThreads: Boolean = true, attachStackTrace: Boolean = true, environment: String? = "environment", tags: Map<String, String> = emptyMap(), sendDefaultPii: Boolean? = null): MainEventProcessor {
             sentryOptions.isAttachThreads = attachThreads
             sentryOptions.isAttachStacktrace = attachStackTrace
             sentryOptions.environment = environment
+            if (sendDefaultPii != null) {
+                sentryOptions.isSendDefaultPii = sendDefaultPii
+            }
             tags.forEach { sentryOptions.setTag(it.key, it.value) }
             return MainEventProcessor(sentryOptions)
         }
@@ -191,6 +195,36 @@ class MainEventProcessorTest {
         assertEquals("production", event.environment)
     }
 
+    @Test
+    fun `when event does not have ip address set and sendDefaultPii is set to true, sets "{{auto}}" as the ip address`() {
+        val sut = fixture.getSut(sendDefaultPii = true)
+        val event = SentryEvent()
+        sut.process(event, null)
+        assertNotNull(event.user)
+        assertEquals("{{auto}}", event.user.ipAddress)
+    }
+
+    @Test
+    fun `when event has ip address set and sendDefaultPii is set to true, keeps original ip address`() {
+        val sut = fixture.getSut(sendDefaultPii = true)
+        val event = SentryEvent()
+        event.user = User()
+        event.user.ipAddress = "192.168.0.1"
+        sut.process(event, null)
+        assertNotNull(event.user)
+        assertEquals("192.168.0.1", event.user.ipAddress)
+    }
+
+    @Test
+    fun `when event does not have ip address set and sendDefaultPii is set to false, does not set ip address`() {
+        val sut = fixture.getSut(sendDefaultPii = false)
+        val event = SentryEvent()
+        event.user = User()
+        sut.process(event, null)
+        assertNotNull(event.user)
+        assertNull(event.user.ipAddress)
+    }
+
     @Test
     fun `when event has environment set, does not overwrite environment`() {
         val sut = fixture.getSut(environment = null)