{{ message }}
Repository navigation
Expand file tree
/
Copy pathtest_data_collection.py
More file actions
463 lines (422 loc) · 15.7 KB
/
Copy pathtest_data_collection.py
File metadata and controls
463 lines (422 loc) · 15.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
import warnings
import pytest
import sentry_sdk
from sentry_sdk.data_collection import _ALL_HTTP_BODY_TYPES
from sentry_sdk.utils import has_data_collection_enabled
def test_kvcb_invalid_mode(sentry_init):
with pytest.raises(ValueError):
sentry_init(data_collection={"cookies": {"mode": "nope"}}) # type: ignore Purposely ignoring to test invalid option
def test_stack_frame_variables_invalid_mode(sentry_init):
with pytest.raises(ValueError):
sentry_init(data_collection={"stack_frame_variables": {"mode": "nope"}})
@pytest.mark.parametrize(
"value",
["3", -1, [1], 2.5],
ids=[
"frame_context_lines_string",
"frame_context_lines_negative",
"frame_context_lines_list",
"frame_context_lines_float",
],
)
def test_frame_context_lines_invalid_value(sentry_init, value):
with pytest.raises(ValueError):
sentry_init(data_collection={"frame_context_lines": value})
def test_kvcb_from_dict_defaults_mode(sentry_init):
sentry_init(data_collection={"cookies": {"mode": "denylist", "terms": ["x"]}})
client = sentry_sdk.get_client()
assert client.options["data_collection"]["cookies"] == {
"mode": "denylist",
"terms": ["x"],
}
def test_http_headers_collection_defaults(sentry_init):
default_terms = ["forwarded", "-ip", "remote-", "via", "-user"]
sentry_init(data_collection={"http_headers": {}}) # type: ignore Purposely ignoring to test invalid option
client = sentry_sdk.get_client()
assert client.options["data_collection"]["http_headers"]["request"] == {
"mode": "denylist"
}
sentry_init(data_collection={"http_headers": "off"}) # type: ignore Purposely ignoring to test invalid option
client = sentry_sdk.get_client()
assert client.options["data_collection"]["http_headers"]["request"] == {
"mode": "denylist"
}
sentry_init()
client = sentry_sdk.get_client()
assert client.options["data_collection"]["http_headers"]["request"] == {
"mode": "denylist",
"terms": default_terms,
}
def test_http_headers_use_default_in_setting_with_missing_config(sentry_init):
sentry_init(
data_collection={
"http_headers": {
"request": {"mode": "allowlist", "terms": ["x-id"]},
}
}
)
client = sentry_sdk.get_client()
assert client.options["data_collection"]["http_headers"]["request"] == {
"mode": "allowlist",
"terms": ["x-id"],
}
def _initialize_client_with_config(sentry_init, **options):
sentry_init(**options)
return sentry_sdk.get_client().options["data_collection"]
def _get(dc, path):
obj = dc
for part in path.split("."):
obj = obj[part]
return obj
@pytest.mark.parametrize(
"options,expected",
[
pytest.param(
{},
{
"user_info": False,
"gen_ai.inputs": False,
"gen_ai.outputs": False,
"cookies.mode": "denylist",
"url_query_params.mode": "denylist",
"http_headers.request.mode": "denylist",
"http_bodies": _ALL_HTTP_BODY_TYPES,
"queues": False,
"frame_context_lines": 5,
},
id="no_options_collects_no_pii",
),
pytest.param(
{"send_default_pii": True},
{
"user_info": True,
"gen_ai.inputs": True,
"gen_ai.outputs": True,
"cookies.mode": "denylist",
"url_query_params.mode": "denylist",
"queues": True,
},
id="send_default_pii_true_collects_pii",
),
pytest.param(
{"send_default_pii": False},
{"user_info": False, "cookies.mode": "denylist", "queues": False},
id="send_default_pii_false_collects_no_pii",
),
pytest.param(
{"data_collection": {}},
{
"user_info": True,
"gen_ai.inputs": True,
"gen_ai.outputs": True,
"cookies.mode": "denylist",
"url_query_params.mode": "denylist",
"http_bodies": _ALL_HTTP_BODY_TYPES,
"queues": True,
},
id="explicit_data_collection_uses_spec_defaults",
),
pytest.param(
{"data_collection": {"user_info": False, "http_bodies": []}},
{
"user_info": False,
"http_bodies": [],
"gen_ai.inputs": True,
"cookies.mode": "denylist",
},
id="explicit_partial_fills_omitted_with_spec_defaults",
),
pytest.param(
{
"data_collection": {},
"include_local_variables": False,
"include_source_context": False,
},
{"stack_frame_variables": True, "frame_context_lines": 5},
id="explicit_data_collection_ignores_legacy_include_local_variables",
),
pytest.param(
{
"data_collection": {
"cookies": {"mode": "off"},
"url_query_params": {"mode": "allowlist", "terms": ["page"]},
"http_headers": {"request": {"mode": "off"}},
"gen_ai": {"inputs": False, "outputs": True},
}
},
{
"cookies.mode": "off",
"url_query_params.mode": "allowlist",
"url_query_params.terms": ["page"],
"http_headers.request.mode": "off",
"gen_ai.inputs": False,
"gen_ai.outputs": True,
},
id="accepts_dict_with_nested_dicts",
),
pytest.param(
{
"data_collection": {
"cookies": None,
"http_headers": None,
"url_query_params": None,
"graphql": None,
"gen_ai": None,
}
},
{
"cookies.mode": "denylist",
"http_headers.request.mode": "denylist",
"url_query_params.mode": "denylist",
"graphql.document": True,
"graphql.variables": True,
"gen_ai.inputs": True,
"gen_ai.outputs": True,
},
id="none_values_fall_back_to_spec_defaults",
),
pytest.param(
{"data_collection": {}},
{
"graphql.document": True,
"graphql.variables": True,
"database_query_data": True,
},
id="explicit_graphql_database_defaults",
),
pytest.param(
{"send_default_pii": False},
{
"graphql.document": False,
"graphql.variables": False,
"database_query_data": False,
"queues": False,
},
id="legacy_pii_off_gates_graphql_database_and_queues",
),
pytest.param(
{"send_default_pii": True},
{
"graphql.document": True,
"graphql.variables": True,
"database_query_data": True,
"queues": True,
},
id="legacy_pii_on_collects_graphql_database_and_queues",
),
pytest.param(
{"data_collection": {"graphql": {"variables": False}}},
{"graphql.document": True, "graphql.variables": False},
id="explicit_partial_graphql_fills_omitted",
),
pytest.param(
{"data_collection": {"frame_context_lines": True}},
{"frame_context_lines": 5},
id="frame_context_lines_bool_fallback_true",
),
pytest.param(
{"data_collection": {"frame_context_lines": False}},
{"frame_context_lines": 0},
id="frame_context_lines_bool_fallback_false",
),
pytest.param(
{"data_collection": {"frame_context_lines": 3}},
{"frame_context_lines": 3},
id="frame_context_lines_bool_fallback_3",
),
pytest.param(
{"data_collection": {"frame_context_lines": 0}},
{"frame_context_lines": 0},
id="frame_context_lines_bool_fallback_0",
),
pytest.param(
{"data_collection": {"stack_frame_variables": True}},
{"stack_frame_variables": True},
id="stack_frame_variables_explicit_true",
),
pytest.param(
{"data_collection": {"stack_frame_variables": False}},
{"stack_frame_variables": False},
id="stack_frame_variables_explicit_false",
),
pytest.param(
{
"data_collection": {
"stack_frame_variables": {
"mode": "allowlist",
"terms": ["order_id"],
}
}
},
{
"stack_frame_variables": {
"mode": "allowlist",
"terms": ["order_id"],
}
},
id="stack_frame_variables_allowlist_dict",
),
pytest.param(
{"data_collection": {"stack_frame_variables": {"terms": ["order_id"]}}},
{
"stack_frame_variables": {
"mode": "denylist",
"terms": ["order_id"],
}
},
id="stack_frame_variables_dict_defaults_mode_to_denylist",
),
pytest.param(
{"data_collection": {"stack_frame_variables": {"mode": "off"}}},
{"stack_frame_variables": {"mode": "off"}},
id="stack_frame_variables_off_dict_omits_terms",
),
pytest.param(
{"data_collection": {"stack_frame_variables": "yes"}},
{"stack_frame_variables": True},
id="stack_frame_variables_non_bool_truthy_coerces_to_true",
),
pytest.param(
{"data_collection": {"stack_frame_variables": ""}},
{"stack_frame_variables": False},
id="stack_frame_variables_non_bool_falsy_coerces_to_false",
),
pytest.param(
{"data_collection": {"frame_context_lines": None}},
{"frame_context_lines": 5},
id="frame_context_lines_none_falls_back_to_spec_default",
),
pytest.param(
{"include_local_variables": False, "include_source_context": False},
{"stack_frame_variables": False, "frame_context_lines": 0},
id="legacy_include_local_variables_off_disables_stack_frame_variables",
),
pytest.param(
{"include_local_variables": True, "include_source_context": True},
{"stack_frame_variables": True, "frame_context_lines": 5},
id="legacy_include_local_variables_on_enables_stack_frame_variables",
),
],
)
def test_initialize_client_data_collection(sentry_init, options, expected):
dc = _initialize_client_with_config(sentry_init, **options)
for path, value in expected.items():
assert _get(dc, path) == value, f"{path} != {value!r}"
def test_initialize_client_data_collection_overrides_send_default_pii_and_warns(
sentry_init,
):
with warnings.catch_warnings(record=True) as caught:
warnings.simplefilter("always")
dc = _initialize_client_with_config(
sentry_init,
send_default_pii=True,
data_collection={"user_info": False},
)
assert dc["user_info"] is False # data_collection wins
assert any(issubclass(w.category, DeprecationWarning) for w in caught)
@pytest.mark.parametrize(
"init_kwargs,expected",
[
pytest.param(
{},
{
"user_info": False,
"provided_by_user": False,
"should_send_default_pii": False,
},
id="defaults_to_no_pii",
),
pytest.param(
{"send_default_pii": True},
{"user_info": True, "provided_by_user": False},
id="send_default_pii_enables_user_info",
),
pytest.param(
{"data_collection": {"user_info": False}},
{"user_info": False, "provided_by_user": True},
id="explicit_data_collection_overrides_user_info",
),
pytest.param(
{"spotlight": True},
{"provided_by_user": False, "user_info": True},
id="dsnless_spotlight_rederives_data_collection",
),
pytest.param(
{
"spotlight": True,
"data_collection": {"user_info": False},
},
{"provided_by_user": True, "user_info": False},
id="dsnless_spotlight_respects_explicit_data_collection",
),
],
)
def test_client_data_collection_settings(sentry_init, init_kwargs, expected):
sentry_init(**init_kwargs)
client = sentry_sdk.get_client()
for key, value in expected.items():
if key == "should_send_default_pii":
assert client.should_send_default_pii() is value
else:
assert client.options["data_collection"][key] is value
def test_has_data_collection_enabled_gates_on_user_provided_config():
assert has_data_collection_enabled(None) is False
assert has_data_collection_enabled({}) is False
# An unset/None option is "not provided by the user".
assert has_data_collection_enabled({"data_collection": None}) is False
# Every SDK call site passes post-resolution client options, where
# `data_collection` is always a fully-resolved dict carrying
# `provided_by_user`. That flag -- not the key's presence -- is the gate.
assert (
has_data_collection_enabled({"data_collection": {"provided_by_user": False}})
is False
)
assert (
has_data_collection_enabled({"data_collection": {"provided_by_user": True}})
is True
)
@pytest.mark.parametrize(
"init_kwargs, expected",
[
pytest.param({}, False, id="no_config"),
pytest.param({"send_default_pii": True}, False, id="send_default_pii_true"),
pytest.param({"send_default_pii": False}, False, id="send_default_pii_false"),
pytest.param({"data_collection": {}}, True, id="empty_data_collection"),
pytest.param(
{"data_collection": {"user_info": False}},
True,
id="partial_data_collection",
),
],
)
def test_has_data_collection_enabled_after_resolution(
sentry_init, init_kwargs, expected
):
sentry_init(**init_kwargs)
assert has_data_collection_enabled(sentry_sdk.get_client().options) is expected
def test_no_data_collection_values_fall_back_to_send_default_pii_configuration(
sentry_init,
):
sentry_init(send_default_pii=True)
client = sentry_sdk.get_client()
dc = client.options["data_collection"]
assert dc["provided_by_user"] is False
assert dc["user_info"] is True
assert has_data_collection_enabled(client.options) is False
def test_data_collection_via_experiments(sentry_init):
sentry_init(
_experiments={"data_collection": {"user_info": True}},
)
dc = sentry_sdk.get_client().options["data_collection"]
assert dc is not None
assert dc["provided_by_user"] is True
assert dc["user_info"] is True
def test_top_level_takes_precedence_over_experiments(sentry_init):
sentry_init(
data_collection={"user_info": False},
_experiments={"data_collection": {"user_info": True}},
)
dc = sentry_sdk.get_client().options["data_collection"]
assert dc is not None
assert dc["provided_by_user"] is True
assert dc["user_info"] is False
You can’t perform that action at this time.