pg_rails 7.6.46 → 7.6.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 983b0ac59ee7841a5c1a686e35ef35d2e838b012baceecfd1c42cba5e46ff6bf
-  data.tar.gz: a39c0e76e39a29df881f56528e92b02e0f3ea6273eb37ea7e21d7825158dcfe2
+  metadata.gz: 591319e8a54f63a347c80ff17ee90834b5b85421beefe137661390b40199a5b5
+  data.tar.gz: 0e4b70de53c11f4c3484f462fa48b193fd988f2112f7f44347ae62c60b297d72
 SHA512:
-  metadata.gz: b63d7df8af9c3cdb15c041679855fd2040a3db1b5669a7d57017e63111580aedb6c75fffad3c46f008b3a4fb6575ad6753273c599eecb793bdc1a89ad6cbc77b
-  data.tar.gz: 62d566279fbe3a8aa05dffed007a35b078aeb3215900f8a3e6f8efb015df302c6ea43c321e9ccfbf1ec0218e77e7e8493f072d17b58e35cbcb29a4677fef271e
+  metadata.gz: bebfda4fcd522f32f070e8690d033690936ffbfe29f6c0771592278c0a87bfdbf0ca9ee2593d277e601296ccc6c1a9ec874651bb3311bb317f94b002cdee329f
+  data.tar.gz: 8f9bdac3e190a317fd1377e5161d6988223a2cb726b072fe174b7f437ebe9b3021b62107bb4f51c94e480101067bccde9a4b00c5899e77792d46134e201c89c4

data/pg_engine/app/controllers/pg_engine/health_controller.rb

@@ -6,83 +6,26 @@ module PgEngine
       render_down
     end
 
+    # Examples:
+    # ?except=["good_job", "ssl", "websocket"]
+    # ?only=["redis"]
     def show
-      check_redis
-      check_postgres
-      check_websocket
-      check_ssl
-      # FIXME: make configurable
-      check_good_job unless ENV.fetch("HEALTH_CHECK_SKIP_GOOD_JOB", nil) == "1"
+      HealthChecker.new.run_checks(
+        only: parse_ary(params[:only]),
+        except: parse_ary(params[:except])
+      )
+
       render_up
     end
 
     private
 
-    def check_good_job
-      return if GoodJob::Process.active.count.positive?
-
-      raise PgEngine::Error, 'good_job is down'
-    end
-
-    def check_postgres
-      return if User.count.is_a? Integer
-
-      raise PgEngine::Error, 'postgres is down'
-    end
-
-    def check_redis
-      return if Kredis.counter('healthcheck').increment.is_a? Integer
-
-      raise PgEngine::Error, 'redis is down'
-    end
-
-    def check_websocket
-      result = nil
-      begin
-        Timeout.timeout(5) do
-          EM.run do
-            url = Rails.application.config.action_cable.url
-            ws = Faye::WebSocket::Client.new(url)
-
-            ws.on :message do |event|
-              type = JSON.parse(event.data)['type']
-              if type == 'welcome'
-                result = :success
-                ws.close
-                EM.stop
-              end
-            end
-          end
-        end
-      rescue Timeout::Error
-        raise PgEngine::Error, 'websocket server is down'
-      end
-
-      return if result == :success
-
-      raise PgEngine::Error, 'websocket server is down'
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    def check_ssl
-      raise PgEngine::Error, 'no ssl log file' unless File.exist?(PgEngine::SslVerifier::OUTPUT_PATH)
-
-      sites = JSON.parse(File.read(PgEngine::SslVerifier::OUTPUT_PATH))
-      PgEngine.config.health_ssl_urls.each do |url|
-        check_site_ssl(sites, url)
-      end
-    end
-
-    def check_site_ssl(sites, url)
-      raise PgEngine::Error, "SSL record not present: #{url}. Forgot to run PgEngine::SslVerifier ?" if sites[url].blank?
-
-      if Time.zone.parse(sites[url]['verified_at']) < 2.days.ago
-        raise PgEngine::Error, "The SSL info is outdated: #{url}. PgEngine::SslVerifier is down?"
-      end
+    def parse_ary(param)
+      return if param.blank?
 
