Skip to content

ref(pymongo): Drop send_default_pii support #7714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pabloDeputter wants to merge 1 commit into
base: major/3.0
Choose a base branch
from
+17 −113
Open

ref(pymongo): Drop send_default_pii support #7714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions sentry_sdk/integrations/pymongo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@
import sentry_sdk
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.integrations import DidNotEnable, Integration, _check_minimum_version
from sentry_sdk.scope import should_send_default_pii
from sentry_sdk.traces import SpanStatus
from sentry_sdk.utils import (
capture_internal_exceptions,
has_data_collection_enabled,
parse_version,
)

Expand Down Expand Up @@ -141,10 +139,7 @@ def started(self, event: "CommandStartedEvent") -> None:
operation_name = event.command_name

command.pop("lsid", None)
if has_data_collection_enabled(client.options):
if not client.options["data_collection"]["database_query_data"]:
command = _strip_pii(command)
elif not should_send_default_pii():
if not client.options["data_collection"]["database_query_data"]:
command = _strip_pii(command)

query = json.dumps(command, default=str)
Expand Down
123 changes: 16 additions & 107 deletions tests/integrations/pymongo/test_pymongo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,45 +27,33 @@ def mongo_server():

DATA_COLLECTION_DATABASE_QUERY_DATA_USE_CASES = [
pytest.param(
{"data_collection": {"database_query_data": True}},
{"database_query_data": True},
True,
id="query_data_enabled",
),
pytest.param(
{"data_collection": {"database_query_data": False}},
{"database_query_data": False},
False,
id="query_data_disabled",
),
pytest.param(
{"data_collection": {}},
{},
True,
id="query_data_default",
),
pytest.param(
{
"send_default_pii": False,
"data_collection": {"database_query_data": True},
},
True,
id="data_collection_overrides_pii_off",
),
pytest.param(
{
"send_default_pii": True,
"data_collection": {"database_query_data": False},
},
False,
id="data_collection_overrides_pii_on",
),
]


@pytest.mark.parametrize("with_pii", [False, True])
def test_segment(sentry_init, capture_items, mongo_server, with_pii):
@pytest.mark.parametrize(
"data_collection,expect_query_values", DATA_COLLECTION_DATABASE_QUERY_DATA_USE_CASES
)
def test_segment(
sentry_init, capture_items, mongo_server, data_collection, expect_query_values
):
sentry_init(
integrations=[PyMongoIntegration()],
traces_sample_rate=1.0,
send_default_pii=with_pii,
data_collection=data_collection,
)
items = capture_items("span")

Expand Down Expand Up @@ -115,7 +103,7 @@ def test_segment(sentry_init, capture_items, mongo_server, with_pii):
for span in find, insert_success, insert_fail:
assert span["attributes"][SPANDATA.DB_QUERY_TEXT] == span["name"]

if with_pii:
if expect_query_values:
assert "1" in find["name"]
assert "2" in insert_success["name"]
assert "3" in insert_fail["name"] and "4" in insert_fail["name"]
Expand All @@ -130,61 +118,15 @@ def test_segment(sentry_init, capture_items, mongo_server, with_pii):


@pytest.mark.parametrize(
"init_kwargs,expect_query_values", DATA_COLLECTION_DATABASE_QUERY_DATA_USE_CASES
"data_collection,expect_query_values", DATA_COLLECTION_DATABASE_QUERY_DATA_USE_CASES
)
def test_segment_with_data_collection(
sentry_init, capture_items, mongo_server, init_kwargs, expect_query_values
def test_breadcrumbs(
sentry_init, capture_items, mongo_server, data_collection, expect_query_values
):
sentry_init(
integrations=[PyMongoIntegration()],
traces_sample_rate=1.0,
**init_kwargs,
)
items = capture_items("span")

connection = MongoClient(mongo_server.uri)

with sentry_sdk.start_span(name="test_segment"):
list(
connection["test_db"]["test_collection"].find({"foobar": 1})
) # force query execution
connection["test_db"]["test_collection"].insert_one({"foo": 2})
try:
connection["test_db"]["erroneous"].insert_many([{"bar": 3}, {"baz": 4}])
pytest.fail("Request should raise")
except Exception:
pass
sentry_sdk.flush()

spans = [item.payload for item in items]
assert len(spans) == 4

(find, insert_success, insert_fail, segment) = spans
assert segment["name"] == "test_segment"

assert find["name"].startswith('{"find')
assert insert_success["name"].startswith('{"insert')
assert insert_fail["name"].startswith('{"insert')

for span in find, insert_success, insert_fail:
assert span["attributes"][SPANDATA.DB_QUERY_TEXT] == span["name"]

if expect_query_values:
assert "1" in find["name"]
assert "2" in insert_success["name"]
assert "3" in insert_fail["name"] and "4" in insert_fail["name"]
else:
assert "1" not in find["name"]
assert "2" not in insert_success["name"]
assert "3" not in insert_fail["name"] and "4" not in insert_fail["name"]


@pytest.mark.parametrize("with_pii", [False, True])
def test_breadcrumbs(sentry_init, capture_items, mongo_server, with_pii):
sentry_init(
integrations=[PyMongoIntegration()],
traces_sample_rate=1.0,
send_default_pii=with_pii,
data_collection=data_collection,
)
items = capture_items("event")

Expand All @@ -200,7 +142,7 @@ def test_breadcrumbs(sentry_init, capture_items, mongo_server, with_pii):

assert crumb["category"] == "query"
assert crumb["message"].startswith('{"find')
if with_pii:
if expect_query_values:
assert "1" in crumb["message"]
else:
assert "1" not in crumb["message"]
Expand All @@ -219,39 +161,6 @@ def test_breadcrumbs(sentry_init, capture_items, mongo_server, with_pii):
assert data[SPANDATA.SERVER_PORT] == mongo_server.port


@pytest.mark.parametrize(
"init_kwargs,expect_query_values", DATA_COLLECTION_DATABASE_QUERY_DATA_USE_CASES
)
def test_breadcrumbs_with_data_collection(
sentry_init, capture_items, mongo_server, init_kwargs, expect_query_values
):
sentry_init(
integrations=[PyMongoIntegration()],
traces_sample_rate=1.0,
**init_kwargs,
)
items = capture_items("event")

connection = MongoClient(mongo_server.uri)

list(
connection["test_db"]["test_collection"].find({"foobar": 1})
) # force query execution
capture_message("hi")

event = items[0].payload
(crumb,) = event["breadcrumbs"]["values"]

assert crumb["category"] == "query"
assert crumb["message"].startswith('{"find')
if expect_query_values:
assert "1" in crumb["message"]
else:
assert "1" not in crumb["message"]
assert crumb["type"] == "db"
assert crumb["data"]["db.query.text"] == crumb["message"]


@pytest.mark.parametrize(
"testcase",
[
Expand Down
Loading