Class: Prefab::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/prefab/client.rb

Constant Summary collapse

MAX_SLEEP_SEC = 
10
BASE_SLEEP_SEC = 
0.5
NO_DEFAULT_PROVIDED = 
:no_default_provided

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = Prefab::Options.new) ⇒ Client

Returns a new instance of Client.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/prefab/client.rb', line 20

def initialize(options = Prefab::Options.new)
  @options = options.is_a?(Prefab::Options) ? options : Prefab::Options.new(options)
  @shared_cache = @options.shared_cache
  @stats = @options.stats
  @namespace = @options.namespace
  @stubs = {}
  @instance_hash = UUID.new.generate

  if @options.local_only?
    log_internal ::Logger::INFO, 'Prefab Running in Local Mode'
  else
    @api_key = @options.api_key
    raise Prefab::Errors::InvalidApiKeyError, @api_key if @api_key.nil? || @api_key.empty? || api_key.count('-') < 1

    @interceptor = Prefab::AuthInterceptor.new(@api_key)
    @prefab_api_url = @options.prefab_api_url
    @prefab_grpc_url = @options.prefab_grpc_url
    log_internal ::Logger::INFO,
                 "Prefab Connecting to: #{@prefab_api_url} and #{@prefab_grpc_url} Secure: #{http_secure?}"
    at_exit do
      channel.destroy
    end
  end
  # start config client
  config_client
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



15
16
17
 
# File 'lib/prefab/client.rb', line 15

def api_key
  @api_key
end

#instance_hash ⇒ Object (readonly)

Returns the value of attribute instance_hash.



18
19
20
 
# File 'lib/prefab/client.rb', line 18

def instance_hash
  @instance_hash
end

#interceptor ⇒ Object (readonly)

Returns the value of attribute interceptor.



14
15
16
 
# File 'lib/prefab/client.rb', line 14

def interceptor
  @interceptor
end

#namespace ⇒ Object (readonly)

Returns the value of attribute namespace.



13
14
15
 
# File 'lib/prefab/client.rb', line 13

def namespace
  @namespace
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



17
18
19
 
# File 'lib/prefab/client.rb', line 17

def options
  @options
end

#prefab_api_url ⇒ Object (readonly)

Returns the value of attribute prefab_api_url.



16
17
18
 
# File 'lib/prefab/client.rb', line 16

def prefab_api_url
  @prefab_api_url
end

#shared_cache ⇒ Object (readonly)

Returns the value of attribute shared_cache.



11
12
13
 
# File 'lib/prefab/client.rb', line 11

def shared_cache
  @shared_cache
end

#stats ⇒ Object (readonly)

Returns the value of attribute stats.



12
13
14
 
# File 'lib/prefab/client.rb', line 12

def stats
  @stats
end

Instance Method Details

#channel ⇒ Object 



57
58
59
60
 
# File 'lib/prefab/client.rb', line 57

def channel
  credentials = http_secure? ? creds : :this_channel_is_insecure
  @_channel ||= GRPC::Core::Channel.new(@prefab_grpc_url, nil, credentials)
end

#config_client(timeout: 5.0) ⇒ Object 



62
63
64
 
# File 'lib/prefab/client.rb', line 62

def config_client(timeout: 5.0)
  @config_client ||= Prefab::ConfigClient.new(self, timeout)
end

#enabled?(feature_name, lookup_key = nil, attributes = {}) ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/prefab/client.rb', line 133

def enabled?(feature_name, lookup_key = nil, attributes = {})
  feature_flag_client.feature_is_on_for?(feature_name, lookup_key, attributes: attributes)
end

#feature_flag_client ⇒ Object 



70
71
72
 
# File 'lib/prefab/client.rb', line 70

def feature_flag_client
  @feature_flag_client ||= Prefab::FeatureFlagClient.new(self)
end

