This repository was archived by the owner on May 5, 2022. It is now read-only.
forked from launchdarkly/python-server-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclient.py
More file actions
233 lines (181 loc) · 8.64 KB
/
Copy pathclient.py
File metadata and controls
233 lines (181 loc) · 8.64 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
from __future__ import division, with_statement, absolute_import
import hashlib
import hmac
import threading
import time
import requests
from builtins import object
from ldclient.config import Config as Config
from ldclient.feature_requester import FeatureRequesterImpl
from ldclient.flag import evaluate
from ldclient.polling import PollingUpdateProcessor
from ldclient.streaming import StreamingUpdateProcessor
from ldclient.util import check_uwsgi, log
# noinspection PyBroadException
try:
import queue
except:
# noinspection PyUnresolvedReferences,PyPep8Naming
import Queue as queue
from cachecontrol import CacheControl
from threading import Lock
class LDClient(object):
def __init__(self, sdk_key=None, config=None, start_wait=5):
check_uwsgi()
if config is not None and config.sdk_key is not None and sdk_key is not None:
raise Exception("LaunchDarkly client init received both sdk_key and config with sdk_key. "
"Only one of either is expected")
if sdk_key is not None:
log.warn("Deprecated sdk_key argument was passed to init. Use config object instead.")
self._config = Config(sdk_key=sdk_key)
else:
self._config = config or Config.default()
self._session = CacheControl(requests.Session())
self._queue = queue.Queue(self._config.events_max_pending)
self._event_consumer = None
self._lock = Lock()
self._store = self._config.feature_store
""" :type: FeatureStore """
if self._config.offline:
log.info("Started LaunchDarkly Client in offline mode")
return
if self._config.events_enabled:
self._event_consumer = self._config.event_consumer_class(self._queue, self._config)
self._event_consumer.start()
if self._config.use_ldd:
log.info("Started LaunchDarkly Client in LDD mode")
return
if self._config.feature_requester_class:
self._feature_requester = self._config.feature_requester_class(self._config)
else:
self._feature_requester = FeatureRequesterImpl(self._config)
""" :type: FeatureRequester """
update_processor_ready = threading.Event()
if self._config.update_processor_class:
log.info("Using user-specified update processor: " + str(self._config.update_processor_class))
self._update_processor = self._config.update_processor_class(
self._config, self._feature_requester, self._store, update_processor_ready)
else:
if self._config.stream:
self._update_processor = StreamingUpdateProcessor(
self._config, self._feature_requester, self._store, update_processor_ready)
else:
self._update_processor = PollingUpdateProcessor(
self._config, self._feature_requester, self._store, update_processor_ready)
""" :type: UpdateProcessor """
self._update_processor.start()
log.info("Waiting up to " + str(start_wait) + " seconds for LaunchDarkly client to initialize...")
update_processor_ready.wait(start_wait)
if self._update_processor.initialized() is True:
log.info("Started LaunchDarkly Client: OK")
else:
log.warn("Initialization timeout exceeded for LaunchDarkly Client or an error occurred. "
"Feature Flags may not yet be available.")
def get_sdk_key(self):
return self._config.sdk_key
def close(self):
log.info("Closing LaunchDarkly client..")
if self.is_offline():
return
if self._event_consumer and self._event_consumer.is_alive():
self._event_consumer.stop()
if self._update_processor and self._update_processor.is_alive():
self._update_processor.stop()
def _send_event(self, event):
if self._config.offline or not self._config.events_enabled:
return
event['creationDate'] = int(time.time() * 1000)
if self._queue.full():
log.warning("Event queue is full-- dropped an event")
else:
self._queue.put(event)
def track(self, event_name, user, data=None):
self._sanitize_user(user)
if user is None or user.get('key') is None:
log.warn("Missing user or user key when calling track().")
self._send_event({'kind': 'custom', 'key': event_name, 'user': user, 'data': data})
def identify(self, user):
self._sanitize_user(user)
if user is None or user.get('key') is None:
log.warn("Missing user or user key when calling identify().")
self._send_event({'kind': 'identify', 'key': user.get('key'), 'user': user})
def is_offline(self):
return self._config.offline
def is_initialized(self):
return self.is_offline() or self._config.use_ldd or self._update_processor.initialized()
def flush(self):
if self._config.offline or not self._config.events_enabled:
return
return self._event_consumer.flush()
def toggle(self, key, user, default):
log.warn("Deprecated method: toggle() called. Use variation() instead.")
return self.variation(key, user, default)
def variation(self, key, user, default):
default = self._config.get_default(key, default)
self._sanitize_user(user)
if self._config.offline:
return default
def send_event(value, version=None):
self._send_event({'kind': 'feature', 'key': key,
'user': user, 'value': value, 'default': default, 'version': version})
if not self.is_initialized():
log.warn("Feature Flag evaluation attempted before client has initialized! Returning default: "
+ str(default) + " for feature key: " + key)
send_event(default)
return default
if user is None or user.get('key') is None:
log.warn("Missing user or user key when evaluating Feature Flag key: " + key + ". Returning default.")
send_event(default)
return default
if user.get('key', "") == "":
log.warn("User key is blank. Flag evaluation will proceed, but the user will not be stored in LaunchDarkly.")
def cb(flag):
try:
if not flag:
log.warn("Feature Flag key: " + key + " not found in Feature Store. Returning default.")
send_event(default)
return default
return self._evaluate_and_send_events(flag, user, default)
except Exception as e:
log.error("Exception caught in variation: " + e.message + " for flag key: " + key + " and user: " + str(user))
return default
return self._store.get(key, cb)
def _evaluate(self, flag, user):
return evaluate(flag, user, self._store)
def _evaluate_and_send_events(self, flag, user, default):
value, events = self._evaluate(flag, user)
for event in events or []:
self._send_event(event)
if value is None:
value = default
self._send_event({'kind': 'feature', 'key': flag.get('key'),
'user': user, 'value': value, 'default': default, 'version': flag.get('version')})
return value
def all_flags(self, user):
if self._config.offline:
log.warn("all_flags() called, but client is in offline mode. Returning None")
return None
if not self.is_initialized():
log.warn("all_flags() called before client has finished initializing! Returning None")
return None
if user is None or user.get('key') is None:
log.warn("User or user key is None when calling all_flags(). Returning None.")
return None
def cb(all_flags):
try:
return self._evaluate_multi(user, all_flags)
except Exception as e:
log.error("Exception caught in all_flags: " + e.message + " for user: " + str(user))
return {}
return self._store.all(cb)
def _evaluate_multi(self, user, flags):
return dict([(k, self._evaluate(v, user)[0]) for k, v in flags.items() or {}])
def secure_mode_hash(self, user):
if user.get('key') is None or self._config.sdk_key is None:
return ""
return hmac.new(self._config.sdk_key.encode(), user.get('key').encode(), hashlib.sha256).hexdigest()
@staticmethod
def _sanitize_user(user):
if 'key' in user:
user['key'] = str(user['key'])
__all__ = ['LDClient', 'Config']