Class: Featurevisor::Instance

Inherits:
Object
  • Object
show all
Defined in:
lib/featurevisor/instance.rb

Overview

Instance class for managing feature flag evaluations

Constant Summary collapse

EMPTY_DATAFILE =

Empty datafile template

{
  schemaVersion: "2",
  revision: "unknown",
  segments: {},
  features: {},
  variables: {}
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Instance

Initialize a new Featurevisor instance

Parameters:

  • options (Hash) (defaults to: {}) —

    Instance options

Options Hash (options):

  • :datafile (Hash, String) —

    Datafile content or JSON string

  • :context (Hash) —

    Initial context

  • :log_level (String) —

    Log level

  • :sticky_features (Hash) —

    Sticky features

  • :modules (Array<Hash, FeaturevisorModule>) —

    Array of modules

  • :on_diagnostic (Proc) —

    Diagnostic handler



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
 
# File 'lib/featurevisor/instance.rb', line 26

def initialize(options = {})
  # from options
  @context = options[:context] || {}
  @diagnostics = DiagnosticReporter.new(
    level: options[:log_level] || "info",
    handler: method(:handle_evaluation_diagnostic)
  )
  @on_diagnostic = options[:on_diagnostic] || options[:onDiagnostic]
  @emitter = Featurevisor::Emitter.new
  @sticky_features = options[:sticky_features] || options[:stickyFeatures] || {}
  @sticky_variables = options[:sticky_variables] || options[:stickyVariables] || {}
  @closed = false
  @module_diagnostic_subscriptions = []

  # datafile
  @datafile = InstanceEvaluationDataProvider.new(
    datafile: EMPTY_DATAFILE,
    diagnostics: @diagnostics
  )

  @modules_manager = Featurevisor::Modules::ModulesManager.new(
    modules: options[:modules] || [],
    report_diagnostic: method(:report_diagnostic),
    module_api_factory: method(:create_module_api),
    clear_module_diagnostic_subscriptions: method(:clear_module_diagnostic_subscriptions)
  )

  if options[:datafile]
    set_datafile(options[:datafile], true)
  end

  report_diagnostic(
    level: "info",
    code: "sdk_initialized",
    message: "SDK initialized"
  )
end

Instance Method Details

#add_module(mod) ⇒ Proc?

Add a module

Parameters:

  • mod (Hash, FeaturevisorModule) —

    Module to add

Returns:

  • (Proc, nil) —

    Remove function or nil if module already exists



213
214
215
 
# File 'lib/featurevisor/instance.rb', line 213

def add_module(mod)
  @modules_manager.add(mod)
end

#close ⇒ Object

Close the instance



232
233
234
235
236
237
238
239
 
# File 'lib/featurevisor/instance.rb', line 232

def close
  return if @closed

  @closed = true
  @modules_manager.close_all
  @module_diagnostic_subscriptions = []
  @emitter.clear_all
end

#evaluate_flag(feature_key, context = {}, options = {}) ⇒ Hash

Evaluate a flag

Parameters:

  • feature_key (String) —

    Feature key

  • context (Hash) (defaults to: {}) —

    Context

  • options (Hash) (defaults to: {}) —

    Override options

Returns:

  • (Hash) —

    Evaluation result



299
300
301
302
303
304
305
306
 
# File 'lib/featurevisor/instance.rb', line 299

def evaluate_flag(feature_key, context = {}, options = {})
  Featurevisor::Evaluate.evaluate_with_modules(
    get_evaluation_dependencies(context, options).merge(
      type: "flag",
      feature_key: feature_key
    )
  )
end

#evaluate_variable(feature_or_variable_key, variable_key_or_context = nil, context_or_options = {}, options = {}) ⇒ Hash

Evaluate a variable

Parameters:

  • feature_key (String) —

    Feature key

  • variable_key (String) —

    Variable key

  • context (Hash) —

    Context

  • options (Hash) (defaults to: {}) —

    Override options

Returns:

  • (Hash) —

    Evaluation result



365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/featurevisor/instance.rb', line 365

def evaluate_variable(feature_or_variable_key, variable_key_or_context = nil, context_or_options = {}, options = {})
  if variable_key_or_context.nil? || variable_key_or_context.is_a?(Hash)
    context = variable_key_or_context || {}
    return evaluate_variable_without_feature(feature_or_variable_key, context, context_or_options)
  end

  Featurevisor::Evaluate.evaluate_with_modules(
    get_evaluation_dependencies(context_or_options, options).merge(
      type: "variable",
      feature_key: feature_or_variable_key,
      variable_key: variable_key_or_context
    )
  )
end

#evaluate_variation(feature_key, context = {}, options = {}) ⇒ Hash

Evaluate a variation

Parameters:

  • feature_key (String) —

    Feature key

  • context (Hash) (defaults to: {}) —

    Context

  • options (Hash) (defaults to: {}) —

    Override options

Returns:

  • (Hash) —

    Evaluation result



328
329
330
331
332
333
334
335
 
# File 'lib/featurevisor/instance.rb', line 328

def evaluate_variation(feature_key, context = {}, options = {})
  Featurevisor::Evaluate.evaluate_with_modules(
    get_evaluation_dependencies(context, options).merge(
      type: "variation",
      feature_key: feature_key
    )
  )
end

#get_context(context = nil) ⇒ Hash

Get context

Parameters:

  • context (Hash, nil) (defaults to: nil) —

    Additional context to merge

Returns:

  • (Hash) —

    Merged context



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/featurevisor/instance.rb', line 270

def get_context(context = nil)
  if context
    {
      **@context,
      **context
    }
  else
    @context
  end
end

#get_feature(feature_key) ⇒ Hash?

Get a feature by key

Parameters:

  • feature_key (String) —

    Feature key

Returns:

  • (Hash, nil) —

    Feature data or nil if not found



206
207
208
 
# File 'lib/featurevisor/instance.rb', line 206

def get_feature(feature_key)
  @datafile.get_feature(feature_key)
end

#get_feature_evaluations(context = {}, feature_keys = [], options = {}) ⇒ Hash

Get all evaluations

Parameters:

  • context (Hash) (defaults to: {}) —

    Context

  • feature_keys (Array<String>) (defaults to: []) —

    Feature keys to evaluate

  • options (Hash) (defaults to: {}) —

    Override options

Returns:

  • (Hash) —

    All evaluations



489
490
491
492
493
494
495
496
497
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
 
# File 'lib/featurevisor/instance.rb', line 489

def get_feature_evaluations(context = {}, feature_keys = [], options = {})
  result = {}

  keys = feature_keys.size > 0 ? feature_keys : @datafile.get_feature_keys

  keys.each do |feature_key|
    # Convert symbol keys to strings for evaluation functions
    feature_key_str = feature_key.to_s

    # isEnabled
    evaluated_feature = {
      enabled: is_enabled(feature_key_str, context, options)
    }

    # variation
    if @datafile.has_variations?(feature_key_str)
      variation = get_variation(feature_key_str, context, options)
      evaluated_feature[:variation] = variation unless variation.nil?
    end

    # variables
    variable_keys = @datafile.get_variable_keys(feature_key_str)
    if variable_keys.size > 0
      evaluated_feature[:variables] = {}

      variable_keys.each do |variable_key|
        evaluated_feature[:variables][variable_key] = get_variable(
          feature_key_str,
          variable_key,
          context,
          options
        )
      end
    end

    result[feature_key] = evaluated_feature
  end

  result
end

#get_feature_keys ⇒ Object 



191
192
193
 
# File 'lib/featurevisor/instance.rb', line 191

def get_feature_keys
  @datafile.get_feature_keys
end

#get_revision ⇒ String

Get the revision

Returns:

  • (String) —

    Revision string



179
180
181
 
# File 'lib/featurevisor/instance.rb', line 179

def get_revision
  @datafile.get_revision
end

#get_schema_version ⇒ Object 



183
184
185
 
# File 'lib/featurevisor/instance.rb', line 183

def get_schema_version
  @datafile.get_schema_version
end

#get_segment(segment_key) ⇒ Object 



187
188
189
 
# File 'lib/featurevisor/instance.rb', line 187

def get_segment(segment_key)
  @datafile.get_segment(segment_key)
end

#get_variable(feature_or_variable_key, variable_key_or_context = nil, context_or_options = {}, options = {}) ⇒ Object?

Get variable value

Parameters:

  • feature_key (String) —

    Feature key

  • variable_key (String) —

    Variable key

  • context (Hash) —

    Context

  • options (Hash) (defaults to: {}) —

    Override options

Returns:

  • (Object, nil) —

    Variable value or nil



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/featurevisor/instance.rb', line 386

def get_variable(feature_or_variable_key, variable_key_or_context = nil, context_or_options = {}, options = {})
  begin
    evaluation = evaluate_variable(feature_or_variable_key, variable_key_or_context, context_or_options, options)

    if evaluation.key?(:variable_value)
      variable_type = evaluation.dig(:variable_schema, :type) || evaluation.dig(:variable, :type)
      if variable_type == "json" &&
         evaluation[:variable_value].is_a?(String)
        JSON.parse(evaluation[:variable_value], symbolize_names: true)
      else
        evaluation[:variable_value]
      end
    else
      nil
    end
  rescue => e
    report_diagnostic(level: "error", code: "evaluation_error", message: "getVariable failed", originalError: e, details: { variableKey: variable_key_or_context || feature_or_variable_key })
    nil
  end
end

#get_variable_array(*args) ⇒ Array?

Get variable as array

Parameters:

  • feature_key (String) —

    Feature key

  • variable_key (String) —

    Variable key

  • context (Hash) —

    Context

  • options (Hash) —

    Override options

Returns:

  • (Array, nil) —

    Array value or nil



457
458
459
460
 
# File 'lib/featurevisor/instance.rb', line 457

def get_variable_array(*args)
  variable_value = get_variable(*args)
  get_value_by_type(variable_value, "array")
end

#get_variable_boolean(*args) ⇒ Boolean?

Get variable as boolean

Parameters:

  • feature_key (String) —

    Feature key

  • variable_key (String) —

    Variable key

  • context (Hash) —

    Context

  • options (Hash) —

    Override options

Returns:

  • (Boolean, nil) —

    Boolean value or nil



413
414
415
416
 
# File 'lib/featurevisor/instance.rb', line 413

def get_variable_boolean(*args)
  variable_value = get_variable(*args)
  get_value_by_type(variable_value, "boolean")
end

#get_variable_double(*args) ⇒ Float?

Get variable as double

Parameters:

  • feature_key (String) —

    Feature key

  • variable_key (String) —

    Variable key

  • context (Hash) —

    Context

  • options (Hash) —

    Override options

Returns:

  • (Float, nil) —

    Float value or nil



446
447
448
449
 
# File 'lib/featurevisor/instance.rb', line 446

def get_variable_double(*args)
  variable_value = get_variable(*args)
  get_value_by_type(variable_value, "double")
end

#get_variable_evaluations(context = {}, variable_keys = [], options = {}) ⇒ Object 



530
531
532
533
 
# File 'lib/featurevisor/instance.rb', line 530

def get_variable_evaluations(context = {}, variable_keys = [], options = {})
  keys = variable_keys.empty? ? @datafile.get_variable_keys : variable_keys
  keys.to_h { |key| [key, get_variable(key.to_s, context, options)] }
end

#get_variable_integer(*args) ⇒ Integer?

Get variable as integer

Parameters:

  • feature_key (String) —

    Feature key

  • variable_key (String) —

    Variable key

  • context (Hash) —

    Context

  • options (Hash) —

    Override options

Returns:

  • (Integer, nil) —

    Integer value or nil



435
436
437
438
 
# File 'lib/featurevisor/instance.rb', line 435

def get_variable_integer(*args)
  variable_value = get_variable(*args)
  get_value_by_type(variable_value, "integer")
end

#get_variable_json(*args) ⇒ Object?

Get variable as JSON

Parameters:

  • feature_key (String) —

    Feature key

  • variable_key (String) —

    Variable key

  • context (Hash) —

    Context

  • options (Hash) —

    Override options

Returns:

  • (Object, nil) —

    JSON value or nil



479
480
481
482
 
# File 'lib/featurevisor/instance.rb', line 479

def get_variable_json(*args)
  variable_value = get_variable(*args)
  get_value_by_type(variable_value, "json")
end

#get_variable_keys(feature_key = nil) ⇒ Object 



195
196
197
 
# File 'lib/featurevisor/instance.rb', line 195

def get_variable_keys(feature_key = nil)
  @datafile.get_variable_keys(feature_key)
end

#get_variable_object(*args) ⇒ Hash?

Get variable as object

Parameters:

  • feature_key (String) —

    Feature key

  • variable_key (String) —

    Variable key

  • context (Hash) —

    Context

  • options (Hash) —

    Override options

Returns:

  • (Hash, nil) —

    Object value or nil



468
469
470
471
 
# File 'lib/featurevisor/instance.rb', line 468

def get_variable_object(*args)
  variable_value = get_variable(*args)
  get_value_by_type(variable_value, "object")
end

#get_variable_string(*args) ⇒ String?

Get variable as string

Parameters:

  • feature_key (String) —

    Feature key

  • variable_key (String) —

    Variable key

  • context (Hash) —

    Context

  • options (Hash) —

    Override options

Returns:

  • (String, nil) —

    String value or nil



424
425
426
427
 
# File 'lib/featurevisor/instance.rb', line 424

def get_variable_string(*args)
  variable_value = get_variable(*args)
  get_value_by_type(variable_value, "string")
end

#get_variation(feature_key, context = {}, options = {}) ⇒ String?

Get variation value

Parameters:

  • feature_key (String) —

    Feature key

  • context (Hash) (defaults to: {}) —

    Context

  • options (Hash) (defaults to: {}) —

    Override options

Returns:

  • (String, nil) —

    Variation value or nil



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/featurevisor/instance.rb', line 342

def get_variation(feature_key, context = {}, options = {})
  begin
    evaluation = evaluate_variation(feature_key, context, options)

    if evaluation.key?(:variation_value)
      evaluation[:variation_value]
    elsif evaluation[:variation]
      evaluation[:variation][:value]
    else
      nil
    end
  rescue => e
    report_diagnostic(level: "error", code: "evaluation_error", message: "getVariation failed", originalError: e, details: { featureKey: feature_key })
    nil
  end
end

#has_variations?(feature_key) ⇒ Boolean

Returns:

  • (Boolean) 


199
200
201
 
# File 'lib/featurevisor/instance.rb', line 199

def has_variations?(feature_key)
  @datafile.has_variations?(feature_key)
end

#is_enabled(feature_key, context = {}, options = {}) ⇒ Boolean

Check if a feature is enabled

Parameters:

  • feature_key (String) —

    Feature key

  • context (Hash) (defaults to: {}) —

    Context

  • options (Hash) (defaults to: {}) —

    Override options

Returns:

  • (Boolean) —

    True if feature is enabled



313
314
315
316
317
318
319
320
321
 
# File 'lib/featurevisor/instance.rb', line 313

def is_enabled(feature_key, context = {}, options = {})
  begin
    evaluation = evaluate_flag(feature_key, context, options)
    evaluation[:enabled] == true
  rescue => e
    report_diagnostic(level: "error", code: "evaluation_error", message: "isEnabled failed", originalError: e, details: { featureKey: feature_key })
    false
  end
end

#on(event_name, callback) ⇒ Proc

Subscribe to an event

Parameters:

  • event_name (String) —

    Event name

  • callback (Proc) —

    Callback function

Returns:

  • (Proc) —

    Unsubscribe function



225
226
227
228
229
 
# File 'lib/featurevisor/instance.rb', line 225

def on(event_name, callback)
  return -> {} if @closed

  @emitter.on(event_name, callback)
end

#remove_module(name) ⇒ Object 



217
218
219
 
# File 'lib/featurevisor/instance.rb', line 217

def remove_module(name)
  @modules_manager.remove(name)
end

#set_context(context, replace = false) ⇒ Object

Set context

Parameters:

  • context (Hash) —

    Context to set

  • replace (Boolean) (defaults to: false) —

    Whether to replace existing context



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/featurevisor/instance.rb', line 244

def set_context(context, replace = false)
  if replace
    @context = context
  else
    @context = { **@context, **context }
  end

  @emitter.trigger("context_set", {
    context: @context,
    replaced: replace
  })

  report_diagnostic(
    level: "debug",
    code: "context_set",
    message: replace ? "Context replaced" : "Context updated",
    details: {
      context: @context,
      replaced: replace
    }
  )
end

#set_datafile(datafile, replace = false) ⇒ Object

Set the datafile

Parameters:

  • datafile (Hash, String) —

    Datafile content or JSON string

  • replace (Boolean) (defaults to: false) —

    Whether to replace instead of merge



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/featurevisor/instance.rb', line 100

def set_datafile(datafile, replace = false)
  return if @closed

  begin
    parsed_datafile = if datafile.is_a?(String)
                        JSON.parse(datafile, symbolize_names: true)
                      elsif datafile.is_a?(Hash)
                        JSON.parse(JSON.generate(datafile), symbolize_names: true)
                      else
                        datafile
                      end
    unless parsed_datafile.is_a?(Hash) && parsed_datafile[:schemaVersion].is_a?(String) &&
           parsed_datafile[:revision].is_a?(String) && parsed_datafile[:segments].is_a?(Hash) &&
           parsed_datafile[:features].is_a?(Hash) &&
           (!parsed_datafile.key?(:variables) || parsed_datafile[:variables].is_a?(Hash))
      raise ArgumentError, "Invalid datafile"
    end
    next_datafile = replace ? parsed_datafile : merge_datafiles(@datafile.get_datafile, parsed_datafile)
    new_datafile = InstanceEvaluationDataProvider.new(
      datafile: next_datafile,
      diagnostics: @diagnostics
    )

    details = Featurevisor::Events.get_params_for_datafile_set_event(@datafile, new_datafile, replace)
    @datafile = new_datafile

    report_diagnostic(
      level: "info",
      code: "datafile_set",
      message: "Datafile set",
      details: details
    )
    @emitter.trigger("datafile_set", details)
  rescue => e
    report_diagnostic(
      level: "error",
      code: "invalid_datafile",
      message: "Could not parse datafile",
      original_error: e
    )
  end
end

#set_log_level(level) ⇒ Object

Set the log level

Parameters:

  • level (String) —

    Log level



66
67
68
 
# File 'lib/featurevisor/instance.rb', line 66

def set_log_level(level)
  @diagnostics.set_level(level)
end

#set_sticky_features(sticky, replace = false) ⇒ Object

Set sticky features

Parameters:

  • sticky (Hash) —

    Sticky features

  • replace (Boolean) (defaults to: false) —

    Whether to replace existing sticky features



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/featurevisor/instance.rb', line 146

def set_sticky_features(sticky, replace = false)
  previous_sticky_features = @sticky_features || {}

  if replace
    @sticky_features = sticky
  else
    @sticky_features = {
      **@sticky_features,
      **sticky
    }
  end

  params = Featurevisor::Events.get_params_for_sticky_features_set_event(previous_sticky_features, @sticky_features, replace)

  report_diagnostic(
    level: "info",
    code: "sticky_features_set",
    message: "Sticky features set",
    details: params
  )
  @emitter.trigger("sticky_features_set", params)
end

#set_sticky_variables(sticky, replace = false) ⇒ Object 



169
170
171
172
173
174
175
 
# File 'lib/featurevisor/instance.rb', line 169

def set_sticky_variables(sticky, replace = false)
  previous = @sticky_variables || {}
  @sticky_variables = replace ? sticky : { **@sticky_variables, **sticky }
  params = Featurevisor::Events.get_params_for_sticky_variables_set_event(previous, @sticky_variables, replace)
  report_diagnostic(level: "info", code: "sticky_variables_set", message: "Sticky variables set", details: params)
  @emitter.trigger("sticky_variables_set", params)
end

#spawn(context = {}, options = {}) ⇒ ChildInstance

Spawn a child instance

Parameters:

  • context (Hash) (defaults to: {}) —

    Child context

  • options (Hash) (defaults to: {}) —

    Override options

Returns:



285
286
287
288
289
290
291
292
 
# File 'lib/featurevisor/instance.rb', line 285

def spawn(context = {}, options = {})
  Featurevisor::ChildInstance.new(
    parent: self,
    context: get_context(context),
    sticky_features: options[:sticky_features] || options[:stickyFeatures],
    sticky_variables: options[:sticky_variables] || options[:stickyVariables]
  )
end