Class: Optimizely::DatafileProjectConfig

Inherits:
ProjectConfig show all
Defined in:
lib/optimizely/config/datafile_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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(datafile, logger, error_handler) ⇒ DatafileProjectConfig

Returns a new instance of DatafileProjectConfig.

Raises:



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
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 58

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', [])
  @typed_audiences = config.fetch('typedAudiences', [])
  @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_id_map = generate_key_map(@groups, 'id')
  @group_id_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')
  @audience_id_map = @audience_id_map.merge(generate_key_map(@typed_audiences, 'id')) unless @typed_audiences.empty?
  @variation_id_map = {}
  @variation_key_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 key map for rollouts
  @rollout_experiment_key_map = {}
  @rollout_id_map.each_value do |rollout|
    exps = rollout.fetch('experiments')
    @rollout_experiment_key_map = @rollout_experiment_key_map.merge(generate_key_map(exps, 'key'))
  end
  @all_experiments = @experiment_key_map.merge(@rollout_experiment_key_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']
      next if variation_variables.nil?

      @variation_id_to_variable_usage_map[variation_id] = generate_key_map(variation_variables, 'id')
    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')
  @experiment_feature_map = {}
  @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')
    feature_flag['experimentIds'].each do |experiment_id|
      @experiment_feature_map[experiment_id] = [feature_flag['id']]
    end
  end
end

Instance Attribute Details

#account_id ⇒ Object (readonly)

Returns the value of attribute account_id.



27
28
29
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 27

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



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

def anonymize_ip
  @anonymize_ip
end

#attribute_key_map ⇒ Object (readonly)

Returns the value of attribute attribute_key_map.



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

def attribute_key_map
  @attribute_key_map
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



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

def attributes
  @attributes
end

#audience_id_map ⇒ Object (readonly)

Returns the value of attribute audience_id_map.



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

def audience_id_map
  @audience_id_map
end

#audiences ⇒ Object (readonly)

Returns the value of attribute audiences.



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

def audiences
  @audiences
end

#bot_filtering ⇒ Object (readonly)

Returns the value of attribute bot_filtering.



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

def bot_filtering
  @bot_filtering
end

#event_key_map ⇒ Object (readonly)

Returns the value of attribute event_key_map.



45
46
47
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 45

def event_key_map
  @event_key_map
end

#events ⇒ Object (readonly)

Returns the value of attribute events.



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

def events
  @events
end

#experiment_feature_map ⇒ Object (readonly)

Returns the value of attribute experiment_feature_map.



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

def experiment_feature_map
  @experiment_feature_map
end

#experiment_id_map ⇒ Object (readonly)

Returns the value of attribute experiment_id_map.



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

def experiment_id_map
  @experiment_id_map
end

#experiment_key_map ⇒ Object (readonly)

Returns the value of attribute experiment_key_map.



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

def experiment_key_map
  @experiment_key_map
end

#experiments ⇒ Object (readonly)

Returns the value of attribute experiments.



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

def experiments
  @experiments
end

#feature_flag_key_map ⇒ Object (readonly)

Returns the value of attribute feature_flag_key_map.



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

def feature_flag_key_map
  @feature_flag_key_map
end

#feature_flags ⇒ Object (readonly)

Returns the value of attribute feature_flags.



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

def feature_flags
  @feature_flags
end

#feature_variable_key_map ⇒ Object (readonly)

Returns the value of attribute feature_variable_key_map.



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

def feature_variable_key_map
  @feature_variable_key_map
end

#group_id_map ⇒ Object (readonly)

Returns the value of attribute group_id_map.



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

def group_id_map
  @group_id_map
end

#groups ⇒ Object (readonly)

Returns the value of attribute groups.



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

def groups
  @groups
end

#project_id ⇒ Object (readonly)

Returns the value of attribute project_id.



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

def project_id
  @project_id
end

#revision ⇒ Object (readonly)

Returns the value of attribute revision.



39
40
41
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 39

def revision
  @revision
end

#rollout_experiment_key_map ⇒ Object (readonly)

Returns the value of attribute rollout_experiment_key_map.



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

def rollout_experiment_key_map
  @rollout_experiment_key_map
end

#rollout_id_map ⇒ Object (readonly)

Returns the value of attribute rollout_id_map.



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

def rollout_id_map
  @rollout_id_map
end

#rollouts ⇒ Object (readonly)

Returns the value of attribute rollouts.



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

def rollouts
  @rollouts
end

#typed_audiences ⇒ Object (readonly)

Returns the value of attribute typed_audiences.



30
31
32
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 30

def typed_audiences
  @typed_audiences
end

#variation_id_map ⇒ Object (readonly)

Returns the value of attribute variation_id_map.



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

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.



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

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.



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

def variation_key_map
  @variation_key_map
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.create(datafile, logger, error_handler, skip_json_validation) ⇒ Object 



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
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 143

def self.create(datafile, logger, error_handler, skip_json_validation)
  # Looks up and sets datafile and config based on response body.
  #
  # datafile - JSON string representing the Optimizely project.
  # logger - Provides a logger instance.
  # error_handler - Provides a handle_error method to handle exceptions.
  # skip_json_validation - Optional boolean param which allows skipping JSON schema
  #                       validation upon object invocation. By default JSON schema validation will be performed.
  # Returns instance of DatafileProjectConfig, nil otherwise.
  if !skip_json_validation && !Helpers::Validator.datafile_valid?(datafile)
    default_logger = SimpleLogger.new
    default_logger.log(Logger::ERROR, InvalidInputError.new('datafile').message)
    return nil
  end

  begin
    config = new(datafile, logger, error_handler)
  rescue StandardError => e
    default_logger = SimpleLogger.new
    error_msg = e.class == InvalidDatafileVersionError ? e.message : InvalidInputError.new('datafile').message
    error_to_handle = e.class == InvalidDatafileVersionError ? InvalidDatafileVersionError : InvalidInputError
    default_logger.log(Logger::ERROR, error_msg)
    error_handler.handle_error error_to_handle
    return nil
  end

  config
end

Instance Method Details

#experiment_running?(experiment) ⇒ Boolean

Returns:

  • (Boolean) 


172
173
174
175
176
177
178
179
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 172

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

#feature_experiment?(experiment_id) ⇒ Boolean

Returns:

  • (Boolean) 


388
389
390
391
392
393
394
395
396
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 388

def feature_experiment?(experiment_id)
  # Determines if given experiment is a feature test.
  #
  # experiment_id - String experiment ID
  #
  # Returns true if experiment belongs to  any feature,
  #              false otherwise.
  @experiment_feature_map.key?(experiment_id)
end

#get_attribute_id(attribute_key) ⇒ Object 



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 301

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 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 226

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_event_from_key(event_key) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 211

def get_event_from_key(event_key)
  # Get event for the provided event key.
  #
  # event_key - Event key for which event is to be determined.
  #
  # Returns Event corresponding to the provided event key.

  event = @event_key_map[event_key]
  return event if event

  @logger.log Logger::ERROR, "Event '#{event_key}' is not in datafile."
  @error_handler.handle_error InvalidEventError
  nil
end

#get_experiment_from_key(experiment_key) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 181

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_key(experiment_id) ⇒ Object 



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

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 



346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 346

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 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 359

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_rollout_from_id(rollout_id) ⇒ Object 



375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 375

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 



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 241

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 



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 264

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 



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 287

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

#variation_id_exists?(experiment_id, variation_id) ⇒ Boolean

Returns:

  • (Boolean) 


325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/optimizely/config/datafile_project_config.rb', line 325

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