Class: MiddlewareHealthcheck::MainChecker

Inherits:
Object
  • Object
show all
Defined in:
lib/middleware_healthcheck/main_checker.rb

Constant Summary collapse

QUERY_STRING_KEY = 
"QUERY_STRING".freeze
UNDEFINED_CHECKER_ERROR = 
"Can't find checker: ".freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, env) ⇒ MainChecker

Returns a new instance of MainChecker.



8
9
10
11
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 8

def initialize(app, env)
  self.app = app
  self.env = env
end

Instance Attribute Details

#app ⇒ Object

Returns the value of attribute app.



6
7
8
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 6

def app
  @app
end

#env ⇒ Object

Returns the value of attribute env.



6
7
8
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 6

def env
  @env
end

Instance Method Details

#build_error_response ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 38

def build_error_response
  build_text_response(
    configuration.error_response_status,
    errors.join(configuration.errors_delimiter)
  )
end

#build_response ⇒ Object 



23
24
25
26
27
28
29
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 23

def build_response
  if errors.present?
    build_error_response
  else
    build_success_response
  end
end

#build_success_response ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 31

def build_success_response
  build_text_response(
    configuration.success_response_status,
    configuration.success_response_body 
  )
end

#build_text_response(status, body) ⇒ Object 



45
46
47
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 45

def build_text_response(status, body)
  [ status, { "Content-Type" => "text/plain" }, [body] ]
end

#check_health ⇒ Object 



13
14
15
16
17
18
19
20
21
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 13

def check_health
  if full_check?
    run_all_checkers
  elsif selected_check?
    run_selected_checkers
  end

  build_response
end

#configuration ⇒ Object 



99
100
101
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 99

def configuration
  @configuration ||= MiddlewareHealthcheck.configuration
end

#errors ⇒ Object 



88
89
90
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 88

def errors
  @errors ||= []
end

#find_checker_by_name(name) ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 71

def find_checker_by_name(name)
  configuration.checkers.each do |checker|
    return checker if checker.to_s.demodulize.underscore.gsub(/_checker$/, '') == name
  end
  errors.push(UNDEFINED_CHECKER_ERROR + name.camelize)
  nil
end

#full_check? ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 92

def full_check?
  params[configuration.full_check_param_name].present?
end

#params ⇒ Object 



84
85
86
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 84

def params
  @params ||= Rack::Utils.parse_nested_query(@env[QUERY_STRING_KEY])
end

#run_all_checkers ⇒ Object 



49
50
51
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 49

def run_all_checkers
  run_checkers(configuration.checkers)
end

#run_checkers(checkers) ⇒ Object 



58
59
60
61
62
63
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 58

def run_checkers(checkers)
  checkers.each do |checker|
    checker_instance = checker.new(@app, @env)
    errors.push(checker_instance.error) unless checker_instance.healthy?
  end
end

#run_selected_checkers ⇒ Object 



53
54
55
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 53

def run_selected_checkers
  run_checkers(selected_checkers)
end

#selected_check? ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 95

def selected_check?
  params[configuration.selected_check_param_name].present?
end

#selected_checkers ⇒ Object 



65
66
67
68
69
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 65

def selected_checkers
  selected_checkers_names.map do |checker_name|
    find_checker_by_name(checker_name)
  end.compact
end

#selected_checkers_names ⇒ Object 



79
80
81
82
 
# File 'lib/middleware_healthcheck/main_checker.rb', line 79

def selected_checkers_names
  @selected_check_param_names ||= params[configuration.selected_check_param_name]
    .split(configuration.selected_check_param_split_delimiter)
end