optimizely-sdk 3.10.1 → 4.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +202 -202
- data/lib/optimizely/audience.rb +127 -97
- data/lib/optimizely/bucketer.rb +156 -156
- data/lib/optimizely/condition_tree_evaluator.rb +123 -123
- data/lib/optimizely/config/datafile_project_config.rb +539 -552
- data/lib/optimizely/config/proxy_config.rb +34 -34
- data/lib/optimizely/config_manager/async_scheduler.rb +95 -95
- data/lib/optimizely/config_manager/http_project_config_manager.rb +330 -329
- data/lib/optimizely/config_manager/project_config_manager.rb +24 -24
- data/lib/optimizely/config_manager/static_project_config_manager.rb +53 -52
- data/lib/optimizely/decide/optimizely_decide_option.rb +28 -28
- data/lib/optimizely/decide/optimizely_decision.rb +60 -60
- data/lib/optimizely/decide/optimizely_decision_message.rb +26 -26
- data/lib/optimizely/decision_service.rb +563 -563
- data/lib/optimizely/error_handler.rb +39 -39
- data/lib/optimizely/event/batch_event_processor.rb +235 -234
- data/lib/optimizely/event/entity/conversion_event.rb +44 -43
- data/lib/optimizely/event/entity/decision.rb +38 -38
- data/lib/optimizely/event/entity/event_batch.rb +86 -86
- data/lib/optimizely/event/entity/event_context.rb +50 -50
- data/lib/optimizely/event/entity/impression_event.rb +48 -47
- data/lib/optimizely/event/entity/snapshot.rb +33 -33
- data/lib/optimizely/event/entity/snapshot_event.rb +48 -48
- data/lib/optimizely/event/entity/user_event.rb +22 -22
- data/lib/optimizely/event/entity/visitor.rb +36 -35
- data/lib/optimizely/event/entity/visitor_attribute.rb +38 -37
- data/lib/optimizely/event/event_factory.rb +156 -155
- data/lib/optimizely/event/event_processor.rb +25 -25
- data/lib/optimizely/event/forwarding_event_processor.rb +44 -43
- data/lib/optimizely/event/user_event_factory.rb +88 -88
- data/lib/optimizely/event_builder.rb +221 -228
- data/lib/optimizely/event_dispatcher.rb +71 -71
- data/lib/optimizely/exceptions.rb +135 -139
- data/lib/optimizely/helpers/constants.rb +415 -397
- data/lib/optimizely/helpers/date_time_utils.rb +30 -30
- data/lib/optimizely/helpers/event_tag_utils.rb +132 -132
- data/lib/optimizely/helpers/group.rb +31 -31
- data/lib/optimizely/helpers/http_utils.rb +65 -64
- data/lib/optimizely/helpers/validator.rb +183 -183
- data/lib/optimizely/helpers/variable_type.rb +67 -67
- data/lib/optimizely/logger.rb +46 -45
- data/lib/optimizely/notification_center.rb +174 -176
- data/lib/optimizely/optimizely_config.rb +271 -272
- data/lib/optimizely/optimizely_factory.rb +181 -181
- data/lib/optimizely/optimizely_user_context.rb +204 -179
- data/lib/optimizely/params.rb +31 -31
- data/lib/optimizely/project_config.rb +99 -91
- data/lib/optimizely/semantic_version.rb +166 -166
- data/lib/optimizely/{custom_attribute_condition_evaluator.rb → user_condition_evaluator.rb} +391 -369
- data/lib/optimizely/user_profile_service.rb +35 -35
- data/lib/optimizely/version.rb +21 -21
- data/lib/optimizely.rb +1130 -1145
- metadata +15 -14
@@ -1,552 +1,539 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
# Copyright 2019-
|
4
|
-
#
|
5
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
-
# you may not use this file except in compliance with the License.
|
7
|
-
# You may obtain a copy of the License at
|
8
|
-
#
|
9
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
-
#
|
11
|
-
# Unless required by applicable law or agreed to in writing, software
|
12
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
-
# See the License for the specific language governing permissions and
|
15
|
-
# limitations under the License.
|
16
|
-
#
|
17
|
-
require 'json'
|
18
|
-
require 'optimizely/project_config'
|
19
|
-
require 'optimizely/helpers/constants'
|
20
|
-
require 'optimizely/helpers/validator'
|
21
|
-
module Optimizely
|
22
|
-
class DatafileProjectConfig < ProjectConfig
|
23
|
-
# Representation of the Optimizely project config.
|
24
|
-
RUNNING_EXPERIMENT_STATUS = ['Running'].freeze
|
25
|
-
RESERVED_ATTRIBUTE_PREFIX = '$opt_'
|
26
|
-
|
27
|
-
attr_reader :datafile
|
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
|
-
end
|
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
|
-
end
|
462
|
-
|
463
|
-
def
|
464
|
-
# Retrieves the
|
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
|
-
nil
|
490
|
-
end
|
491
|
-
|
492
|
-
def
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
# Returns
|
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
|
-
def generate_key_map(array, key)
|
542
|
-
# Helper method to generate map from key to hash in array of hashes
|
543
|
-
#
|
544
|
-
# array - Array consisting of hash
|
545
|
-
# key - Key in each hash which will be key in the map
|
546
|
-
#
|
547
|
-
# Returns map mapping key to hash
|
548
|
-
|
549
|
-
Hash[array.map { |obj| [obj[key], obj] }]
|
550
|
-
end
|
551
|
-
end
|
552
|
-
end
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2019-2022, Optimizely and contributors
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
#
|
17
|
+
require 'json'
|
18
|
+
require 'optimizely/project_config'
|
19
|
+
require 'optimizely/helpers/constants'
|
20
|
+
require 'optimizely/helpers/validator'
|
21
|
+
module Optimizely
|
22
|
+
class DatafileProjectConfig < ProjectConfig
|
23
|
+
# Representation of the Optimizely project config.
|
24
|
+
RUNNING_EXPERIMENT_STATUS = ['Running'].freeze
|
25
|
+
RESERVED_ATTRIBUTE_PREFIX = '$opt_'
|
26
|
+
|
27
|
+
attr_reader :datafile, :account_id, :attributes, :audiences, :typed_audiences, :events,
|
28
|
+
:experiments, :feature_flags, :groups, :project_id, :bot_filtering, :revision,
|
29
|
+
:sdk_key, :environment_key, :rollouts, :version, :send_flag_decisions,
|
30
|
+
:attribute_key_map, :audience_id_map, :event_key_map, :experiment_feature_map,
|
31
|
+
:experiment_id_map, :experiment_key_map, :feature_flag_key_map, :feature_variable_key_map,
|
32
|
+
:group_id_map, :rollout_id_map, :rollout_experiment_id_map, :variation_id_map,
|
33
|
+
:variation_id_to_variable_usage_map, :variation_key_map, :variation_id_map_by_experiment_id,
|
34
|
+
:variation_key_map_by_experiment_id, :flag_variation_map, :integration_key_map, :integrations,
|
35
|
+
:public_key_for_odp, :host_for_odp, :all_segments
|
36
|
+
# Boolean - denotes if Optimizely should remove the last block of visitors' IP address before storing event data
|
37
|
+
attr_reader :anonymize_ip
|
38
|
+
|
39
|
+
def initialize(datafile, logger, error_handler)
|
40
|
+
# ProjectConfig init method to fetch and set project config data
|
41
|
+
#
|
42
|
+
# datafile - JSON string representing the project
|
43
|
+
super()
|
44
|
+
|
45
|
+
config = JSON.parse(datafile)
|
46
|
+
|
47
|
+
@datafile = datafile
|
48
|
+
@error_handler = error_handler
|
49
|
+
@logger = logger
|
50
|
+
@version = config['version']
|
51
|
+
|
52
|
+
raise InvalidDatafileVersionError, @version unless Helpers::Constants::SUPPORTED_VERSIONS.value?(@version)
|
53
|
+
|
54
|
+
@account_id = config['accountId']
|
55
|
+
@attributes = config.fetch('attributes', [])
|
56
|
+
@audiences = config.fetch('audiences', [])
|
57
|
+
@typed_audiences = config.fetch('typedAudiences', [])
|
58
|
+
@events = config.fetch('events', [])
|
59
|
+
@experiments = config['experiments']
|
60
|
+
@feature_flags = config.fetch('featureFlags', [])
|
61
|
+
@groups = config.fetch('groups', [])
|
62
|
+
@project_id = config['projectId']
|
63
|
+
@anonymize_ip = config.key?('anonymizeIP') ? config['anonymizeIP'] : false
|
64
|
+
@bot_filtering = config['botFiltering']
|
65
|
+
@revision = config['revision']
|
66
|
+
@sdk_key = config.fetch('sdkKey', '')
|
67
|
+
@environment_key = config.fetch('environmentKey', '')
|
68
|
+
@rollouts = config.fetch('rollouts', [])
|
69
|
+
@send_flag_decisions = config.fetch('sendFlagDecisions', false)
|
70
|
+
@integrations = config.fetch('integrations', [])
|
71
|
+
|
72
|
+
# Json type is represented in datafile as a subtype of string for the sake of backwards compatibility.
|
73
|
+
# Converting it to a first-class json type while creating Project Config
|
74
|
+
@feature_flags.each do |feature_flag|
|
75
|
+
feature_flag['variables'].each do |variable|
|
76
|
+
if variable['type'] == 'string' && variable['subType'] == 'json'
|
77
|
+
variable['type'] = 'json'
|
78
|
+
variable.delete('subType')
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
# Utility maps for quick lookup
|
84
|
+
@attribute_key_map = generate_key_map(@attributes, 'key')
|
85
|
+
@event_key_map = generate_key_map(@events, 'key')
|
86
|
+
@group_id_map = generate_key_map(@groups, 'id')
|
87
|
+
@group_id_map.each do |key, group|
|
88
|
+
exps = group.fetch('experiments')
|
89
|
+
exps.each do |exp|
|
90
|
+
@experiments.push(exp.merge('groupId' => key))
|
91
|
+
end
|
92
|
+
end
|
93
|
+
@experiment_key_map = generate_key_map(@experiments, 'key')
|
94
|
+
@experiment_id_map = generate_key_map(@experiments, 'id')
|
95
|
+
@audience_id_map = generate_key_map(@audiences, 'id')
|
96
|
+
@integration_key_map = generate_key_map(@integrations, 'key')
|
97
|
+
@audience_id_map = @audience_id_map.merge(generate_key_map(@typed_audiences, 'id')) unless @typed_audiences.empty?
|
98
|
+
@variation_id_map = {}
|
99
|
+
@variation_key_map = {}
|
100
|
+
@variation_id_map_by_experiment_id = {}
|
101
|
+
@variation_key_map_by_experiment_id = {}
|
102
|
+
@variation_id_to_variable_usage_map = {}
|
103
|
+
@variation_id_to_experiment_map = {}
|
104
|
+
@flag_variation_map = {}
|
105
|
+
|
106
|
+
@experiment_id_map.each_value do |exp|
|
107
|
+
# Excludes experiments from rollouts
|
108
|
+
variations = exp.fetch('variations')
|
109
|
+
variations.each do |variation|
|
110
|
+
variation_id = variation['id']
|
111
|
+
@variation_id_to_experiment_map[variation_id] = exp
|
112
|
+
end
|
113
|
+
end
|
114
|
+
@rollout_id_map = generate_key_map(@rollouts, 'id')
|
115
|
+
# split out the experiment key map for rollouts
|
116
|
+
@rollout_experiment_id_map = {}
|
117
|
+
@rollout_id_map.each_value do |rollout|
|
118
|
+
exps = rollout.fetch('experiments')
|
119
|
+
@rollout_experiment_id_map = @rollout_experiment_id_map.merge(generate_key_map(exps, 'id'))
|
120
|
+
end
|
121
|
+
|
122
|
+
if (odp_integration = @integration_key_map&.fetch('odp', nil))
|
123
|
+
@public_key_for_odp = odp_integration['publicKey']
|
124
|
+
@host_for_odp = odp_integration['host']
|
125
|
+
end
|
126
|
+
|
127
|
+
@all_segments = []
|
128
|
+
@audience_id_map.each_value do |audience|
|
129
|
+
@all_segments.concat Audience.get_segments(audience['conditions'])
|
130
|
+
end
|
131
|
+
|
132
|
+
@flag_variation_map = generate_feature_variation_map(@feature_flags)
|
133
|
+
@all_experiments = @experiment_id_map.merge(@rollout_experiment_id_map)
|
134
|
+
@all_experiments.each do |id, exp|
|
135
|
+
variations = exp.fetch('variations')
|
136
|
+
variations.each do |variation|
|
137
|
+
variation_id = variation['id']
|
138
|
+
variation['featureEnabled'] = variation['featureEnabled'] == true
|
139
|
+
variation_variables = variation['variables']
|
140
|
+
next if variation_variables.nil?
|
141
|
+
|
142
|
+
@variation_id_to_variable_usage_map[variation_id] = generate_key_map(variation_variables, 'id')
|
143
|
+
end
|
144
|
+
@variation_id_map[exp['key']] = generate_key_map(variations, 'id')
|
145
|
+
@variation_key_map[exp['key']] = generate_key_map(variations, 'key')
|
146
|
+
@variation_id_map_by_experiment_id[id] = generate_key_map(variations, 'id')
|
147
|
+
@variation_key_map_by_experiment_id[id] = generate_key_map(variations, 'key')
|
148
|
+
end
|
149
|
+
@feature_flag_key_map = generate_key_map(@feature_flags, 'key')
|
150
|
+
@experiment_feature_map = {}
|
151
|
+
@feature_variable_key_map = {}
|
152
|
+
@feature_flag_key_map.each do |key, feature_flag|
|
153
|
+
@feature_variable_key_map[key] = generate_key_map(feature_flag['variables'], 'key')
|
154
|
+
feature_flag['experimentIds'].each do |experiment_id|
|
155
|
+
@experiment_feature_map[experiment_id] = [feature_flag['id']]
|
156
|
+
end
|
157
|
+
end
|
158
|
+
end
|
159
|
+
|
160
|
+
def get_rules_for_flag(feature_flag)
|
161
|
+
# Retrieves rules for a given feature flag
|
162
|
+
#
|
163
|
+
# feature_flag - String key representing the feature_flag
|
164
|
+
#
|
165
|
+
# Returns rules in feature flag
|
166
|
+
rules = feature_flag['experimentIds'].map { |exp_id| @experiment_id_map[exp_id] }
|
167
|
+
rollout = feature_flag['rolloutId'].empty? ? nil : @rollout_id_map[feature_flag['rolloutId']]
|
168
|
+
|
169
|
+
if rollout
|
170
|
+
rollout_experiments = rollout.fetch('experiments')
|
171
|
+
rollout_experiments.each do |exp|
|
172
|
+
rules.push(exp)
|
173
|
+
end
|
174
|
+
end
|
175
|
+
rules
|
176
|
+
end
|
177
|
+
|
178
|
+
def self.create(datafile, logger, error_handler, skip_json_validation)
|
179
|
+
# Looks up and sets datafile and config based on response body.
|
180
|
+
#
|
181
|
+
# datafile - JSON string representing the Optimizely project.
|
182
|
+
# logger - Provides a logger instance.
|
183
|
+
# error_handler - Provides a handle_error method to handle exceptions.
|
184
|
+
# skip_json_validation - Optional boolean param which allows skipping JSON schema
|
185
|
+
# validation upon object invocation. By default JSON schema validation will be performed.
|
186
|
+
# Returns instance of DatafileProjectConfig, nil otherwise.
|
187
|
+
if !skip_json_validation && !Helpers::Validator.datafile_valid?(datafile)
|
188
|
+
default_logger = SimpleLogger.new
|
189
|
+
default_logger.log(Logger::ERROR, InvalidInputError.new('datafile').message)
|
190
|
+
return nil
|
191
|
+
end
|
192
|
+
|
193
|
+
begin
|
194
|
+
config = new(datafile, logger, error_handler)
|
195
|
+
rescue StandardError => e
|
196
|
+
default_logger = SimpleLogger.new
|
197
|
+
error_to_handle = e.instance_of?(InvalidDatafileVersionError) ? e : InvalidInputError.new('datafile')
|
198
|
+
error_msg = error_to_handle.message
|
199
|
+
|
200
|
+
default_logger.log(Logger::ERROR, error_msg)
|
201
|
+
error_handler.handle_error error_to_handle
|
202
|
+
return nil
|
203
|
+
end
|
204
|
+
|
205
|
+
config
|
206
|
+
end
|
207
|
+
|
208
|
+
def experiment_running?(experiment)
|
209
|
+
# Determine if experiment corresponding to given key is running
|
210
|
+
#
|
211
|
+
# experiment - Experiment
|
212
|
+
#
|
213
|
+
# Returns true if experiment is running
|
214
|
+
RUNNING_EXPERIMENT_STATUS.include?(experiment['status'])
|
215
|
+
end
|
216
|
+
|
217
|
+
def get_experiment_from_key(experiment_key)
|
218
|
+
# Retrieves experiment ID for a given key
|
219
|
+
#
|
220
|
+
# experiment_key - String key representing the experiment
|
221
|
+
#
|
222
|
+
# Returns Experiment or nil if not found
|
223
|
+
|
224
|
+
experiment = @experiment_key_map[experiment_key]
|
225
|
+
return experiment if experiment
|
226
|
+
|
227
|
+
@logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
|
228
|
+
@error_handler.handle_error InvalidExperimentError
|
229
|
+
nil
|
230
|
+
end
|
231
|
+
|
232
|
+
def get_experiment_from_id(experiment_id)
|
233
|
+
# Retrieves experiment ID for a given key
|
234
|
+
#
|
235
|
+
# experiment_id - String id representing the experiment
|
236
|
+
#
|
237
|
+
# Returns Experiment or nil if not found
|
238
|
+
|
239
|
+
experiment = @experiment_id_map[experiment_id]
|
240
|
+
return experiment if experiment
|
241
|
+
|
242
|
+
@logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
|
243
|
+
@error_handler.handle_error InvalidExperimentError
|
244
|
+
nil
|
245
|
+
end
|
246
|
+
|
247
|
+
def get_experiment_key(experiment_id)
|
248
|
+
# Retrieves experiment key for a given ID.
|
249
|
+
#
|
250
|
+
# experiment_id - String ID representing the experiment.
|
251
|
+
#
|
252
|
+
# Returns String key.
|
253
|
+
|
254
|
+
experiment = @experiment_id_map[experiment_id]
|
255
|
+
return experiment['key'] unless experiment.nil?
|
256
|
+
|
257
|
+
@logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
|
258
|
+
@error_handler.handle_error InvalidExperimentError
|
259
|
+
nil
|
260
|
+
end
|
261
|
+
|
262
|
+
def get_event_from_key(event_key)
|
263
|
+
# Get event for the provided event key.
|
264
|
+
#
|
265
|
+
# event_key - Event key for which event is to be determined.
|
266
|
+
#
|
267
|
+
# Returns Event corresponding to the provided event key.
|
268
|
+
|
269
|
+
event = @event_key_map[event_key]
|
270
|
+
return event if event
|
271
|
+
|
272
|
+
@logger.log Logger::ERROR, "Event '#{event_key}' is not in datafile."
|
273
|
+
@error_handler.handle_error InvalidEventError
|
274
|
+
nil
|
275
|
+
end
|
276
|
+
|
277
|
+
def get_audience_from_id(audience_id)
|
278
|
+
# Get audience for the provided audience ID
|
279
|
+
#
|
280
|
+
# audience_id - ID of the audience
|
281
|
+
#
|
282
|
+
# Returns the audience
|
283
|
+
|
284
|
+
audience = @audience_id_map[audience_id]
|
285
|
+
return audience if audience
|
286
|
+
|
287
|
+
@logger.log Logger::ERROR, "Audience '#{audience_id}' is not in datafile."
|
288
|
+
@error_handler.handle_error InvalidAudienceError
|
289
|
+
nil
|
290
|
+
end
|
291
|
+
|
292
|
+
def get_variation_from_flag(flag_key, target_value, attribute)
|
293
|
+
variations = @flag_variation_map[flag_key]
|
294
|
+
return variations.select { |variation| variation[attribute] == target_value }.first if variations
|
295
|
+
|
296
|
+
nil
|
297
|
+
end
|
298
|
+
|
299
|
+
def get_variation_from_id(experiment_key, variation_id)
|
300
|
+
# Get variation given experiment key and variation ID
|
301
|
+
#
|
302
|
+
# experiment_key - Key representing parent experiment of variation
|
303
|
+
# variation_id - ID of the variation
|
304
|
+
#
|
305
|
+
# Returns the variation or nil if not found
|
306
|
+
|
307
|
+
variation_id_map = @variation_id_map[experiment_key]
|
308
|
+
if variation_id_map
|
309
|
+
variation = variation_id_map[variation_id]
|
310
|
+
return variation if variation
|
311
|
+
|
312
|
+
@logger.log Logger::ERROR, "Variation id '#{variation_id}' is not in datafile."
|
313
|
+
@error_handler.handle_error InvalidVariationError
|
314
|
+
return nil
|
315
|
+
end
|
316
|
+
|
317
|
+
@logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
|
318
|
+
@error_handler.handle_error InvalidExperimentError
|
319
|
+
nil
|
320
|
+
end
|
321
|
+
|
322
|
+
def get_variation_from_id_by_experiment_id(experiment_id, variation_id)
|
323
|
+
# Get variation given experiment ID and variation ID
|
324
|
+
#
|
325
|
+
# experiment_id - ID representing parent experiment of variation
|
326
|
+
# variation_id - ID of the variation
|
327
|
+
#
|
328
|
+
# Returns the variation or nil if not found
|
329
|
+
|
330
|
+
variation_id_map_by_experiment_id = @variation_id_map_by_experiment_id[experiment_id]
|
331
|
+
if variation_id_map_by_experiment_id
|
332
|
+
variation = variation_id_map_by_experiment_id[variation_id]
|
333
|
+
return variation if variation
|
334
|
+
|
335
|
+
@logger.log Logger::ERROR, "Variation id '#{variation_id}' is not in datafile."
|
336
|
+
@error_handler.handle_error InvalidVariationError
|
337
|
+
return nil
|
338
|
+
end
|
339
|
+
|
340
|
+
@logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
|
341
|
+
@error_handler.handle_error InvalidExperimentError
|
342
|
+
nil
|
343
|
+
end
|
344
|
+
|
345
|
+
def get_variation_id_from_key_by_experiment_id(experiment_id, variation_key)
|
346
|
+
# Get variation given experiment ID and variation key
|
347
|
+
#
|
348
|
+
# experiment_id - ID representing parent experiment of variation
|
349
|
+
# variation_key - Key of the variation
|
350
|
+
#
|
351
|
+
# Returns the variation or nil if not found
|
352
|
+
|
353
|
+
variation_key_map = @variation_key_map_by_experiment_id[experiment_id]
|
354
|
+
if variation_key_map
|
355
|
+
variation = variation_key_map[variation_key]
|
356
|
+
return variation['id'] if variation
|
357
|
+
|
358
|
+
@logger.log Logger::ERROR, "Variation key '#{variation_key}' is not in datafile."
|
359
|
+
@error_handler.handle_error InvalidVariationError
|
360
|
+
return nil
|
361
|
+
end
|
362
|
+
|
363
|
+
@logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
|
364
|
+
@error_handler.handle_error InvalidExperimentError
|
365
|
+
nil
|
366
|
+
end
|
367
|
+
|
368
|
+
def get_variation_id_from_key(experiment_key, variation_key)
|
369
|
+
# Get variation ID given experiment key and variation key
|
370
|
+
#
|
371
|
+
# experiment_key - Key representing parent experiment of variation
|
372
|
+
# variation_key - Key of the variation
|
373
|
+
#
|
374
|
+
# Returns ID of the variation
|
375
|
+
|
376
|
+
variation_key_map = @variation_key_map[experiment_key]
|
377
|
+
if variation_key_map
|
378
|
+
variation = variation_key_map[variation_key]
|
379
|
+
return variation['id'] if variation
|
380
|
+
|
381
|
+
@logger.log Logger::ERROR, "Variation key '#{variation_key}' is not in datafile."
|
382
|
+
@error_handler.handle_error InvalidVariationError
|
383
|
+
return nil
|
384
|
+
end
|
385
|
+
|
386
|
+
@logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
|
387
|
+
@error_handler.handle_error InvalidExperimentError
|
388
|
+
nil
|
389
|
+
end
|
390
|
+
|
391
|
+
def get_whitelisted_variations(experiment_id)
|
392
|
+
# Retrieves whitelisted variations for a given experiment id
|
393
|
+
#
|
394
|
+
# experiment_id - String id representing the experiment
|
395
|
+
#
|
396
|
+
# Returns whitelisted variations for the experiment or nil
|
397
|
+
|
398
|
+
experiment = @experiment_id_map[experiment_id]
|
399
|
+
return experiment['forcedVariations'] if experiment
|
400
|
+
|
401
|
+
@logger.log Logger::ERROR, "Experiment ID '#{experiment_id}' is not in datafile."
|
402
|
+
@error_handler.handle_error InvalidExperimentError
|
403
|
+
end
|
404
|
+
|
405
|
+
def get_attribute_id(attribute_key)
|
406
|
+
# Get attribute ID for the provided attribute key.
|
407
|
+
#
|
408
|
+
# Args:
|
409
|
+
# Attribute key for which attribute is to be fetched.
|
410
|
+
#
|
411
|
+
# Returns:
|
412
|
+
# Attribute ID corresponding to the provided attribute key.
|
413
|
+
attribute = @attribute_key_map[attribute_key]
|
414
|
+
has_reserved_prefix = attribute_key.to_s.start_with?(RESERVED_ATTRIBUTE_PREFIX)
|
415
|
+
unless attribute.nil?
|
416
|
+
if has_reserved_prefix
|
417
|
+
@logger.log(Logger::WARN, "Attribute '#{attribute_key}' unexpectedly has reserved prefix '#{RESERVED_ATTRIBUTE_PREFIX}'; "\
|
418
|
+
'using attribute ID instead of reserved attribute name.')
|
419
|
+
end
|
420
|
+
return attribute['id']
|
421
|
+
end
|
422
|
+
return attribute_key if has_reserved_prefix
|
423
|
+
|
424
|
+
@logger.log Logger::ERROR, "Attribute key '#{attribute_key}' is not in datafile."
|
425
|
+
@error_handler.handle_error InvalidAttributeError
|
426
|
+
nil
|
427
|
+
end
|
428
|
+
|
429
|
+
def variation_id_exists?(experiment_id, variation_id)
|
430
|
+
# Determines if a given experiment ID / variation ID pair exists in the datafile
|
431
|
+
#
|
432
|
+
# experiment_id - String experiment ID
|
433
|
+
# variation_id - String variation ID
|
434
|
+
#
|
435
|
+
# Returns true if variation is in datafile
|
436
|
+
|
437
|
+
experiment_key = get_experiment_key(experiment_id)
|
438
|
+
variation_id_map = @variation_id_map[experiment_key]
|
439
|
+
if variation_id_map
|
440
|
+
variation = variation_id_map[variation_id]
|
441
|
+
return true if variation
|
442
|
+
|
443
|
+
@logger.log Logger::ERROR, "Variation ID '#{variation_id}' is not in datafile."
|
444
|
+
@error_handler.handle_error InvalidVariationError
|
445
|
+
end
|
446
|
+
|
447
|
+
false
|
448
|
+
end
|
449
|
+
|
450
|
+
def get_feature_flag_from_key(feature_flag_key)
|
451
|
+
# Retrieves the feature flag with the given key
|
452
|
+
#
|
453
|
+
# feature_flag_key - String feature key
|
454
|
+
#
|
455
|
+
# Returns feature flag if found, otherwise nil
|
456
|
+
feature_flag = @feature_flag_key_map[feature_flag_key]
|
457
|
+
return feature_flag if feature_flag
|
458
|
+
|
459
|
+
@logger.log Logger::ERROR, "Feature flag key '#{feature_flag_key}' is not in datafile."
|
460
|
+
nil
|
461
|
+
end
|
462
|
+
|
463
|
+
def get_feature_variable(feature_flag, variable_key)
|
464
|
+
# Retrieves the variable with the given key for the given feature
|
465
|
+
#
|
466
|
+
# feature_flag - The feature flag for which we are retrieving the variable
|
467
|
+
# variable_key - String variable key
|
468
|
+
#
|
469
|
+
# Returns variable if found, otherwise nil
|
470
|
+
feature_flag_key = feature_flag['key']
|
471
|
+
variable = @feature_variable_key_map[feature_flag_key][variable_key]
|
472
|
+
return variable if variable
|
473
|
+
|
474
|
+
@logger.log Logger::ERROR, "No feature variable was found for key '#{variable_key}' in feature flag "\
|
475
|
+
"'#{feature_flag_key}'."
|
476
|
+
nil
|
477
|
+
end
|
478
|
+
|
479
|
+
def get_rollout_from_id(rollout_id)
|
480
|
+
# Retrieves the rollout with the given ID
|
481
|
+
#
|
482
|
+
# rollout_id - String rollout ID
|
483
|
+
#
|
484
|
+
# Returns the rollout if found, otherwise nil
|
485
|
+
rollout = @rollout_id_map[rollout_id]
|
486
|
+
return rollout if rollout
|
487
|
+
|
488
|
+
@logger.log Logger::ERROR, "Rollout with ID '#{rollout_id}' is not in the datafile."
|
489
|
+
nil
|
490
|
+
end
|
491
|
+
|
492
|
+
def feature_experiment?(experiment_id)
|
493
|
+
# Determines if given experiment is a feature test.
|
494
|
+
#
|
495
|
+
# experiment_id - String experiment ID
|
496
|
+
#
|
497
|
+
# Returns true if experiment belongs to any feature,
|
498
|
+
# false otherwise.
|
499
|
+
@experiment_feature_map.key?(experiment_id)
|
500
|
+
end
|
501
|
+
|
502
|
+
def rollout_experiment?(experiment_id)
|
503
|
+
# Determines if given experiment is a rollout test.
|
504
|
+
#
|
505
|
+
# experiment_id - String experiment ID
|
506
|
+
#
|
507
|
+
# Returns true if experiment belongs to any rollout,
|
508
|
+
# false otherwise.
|
509
|
+
@rollout_experiment_id_map.key?(experiment_id)
|
510
|
+
end
|
511
|
+
|
512
|
+
private
|
513
|
+
|
514
|
+
def generate_feature_variation_map(feature_flags)
|
515
|
+
flag_variation_map = {}
|
516
|
+
feature_flags.each do |flag|
|
517
|
+
variations = []
|
518
|
+
get_rules_for_flag(flag).each do |rule|
|
519
|
+
rule['variations'].each do |rule_variation|
|
520
|
+
variations.push(rule_variation) if variations.select { |variation| variation['id'] == rule_variation['id'] }.empty?
|
521
|
+
end
|
522
|
+
end
|
523
|
+
flag_variation_map[flag['key']] = variations
|
524
|
+
end
|
525
|
+
flag_variation_map
|
526
|
+
end
|
527
|
+
|
528
|
+
def generate_key_map(array, key)
|
529
|
+
# Helper method to generate map from key to hash in array of hashes
|
530
|
+
#
|
531
|
+
# array - Array consisting of hash
|
532
|
+
# key - Key in each hash which will be key in the map
|
533
|
+
#
|
534
|
+
# Returns map mapping key to hash
|
535
|
+
|
536
|
+
Hash[array.map { |obj| [obj[key], obj] }]
|
537
|
+
end
|
538
|
+
end
|
539
|
+
end
|