/
config.rb
411 lines (368 loc) · 14.2 KB
/
config.rb
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
require "logger"
module LaunchDarkly
#
# This class exposes advanced configuration options for the LaunchDarkly
# client library. Most users will not need to use a custom configuration--
# the default configuration sets sane defaults for most use cases.
#
#
class Config
# rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
#
# Constructor for creating custom LaunchDarkly configurations.
#
# @param opts [Hash] the configuration options
# @option opts [Logger] :logger See {#logger}.
# @option opts [String] :base_uri ("https://app.launchdarkly.com") See {#base_uri}.
# @option opts [String] :stream_uri ("https://stream.launchdarkly.com") See {#stream_uri}.
# @option opts [String] :events_uri ("https://events.launchdarkly.com") See {#events_uri}.
# @option opts [Integer] :capacity (10000) See {#capacity}.
# @option opts [Float] :flush_interval (30) See {#flush_interval}.
# @option opts [Float] :read_timeout (10) See {#read_timeout}.
# @option opts [Float] :connect_timeout (2) See {#connect_timeout}.
# @option opts [Object] :cache_store See {#cache_store}.
# @option opts [Object] :feature_store See {#feature_store}.
# @option opts [Boolean] :use_ldd (false) See {#use_ldd?}.
# @option opts [Boolean] :offline (false) See {#offline?}.
# @option opts [Float] :poll_interval (30) See {#poll_interval}.
# @option opts [Boolean] :stream (true) See {#stream?}.
# @option opts [Boolean] all_attributes_private (false) See {#all_attributes_private}.
# @option opts [Array] :private_attribute_names See {#private_attribute_names}.
# @option opts [Boolean] :send_events (true) See {#send_events}.
# @option opts [Integer] :user_keys_capacity (1000) See {#user_keys_capacity}.
# @option opts [Float] :user_keys_flush_interval (300) See {#user_keys_flush_interval}.
# @option opts [Boolean] :inline_users_in_events (false) See {#inline_users_in_events}.
# @option opts [Object] :data_source See {#data_source}.
# @option opts [Object] :update_processor Obsolete synonym for `data_source`.
# @option opts [Object] :update_processor_factory Obsolete synonym for `data_source`.
#
def initialize(opts = {})
@base_uri = (opts[:base_uri] || Config.default_base_uri).chomp("/")
@stream_uri = (opts[:stream_uri] || Config.default_stream_uri).chomp("/")
@events_uri = (opts[:events_uri] || Config.default_events_uri).chomp("/")
@capacity = opts[:capacity] || Config.default_capacity
@logger = opts[:logger] || Config.default_logger
@cache_store = opts[:cache_store] || Config.default_cache_store
@flush_interval = opts[:flush_interval] || Config.default_flush_interval
@connect_timeout = opts[:connect_timeout] || Config.default_connect_timeout
@read_timeout = opts[:read_timeout] || Config.default_read_timeout
@feature_store = opts[:feature_store] || Config.default_feature_store
@stream = opts.has_key?(:stream) ? opts[:stream] : Config.default_stream
@use_ldd = opts.has_key?(:use_ldd) ? opts[:use_ldd] : Config.default_use_ldd
@offline = opts.has_key?(:offline) ? opts[:offline] : Config.default_offline
@poll_interval = opts.has_key?(:poll_interval) && opts[:poll_interval] > Config.default_poll_interval ? opts[:poll_interval] : Config.default_poll_interval
@all_attributes_private = opts[:all_attributes_private] || false
@private_attribute_names = opts[:private_attribute_names] || []
@send_events = opts.has_key?(:send_events) ? opts[:send_events] : Config.default_send_events
@user_keys_capacity = opts[:user_keys_capacity] || Config.default_user_keys_capacity
@user_keys_flush_interval = opts[:user_keys_flush_interval] || Config.default_user_keys_flush_interval
@inline_users_in_events = opts[:inline_users_in_events] || false
@data_source = opts[:data_source] || opts[:update_processor] || opts[:update_processor_factory]
@update_processor = opts[:update_processor]
@update_processor_factory = opts[:update_processor_factory]
end
#
# The base URL for the LaunchDarkly server. This is configurable mainly for testing
# purposes; most users should use the default value.
# @return [String]
#
attr_reader :base_uri
#
# The base URL for the LaunchDarkly streaming server. This is configurable mainly for testing
# purposes; most users should use the default value.
# @return [String]
#
attr_reader :stream_uri
#
# The base URL for the LaunchDarkly events server. This is configurable mainly for testing
# purposes; most users should use the default value.
# @return [String]
#
attr_reader :events_uri
#
# Whether streaming mode should be enabled. Streaming mode asynchronously updates
# feature flags in real-time using server-sent events. Streaming is enabled by default, and
# should only be disabled on the advice of LaunchDarkly support.
# @return [Boolean]
#
def stream?
@stream
end
#
# Whether to use the LaunchDarkly relay proxy in daemon mode. In this mode, the client does not
# use polling or streaming to get feature flag updates from the server, but instead reads them
# from the {#feature_store feature store}, which is assumed to be a database that is populated by
# a LaunchDarkly relay proxy. For more information, see ["The relay proxy"](https://docs.launchdarkly.com/v2.0/docs/the-relay-proxy)
# and ["Using a persistent feature store"](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
#
# All other properties related to streaming or polling are ignored if this option is set to true.
#
# @return [Boolean]
#
def use_ldd?
@use_ldd
end
#
# Whether the client should be initialized in offline mode. In offline mode, default values are
# returned for all flags and no remote network requests are made.
# @return [Boolean]
#
def offline?
@offline
end
#
# The number of seconds between flushes of the event buffer. Decreasing the flush interval means
# that the event buffer is less likely to reach capacity.
# @return [Float]
#
attr_reader :flush_interval
#
# The number of seconds to wait before polling for feature flag updates. This option has no
# effect unless streaming is disabled.
# @return [Float]
#
attr_reader :poll_interval
#
# The configured logger for the LaunchDarkly client. The client library uses the log to
# print warning and error messages. If not specified, this defaults to the Rails logger
# in a Rails environment, or stdout otherwise.
# @return [Logger]
#
attr_reader :logger
#
# The capacity of the events buffer. The client buffers up to this many
# events in memory before flushing. If the capacity is exceeded before
# the buffer is flushed, events will be discarded.
# Increasing the capacity means that events are less likely to be discarded,
# at the cost of consuming more memory.
# @return [Integer]
#
attr_reader :capacity
#
# A store for HTTP caching (used only in polling mode). This must support the semantics used by
# the [`faraday-http-cache`](https://github.com/plataformatec/faraday-http-cache) gem, although
# the SDK no longer uses Faraday. Defaults to the Rails cache in a Rails environment, or a
# thread-safe in-memory store otherwise.
# @return [Object]
#
attr_reader :cache_store
#
# The read timeout for network connections in seconds. This does not apply to the streaming
# connection, which uses a longer timeout since the server does not send data constantly.
# @return [Float]
#
attr_reader :read_timeout
#
# The connect timeout for network connections in seconds.
# @return [Float]
#
attr_reader :connect_timeout
#
# A store for feature flags and related data. The client uses it to store all data received
# from LaunchDarkly, and uses the last stored data when evaluating flags. Defaults to
# {InMemoryFeatureStore}; for other implementations, see {LaunchDarkly::Integrations}.
#
# For more information, see ["Using a persistent feature store"](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
#
# @return [LaunchDarkly::Interfaces::FeatureStore]
#
attr_reader :feature_store
#
# True if all user attributes (other than the key) should be considered private. This means
# that the attribute values will not be sent to LaunchDarkly in analytics events and will not
# appear on the LaunchDarkly dashboard.
# @return [Boolean]
# @see #private_attribute_names
#
attr_reader :all_attributes_private
#
# A list of user attribute names that should always be considered private. This means that the
# attribute values will not be sent to LaunchDarkly in analytics events and will not appear on
# the LaunchDarkly dashboard.
#
# You can also specify the same behavior for an individual flag evaluation by storing an array
# of attribute names in the `:privateAttributeNames` property (note camelcase name) of the
# user object.
#
# @return [Array<String>]
# @see #all_attributes_private
#
attr_reader :private_attribute_names
#
# Whether to send events back to LaunchDarkly. This differs from {#offline?} in that it affects
# only the sending of client-side events, not streaming or polling for events from the server.
# @return [Boolean]
#
attr_reader :send_events
#
# The number of user keys that the event processor can remember at any one time. This reduces the
# amount of duplicate user details sent in analytics events.
# @return [Integer]
# @see #user_keys_flush_interval
#
attr_reader :user_keys_capacity
#
# The interval in seconds at which the event processor will reset its set of known user keys.
# @return [Float]
# @see #user_keys_capacity
#
attr_reader :user_keys_flush_interval
#
# Whether to include full user details in every analytics event. By default, events will only
# include the user key, except for one "index" event that provides the full details for the user.
# The only reason to change this is if you are using the Analytics Data Stream.
# @return [Boolean]
#
attr_reader :inline_users_in_events
#
# An object that is responsible for receiving feature flag data from LaunchDarkly. By default,
# the client uses its standard polling or streaming implementation; this is customizable for
# testing purposes.
#
# This may be set to either an object that conforms to {LaunchDarkly::Interfaces::DataSource},
# or a lambda (or Proc) that takes two parameters-- SDK key and {Config}-- and returns such an
# object.
#
# @return [LaunchDarkly::Interfaces::DataSource|lambda]
# @see FileDataSource
#
attr_reader :data_source
# @deprecated This is replaced by {#data_source}.
attr_reader :update_processor
# @deprecated This is replaced by {#data_source}.
attr_reader :update_processor_factory
#
# The default LaunchDarkly client configuration. This configuration sets
# reasonable defaults for most users.
# @return [Config] The default LaunchDarkly configuration.
#
def self.default
Config.new
end
#
# The default value for {#capacity}.
# @return [Integer] 10000
#
def self.default_capacity
10000
end
#
# The default value for {#base_uri}.
# @return [String] "https://app.launchdarkly.com"
#
def self.default_base_uri
"https://app.launchdarkly.com"
end
#
# The default value for {#stream_uri}.
# @return [String] "https://stream.launchdarkly.com"
#
def self.default_stream_uri
"https://stream.launchdarkly.com"
end
#
# The default value for {#events_uri}.
# @return [String] "https://events.launchdarkly.com"
#
def self.default_events_uri
"https://events.launchdarkly.com"
end
#
# The default value for {#cache_store}.
# @return [Object] the Rails cache if in Rails, or a simple in-memory implementation otherwise
#
def self.default_cache_store
defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : ThreadSafeMemoryStore.new
end
#
# The default value for {#flush_interval}.
# @return [Float] 10
#
def self.default_flush_interval
10
end
#
# The default value for {#read_timeout}.
# @return [Float] 10
#
def self.default_read_timeout
10
end
#
# The default value for {#connect_timeout}.
# @return [Float] 10
#
def self.default_connect_timeout
2
end
#
# The default value for {#logger}.
# @return [Logger] the Rails logger if in Rails, or a default Logger at WARN level otherwise
#
def self.default_logger
if defined?(Rails) && Rails.respond_to?(:logger)
Rails.logger
else
log = ::Logger.new($stdout)
log.level = ::Logger::WARN
log
end
end
#
# The default value for {#stream?}.
# @return [Boolean] true
#
def self.default_stream
true
end
#
# The default value for {#use_ldd?}.
# @return [Boolean] false
#
def self.default_use_ldd
false
end
#
# The default value for {#feature_store}.
# @return [LaunchDarkly::Interfaces::FeatureStore] an {InMemoryFeatureStore}
#
def self.default_feature_store
InMemoryFeatureStore.new
end
#
# The default value for {#offline?}.
# @return [Boolean] false
#
def self.default_offline
false
end
#
# The default value for {#poll_interval}.
# @return [Float] 30
#
def self.default_poll_interval
30
end
#
# The default value for {#send_events}.
# @return [Boolean] true
#
def self.default_send_events
true
end
#
# The default value for {#user_keys_capacity}.
# @return [Integer] 1000
#
def self.default_user_keys_capacity
1000
end
#
# The default value for {#user_keys_flush_interval}.
# @return [Float] 300
#
def self.default_user_keys_flush_interval
300
end
end
end