forked from getsentry/sentry-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_statsig.py
More file actions
228 lines (178 loc) · 7.66 KB
/
Copy pathtest_statsig.py
File metadata and controls
228 lines (178 loc) · 7.66 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
import concurrent.futures as cf
import sys
from contextlib import contextmanager
from random import random
from unittest.mock import Mock
import pytest
from statsig import statsig
from statsig.statsig_user import StatsigUser
import sentry_sdk
from sentry_sdk import start_span, start_transaction
from sentry_sdk.integrations.statsig import StatsigIntegration
from tests.conftest import ApproxDict
@contextmanager
def mock_statsig(gate_dict):
old_check_gate = statsig.check_gate
def mock_check_gate(user, gate, *args, **kwargs):
return gate_dict.get(gate, False)
statsig.check_gate = Mock(side_effect=mock_check_gate)
yield
statsig.check_gate = old_check_gate
def test_check_gate(sentry_init, capture_events, uninstall_integration):
uninstall_integration(StatsigIntegration.identifier)
with mock_statsig({"hello": True, "world": False}):
sentry_init(integrations=[StatsigIntegration()])
events = capture_events()
user = StatsigUser(user_id="user-id")
statsig.check_gate(user, "hello")
statsig.check_gate(user, "world")
statsig.check_gate(user, "other") # unknown gates default to False.
sentry_sdk.capture_exception(Exception("something wrong!"))
assert len(events) == 1
assert events[0]["contexts"]["flags"] == {
"values": [
{"flag": "hello", "result": True},
{"flag": "world", "result": False},
{"flag": "other", "result": False},
]
}
def test_check_gate_threaded(sentry_init, capture_events, uninstall_integration):
uninstall_integration(StatsigIntegration.identifier)
with mock_statsig({"hello": True, "world": False}):
sentry_init(integrations=[StatsigIntegration()])
events = capture_events()
user = StatsigUser(user_id="user-id")
# Capture an eval before we split isolation scopes.
statsig.check_gate(user, "hello")
def task(flag_key):
# Creates a new isolation scope for the thread.
# This means the evaluations in each task are captured separately.
with sentry_sdk.isolation_scope():
statsig.check_gate(user, flag_key)
# use a tag to identify to identify events later on
sentry_sdk.set_tag("task_id", flag_key)
sentry_sdk.capture_exception(Exception("something wrong!"))
with cf.ThreadPoolExecutor(max_workers=2) as pool:
pool.map(task, ["world", "other"])
# Capture error in original scope
sentry_sdk.set_tag("task_id", "0")
sentry_sdk.capture_exception(Exception("something wrong!"))
assert len(events) == 3
events.sort(key=lambda e: e["tags"]["task_id"])
assert events[0]["contexts"]["flags"] == {
"values": [
{"flag": "hello", "result": True},
]
}
assert events[1]["contexts"]["flags"] == {
"values": [
{"flag": "hello", "result": True},
{"flag": "other", "result": False},
]
}
assert events[2]["contexts"]["flags"] == {
"values": [
{"flag": "hello", "result": True},
{"flag": "world", "result": False},
]
}
@pytest.mark.skipif(sys.version_info < (3, 7), reason="requires python3.7 or higher")
def test_check_gate_asyncio(sentry_init, capture_events, uninstall_integration):
asyncio = pytest.importorskip("asyncio")
uninstall_integration(StatsigIntegration.identifier)
with mock_statsig({"hello": True, "world": False}):
sentry_init(integrations=[StatsigIntegration()])
events = capture_events()
user = StatsigUser(user_id="user-id")
# Capture an eval before we split isolation scopes.
statsig.check_gate(user, "hello")
async def task(flag_key):
with sentry_sdk.isolation_scope():
statsig.check_gate(user, flag_key)
# use a tag to identify to identify events later on
sentry_sdk.set_tag("task_id", flag_key)
sentry_sdk.capture_exception(Exception("something wrong!"))
async def runner():
return asyncio.gather(task("world"), task("other"))
asyncio.run(runner())
# Capture error in original scope
sentry_sdk.set_tag("task_id", "0")
sentry_sdk.capture_exception(Exception("something wrong!"))
assert len(events) == 3
events.sort(key=lambda e: e["tags"]["task_id"])
assert events[0]["contexts"]["flags"] == {
"values": [
{"flag": "hello", "result": True},
]
}
assert events[1]["contexts"]["flags"] == {
"values": [
{"flag": "hello", "result": True},
{"flag": "other", "result": False},
]
}
assert events[2]["contexts"]["flags"] == {
"values": [
{"flag": "hello", "result": True},
{"flag": "world", "result": False},
]
}
def test_wraps_original(sentry_init, uninstall_integration):
uninstall_integration(StatsigIntegration.identifier)
flag_value = random() < 0.5
with mock_statsig(
{"test-flag": flag_value}
): # patches check_gate with a Mock object.
mock_check_gate = statsig.check_gate
sentry_init(integrations=[StatsigIntegration()]) # wraps check_gate.
user = StatsigUser(user_id="user-id")
res = statsig.check_gate(user, "test-flag", "extra-arg", kwarg=1) # type: ignore[arg-type]
assert res == flag_value
assert mock_check_gate.call_args == ( # type: ignore[attr-defined]
(user, "test-flag", "extra-arg"),
{"kwarg": 1},
)
def test_wrapper_attributes(sentry_init, uninstall_integration):
uninstall_integration(StatsigIntegration.identifier)
original_check_gate = statsig.check_gate
sentry_init(integrations=[StatsigIntegration()])
# Methods have not lost their qualified names after decoration.
assert statsig.check_gate.__name__ == "check_gate"
assert statsig.check_gate.__qualname__ == original_check_gate.__qualname__
# Clean up
statsig.check_gate = original_check_gate
@pytest.mark.parametrize(
"span_streaming",
[True, False],
)
def test_statsig_span_integration(
sentry_init, capture_events, capture_items, uninstall_integration, span_streaming
):
uninstall_integration(StatsigIntegration.identifier)
with mock_statsig({"hello": True}):
sentry_init(
traces_sample_rate=1.0,
integrations=[StatsigIntegration()],
_experiments={"trace_lifecycle": "stream" if span_streaming else "static"},
)
user = StatsigUser(user_id="user-id")
if span_streaming:
items = capture_items("span")
with sentry_sdk.traces.start_span(name="hi"):
statsig.check_gate(user, "hello")
statsig.check_gate(user, "world")
sentry_sdk.flush()
assert len(items) == 1
span = items[0].payload
assert span["attributes"]["flag.evaluation.hello"] is True
assert span["attributes"]["flag.evaluation.world"] is False
else:
events = capture_events()
with start_transaction(name="hi"):
with start_span(op="foo", name="bar"):
statsig.check_gate(user, "hello")
statsig.check_gate(user, "world")
(event,) = events
assert event["spans"][0]["data"] == ApproxDict(
{"flag.evaluation.hello": True, "flag.evaluation.world": False}
)