Drop scrubbed user IP addresses

Author: juliosuas

sentry_sdk/scrubber.py

@@ -66,7 +66,6 @@ def __init__(
         recursive: bool = False,
         send_default_pii: bool = False,
         pii_denylist: "Optional[List[str]]" = None,
-        remove_user_ip_address: bool = False,
     ) -> None:
         """
         A scrubber that goes through the event payload and removes sensitive data configured through denylists.
@@ -75,7 +74,6 @@ def __init__(
         :param recursive: Whether to scrub the event payload recursively, default False.
         :param send_default_pii: Whether pii is sending is on, pii fields are not scrubbed.
         :param pii_denylist: The denylist to use for scrubbing when pii is not sent, defaults to DEFAULT_PII_DENYLIST.
-        :param remove_user_ip_address: Whether to remove ``user.ip_address`` instead of replacing it with ``[Filtered]``.
         """
         self.denylist = DEFAULT_DENYLIST.copy() if denylist is None else denylist
 
@@ -87,7 +85,6 @@ def __init__(
 
         self.denylist = [x.lower() for x in self.denylist]
         self.recursive = recursive
-        self.remove_user_ip_address = remove_user_ip_address
 
     def scrub_list(self, lst: object) -> None:
         """
@@ -141,11 +138,7 @@ def scrub_user(self, event: "Event") -> None:
         with capture_internal_exceptions():
             if "user" in event:
                 user = event["user"]
-                if (
-                    "ip_address" in self.denylist
-                    and self.remove_user_ip_address
-                    and isinstance(user, dict)
-                ):
+                if "ip_address" in self.denylist and isinstance(user, dict):
                     user.pop("ip_address", None)
                 self.scrub_dict(user)
 

tests/new_scopes_compat/test_new_scopes_compat_event.py

@@ -102,7 +102,6 @@ def create_expected_error_event(trx, span):
             "user": {
                 "id": "123",
                 "email": "[email protected]",
-                "ip_address": "[Filtered]",
             },
             "transaction": "test_transaction",
             "transaction_info": {"source": "custom"},
@@ -137,7 +136,6 @@ def create_expected_error_event(trx, span):
             },
             "platform": "python",
             "_meta": {
-                "user": {"ip_address": {"": {"rem": [["!config", "s"]]}}},
                 "extra": {
                     "should_be_removed_by_event_scrubber": {
                         "": {"rem": [["!config", "s"]]}
@@ -207,7 +205,6 @@ def create_expected_transaction_event(trx, span):
             "user": {
                 "id": "123",
                 "email": "[email protected]",
-                "ip_address": "[Filtered]",
             },
             "extra": {
                 "extra1": "extra1_value",
@@ -226,7 +223,6 @@ def create_expected_transaction_event(trx, span):
             },
             "platform": "python",
             "_meta": {
-                "user": {"ip_address": {"": {"rem": [["!config", "s"]]}}},
                 "extra": {
                     "should_be_removed_by_event_scrubber": {
                         "": {"rem": [["!config", "s"]]}

tests/test_scrubber.py

@@ -89,7 +89,7 @@ def test_ip_address_not_scrubbed_when_pii_enabled(sentry_init, capture_events):
     }
 
 
-def test_user_ip_address_scrubbed_when_pii_disabled(sentry_init, capture_events):
+def test_user_ip_address_removed_when_pii_disabled(sentry_init, capture_events):
     sentry_init()
     events = capture_events()
 
@@ -103,12 +103,12 @@ def test_user_ip_address_scrubbed_when_pii_disabled(sentry_init, capture_events)
 
     (event,) = events
 
-    assert event["user"] == {"id": "42", "ip_address": "[Filtered]"}
-    assert event["_meta"]["user"] == {"ip_address": {"": {"rem": [["!config", "s"]]}}}
+    assert event["user"] == {"id": "42"}
+    assert "user" not in event.get("_meta", {})
 
 
-def test_user_ip_address_removed_when_configured(sentry_init, capture_events):
-    sentry_init(event_scrubber=EventScrubber(remove_user_ip_address=True))
+def test_user_ip_address_not_removed_when_pii_enabled(sentry_init, capture_events):
+    sentry_init(send_default_pii=True)
     events = capture_events()
 
     try:
@@ -121,7 +121,7 @@ def test_user_ip_address_removed_when_configured(sentry_init, capture_events):
 
     (event,) = events
 
-    assert event["user"] == {"id": "42"}
+    assert event["user"] == {"id": "42", "ip_address": "127.0.0.1"}
     assert "user" not in event.get("_meta", {})