Class: Optimizely::ProjectConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/optimizely/project_config.rb

Constant Summary collapse

RUNNING_EXPERIMENT_STATUS =

Representation of the Optimizely project config.

['Running'].freeze
RESERVED_ATTRIBUTE_PREFIX = 
'$opt_'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(datafile, logger, error_handler) ⇒ ProjectConfig

Returns a new instance of ProjectConfig.

Raises:



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
 
# File 'lib/optimizely/project_config.rb', line 66

def initialize(datafile, logger, error_handler)
  # ProjectConfig init method to fetch and set project config data
  #
  # datafile - JSON string representing the project

  config = JSON.parse(datafile)

  @error_handler = error_handler
  @logger = logger
  @version = config['version']

  raise InvalidDatafileVersionError, @version unless Helpers::Constants::SUPPORTED_VERSIONS.value?(@version)

  @account_id = config['accountId']
  @attributes = config.fetch('attributes', [])
  @audiences = config.fetch('audiences', [])
  @events = config.fetch('events', [])
  @experiments = config['experiments']
  @feature_flags = config.fetch('featureFlags', [])
  @groups = config.fetch('groups', [])
  @project_id = config['projectId']
  @anonymize_ip = config.key?('anonymizeIP') ? config['anonymizeIP'] : false
  @bot_filtering = config['botFiltering']
  @revision = config['revision']
  @rollouts = config.fetch('rollouts', [])

  # Utility maps for quick lookup
  @attribute_key_map = generate_key_map(@attributes, 'key')
  @event_key_map = generate_key_map(@events, 'key')
  @group_key_map = generate_key_map(@groups, 'id')
  @group_key_map.each do |key, group|
    exps = group.fetch('experiments')
    exps.each do |exp|
      @experiments.push(exp.merge('groupId' => key))
    end
  end
  @experiment_key_map = generate_key_map(@experiments, 'key')
  @experiment_id_map = generate_key_map(@experiments, 'id')
  @audience_id_map = generate_key_map(@audiences, 'id')
  @variation_id_map = {}
  @variation_key_map = {}
  @forced_variation_map = {}
  @variation_id_to_variable_usage_map = {}
  @variation_id_to_experiment_map = {}
  @experiment_key_map.each_value do |exp|
    # Excludes experiments from rollouts
    variations = exp.fetch('variations')
    variations.each do |variation|
      variation_id = variation['id']
      @variation_id_to_experiment_map[variation_id] = exp
    end
  end
  @rollout_id_map = generate_key_map(@rollouts, 'id')
  # split out the experiment id map for rollouts
  @rollout_experiment_id_map = {}
  @rollout_id_map.each_value do |rollout|
    exps = rollout.fetch('experiments')
    @rollout_experiment_id_map = @rollout_experiment_id_map.merge(generate_key_map(exps, 'id'))
  end
  @all_experiments = @experiment_key_map.merge(@rollout_experiment_id_map)
  @all_experiments.each do |key, exp|
    variations = exp.fetch('variations')
    variations.each do |variation|
      variation_id = variation['id']
      variation['featureEnabled'] = variation['featureEnabled'] == true
      variation_variables = variation['variables']
      unless variation_variables.nil?
        @variation_id_to_variable_usage_map[variation_id] = generate_key_map(variation_variables, 'id')
      end
    end
    @variation_id_map[key] = generate_key_map(variations, 'id')
    @variation_key_map[key] = generate_key_map(variations, 'key')
  end
  @feature_flag_key_map = generate_key_map(@feature_flags, 'key')
  @feature_variable_key_map = {}
  @feature_flag_key_map.each do |key, feature_flag|
    @feature_variable_key_map[key] = generate_key_map(feature_flag['variables'], 'key')
  end
end

Instance Attribute Details

#account_id ⇒ Object (readonly)

Returns the value of attribute account_id.



31
32
33
 
# File 'lib/optimizely/project_config.rb', line 31

def 
  @account_id
end

#anonymize_ip ⇒ Object (readonly)

Boolean - denotes if Optimizely should remove the last block of visitors’ IP address before storing event data



40
41
42
 
# File 'lib/optimizely/project_config.rb', line 40

def anonymize_ip
  @anonymize_ip
end

#attribute_key_map ⇒ Object (readonly)

