-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_sdk.py
More file actions
468 lines (401 loc) · 20.3 KB
/
Copy pathtest_sdk.py
File metadata and controls
468 lines (401 loc) · 20.3 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
from __future__ import annotations
import sys
import unittest
from io import StringIO
from unittest.mock import patch
sys.path.insert(0, "src")
from featurevisor import FeaturevisorChildInstance, create_featurevisor
from featurevisor.bucketer import MAX_BUCKETED_NUMBER, get_bucket_key, get_bucketed_number
from featurevisor.compare_versions import compare_versions
from featurevisor.conditions import condition_is_matched
from featurevisor.evaluation_data_provider import _InstanceEvaluationDataProvider
from featurevisor.events import get_params_for_datafile_set_event, get_params_for_sticky_features_set_event
from featurevisor.emitter import Emitter
from featurevisor.diagnostics import _create_evaluation_diagnostics
class SDKTests(unittest.TestCase):
def test_known_bucket_numbers(self) -> None:
expected = {
"foo": 20602,
"bar": 89144,
"123.foo": 3151,
"123.bar": 9710,
"123.456.foo": 14432,
"123.456.bar": 1982,
}
for key, value in expected.items():
self.assertEqual(get_bucketed_number(key), value)
def test_compare_versions(self) -> None:
self.assertEqual(compare_versions("1.2.3", "1.2.3"), 0)
self.assertEqual(compare_versions("1.2.4", "1.2.3"), 1)
self.assertEqual(compare_versions("1.2.2", "1.2.3"), -1)
def test_condition_exists_and_not_exists(self) -> None:
get_regex = lambda value, flags="": __import__("re").compile(value)
self.assertTrue(condition_is_matched({"attribute": "country", "operator": "exists"}, {"country": None}, get_regex))
self.assertTrue(condition_is_matched({"attribute": "country", "operator": "notExists"}, {}, get_regex))
def test_bucket_key_keeps_none_values(self) -> None:
diagnostics = _create_evaluation_diagnostics()
bucket_key = get_bucket_key(featureKey="my_feature", bucketBy="userId", context={"userId": None}, diagnostics=diagnostics)
self.assertEqual(bucket_key, ".my_feature")
def test_bucket_key_stringifies_numbers_like_javascript(self) -> None:
diagnostics = _create_evaluation_diagnostics()
bucket_key = get_bucket_key(
featureKey="feature",
bucketBy=["whole", "negativeZero", "small", "large"],
context={"whole": 1.0, "negativeZero": -0.0, "small": 1e-6, "large": 1e21},
diagnostics=diagnostics,
)
self.assertEqual(bucket_key, "1.0.0.000001.1e+21.feature")
def test_bucketed_number_range(self) -> None:
value = get_bucketed_number("foo.bar")
self.assertGreaterEqual(value, 0)
self.assertLess(value, MAX_BUCKETED_NUMBER)
def test_bucket_key_variants(self) -> None:
diagnostics = _create_evaluation_diagnostics()
self.assertEqual(get_bucket_key(featureKey="test-feature", bucketBy="userId", context={"userId": "123"}, diagnostics=diagnostics), "123.test-feature")
self.assertEqual(get_bucket_key(featureKey="test-feature", bucketBy=["organizationId", "user.id"], context={"organizationId": "123", "user": {"id": "234"}}, diagnostics=diagnostics), "123.234.test-feature")
self.assertEqual(get_bucket_key(featureKey="test-feature", bucketBy={"or": ["userId", "deviceId"]}, context={"deviceId": "deviceIdHere"}, diagnostics=diagnostics), "deviceIdHere.test-feature")
def test_instance_basic_flow(self) -> None:
datafile = {
"schemaVersion": "2",
"revision": "1",
"segments": {"everyone": {"conditions": "*"}},
"features": {
"my_feature": {
"bucketBy": "userId",
"traffic": [{"key": "everyone", "segments": "everyone", "percentage": 100000}],
"variablesSchema": {"title": {"type": "string", "defaultValue": "Hello"}},
}
},
}
instance = create_featurevisor({"datafile": datafile, "context": {"userId": "123"}})
self.assertTrue(instance.is_enabled("my_feature"))
self.assertEqual(instance.get_variable("my_feature", "title"), "Hello")
self.assertEqual(instance.get_feature_evaluations()["my_feature"]["variables"]["title"], "Hello")
def test_set_datafile_merges_by_default_and_replace_opt_in(self) -> None:
instance = create_featurevisor(
{
"datafile": {
"schemaVersion": "2",
"revision": "1",
"featurevisorVersion": "3.0.0",
"segments": {},
"features": {"first": {"bucketBy": "userId", "traffic": [{"key": "1", "segments": "*", "percentage": 100000}]}},
},
"logLevel": "fatal",
}
)
instance.set_datafile(
{
"schemaVersion": "2",
"revision": "2",
"featurevisorVersion": "3.1.0",
"segments": {},
"features": {"second": {"bucketBy": "userId", "traffic": [{"key": "1", "segments": "*", "percentage": 100000}]}},
}
)
self.assertEqual(instance.get_revision(), "2")
self.assertEqual(instance.datafile.featurevisor_version, "3.1.0")
self.assertIsNotNone(instance.get_feature("first"))
self.assertIsNotNone(instance.get_feature("second"))
instance.set_datafile(
{
"schemaVersion": "2",
"revision": "3",
"segments": {},
"features": {"third": {"bucketBy": "userId", "traffic": [{"key": "1", "segments": "*", "percentage": 100000}]}},
},
True,
)
self.assertIsNone(instance.get_feature("first"))
self.assertIsNone(instance.get_feature("second"))
self.assertIsNotNone(instance.get_feature("third"))
def test_datafile_set_event_includes_replaced(self) -> None:
events = []
instance = create_featurevisor({"logLevel": "fatal"})
instance.on("datafile_set", lambda event: events.append(event))
instance.set_datafile({"schemaVersion": "2", "revision": "1", "segments": {}, "features": {}})
instance.set_datafile({"schemaVersion": "2", "revision": "2", "segments": {}, "features": {}}, True)
self.assertEqual([event["replaced"] for event in events], [False, True])
def test_lifecycle_mutations_report_diagnostics(self) -> None:
diagnostics = []
instance = create_featurevisor({"logLevel": "debug", "onDiagnostic": lambda diagnostic: diagnostics.append(diagnostic)})
instance.set_datafile({"schemaVersion": "2", "revision": "1", "segments": {}, "features": {}})
instance.set_sticky_features({"test": {"enabled": True}})
instance.set_context({"country": "nl"})
codes = [diagnostic["code"] for diagnostic in diagnostics]
self.assertIn("datafile_set", codes)
self.assertIn("sticky_features_set", codes)
self.assertIn("context_set", codes)
def test_module_lifecycle_duplicate_diagnostics_and_close(self) -> None:
diagnostics = []
errors = []
setup_revision = {}
closed = []
instance = create_featurevisor(
{
"logLevel": "error",
"onDiagnostic": lambda diagnostic: diagnostics.append(diagnostic),
"modules": [
{
"name": "lifecycle",
"setup": lambda api: setup_revision.update(revision=api["getRevision"]()),
"close": lambda: closed.append("lifecycle"),
}
],
}
)
instance.on("error", lambda event: errors.append(event))
self.assertEqual(setup_revision["revision"], "unknown")
self.assertIsNone(instance.add_module({"name": "lifecycle"}))
self.assertEqual(diagnostics[-1]["code"], "duplicate_module")
self.assertEqual(errors[-1]["diagnostic"]["code"], "duplicate_module")
instance.close()
self.assertEqual(closed, ["lifecycle"])
def test_add_module_unsubscribe_closes_module_once(self) -> None:
closed = []
instance = create_featurevisor({"logLevel": "fatal"})
unsubscribe = instance.add_module({"name": "dynamic", "close": lambda: closed.append("dynamic")})
unsubscribe()
unsubscribe()
self.assertEqual(closed, ["dynamic"])
def test_module_setup_and_diagnostic_handler_failures_are_isolated(self) -> None:
diagnostics = []
closed = []
seen = []
instance = create_featurevisor({"logLevel": "error", "onDiagnostic": lambda diagnostic: diagnostics.append(diagnostic)})
def fail_setup(api):
api["onDiagnostic"](lambda diagnostic: None)
raise RuntimeError("setup failed")
self.assertIsNone(instance.add_module({"name": "broken-setup", "setup": fail_setup, "close": lambda: closed.append("broken-setup")}))
self.assertEqual(closed, ["broken-setup"])
self.assertTrue(any(item.get("code") == "module_setup_error" for item in diagnostics))
instance.add_module({"name": "broken-handler", "setup": lambda api: api["onDiagnostic"](lambda diagnostic: (_ for _ in ()).throw(RuntimeError("handler failed")), {"logLevel": "debug"})})
instance.add_module({"name": "working-handler", "setup": lambda api: api["onDiagnostic"](lambda diagnostic: seen.append(diagnostic["code"]), {"logLevel": "debug"})})
instance.set_context({"country": "nl"})
self.assertIn("context_set", seen)
def test_module_close_errors_are_reported_and_do_not_stop_cleanup(self) -> None:
diagnostics = []
errors = []
closed = []
def fail_close() -> None:
closed.append("first")
raise RuntimeError("first close failed")
instance = create_featurevisor(
{
"logLevel": "error",
"onDiagnostic": lambda diagnostic: diagnostics.append(diagnostic),
"modules": [
{"name": "first", "close": fail_close},
{"name": "second", "close": lambda: closed.append("second")},
],
}
)
instance.on("error", lambda event: errors.append(event))
instance.close()
self.assertEqual(closed, ["first", "second"])
self.assertTrue(
any(
diagnostic.get("code") == "module_close_error"
and diagnostic.get("moduleName") == "first"
and diagnostic.get("level") == "error"
and isinstance(diagnostic.get("originalError"), RuntimeError)
for diagnostic in diagnostics
)
)
self.assertTrue(any(
event.get("diagnostic", {}).get("code") == "module_close_error"
and event.get("diagnostic", {}).get("moduleName") == "first"
for event in errors
))
def test_module_unsubscribe_reports_close_errors_once(self) -> None:
diagnostics = []
instance = create_featurevisor({"logLevel": "error", "onDiagnostic": lambda diagnostic: diagnostics.append(diagnostic)})
def fail_close() -> None:
raise RuntimeError("dynamic close failed")
unsubscribe = instance.add_module({"name": "dynamic", "close": fail_close})
unsubscribe()
unsubscribe()
self.assertEqual(
1,
sum(
1
for diagnostic in diagnostics
if diagnostic.get("code") == "module_close_error" and diagnostic.get("moduleName") == "dynamic"
),
)
def test_module_diagnostic_subscribe_report_and_remove_cleanup(self) -> None:
instance_diagnostics = []
listener_diagnostics = []
reporter_api = {}
listener_closed = []
instance = create_featurevisor(
{
"onDiagnostic": lambda diagnostic: instance_diagnostics.append(diagnostic),
"modules": [
{
"name": "listener",
"setup": lambda api: api["onDiagnostic"](lambda diagnostic: listener_diagnostics.append(diagnostic)),
"close": lambda: listener_closed.append(True),
},
{
"name": "reporter",
"setup": lambda api: reporter_api.update(api=api),
},
],
}
)
reporter_api["api"]["reportDiagnostic"]({"level": "warn", "code": "module_warning", "message": "module warning"})
self.assertEqual(instance_diagnostics[-1]["module"], "reporter")
self.assertEqual(listener_diagnostics[-1]["code"], "module_warning")
instance.remove_module("listener")
reporter_api["api"]["reportDiagnostic"]({"level": "warn", "code": "after_remove", "message": "after remove"})
self.assertEqual(instance_diagnostics[-1]["code"], "after_remove")
self.assertEqual(listener_diagnostics[-1]["code"], "module_warning")
self.assertEqual(listener_closed, [True])
def test_module_diagnostic_level_is_independent_from_instance_level(self) -> None:
observed = []
instance = create_featurevisor(
{
"logLevel": "fatal",
"modules": [
{
"name": "observer",
"setup": lambda api: api["onDiagnostic"](
lambda diagnostic: observed.append(diagnostic),
{"logLevel": "debug"},
),
}
],
}
)
instance.is_enabled("missing")
diagnostic = next(item for item in observed if item["code"] == "feature_not_found")
self.assertEqual(diagnostic["details"]["featureKey"], "missing")
self.assertEqual(diagnostic["details"]["reason"], "feature_not_found")
def test_evaluation_data_provider_parses_stringified_conditions(self) -> None:
reader = _InstanceEvaluationDataProvider(
datafile={
"schemaVersion": "2",
"revision": "1",
"segments": {"eu": {"conditions": '[{"attribute":"country","operator":"equals","value":"nl"}]'}},
"features": {},
},
diagnostics=_create_evaluation_diagnostics(),
)
segment = reader.get_segment("eu")
self.assertTrue(reader.segment_is_matched(segment, {"country": "nl"}))
def test_events_helpers(self) -> None:
self.assertEqual(
get_params_for_sticky_features_set_event({"feature1": {"enabled": True}}, {"feature2": {"enabled": True}}, True),
{"features": ["feature1", "feature2"], "replaced": True},
)
diagnostics = _create_evaluation_diagnostics()
previous = _InstanceEvaluationDataProvider(datafile={"schemaVersion": "2", "revision": "1", "segments": {}, "features": {"feature1": {"bucketBy": "userId", "hash": "hash1", "traffic": []}}}, diagnostics=diagnostics)
current = _InstanceEvaluationDataProvider(datafile={"schemaVersion": "2", "revision": "2", "segments": {}, "features": {"feature1": {"bucketBy": "userId", "hash": "hash2", "traffic": []}, "feature2": {"bucketBy": "userId", "hash": "hash3", "traffic": []}}}, diagnostics=diagnostics)
self.assertEqual(
get_params_for_datafile_set_event(previous, current),
{"revision": "2", "previousRevision": "1", "revisionChanged": True, "features": ["feature1", "feature2"], "variables": [], "replaced": False},
)
def test_emitter_subscribe_unsubscribe(self) -> None:
emitter = Emitter()
handled = []
unsubscribe = emitter.on("datafile_set", lambda details: handled.append(details))
emitter.trigger("datafile_set", {"key": "value"})
emitter.trigger("sticky_features_set", {"key": "value2"})
self.assertEqual(handled, [{"key": "value"}])
unsubscribe()
self.assertEqual(len(emitter.listeners["datafile_set"]), 0)
emitter.clear_all()
self.assertEqual(dict(emitter.listeners), {})
def test_emitter_uses_listener_snapshot(self) -> None:
emitter = Emitter()
calls = []
unsubscribe_second = None
def first(_details: dict) -> None:
calls.append("first")
unsubscribe_second()
def second(_details: dict) -> None:
calls.append("second")
emitter.on("sticky_features_set", first)
unsubscribe_second = emitter.on("sticky_features_set", second)
emitter.trigger("sticky_features_set")
emitter.trigger("sticky_features_set")
self.assertEqual(calls, ["first", "second", "first"])
def test_child_instance_flow(self) -> None:
datafile = {
"schemaVersion": "2",
"revision": "1",
"segments": {
"belgium": {"conditions": [{"attribute": "country", "operator": "equals", "value": "be"}]},
},
"features": {
"test": {
"bucketBy": "userId",
"variablesSchema": {
"color": {"type": "string", "defaultValue": "red"},
"nestedConfig": {"type": "json", "defaultValue": '{"key":{"nested":"value"}}'},
},
"variations": [{"value": "control"}],
"traffic": [{"key": "1", "segments": "*", "percentage": 100000, "variation": "control", "variables": {"color": "black"}}],
}
},
}
instance = create_featurevisor({"datafile": datafile, "context": {"appVersion": "1.0.0"}, "logLevel": "fatal"})
child = instance.spawn({"userId": "123", "country": "be"})
changes = []
unsubscribe = child.on("context_set", lambda details: changes.append(details))
child.set_context({"country": "be"})
self.assertEqual(child.get_context(), {"appVersion": "1.0.0", "userId": "123", "country": "be"})
self.assertTrue(child.is_enabled("test"))
self.assertEqual(child.get_variation("test"), "control")
self.assertTrue(child.evaluate_flag("test")["enabled"])
self.assertEqual(child.evaluate_variation("test")["variation"]["value"], "control")
self.assertEqual(child.get_variable("test", "color"), "black")
self.assertEqual(child.evaluate_variable("test", "color")["variableValue"], "black")
self.assertEqual(child.get_variable_json("test", "nestedConfig"), {"key": {"nested": "value"}})
unsubscribe()
self.assertTrue(changes)
def test_child_close_removes_delegated_subscriptions_and_empty_sticky_is_isolated(self) -> None:
instance = create_featurevisor({
"logLevel": "fatal",
"sticky": {"test": {"enabled": True}},
})
child = instance.spawn({}, {"sticky": {}})
delegated = []
child.on("datafile_set", lambda details: delegated.append(details))
self.assertFalse(child.is_enabled("test"))
child.close()
child.close()
instance.set_datafile({
"schemaVersion": "2",
"revision": "after-close",
"segments": {},
"features": {},
})
self.assertEqual(delegated, [])
def test_child_context_matches_javascript_snapshot_behavior(self) -> None:
instance = create_featurevisor({"context": {"country": "nl", "plan": "free"}, "logLevel": "fatal"})
child = instance.spawn({"country": "de"})
instance.set_context({"plan": "pro", "locale": "de-DE"})
self.assertEqual(child.get_context(), {
"country": "de",
"plan": "free",
"locale": "de-DE",
})
def test_default_variable_json_parsing(self) -> None:
datafile = {
"schemaVersion": "2",
"revision": "1",
"segments": {},
"features": {
"test": {
"bucketBy": "userId",
"traffic": [{"key": "1", "segments": "*", "percentage": 100000}],
"variablesSchema": {"config": {"type": "json", "defaultValue": '{"enabled":true}'}},
}
},
}
instance = create_featurevisor({"datafile": datafile, "context": {"userId": "123"}, "logLevel": "fatal"})
self.assertEqual(instance.get_variable("test", "config"), {"enabled": True})
if __name__ == "__main__":
unittest.main()