forked from getsentry/sentry-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_wsgi.py
More file actions
890 lines (724 loc) · 26.5 KB
/
Copy pathtest_wsgi.py
File metadata and controls
890 lines (724 loc) · 26.5 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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
from collections import Counter
from unittest import mock
import pytest
from werkzeug.test import Client
import sentry_sdk
from sentry_sdk import capture_message
from sentry_sdk.integrations.wsgi import (
SentryWsgiMiddleware,
_ScopedResponse,
get_request_url,
)
@pytest.fixture
def crashing_app():
def app(environ, start_response):
1 / 0
return app
class IterableApp:
def __init__(self, iterable):
self.iterable = iterable
def __call__(self, environ, start_response):
return self.iterable
class ExitingIterable:
def __init__(self, exc_func):
self._exc_func = exc_func
def __iter__(self):
return self
def __next__(self):
raise self._exc_func()
def next(self):
return type(self).__next__(self)
def test_basic(sentry_init, crashing_app, capture_events):
sentry_init(send_default_pii=True)
app = SentryWsgiMiddleware(crashing_app)
client = Client(app)
events = capture_events()
with pytest.raises(ZeroDivisionError):
client.get("/")
(event,) = events
assert event["transaction"] == "generic WSGI request"
assert event["request"] == {
"env": {"SERVER_NAME": "localhost", "SERVER_PORT": "80"},
"headers": {"Host": "localhost"},
"method": "GET",
"query_string": "",
"url": "http://localhost/",
}
@pytest.mark.parametrize("path_info", ("bark/", "/bark/"))
@pytest.mark.parametrize("script_name", ("woof/woof", "woof/woof/"))
def test_script_name_is_respected(
sentry_init, crashing_app, capture_events, script_name, path_info
):
sentry_init(send_default_pii=True)
app = SentryWsgiMiddleware(crashing_app)
client = Client(app)
events = capture_events()
with pytest.raises(ZeroDivisionError):
# setting url with PATH_INFO: bark/, HTTP_HOST: dogs.are.great and SCRIPT_NAME: woof/woof/
client.get(path_info, f"https://dogs.are.great/{script_name}") # noqa: E231
(event,) = events
assert event["request"]["url"] == "https://dogs.are.great/woof/woof/bark/"
@pytest.fixture(params=[0, None])
def test_systemexit_zero_is_ignored(sentry_init, capture_events, request):
zero_code = request.param
sentry_init(send_default_pii=True)
iterable = ExitingIterable(lambda: SystemExit(zero_code))
app = SentryWsgiMiddleware(IterableApp(iterable))
client = Client(app)
events = capture_events()
with pytest.raises(SystemExit):
client.get("/")
assert len(events) == 0
@pytest.fixture(params=["", "foo", 1, 2])
def test_systemexit_nonzero_is_captured(sentry_init, capture_events, request):
nonzero_code = request.param
sentry_init(send_default_pii=True)
iterable = ExitingIterable(lambda: SystemExit(nonzero_code))
app = SentryWsgiMiddleware(IterableApp(iterable))
client = Client(app)
events = capture_events()
with pytest.raises(SystemExit):
client.get("/")
(event,) = events
assert "exception" in event
exc = event["exception"]["values"][-1]
assert exc["type"] == "SystemExit"
assert exc["value"] == nonzero_code
assert event["level"] == "error"
def test_keyboard_interrupt_is_captured(sentry_init, capture_events):
sentry_init(send_default_pii=True)
iterable = ExitingIterable(lambda: KeyboardInterrupt())
app = SentryWsgiMiddleware(IterableApp(iterable))
client = Client(app)
events = capture_events()
with pytest.raises(KeyboardInterrupt):
client.get("/")
(event,) = events
assert "exception" in event
exc = event["exception"]["values"][-1]
assert exc["type"] == "KeyboardInterrupt"
assert exc["value"] == ""
assert event["level"] == "error"
@pytest.mark.parametrize("span_streaming", [True, False])
def test_transaction_with_error(
sentry_init,
crashing_app,
capture_events,
capture_items,
DictionaryContaining, # noqa:N803
span_streaming,
):
def dogpark(environ, start_response):
raise ValueError("Fetch aborted. The ball was not returned.")
sentry_init(
send_default_pii=True,
traces_sample_rate=1.0,
_experiments={
"trace_lifecycle": "stream" if span_streaming else "static",
},
)
app = SentryWsgiMiddleware(dogpark)
client = Client(app)
if span_streaming:
items = capture_items("event", "span")
else:
events = capture_events()
with pytest.raises(ValueError):
client.get("http://dogs.are.great/sit/stay/rollover/")
sentry_sdk.flush()
if span_streaming:
assert len(items) == 2
assert items[0].type == "event"
assert items[1].type == "span"
error_event = items[0].payload
span_item = items[1].payload
else:
error_event, envelope = events
assert error_event["transaction"] == "generic WSGI request"
assert error_event["contexts"]["trace"]["op"] == "http.server"
assert error_event["exception"]["values"][0]["type"] == "ValueError"
assert error_event["exception"]["values"][0]["mechanism"]["type"] == "wsgi"
assert error_event["exception"]["values"][0]["mechanism"]["handled"] is False
assert (
error_event["exception"]["values"][0]["value"]
== "Fetch aborted. The ball was not returned."
)
if span_streaming:
assert span_item["trace_id"] == error_event["contexts"]["trace"]["trace_id"]
assert span_item["span_id"] == error_event["contexts"]["trace"]["span_id"]
assert span_item["status"] == "error"
else:
assert envelope["type"] == "transaction"
# event trace context is a subset of envelope trace context
assert envelope["contexts"]["trace"] == DictionaryContaining(
error_event["contexts"]["trace"]
)
assert envelope["contexts"]["trace"]["status"] == "internal_error"
assert envelope["transaction"] == error_event["transaction"]
assert envelope["request"] == error_event["request"]
@pytest.mark.parametrize("send_pii", [True, False])
@pytest.mark.parametrize("span_streaming", [True, False])
def test_transaction_no_error(
sentry_init,
capture_events,
capture_items,
DictionaryContaining, # noqa:N803
span_streaming,
send_pii,
):
def dogpark(environ, start_response):
start_response("200 OK", [])
return ["Go get the ball! Good dog!"]
sentry_init(
send_default_pii=send_pii,
traces_sample_rate=1.0,
_experiments={
"trace_lifecycle": "stream" if span_streaming else "static",
},
)
app = SentryWsgiMiddleware(dogpark)
client = Client(app)
if span_streaming:
items = capture_items("span")
else:
events = capture_events()
client.get("/dogs/are/great?toy=tennisball")
sentry_sdk.flush()
if span_streaming:
assert len(items) == 1
span = items[0].payload
assert span["is_segment"] is True
assert span["name"] == "generic WSGI request"
assert span["attributes"]["sentry.op"] == "http.server"
assert span["attributes"]["sentry.span.source"] == "route"
assert span["attributes"]["http.request.method"] == "GET"
assert span["attributes"]["http.response.status_code"] == 200
assert span["status"] == "ok"
if send_pii:
assert span["attributes"]["url.full"] == "http://localhost/dogs/are/great"
assert span["attributes"]["url.path"] == "/dogs/are/great"
assert span["attributes"]["http.query"] == "toy=tennisball"
else:
assert "url.path" not in span["attributes"]
assert "url.full" not in span["attributes"]
assert "http.query" not in span["attributes"]
else:
envelope = events[0]
assert envelope["type"] == "transaction"
assert envelope["transaction"] == "generic WSGI request"
assert envelope["contexts"]["trace"]["op"] == "http.server"
assert envelope["request"] == DictionaryContaining(
{
"method": "GET",
"url": "http://localhost/dogs/are/great",
"query_string": "toy=tennisball",
}
)
@pytest.mark.parametrize("span_streaming", [True, False])
def test_has_trace_if_performance_enabled(
sentry_init,
capture_events,
capture_items,
span_streaming,
):
def dogpark(environ, start_response):
capture_message("Attempting to fetch the ball")
raise ValueError("Fetch aborted. The ball was not returned.")
sentry_init(
traces_sample_rate=1.0,
_experiments={
"trace_lifecycle": "stream" if span_streaming else "static",
},
)
app = SentryWsgiMiddleware(dogpark)
client = Client(app)
if span_streaming:
items = capture_items("event", "span")
else:
events = capture_events()
with pytest.raises(ValueError):
client.get("http://dogs.are.great/sit/stay/rollover/")
sentry_sdk.flush()
if span_streaming:
msg_event, error_event, span_item = items
assert msg_event.type == "event"
msg_event = msg_event.payload
assert msg_event["contexts"]["trace"]
assert "trace_id" in msg_event["contexts"]["trace"]
assert error_event.type == "event"
error_event = error_event.payload
assert error_event["contexts"]["trace"]
assert "trace_id" in error_event["contexts"]["trace"]
assert span_item.type == "span"
span_item = span_item.payload
assert span_item["trace_id"] is not None
assert (
msg_event["contexts"]["trace"]["trace_id"]
== error_event["contexts"]["trace"]["trace_id"]
== span_item["trace_id"]
)
else:
msg_event, error_event, transaction_event = events
assert msg_event["contexts"]["trace"]
assert "trace_id" in msg_event["contexts"]["trace"]
assert error_event["contexts"]["trace"]
assert "trace_id" in error_event["contexts"]["trace"]
assert transaction_event["contexts"]["trace"]
assert "trace_id" in transaction_event["contexts"]["trace"]
assert (
msg_event["contexts"]["trace"]["trace_id"]
== error_event["contexts"]["trace"]["trace_id"]
== transaction_event["contexts"]["trace"]["trace_id"]
)
def test_has_trace_if_performance_disabled(
sentry_init,
capture_events,
):
def dogpark(environ, start_response):
capture_message("Attempting to fetch the ball")
raise ValueError("Fetch aborted. The ball was not returned.")
sentry_init()
app = SentryWsgiMiddleware(dogpark)
client = Client(app)
events = capture_events()
with pytest.raises(ValueError):
client.get("http://dogs.are.great/sit/stay/rollover/")
msg_event, error_event = events
assert msg_event["contexts"]["trace"]
assert "trace_id" in msg_event["contexts"]["trace"]
assert error_event["contexts"]["trace"]
assert "trace_id" in error_event["contexts"]["trace"]
@pytest.mark.parametrize("span_streaming", [True, False])
def test_trace_from_headers_if_performance_enabled(
sentry_init,
capture_events,
capture_items,
span_streaming,
):
def dogpark(environ, start_response):
capture_message("Attempting to fetch the ball")
raise ValueError("Fetch aborted. The ball was not returned.")
sentry_init(
traces_sample_rate=1.0,
_experiments={
"trace_lifecycle": "stream" if span_streaming else "static",
},
)
app = SentryWsgiMiddleware(dogpark)
client = Client(app)
if span_streaming:
items = capture_items("event", "span")
else:
events = capture_events()
trace_id = "582b43a4192642f0b136d5159a501701"
sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)
with pytest.raises(ValueError):
client.get(
"http://dogs.are.great/sit/stay/rollover/",
headers={"sentry-trace": sentry_trace_header},
)
sentry_sdk.flush()
if span_streaming:
msg_event, error_event, span_item = items
assert msg_event.payload["contexts"]["trace"]["trace_id"] == trace_id
assert error_event.payload["contexts"]["trace"]["trace_id"] == trace_id
assert span_item.payload["trace_id"] == trace_id
else:
msg_event, error_event, transaction_event = events
assert msg_event["contexts"]["trace"]
assert "trace_id" in msg_event["contexts"]["trace"]
assert error_event["contexts"]["trace"]
assert "trace_id" in error_event["contexts"]["trace"]
assert transaction_event["contexts"]["trace"]
assert "trace_id" in transaction_event["contexts"]["trace"]
assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
assert error_event["contexts"]["trace"]["trace_id"] == trace_id
assert transaction_event["contexts"]["trace"]["trace_id"] == trace_id
def test_trace_from_headers_if_performance_disabled(
sentry_init,
capture_events,
):
def dogpark(environ, start_response):
capture_message("Attempting to fetch the ball")
raise ValueError("Fetch aborted. The ball was not returned.")
sentry_init()
app = SentryWsgiMiddleware(dogpark)
client = Client(app)
events = capture_events()
trace_id = "582b43a4192642f0b136d5159a501701"
sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)
with pytest.raises(ValueError):
client.get(
"http://dogs.are.great/sit/stay/rollover/",
headers={"sentry-trace": sentry_trace_header},
)
msg_event, error_event = events
assert msg_event["contexts"]["trace"]
assert "trace_id" in msg_event["contexts"]["trace"]
assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
assert error_event["contexts"]["trace"]
assert "trace_id" in error_event["contexts"]["trace"]
assert error_event["contexts"]["trace"]["trace_id"] == trace_id
@pytest.mark.parametrize("span_streaming", [True, False])
def test_traces_sampler_gets_correct_values_in_sampling_context(
sentry_init,
DictionaryContaining, # noqa:N803
span_streaming,
):
def app(environ, start_response):
start_response("200 OK", [])
return ["Go get the ball! Good dog!"]
traces_sampler = mock.Mock(return_value=True)
sentry_init(
send_default_pii=True,
traces_sampler=traces_sampler,
_experiments={
"trace_lifecycle": "stream" if span_streaming else "static",
},
)
app = SentryWsgiMiddleware(app)
client = Client(app)
client.get("/dogs/are/great/")
if span_streaming:
traces_sampler.assert_any_call(
DictionaryContaining(
{
"span_context": DictionaryContaining(
{
"name": "generic WSGI request",
},
),
"wsgi_environ": DictionaryContaining(
{
"PATH_INFO": "/dogs/are/great/",
"REQUEST_METHOD": "GET",
},
),
}
)
)
else:
traces_sampler.assert_any_call(
DictionaryContaining(
{
"wsgi_environ": DictionaryContaining(
{
"PATH_INFO": "/dogs/are/great/",
"REQUEST_METHOD": "GET",
},
),
}
)
)
@pytest.mark.parametrize("span_streaming", [True, False])
def test_session_mode_defaults_to_request_mode_in_wsgi_handler(
capture_envelopes, sentry_init, span_streaming
):
"""
Test that ensures that even though the default `session_mode` for
auto_session_tracking is `application`, that flips to `request` when we are
in the WSGI handler
"""
def app(environ, start_response):
start_response("200 OK", [])
return ["Go get the ball! Good dog!"]
traces_sampler = mock.Mock(return_value=True)
sentry_init(
send_default_pii=True,
traces_sampler=traces_sampler,
_experiments={
"trace_lifecycle": "stream" if span_streaming else "static",
},
)
app = SentryWsgiMiddleware(app)
envelopes = capture_envelopes()
client = Client(app)
client.get("/dogs/are/great/")
sentry_sdk.flush()
session_envelopes = [
e for e in envelopes if any(item.type == "sessions" for item in e.items)
]
assert len(session_envelopes) == 1
sess = session_envelopes[0]
assert len(sess.items) == 1
sess_event = sess.items[0].payload.json
aggregates = sess_event["aggregates"]
assert len(aggregates) == 1
assert aggregates[0]["exited"] == 1
@pytest.mark.parametrize("span_streaming", [True, False])
def test_auto_session_tracking_with_aggregates(
sentry_init, capture_envelopes, span_streaming
):
"""
Test for correct session aggregates in auto session tracking.
"""
def sample_app(environ, start_response):
if environ["REQUEST_URI"] != "/dogs/are/great/":
1 / 0
start_response("200 OK", [])
return ["Go get the ball! Good dog!"]
traces_sampler = mock.Mock(return_value=True)
sentry_init(
send_default_pii=True,
traces_sampler=traces_sampler,
_experiments={
"trace_lifecycle": "stream" if span_streaming else "static",
},
)
app = SentryWsgiMiddleware(sample_app)
envelopes = capture_envelopes()
assert len(envelopes) == 0
client = Client(app)
client.get("/dogs/are/great/")
client.get("/dogs/are/great/")
try:
client.get("/trigger/an/error/")
except ZeroDivisionError:
pass
sentry_sdk.flush()
count_item_types = Counter()
for envelope in envelopes:
for item in envelope.items:
count_item_types[item.type] += 1
if span_streaming:
assert count_item_types["span"] == 3
else:
assert count_item_types["transaction"] == 3
assert count_item_types["event"] == 1
assert count_item_types["sessions"] == 1
session_envelopes = [
e for e in envelopes if any(item.type == "sessions" for item in e.items)
]
assert len(session_envelopes) == 1
session_aggregates = session_envelopes[0].items[0].payload.json["aggregates"]
# Sum across buckets: sessions split by minute-truncated start time.
assert sum(agg.get("exited", 0) for agg in session_aggregates) == 2
assert sum(agg.get("crashed", 0) for agg in session_aggregates) == 1
@mock.patch("sentry_sdk.profiler.transaction_profiler.PROFILE_MINIMUM_SAMPLES", 0)
def test_profile_sent(
sentry_init,
capture_envelopes,
teardown_profiling,
):
def test_app(environ, start_response):
start_response("200 OK", [])
return ["Go get the ball! Good dog!"]
sentry_init(
traces_sample_rate=1.0,
_experiments={"profiles_sample_rate": 1.0},
)
app = SentryWsgiMiddleware(test_app)
envelopes = capture_envelopes()
client = Client(app)
client.get("/")
envelopes = [envelope for envelope in envelopes]
assert len(envelopes) == 1
profiles = [item for item in envelopes[0].items if item.type == "profile"]
assert len(profiles) == 1
@pytest.mark.parametrize("span_streaming", [True, False])
def test_span_origin_manual(sentry_init, capture_events, capture_items, span_streaming):
def dogpark(environ, start_response):
start_response("200 OK", [])
return ["Go get the ball! Good dog!"]
sentry_init(
send_default_pii=True,
traces_sample_rate=1.0,
_experiments={
"trace_lifecycle": "stream" if span_streaming else "static",
},
)
app = SentryWsgiMiddleware(dogpark)
if span_streaming:
items = capture_items("span")
else:
events = capture_events()
client = Client(app)
client.get("/dogs/are/great/")
sentry_sdk.flush()
if span_streaming:
assert len(items) == 1
assert items[0].payload["attributes"]["sentry.origin"] == "manual"
else:
(event,) = events
assert event["contexts"]["trace"]["origin"] == "manual"
@pytest.mark.parametrize("span_streaming", [True, False])
def test_span_origin_custom(sentry_init, capture_events, capture_items, span_streaming):
def dogpark(environ, start_response):
start_response("200 OK", [])
return ["Go get the ball! Good dog!"]
sentry_init(
send_default_pii=True,
traces_sample_rate=1.0,
_experiments={
"trace_lifecycle": "stream" if span_streaming else "static",
},
)
app = SentryWsgiMiddleware(
dogpark,
span_origin="auto.dogpark.deluxe",
)
if span_streaming:
items = capture_items("span")
else:
events = capture_events()
client = Client(app)
client.get("/dogs/are/great/")
sentry_sdk.flush()
if span_streaming:
assert len(items) == 1
assert items[0].payload["attributes"]["sentry.origin"] == "auto.dogpark.deluxe"
else:
(event,) = events
assert event["contexts"]["trace"]["origin"] == "auto.dogpark.deluxe"
@pytest.mark.parametrize(
"has_file_wrapper, has_fileno, expect_wrapped",
[
(True, True, False), # both conditions met → unwrapped
(False, True, True), # no file_wrapper → wrapped
(True, False, True), # no fileno → wrapped
(False, False, True), # neither condition → wrapped
],
)
def test_file_response_wrapping(
sentry_init, has_file_wrapper, has_fileno, expect_wrapped
):
sentry_init()
response_mock = mock.MagicMock()
if not has_fileno:
del response_mock.fileno
def app(environ, start_response):
start_response("200 OK", [])
return response_mock
environ_extra = {}
if has_file_wrapper:
environ_extra["wsgi.file_wrapper"] = mock.MagicMock()
middleware = SentryWsgiMiddleware(app)
result = middleware(
{
"REQUEST_METHOD": "GET",
"PATH_INFO": "/",
"SERVER_NAME": "localhost",
"SERVER_PORT": "80",
"wsgi.url_scheme": "http",
"wsgi.input": mock.MagicMock(),
**environ_extra,
},
lambda status, headers: None,
)
if expect_wrapped:
assert isinstance(result, _ScopedResponse)
else:
assert result is response_mock
@pytest.mark.parametrize(
"environ,use_x_forwarded_for,expected_url",
[
# Without use_x_forwarded_for, wsgi.url_scheme is used
(
{
"wsgi.url_scheme": "http",
"SERVER_NAME": "example.com",
"SERVER_PORT": "80",
"PATH_INFO": "/test",
"HTTP_X_FORWARDED_PROTO": "https",
},
False,
"http://example.com/test",
),
# With use_x_forwarded_for, HTTP_X_FORWARDED_PROTO is respected
(
{
"wsgi.url_scheme": "http",
"SERVER_NAME": "example.com",
"SERVER_PORT": "80",
"PATH_INFO": "/test",
"HTTP_X_FORWARDED_PROTO": "https",
},
True,
"https://example.com/test",
),
# With use_x_forwarded_for but no forwarded proto, wsgi.url_scheme is used
(
{
"wsgi.url_scheme": "http",
"SERVER_NAME": "example.com",
"SERVER_PORT": "80",
"PATH_INFO": "/test",
},
True,
"http://example.com/test",
),
# Forwarded host with default https port is stripped using forwarded proto
(
{
"wsgi.url_scheme": "http",
"SERVER_NAME": "internal",
"SERVER_PORT": "80",
"PATH_INFO": "/test",
"HTTP_X_FORWARDED_PROTO": "https",
"HTTP_X_FORWARDED_HOST": "example.com:443",
},
True,
"https://example.com/test",
),
# Forwarded host with non-default port is preserved
(
{
"wsgi.url_scheme": "http",
"SERVER_NAME": "internal",
"SERVER_PORT": "80",
"PATH_INFO": "/test",
"HTTP_X_FORWARDED_PROTO": "https",
"HTTP_X_FORWARDED_HOST": "example.com:8443",
},
True,
"https://example.com:8443/test",
),
# Forwarded proto with HTTP_HOST (no forwarded host) strips default port
(
{
"wsgi.url_scheme": "http",
"HTTP_HOST": "example.com:443",
"SERVER_NAME": "internal",
"SERVER_PORT": "80",
"PATH_INFO": "/test",
"HTTP_X_FORWARDED_PROTO": "https",
},
True,
"https://example.com/test",
),
],
ids=[
"ignores_forwarded_proto_when_disabled",
"respects_forwarded_proto_when_enabled",
"falls_back_to_url_scheme_when_no_forwarded_proto",
"strips_default_https_port_from_forwarded_host",
"preserves_non_default_port_on_forwarded_host",
"strips_default_port_from_http_host_with_forwarded_proto",
],
)
def test_get_request_url_x_forwarded_proto(environ, use_x_forwarded_for, expected_url):
assert get_request_url(environ, use_x_forwarded_for) == expected_url
@pytest.mark.parametrize("send_default_pii", [True, False])
def test_user_ip_address_on_all_spans(sentry_init, capture_items, send_default_pii):
def dogpark(environ, start_response):
with sentry_sdk.traces.start_span(name="child-span"):
pass
start_response("200 OK", [])
return ["Go get the ball! Good dog!"]
sentry_init(
send_default_pii=send_default_pii,
traces_sample_rate=1.0,
_experiments={"trace_lifecycle": "stream"},
)
app = SentryWsgiMiddleware(dogpark)
client = Client(app)
items = capture_items("span")
client.get("/dogs/are/great/", environ_base={"REMOTE_ADDR": "127.0.0.1"})
sentry_sdk.flush()
child_span, server_span = [item.payload for item in items]
if send_default_pii:
assert server_span["attributes"]["user.ip_address"] == "127.0.0.1"
assert child_span["attributes"]["user.ip_address"] == "127.0.0.1"
else:
assert "user.ip_address" not in server_span["attributes"]
assert "user.ip_address" not in child_span["attributes"]