Returns the value of attribute attribute_key_map.



46
47
48
 
# File 'lib/optimizely/project_config.rb', line 46

def attribute_key_map
  @attribute_key_map
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



32
33
34
 
# File 'lib/optimizely/project_config.rb', line 32

def attributes
  @attributes
end

#audience_id_map ⇒ Object (readonly)

Returns the value of attribute audience_id_map.



47
48
49
 
# File 'lib/optimizely/project_config.rb', line 47

def audience_id_map
  @audience_id_map
end

#audiences ⇒ Object (readonly)

Returns the value of attribute audiences.



33
34
35
 
# File 'lib/optimizely/project_config.rb', line 33

def audiences
  @audiences
end

#bot_filtering ⇒ Object (readonly)

Returns the value of attribute bot_filtering.



41
42
43
 
# File 'lib/optimizely/project_config.rb', line 41

def bot_filtering
  @bot_filtering
end

#error_handler ⇒ Object (readonly)

Gets project config attributes.



28
29
30
 
# File 'lib/optimizely/project_config.rb', line 28

def error_handler
  @error_handler
end

#event_key_map ⇒ Object (readonly)

Returns the value of attribute event_key_map.



48
49
50
 
# File 'lib/optimizely/project_config.rb', line 48

def event_key_map
  @event_key_map
end

#events ⇒ Object (readonly)

Returns the value of attribute events.



34
35
36
 
# File 'lib/optimizely/project_config.rb', line 34

def events
  @events
end

#experiment_id_map ⇒ Object (readonly)

Returns the value of attribute experiment_id_map.



49
50
51
 
# File 'lib/optimizely/project_config.rb', line 49

def experiment_id_map
  @experiment_id_map
end

#experiment_key_map ⇒ Object (readonly)

Returns the value of attribute experiment_key_map.



50
51
52
 
# File 'lib/optimizely/project_config.rb', line 50

def experiment_key_map
  @experiment_key_map
end

#experiments ⇒ Object (readonly)

Returns the value of attribute experiments.



35
36
37
 
# File 'lib/optimizely/project_config.rb', line 35

def experiments
  @experiments
end

#feature_flag_key_map ⇒ Object (readonly)

Returns the value of attribute feature_flag_key_map.



51
52
53
 
# File 'lib/optimizely/project_config.rb', line 51

def feature_flag_key_map
  @feature_flag_key_map
end

#feature_flags ⇒ Object (readonly)

Returns the value of attribute feature_flags.



36
37
38
 
# File 'lib/optimizely/project_config.rb', line 36

def feature_flags
  @feature_flags
end

#feature_variable_key_map ⇒ Object (readonly)

Returns the value of attribute feature_variable_key_map.



52
53
54
 
# File 'lib/optimizely/project_config.rb', line 52

def feature_variable_key_map
  @feature_variable_key_map
end

#forced_variation_map ⇒ Object (readonly)

Hash of user IDs to a Hash of experiments to variations. This contains all the forced variations set by the user by calling setForcedVariation (it is not the same as the whitelisting forcedVariations data structure in the Experiments class).



64
65
66
 
# File 'lib/optimizely/project_config.rb', line 64

def forced_variation_map
  @forced_variation_map
end

#group_key_map ⇒ Object (readonly)

Returns the value of attribute group_key_map.



53
54
55
 
# File 'lib/optimizely/project_config.rb', line 53

def group_key_map
  @group_key_map
end

#groups ⇒ Object (readonly)

Returns the value of attribute groups.



37
38
39
 
# File 'lib/optimizely/project_config.rb', line 37

def groups
  @groups
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



29
30
31
 
# File 'lib/optimizely/project_config.rb', line 29

def logger
  @logger
end

#project_id ⇒ Object (readonly)

Returns the value of attribute project_id.



38
39
40
 
# File 'lib/optimizely/project_config.rb', line 38

def project_id
  @project_id
end

#revision ⇒ Object (readonly)

Returns the value of attribute revision.



42
43
44
 
# File 'lib/optimizely/project_config.rb', line 42

def revision
  @revision
end

#rollout_experiment_id_map ⇒ Object (readonly)

Returns the value of attribute rollout_experiment_id_map.



55
56
57
 
