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, repositories, status_manager, config, impressions_manager, telemetry_evaluation_producer) ⇒ SplitIoClient

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

Parameters:

  • api_key (String) —

    the API key for your split account



17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 17

def initialize(api_key, repositories, status_manager, config, impressions_manager, telemetry_evaluation_producer)
  @api_key = api_key
  @splits_repository = repositories[:splits]
  @segments_repository = repositories[:segments]
  @impressions_repository = repositories[:impressions]
  @events_repository = repositories[:events]
  @status_manager = status_manager
  @destroyed = false
  @config = config
  @impressions_manager = impressions_manager
  @telemetry_evaluation_producer = telemetry_evaluation_producer
end

Instance Method Details

#block_until_ready(time = nil) ⇒ Object 



159
160
161
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 159

def block_until_ready(time = nil)
  @status_manager.wait_until_ready(time) if @status_manager
end

#destroy ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 68

def destroy
  @config.logger.info('Split client shutdown started...') if @config.debug_enabled

  @config.threads.select { |name, thread| name.to_s.end_with? 'sender' }.values.each do |thread|
    thread.raise(SplitIoClient::SDKShutdownException)
    thread.join
  end

  @config.threads.values.each { |thread| Thread.kill(thread) }

  @splits_repository.clear
  @segments_repository.clear

  SplitIoClient.load_factory_registry
  SplitIoClient.split_factory_registry.remove(@api_key)

  @config.logger.info('Split client shutdown complete') if @config.debug_enabled
  @config.valid_mode = false
  @destroyed = true
end

#get_treatment(key, split_name, attributes = {}, split_data = nil, store_impressions = true, multiple = false, evaluator = nil) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 30

def get_treatment(
    key, split_name, attributes = {}, split_data = nil, store_impressions = true,
    multiple = false, evaluator = nil
  )
  impressions = []
  result = treatment(key, split_name, attributes, split_data, store_impressions, multiple, evaluator, GET_TREATMENT, impressions)
  @impressions_manager.track(impressions)

  if multiple
    result.tap { |t| t.delete(:config) }
  else
    result[:treatment]
  end
end

#get_treatment_with_config(key, split_name, attributes = {}, split_data = nil, store_impressions = true, multiple = false, evaluator = nil) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 45

def get_treatment_with_config(
    key, split_name, attributes = {}, split_data = nil, store_impressions = true,
    multiple = false, evaluator = nil
  )
  impressions = []
  result = treatment(key, split_name, attributes, split_data, store_impressions, multiple, evaluator, GET_TREATMENT_WITH_CONFIG, impressions)
  @impressions_manager.track(impressions)

  result
end

#get_treatments(key, split_names, attributes = {}) ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 56

def get_treatments(key, split_names, attributes = {})
  treatments = treatments(key, split_names, attributes)
  return treatments if treatments.nil?
  keys = treatments.keys
  treats = treatments.map { |_,t| t[:treatment]  }
  Hash[keys.zip(treats)]
end

#get_treatments_with_config(key, split_names, attributes = {}) ⇒ Object 



64
65
66
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 64

def get_treatments_with_config(key, split_names, attributes = {})
  treatments(key, split_names, attributes, GET_TREATMENTS_WITH_CONFIG)
end

#keys_from_key(key) ⇒ Object 



120
121
122
123
124
125
126
127
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 120

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

#parsed_treatment(multiple, treatment_data) ⇒ Object 



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

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

#sanitize_split_names(calling_method, split_names) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/splitclient-rb/clients/split_client.rb', line 145

def sanitize_split_names(calling_method, split_names)
  split_names.compact.uniq.select do |split_name|
    if (split_name.is_a?(String) || split_name.is_a?(Symbol)) && !split_name.empty?
      true
    elsif split_name.is_a?(String) && split_name.empty?
      @config.logger.warn("#{calling_method}: you passed an empty split_name, split_name must be a non-empty String or a Symbol")
      false
    else
      @config.logger.warn("#{calling_method}: you passed an invalid split_name, split_name must be a non-empty String or a Symbol")
      false
    end
  end
end

#track(key, traffic_type_name, event_type, value = nil, properties = nil) ⇒ Object 



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

def track(key, traffic_type_name, event_type, value = nil, properties = nil)
  return false unless valid_client && @config.split_validator.valid_track_parameters(key, traffic_type_name, event_type, value, properties)

  start = Time.now
  properties_size = EVENT_AVERAGE_SIZE

  if !properties.nil?
    properties, size = validate_properties(properties)
    properties_size += size
    if (properties_size > EVENTS_SIZE_THRESHOLD)
      @config.logger.error("The maximum size allowed for the properties is #{EVENTS_SIZE_THRESHOLD}. Current is #{properties_size}. Event not queued")
      return false
    end
  end

  if ready? && !@config.localhost_mode && !@splits_repository.traffic_type_exists(traffic_type_name)
    @config.logger.warn("track: Traffic Type #{traffic_type_name} " \
      "does not have any corresponding Splits in this environment, make sure you're tracking " \
      'your events to a valid traffic type defined in the Split console')
  end

  @events_repository.add(key.to_s, traffic_type_name.downcase, event_type.to_s, (Time.now.to_f * 1000).to_i, value, properties, properties_size)
  record_latency(TRACK, start)
  true
rescue StandardError => e
  @config.log_found_exception(__method__.to_s, e)
  record_exception(TRACK)

  false
end