hey_doctor 1.1.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 249060591232e22edd365caab083880ccf25af55885c865254880de7884e1b22
-  data.tar.gz: 9b2db9ce532a468886c5968b7197763bf621488eaadb75191fa4ab32f54d90d7
+  metadata.gz: d854aed46a009b3d8fab4116a9ce9277fb76c7d3d1a9117dc28fa6c82a54e1f6
+  data.tar.gz: 0dd3285bbaaf52996df32277f7261aa35fceced3ffe749b4091de0b7db4d932f
 SHA512:
-  metadata.gz: 2cb1982e3c1844cb53d2daa6ec239d61b3e2d75a7856f32aec979a52372445fc24193507770090827fe0ac865c0a35734208651308a9aef56842dfe941beec5e
-  data.tar.gz: badfcb2c2ffee093ae84e984d948b13eaecd01a2db81046cdae5123174b87c2f2e25102aa8f8338f94e0bd83bc85ebccfe5cef6265f4432d4572cf0af7b225b9
+  metadata.gz: 288322908e582f60fbce12bcd4cac0f277b4ca23c8b549316538bc6abc16d7af33a6e2b6a7f48f43284a89066d776b82d5bd2622a36d304cdf2efe920d504a1b
+  data.tar.gz: 2c1b20cf9f589c57c494229ebab8e012e11de2e05f0d19a2d4710c2179adc46641c55227f7b56ee58a49e8d4ae7b6af4fa63240d52b995e3c4d029ee5088f9d3

data/README.md

@@ -39,7 +39,7 @@ Redis.current ||= Redis.new(url: ENV['REDIS_URL'])
 
 It is very important to use the env `REDIS_URL`, because it will be used to check whether or not to render the redis response.
 
-* Add a env var `RAILS_PORT` with the current application port.
+* Add a env var `RAILS_PORT` with the current application port, it will also work with the env `PORT` for backward compatibility with GAE applications.
 
 * Add this line to your application's Gemfile:
 
@@ -81,6 +81,8 @@ end
 ## Developing
 
 ```bash
+docker network create dev-net # only the fist time you run this project
+
 docker-compose build && docker-compose up
 
 docker-compose exec web bash
@@ -97,11 +99,22 @@ Minimum coverage is set to 95%.
 Change the tag in `lib/hey_doctor/version.rb` each release using [SEMVER](https://semver.org/lang/pt-BR/).
 
 ```bash
+# After merging the PR checkout to master branch and update it.
+git checkout master
+git pull
+
+# build gem in pkg/hey_doctor-TAG.gem (Also changes Gemfile.lock)
 bundle exec rake build
-# build gem in pkg/hey_doctor-TAG.gem
+
+# Add the changed files
+git add Gemfile.lock lib/hey_doctor/version.rb
+git commit -m "v0.0.0"
+
+# Create a new git tag
+git tag -a v0.0.0 -m "Description here."
 
 bundle exec rake release
-# Ask for rubygems credentials and makes the release
+# Ask for rubygems credentials and makes the release, push the commit and the tag
 ```
 ## Contributing
 

data/app/services/hey_doctor/check_application_health_service.rb

@@ -3,15 +3,18 @@
 class HeyDoctor::CheckApplicationHealthService
   class << self
     SUCCESS = {
-      message: 'Application is running',
-      success: true
+      success: true,
+      message: 'Application is running'
     }.freeze
 
     ERROR = {
-      message: 'Application down, call the firefighters',
-      success: false
+      success: false,
+      message: 'Application down, call the firefighters'
     }.freeze
 
+    START_COUNTER = 1
+    DEFAULT_PORT = ENV['RAILS_PORT'] || ENV['PORT']
+
     def call
       return SUCCESS if responding?
 
@@ -21,15 +24,31 @@ class HeyDoctor::CheckApplicationHealthService
     private
 
     def responding?
-      app_http_code == '200'
+      app_http_code('localhost', DEFAULT_PORT, START_COUNTER) == 200
     rescue StandardError
       false
     end
 
-    def app_http_code
-      Net::HTTP.start('localhost', ENV['RAILS_PORT']) do |http|
+    def app_http_code(location, port, retry_counter)
+      ssl = port.to_i == 443
+
+      response = Net::HTTP.start(location, port, use_ssl: ssl) do |http|
         http.head('/_ah/app_health')
-      end.code
+      end
+
+      return response.code.to_i if retry_counter > 3
+
+      if response.is_a?(Net::HTTPRedirection)
+        location = response['location']&.match(/https:\/\/(\w+.\.\w+)\//)
+
+        unless location.nil?
+          retry_counter += 1
+
+          return app_http_code(location[1], 443, retry_counter)
+        end
+      end
+
+      response.code.to_i
     end
   end
 end

data/app/services/hey_doctor/check_database_health_service.rb

@@ -3,18 +3,18 @@
 class HeyDoctor::CheckDatabaseHealthService
   class << self
     SUCCESS = {
-      message: 'Database is connected',
-      success: true
+      success: true,
+      message: 'Database is connected'
     }.freeze
 
     MIGRATION_PENDING = {
-      message: 'Pending migrations detected',
-      success: true
+      success: true,
+      message: 'Pending migrations detected'
     }.freeze
 
     ERROR = {
-      message: 'Error connecting to database',
-      success: false
+      success: false,
+      message: 'Error connecting to database'
     }.freeze
 
     def call

data/app/services/hey_doctor/check_redis_health_service.rb

@@ -3,13 +3,13 @@
 class HeyDoctor::CheckRedisHealthService
   class << self
     SUCCESS = {
-      message: 'Redis is connected',
-      success: true
+      success: true,
+      message: 'Redis is connected'
     }.freeze
 
     ERROR = {
-      message: 'Error connecting to redis',
-      success: false
+      success: false,
+      message: 'Error connecting to redis'
     }.freeze
 
     def call

data/app/services/hey_doctor/check_sidekiq_health_service.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class HeyDoctor::CheckSidekiqHealthService
+  class << self
+    SUCCESS = {
+      success: true,
+      message: 'Sidekiq is connected'
+    }.freeze
+
+    ERROR = {
+      success: false,
+      message: 'Error connecting to sidekiq'
+    }.freeze
+
+    NO_EXECUTOR = {
+      success: false,
+      message: 'None sidekiq host was found, add it to the ENV SIDEKIQ_HOSTS' \
+               ' listing your machine(s) ip or dns using  ; for each host'
+    }.freeze
+
+    def call
+      return NO_EXECUTOR if hosts.blank?
+
+      hosts.map { |host| response(host).merge({ host: host }) }
+    end
+
+    private
+
+    def hosts
+      @hosts ||= ENV['SIDEKIQ_HOSTS']&.split(';')
+    end
+
+    def response(host)
+      connected?(host) ? SUCCESS : ERROR
+    end
+
+    def connected?(host)
+      system("ping -c1 #{host}")
+    rescue StandardError
+      false
+    end
+  end
+end

data/lib/hey_doctor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HeyDoctor
-  VERSION = '1.1.2'
+  VERSION = '1.3.1'
 end

data/lib/hey_doctor.rb

@@ -21,6 +21,12 @@ module HeyDoctor::Rack
         response.merge!({ redis: ::HeyDoctor::CheckRedisHealthService.call })
       end
 
+      unless ENV['SIDEKIQ_HOSTS'].blank?
+        response.merge!(
+          { sidekiq: ::HeyDoctor::CheckSidekiqHealthService.call }
+        )
+      end
+
       response.to_json
     end
   end