# File 'lib/optimizely/project_config.rb', line 55

def rollout_experiment_id_map
  @rollout_experiment_id_map
end

#rollout_id_map ⇒ Object (readonly)

Returns the value of attribute rollout_id_map.



54
55
56
 
# File 'lib/optimizely/project_config.rb', line 54

def rollout_id_map
  @rollout_id_map
end

#rollouts ⇒ Object (readonly)

Returns the value of attribute rollouts.



43
44
45
 
# File 'lib/optimizely/project_config.rb', line 43

def rollouts
  @rollouts
end

#variation_id_map ⇒ Object (readonly)

Returns the value of attribute variation_id_map.



56
57
58
 
# File 'lib/optimizely/project_config.rb', line 56

def variation_id_map
  @variation_id_map
end

#variation_id_to_variable_usage_map ⇒ Object (readonly)

Returns the value of attribute variation_id_to_variable_usage_map.



57
58
59
 
# File 'lib/optimizely/project_config.rb', line 57

def variation_id_to_variable_usage_map
  @variation_id_to_variable_usage_map
end

#variation_key_map ⇒ Object (readonly)

Returns the value of attribute variation_key_map.



58
59
60
 
# File 'lib/optimizely/project_config.rb', line 58

def variation_key_map
  @variation_key_map
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



44
45
46
 
# File 'lib/optimizely/project_config.rb', line 44

def version
  @version
end

Instance Method Details

#experiment_running?(experiment) ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
149
150
151
152
153
 
# File 'lib/optimizely/project_config.rb', line 146

def experiment_running?(experiment)
  # Determine if experiment corresponding to given key is running
  #
  # experiment - Experiment
  #
  # Returns true if experiment is running
  RUNNING_EXPERIMENT_STATUS.include?(experiment['status'])
end

#get_attribute_id(attribute_key) ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/optimizely/project_config.rb', line 362

def get_attribute_id(attribute_key)
  # Get attribute ID for the provided attribute key.
  #
  # Args:
  #   Attribute key for which attribute is to be fetched.
  #
  # Returns:
  #   Attribute ID corresponding to the provided attribute key.
  attribute = @attribute_key_map[attribute_key]
  has_reserved_prefix = attribute_key.to_s.start_with?(RESERVED_ATTRIBUTE_PREFIX)
  unless attribute.nil?
    if has_reserved_prefix
      @logger.log(Logger::WARN, "Attribute '#{attribute_key}' unexpectedly has reserved prefix '#{RESERVED_ATTRIBUTE_PREFIX}'; "\
                  'using attribute ID instead of reserved attribute name.')
    end
    return attribute['id']
  end
  return attribute_key if has_reserved_prefix
  @logger.log Logger::ERROR, "Attribute key '#{attribute_key}' is not in datafile."
  @error_handler.handle_error InvalidAttributeError
  nil
end

#get_audience_from_id(audience_id) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/optimizely/project_config.rb', line 197

def get_audience_from_id(audience_id)
  # Get audience for the provided audience ID
  #
  # audience_id - ID of the audience
  #
  # Returns the audience

  audience = @audience_id_map[audience_id]
  return audience if audience
  @logger.log Logger::ERROR, "Audience '#{audience_id}' is not in datafile."
  @error_handler.handle_error InvalidAudienceError
  nil
end

#get_experiment_from_key(experiment_key) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/optimizely/project_config.rb', line 155

def get_experiment_from_key(experiment_key)
  # Retrieves experiment ID for a given key
  #
  # experiment_key - String key representing the experiment
  #
  # Returns Experiment or nil if not found

  experiment = @experiment_key_map[experiment_key]
  return experiment if experiment
  @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
  @error_handler.handle_error InvalidExperimentError
  nil
end

#get_experiment_ids_for_event(event_key) ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/optimizely/project_config.rb', line 183

def get_experiment_ids_for_event(event_key)
  # Get experiment IDs for the provided event key.
  #
  # event_key - Event key for which experiment IDs are to be retrieved.
  #
  # Returns array of all experiment IDs for the event.

  event = @event_key_map[event_key]
  return event['experimentIds'] if event
  @logger.log Logger::ERROR, "Event '#{event_key}' is not in datafile."
  @error_handler.handle_error InvalidEventError
  []
end