-      return unless Time.zone.parse(sites[url]['expires_at']) < 7.days.from_now
+      ary = JSON.parse(param)
 
-      raise PgEngine::Error, "The SSL certificate is expired (or about to expire): #{url}"
+      ary.is_a?(Array) ? ary : [ary]
     end
 
     def render_up

data/pg_engine/lib/pg_engine/configuracion.rb

@@ -4,7 +4,8 @@
 
 module PgEngine
   class Configuracion
-    attr_accessor :users_controller, :global_domains, :navigators, :user_profiles, :health_ssl_urls
+    attr_accessor :users_controller, :global_domains, :navigators,
+                  :user_profiles, :health_ssl_urls, :health_checks
 
     # attr_accessor :profile_groups
 
@@ -12,6 +13,7 @@ module PgEngine
       @global_domains = ['app.localhost.com', 'test.host', 'localhost']
       @navigators = [PgEngine::Navigator.new]
       @health_ssl_urls = []
+      @health_checks = []
       # @profile_groups = [:account]
       @user_profiles = {
         account__owner: 0
@@ -55,5 +57,20 @@ module PgEngine
         { name: group, options: }
       end
     end
+
+    # @param [String] name
+    #   description for the check
+    #
+    # @param [Duration] frequency
+    #   interval to wait between check runs, if left blank, check will run
+    #   every time
+    #
+    # @param [Proc] block
+    #   a function that raises error if sth is wrong
+    def add_health_check(name, only_explicit: false, &block)
+      @health_checks.push(
+        { name:, only_explicit:, block: }
+      )
+    end
   end
 end

data/pg_engine/lib/pg_engine/health_checker.rb

@@ -0,0 +1,101 @@
+module PgEngine
+  class HealthChecker
+    def run_checks(only: nil, except: nil)
+      ary = [default_checks, PgEngine.config.health_checks].flatten
+      ary.each do |health_check|
+        included = only.present? && only.include?(health_check[:name].to_s)
+        excluded = except.present? && except.include?(health_check[:name].to_s)
+
+        if included || (only.blank? && !health_check[:only_explicit] && !excluded)
+          Rails.logger.info "Running health check: #{health_check[:name]}"
+
+          health_check[:block].call
+        else
+          Rails.logger.info "Skipping health check: #{health_check[:name]}"
+        end
+      rescue StandardError => e
+        raise "Health check failed: #{health_check[:name]}. With: #{e.message}", cause: e
+      end
+    end
+
+    private
+
+    def default_checks
+      ary = []
+      ary << {
+        name: :redis,
+        block: lambda do
+                 return if Kredis.counter('healthcheck').increment.is_a? Integer
+
+                 raise PgEngine::Error, 'redis is down'
+               end
+      }
+      ary << {
+        name: :postgres,
+        block: lambda do
+                 return if User.count.is_a? Integer
+
+                 raise PgEngine::Error, 'postgres is down'
+               end
+      }
+      ary << {
+        name: :websocket,
+        block: lambda do
+                 result = nil
+                 begin
+                   Timeout.timeout(5) do
+                     EM.run do
+                       url = Rails.application.config.action_cable.url
+                       ws = Faye::WebSocket::Client.new(url)
+
+                       ws.on :message do |event|
+                         type = JSON.parse(event.data)['type']
+                         if type == 'welcome'
+                           result = :success
+                           ws.close
+                           EM.stop
+                         end
+                       end
+                     end
+                   end
+                 rescue Timeout::Error
+                   raise PgEngine::Error, 'websocket server is down'
+                 end
+
+                 return if result == :success
+
+                 raise PgEngine::Error, 'websocket server is down'
+               end
+      }
+      ary << {
+        name: :ssl,
+        block: lambda do
+                 SslChecker.new.check_ssl
+               end
+      }
+    end
+
+    class SslChecker
+      def check_ssl
+        raise PgEngine::Error, 'no ssl log file' unless File.exist?(PgEngine::SslVerifier::OUTPUT_PATH)
+
+        sites = JSON.parse(File.read(PgEngine::SslVerifier::OUTPUT_PATH))
+        PgEngine.config.health_ssl_urls.each do |url|
+          check_site_ssl(sites, url)
+        end
+      end
+
+      def check_site_ssl(sites, url)
+        raise PgEngine::Error, "SSL record not present: #{url}. Forgot to run PgEngine::SslVerifier ?" if sites[url].blank?
+
+        if Time.zone.parse(sites[url]['verified_at']) < 2.days.ago
+          raise PgEngine::Error, "The SSL info is outdated: #{url}. PgEngine::SslVerifier is down?"
+        end
+
+        return unless Time.zone.parse(sites[url]['expires_at']) < 7.days.from_now
+
+        raise PgEngine::Error, "The SSL certificate is expired (or about to expire): #{url}"
+      end
+    end
+  end
+end

data/pg_engine/lib/pg_engine/utils/ssl_verifier.rb

@@ -39,6 +39,10 @@ module PgEngine
             raise PgEngine::Error, "#{url}: The SSL certificate is expired (or about to expire)."
           end
 
+          # FIXME: ensure domain is included in certificate domains
+          # for example, if domain is example.com and certificate is issued for
+          # *.example.com, it fails.
+
           log_output(url, cert.not_after)
         end
       rescue OpenSSL::SSL::SSLError => e

data/pg_engine/lib/pg_engine.rb

@@ -4,6 +4,7 @@ require_relative 'pg_engine/engine'
 require_relative 'pg_engine/core_ext'
 require_relative 'pg_engine/error'
 require_relative 'pg_engine/configuracion'
+require_relative 'pg_engine/health_checker'
 require_relative 'pg_engine/site_brand'
 require_relative 'pg_engine/navigator'
 require_relative 'pg_engine/active_job_extensions'

data/pg_engine/spec/lib/pg_engine/health_checker_spec.rb

@@ -0,0 +1,32 @@
+require 'rails_helper'
+
+describe PgEngine::HealthChecker do
+  let(:health_checker) { described_class.new }
+  let(:doub) { double }
+
+  before do
+    PgEngine.config.health_checks = []
+  end
+
+  it "checks the extras" do
+    allow(doub).to receive(:bla)
+    PgEngine.configurar do |config|
+      config.add_health_check(:dummy_check) do
+        doub.bla
+      end
+    end
+    health_checker.run_checks(only: ["dummy_check"])
+    expect(doub).to have_received(:bla)
+  end
+
+  it "error is descriptive" do
+    PgEngine.configurar do |config|
+      config.add_health_check(:dummy_check) do
+        raise "sth went wrong"
+      end
+    end
+    expect {
+      health_checker.run_checks(only: ["dummy_check"])
+    }.to raise_error(/Health check failed: dummy_check/)
+  end
+end

data/pg_rails/lib/version.rb

@@ -2,6 +2,6 @@
 
 # :nocov:
 module PgRails
-  VERSION = '7.6.46'
+  VERSION = '7.6.47'
 end
 # :nocov:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_rails
 version: !ruby/object:Gem::Version
-  version: 7.6.46
+  version: 7.6.47
 platform: ruby
 authors:
 - Martín Rosso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-03-20 00:00:00.000000000 Z
+date: 2026-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -890,6 +890,7 @@ files:
 - pg_engine/lib/pg_engine/email_observer.rb
 - pg_engine/lib/pg_engine/engine.rb
 - pg_engine/lib/pg_engine/error.rb
+- pg_engine/lib/pg_engine/health_checker.rb
 - pg_engine/lib/pg_engine/mailgun/log_sync.rb
 - pg_engine/lib/pg_engine/navigator.rb
 - pg_engine/lib/pg_engine/route_helpers.rb
@@ -935,6 +936,7 @@ files:
 - pg_engine/spec/lib/pg_engine/date_jumper_spec.rb
 - pg_engine/spec/lib/pg_engine/error_helper_spec.rb
 - pg_engine/spec/lib/pg_engine/form_helper_spec.rb
+- pg_engine/spec/lib/pg_engine/health_checker_spec.rb
 - pg_engine/spec/lib/pg_engine/mailgun/log_sync_spec.rb
 - pg_engine/spec/lib/pg_engine/utils/pg_engine/pg_logger_spec.rb
 - pg_engine/spec/lib/pg_engine/utils/ssl_verifier_spec.rb