From 8fe5bb4b1946874f61bfc09dcce327e20bb24519 Mon Sep 17 00:00:00 2001 From: Burak Yigit Kaya Date: Thu, 21 Nov 2024 15:20:56 +0000 Subject: [PATCH] feat: Send PII to Spotlight when no DSN is set (#3804) * feat: Send PII to Spotlight when no DSN is set Quick fix for getsentry/spotlight#543 until we implement a global scrubber that only scrubs events sent to the clound thorugh the DSN. * add tests fix bugs * Make scrubber initialization more explicit * Refactored to not change the default value of send_default_pii * Add test to show that there is now no way to opt out of sending PII to spotlight. * Revert "Refactored to not change the default value of send_default_pii" This reverts commit 15cf625859852b0a51c70f8126ad92af6d947d48. * Revert "Add test to show that there is now no way to opt out of sending PII to spotlight." This reverts commit de7f39818af78a1012a8fcea6bbd80f20c6b0eb3. --------- Co-authored-by: Anton Pirker --- sentry_sdk/client.py | 12 ++++++++++-- sentry_sdk/consts.py | 3 ++- tests/test_scope.py | 18 ++++++++++++++++++ 3 files changed, 30 insertions(+), 3 deletions(-) diff --git a/sentry_sdk/client.py b/sentry_sdk/client.py index b1e7868031..db2cc19110 100644 --- a/sentry_sdk/client.py +++ b/sentry_sdk/client.py @@ -128,7 +128,11 @@ def _get_options(*args, **kwargs): rv["traces_sample_rate"] = 1.0 if rv["event_scrubber"] is None: - rv["event_scrubber"] = EventScrubber(send_default_pii=rv["send_default_pii"]) + rv["event_scrubber"] = EventScrubber( + send_default_pii=( + False if rv["send_default_pii"] is None else rv["send_default_pii"] + ) + ) if rv["socket_options"] and not isinstance(rv["socket_options"], list): logger.warning( @@ -451,7 +455,11 @@ def should_send_default_pii(self): Returns whether the client should send default PII (Personally Identifiable Information) data to Sentry. """ - return self.options.get("send_default_pii", False) + result = self.options.get("send_default_pii") + if result is None: + result = not self.options["dsn"] and self.spotlight is not None + + return result @property def dsn(self): diff --git a/sentry_sdk/consts.py b/sentry_sdk/consts.py index ae32294d05..bb2a73337e 100644 --- a/sentry_sdk/consts.py +++ b/sentry_sdk/consts.py @@ -489,6 +489,7 @@ class OP: # This type exists to trick mypy and PyCharm into thinking `init` and `Client` # take these arguments (even though they take opaque **kwargs) class ClientConstructor: + def __init__( self, dsn=None, # type: Optional[str] @@ -506,7 +507,7 @@ def __init__( transport=None, # type: Optional[Union[sentry_sdk.transport.Transport, Type[sentry_sdk.transport.Transport], Callable[[Event], None]]] transport_queue_size=DEFAULT_QUEUE_SIZE, # type: int sample_rate=1.0, # type: float - send_default_pii=False, # type: bool + send_default_pii=None, # type: Optional[bool] http_proxy=None, # type: Optional[str] https_proxy=None, # type: Optional[str] ignore_errors=[], # type: Sequence[Union[type, str]] # noqa: B006 diff --git a/tests/test_scope.py b/tests/test_scope.py index 0dfa155d11..374a354446 100644 --- a/tests/test_scope.py +++ b/tests/test_scope.py @@ -811,6 +811,24 @@ def test_should_send_default_pii_false(sentry_init): assert should_send_default_pii() is False +def test_should_send_default_pii_default_false(sentry_init): + sentry_init() + + assert should_send_default_pii() is False + + +def test_should_send_default_pii_false_with_dsn_and_spotlight(sentry_init): + sentry_init(dsn="http://key@localhost/1", spotlight=True) + + assert should_send_default_pii() is False + + +def test_should_send_default_pii_true_without_dsn_and_spotlight(sentry_init): + sentry_init(spotlight=True) + + assert should_send_default_pii() is True + + def test_set_tags(): scope = Scope() scope.set_tags({"tag1": "value1", "tag2": "value2"})