#get(key, default_or_lookup_key = NO_DEFAULT_PROVIDED, properties = {}, ff_default = nil) ⇒ Object 



137
138
139
140
141
142
143
 
# File 'lib/prefab/client.rb', line 137

def get(key, default_or_lookup_key = NO_DEFAULT_PROVIDED, properties = {}, ff_default = nil)
  if is_ff?(key)
    feature_flag_client.get(key, default_or_lookup_key, properties, default: ff_default)
  else
    config_client.get(key, default_or_lookup_key, properties)
  end
end

#log ⇒ Object 



81
82
83
84
85
 
# File 'lib/prefab/client.rb', line 81

def log
  @logger_client ||= Prefab::LoggerClient.new(@options.logdev, formatter: @options.log_formatter,
                                                               prefix: @options.log_prefix,
                                                               log_path_collector: log_path_collector)
end

#log_internal(level, msg, path = nil) ⇒ Object 



96
97
98
 
# File 'lib/prefab/client.rb', line 96

def log_internal(level, msg, path = nil)
  log.log_internal msg, path, nil, level
end

#log_path_collector ⇒ Object 



74
75
76
77
78
79
 
# File 'lib/prefab/client.rb', line 74

def log_path_collector
  return nil if @options.collect_max_paths <= 0

  @log_path_collector ||= LogPathCollector.new(client: self, max_paths: @options.collect_max_paths,
                                               sync_interval: @options.collect_sync_interval)
end

#ratelimit_client(timeout: 5.0) ⇒ Object 



66
67
68
 
# File 'lib/prefab/client.rb', line 66

def ratelimit_client(timeout: 5.0)
  @ratelimit_client ||= Prefab::RateLimitClient.new(self, timeout)
end

#request(service, method, req_options: {}, params: {}) ⇒ Object

Raises:

  • (ArgumentError) 


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
 
# File 'lib/prefab/client.rb', line 100

def request(service, method, req_options: {}, params: {})
  # Future-proofing since we previously bumped into a conflict with a service with a `send` method
  raise ArgumentError, 'Cannot call public_send on an grpc service in Ruby' if method.to_s == 'public_send'

  opts = { timeout: 10 }.merge(req_options)

  attempts = 0
  start_time = Time.now

  begin
    attempts += 1

    stub_for(service, opts[:timeout]).public_send(method, *params)
  rescue StandardError => e
    log_internal ::Logger::WARN, e

    raise e if Time.now - start_time > opts[:timeout]

    sleep_seconds = [BASE_SLEEP_SEC * (2**(attempts - 1)), MAX_SLEEP_SEC].min
    sleep_seconds *= (0.5 * (1 + rand))
    sleep_seconds = [BASE_SLEEP_SEC, sleep_seconds].max
    log_internal ::Logger::INFO, "Sleep #{sleep_seconds} and Reset #{service} #{method}"
    sleep sleep_seconds
    reset!
    retry
  end
end

#reset! ⇒ Object 



128
129
130
131
 
# File 'lib/prefab/client.rb', line 128

def reset!
  @stubs.clear
  @_channel = nil
end

#set_rails_loggers ⇒ Object 



87
88
89
90
91
92
93
94
 
# File 'lib/prefab/client.rb', line 87

def set_rails_loggers
  Rails.logger = log
  ActionView::Base.logger = log
  ActionController::Base.logger = log
  ActiveJob::Base.logger = log
  ActiveRecord::Base.logger = log
  ActiveStorage.logger = log
end

#with_log_context(lookup_key, properties) ⇒ Object 



47
48
49
50
51
52
53
54
55
 
# File 'lib/prefab/client.rb', line 47

def with_log_context(lookup_key, properties)
  Thread.current[:prefab_log_lookup_key] = lookup_key
  Thread.current[:prefab_log_properties] = properties

  yield
ensure
  Thread.current[:prefab_log_lookup_key] = nil
  Thread.current[:prefab_log_properties] = {}
end