#get_experiment_key(experiment_id) ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/optimizely/project_config.rb', line 169

def get_experiment_key(experiment_id)
  # Retrieves experiment key for a given ID.
  #
  # experiment_id - String ID representing the experiment.
  #
  # Returns String key.

  experiment = @experiment_id_map[experiment_id]
  return experiment['key'] unless experiment.nil?
  @logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
  @error_handler.handle_error InvalidExperimentError
  nil
end

#get_feature_flag_from_key(feature_flag_key) ⇒ Object 



405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/optimizely/project_config.rb', line 405

def get_feature_flag_from_key(feature_flag_key)
  # Retrieves the feature flag with the given key
  #
  # feature_flag_key - String feature key
  #
  # Returns feature flag if found, otherwise nil
  feature_flag = @feature_flag_key_map[feature_flag_key]
  return feature_flag if feature_flag
  @logger.log Logger::ERROR, "Feature flag key '#{feature_flag_key}' is not in datafile."
  nil
end

#get_feature_variable(feature_flag, variable_key) ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/optimizely/project_config.rb', line 417

def get_feature_variable(feature_flag, variable_key)
  # Retrieves the variable with the given key for the given feature
  #
  # feature_flag - The feature flag for which we are retrieving the variable
  # variable_key - String variable key
  #
  # Returns variable if found, otherwise nil
  feature_flag_key = feature_flag['key']
  variable = @feature_variable_key_map[feature_flag_key][variable_key]
  return variable if variable
  @logger.log Logger::ERROR, "No feature variable was found for key '#{variable_key}' in feature flag "\
              "'#{feature_flag_key}'."
  nil
end

#get_forced_variation(experiment_key, user_id) ⇒ Object 



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
 
# File 'lib/optimizely/project_config.rb', line 268

def get_forced_variation(experiment_key, user_id)
  # Gets the forced variation for the given user and experiment.
  #
  # experiment_key - String Key for experiment.
  # user_id - String ID for user
  #
  # Returns Variation The variation which the given user and experiment should be forced into.

  return nil unless Optimizely::Helpers::Validator.inputs_valid?(
    {
      experiment_key: experiment_key,
      user_id: user_id
    }, @logger, Logger::DEBUG
  )

  unless @forced_variation_map.key? user_id
    @logger.log(Logger::DEBUG, "User '#{user_id}' is not in the forced variation map.")
    return nil
  end

  experiment_to_variation_map = @forced_variation_map[user_id]
  experiment = get_experiment_from_key(experiment_key)
  experiment_id = experiment['id'] if experiment
  # check for nil and empty string experiment ID
  # this case is logged in get_experiment_from_key
  return nil if experiment_id.nil? || experiment_id.empty?

  unless experiment_to_variation_map.key? experiment_id
    @logger.log(Logger::DEBUG, "No experiment '#{experiment_key}' mapped to user '#{user_id}' "\
                'in the forced variation map.')
    return nil
  end

  variation_id = experiment_to_variation_map[experiment_id]
  variation_key = ''
  variation = get_variation_from_id(experiment_key, variation_id)
  variation_key = variation['key'] if variation

  # check if the variation exists in the datafile
  # this case is logged in get_variation_from_id
  return nil if variation_key.empty?

  @logger.log(Logger::DEBUG, "Variation '#{variation_key}' is mapped to experiment '#{experiment_key}' "\
              "and user '#{user_id}' in the forced variation map")

  variation
end

#get_rollout_from_id(rollout_id) ⇒ Object 



432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/optimizely/project_config.rb', line 432

def get_rollout_from_id(rollout_id)
  # Retrieves the rollout with the given ID
  #
  # rollout_id - String rollout ID
  #
  # Returns the rollout if found, otherwise nil
  rollout = @rollout_id_map[rollout_id]
  return rollout if rollout
  @logger.log Logger::ERROR, "Rollout with ID '#{rollout_id}' is not in the datafile."
  nil
end

#get_variation_from_id(experiment_key, variation_id) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/optimizely/project_config.rb', line 211

