Class: SplitIoClient::SplitClient

Inherits:
Object
  • Object
show all
Defined in:
lib/splitclient-rb/clients/split_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(api_key, config = {}, adapter = nil, splits_repository, segments_repository, impressions_repository, metrics_repository) ⇒ SplitIoClient

Creates a new split client instance that connects to split.io API.

Parameters:

  • api_key (String) —

    the API key for your split account



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 9

def initialize(api_key, config = {}, adapter = nil, splits_repository, segments_repository, impressions_repository, metrics_repository)
  @config = config

  @splits_repository = splits_repository
  @segments_repository = segments_repository
  @impressions_repository = impressions_repository
  @metrics_repository = metrics_repository

  @adapter = adapter
end

Instance Method Details

#get_treatment(key, split_name, attributes = nil, split_data = nil, store_impressions = true, multiple = false) ⇒ String/Hash

obtains the treatment for a given feature

Parameters:

  • key (String/Hash) —

    user id or hash with matching_key/bucketing_key

  • split_name (String/Array) —

    name of the feature that is being validated or array of them

  • attributes (Hash) (defaults to: nil) —

    attributes to pass to the treatment class

  • split_data (Hash) (defaults to: nil) —

    split data, when provided this method doesn't fetch splits_repository for the data

  • store_impressions (Boolean) (defaults to: true) —

    impressions aren't stored if this flag is false

  • multiple (Hash) (defaults to: false) —

    internal flag to signal if method is called by get_treatments

Returns:

  • (String/Hash) —

    Treatment as String or Hash of treatments in case of array of features



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
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 49

def get_treatment(key, split_name, attributes = nil, split_data = nil, store_impressions = true, multiple = false)
  bucketing_key, matching_key = keys_from_key(key)

  if matching_key.nil?
    @config.logger.warn('matching_key was null for split_name: ' + split_name.to_s)
    return parsed_treatment(multiple, { label: Engine::Models::Label::EXCEPTION, treatment: Treatments::CONTROL })
  end

  if split_name.nil?
    @config.logger.warn('split_name was null for key: ' + key)
    return parsed_treatment(multiple, { label: Engine::Models::Label::EXCEPTION, treatment: Treatments::CONTROL })
  end

  start = Time.now
  treatment_label_change_number = { label: Engine::Models::Label::EXCEPTION, treatment: Treatments::CONTROL }

  begin
    split = multiple ? split_data : @splits_repository.get_split(split_name)

    if split.nil?
      @config.logger.debug("split_name: #{split_name} does not exist. Returning CONTROL")
      return parsed_treatment(multiple, treatment_label_change_number)
    else
      treatment_label_change_number = SplitIoClient::Engine::Parser::SplitTreatment.new(@segments_repository).call(
        { bucketing_key: bucketing_key, matching_key: matching_key }, split, attributes
      )
    end
  rescue StandardError => error
    @config.log_found_exception(__method__.to_s, error)

    store_impression(
      split_name, matching_key, bucketing_key,
      { treatment: SplitIoClient::Treatments::CONTROL, label: Engine::Models::Label::EXCEPTION },
      store_impressions
    )

    return parsed_treatment(multiple, treatment_label_change_number)
  end

  begin
    latency = (Time.now - start) * 1000.0
    # Disable impressions if @config.impressions_queue_size == -1
    split && store_impression(split_name, matching_key, bucketing_key, treatment_label_change_number, store_impressions)

    # Measure
    @adapter.metrics.time('sdk.get_treatment', latency)
  rescue StandardError => error
    @config.log_found_exception(__method__.to_s, error)

    store_impression(
      split_name, matching_key, bucketing_key,
      { treatment: SplitIoClient::Treatments::CONTROL, label: Engine::Models::Label::EXCEPTION },
      store_impressions
    )

    return parsed_treatment(multiple, treatment_label_change_number)
  end

  parsed_treatment(multiple, treatment_label_change_number)
end

#get_treatments(key, split_names, attributes = nil) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 20

def get_treatments(key, split_names, attributes = nil)
  bucketing_key, matching_key = keys_from_key(key)

  treatments_labels_change_numbers =
    @splits_repository.get_splits(split_names).each_with_object({}) do |(name, data), memo|
      memo.merge!(name => get_treatment(key, name, attributes, data, false, true))
    end

  if @config.impressions_queue_size > 0
    @impressions_repository.add_bulk(matching_key, bucketing_key, treatments_labels_change_numbers, (Time.now.to_f * 1000.0).to_i)
  end

  split_names = treatments_labels_change_numbers.keys
  treatments = treatments_labels_change_numbers.values.map { |v| v[:treatment] }

  Hash[split_names.zip(treatments)]
end

#keys_from_key(key) ⇒ Object 



123
124
125
126
127
128
129
130
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 123

def keys_from_key(key)
  case key.class.to_s
  when 'Hash'
    key.values_at(:bucketing_key, :matching_key).map { |k| k.nil? ? nil : k.to_s }
  else
    [nil, key].map { |k| k.nil? ? nil : k.to_s }
  end
end

#parsed_treatment(multiple, treatment_label_change_number) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 132

def parsed_treatment(multiple, treatment_label_change_number)
  if multiple
    {
      treatment: treatment_label_change_number[:treatment],
      label: treatment_label_change_number[:label],
      change_number: treatment_label_change_number[:change_number]
    }
  else
    treatment_label_change_number[:treatment]
  end
end

#store_impression(split_name, matching_key, bucketing_key, treatment, store_impressions) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 110

def store_impression(split_name, matching_key, bucketing_key, treatment, store_impressions)
  return if @config.impressions_queue_size <= 0 || !store_impressions

  @impressions_repository.add(split_name,
    'keyName' => matching_key,
    'bucketingKey' => bucketing_key,
    'treatment' => treatment[:treatment],
    'label' => @config.labels_enabled ? treatment[:label] : nil,
    'time' => (Time.now.to_f * 1000.0).to_i,
    'changeNumber' => treatment[:change_number]
  )
end