def get_variation_from_id(experiment_key, variation_id)
  # Get variation given experiment key and variation ID
  #
  # experiment_key - Key representing parent experiment of variation
  # variation_id - ID of the variation
  #
  # Returns the variation or nil if not found

  variation_id_map = @variation_id_map[experiment_key]
  if variation_id_map
    variation = variation_id_map[variation_id]
    return variation if variation
    @logger.log Logger::ERROR, "Variation id '#{variation_id}' is not in datafile."
    @error_handler.handle_error InvalidVariationError
    return nil
  end

  @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
  @error_handler.handle_error InvalidExperimentError
  nil
end

#get_variation_id_from_key(experiment_key, variation_key) ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/optimizely/project_config.rb', line 233

def get_variation_id_from_key(experiment_key, variation_key)
  # Get variation ID given experiment key and variation key
  #
  # experiment_key - Key representing parent experiment of variation
  # variation_key - Key of the variation
  #
  # Returns ID of the variation

  variation_key_map = @variation_key_map[experiment_key]
  if variation_key_map
    variation = variation_key_map[variation_key]
    return variation['id'] if variation
    @logger.log Logger::ERROR, "Variation key '#{variation_key}' is not in datafile."
    @error_handler.handle_error InvalidVariationError
    return nil
  end

  @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
  @error_handler.handle_error InvalidExperimentError
  nil
end

#get_whitelisted_variations(experiment_key) ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/optimizely/project_config.rb', line 255

def get_whitelisted_variations(experiment_key)
  # Retrieves whitelisted variations for a given experiment Key
  #
  # experiment_key - String Key representing the experiment
  #
  # Returns whitelisted variations for the experiment or nil

  experiment = @experiment_key_map[experiment_key]
  return experiment['forcedVariations'] if experiment
  @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
  @error_handler.handle_error InvalidExperimentError
end

#set_forced_variation(experiment_key, user_id, variation_key) ⇒ Object 



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
 
# File 'lib/optimizely/project_config.rb', line 316

def set_forced_variation(experiment_key, user_id, variation_key)
  # Sets a Hash of user IDs to a Hash of experiments to forced variations.
  #
  # experiment_key - String Key for experiment.
  # user_id - String ID for user.
  # variation_key - String Key for variation. If null, then clear the existing experiment-to-variation mapping.
  #
  # Returns a boolean value that indicates if the set completed successfully.

  return false unless Optimizely::Helpers::Validator.inputs_valid?(
    {
      user_id: user_id,
      experiment_key: experiment_key
    }, @logger, Logger::DEBUG
  )

  experiment = get_experiment_from_key(experiment_key)
  experiment_id = experiment['id'] if experiment
  #  check if the experiment exists in the datafile
  return false if experiment_id.nil? || experiment_id.empty?

  #  clear the forced variation if the variation key is null
  if variation_key.nil? || variation_key.empty?
    @forced_variation_map[user_id].delete(experiment_id) if @forced_variation_map.key? user_id
    @logger.log(Logger::DEBUG, "Variation mapped to experiment '#{experiment_key}' has been removed for user "\
                "'#{user_id}'.")
    return true
  end

  variation_id = get_variation_id_from_key(experiment_key, variation_key)

  #  check if the variation exists in the datafile
  unless variation_id
    #  this case is logged in get_variation_id_from_key
    return false
  end

  unless @forced_variation_map.key? user_id
    @forced_variation_map[user_id] = {}
  end
  @forced_variation_map[user_id][experiment_id] = variation_id
  @logger.log(Logger::DEBUG, "Set variation '#{variation_id}' for experiment '#{experiment_id}' and "\
              "user '#{user_id}' in the forced variation map.")
  true
end

#variation_id_exists?(experiment_id, variation_id) ⇒ Boolean

Returns:

  • (Boolean) 


385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/optimizely/project_config.rb', line 385

def variation_id_exists?(experiment_id, variation_id)
  # Determines if a given experiment ID / variation ID pair exists in the datafile
  #
  # experiment_id - String experiment ID
  # variation_id - String variation ID
  #
  # Returns true if variation is in datafile

  experiment_key = get_experiment_key(experiment_id)
  variation_id_map = @variation_id_map[experiment_key]
  if variation_id_map
    variation = variation_id_map[variation_id]
    return true if variation
    @logger.log Logger::ERROR, "Variation ID '#{variation_id}' is not in datafile."
    @error_handler.handle_error InvalidVariationError
  end

  false
end