rails_health_checks 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9033111f01524e17546525feaba1a215ac6e3cad1c7c8b0b12dd527850c74e7f
-  data.tar.gz: 3eded20b26844b046d33689f6a5512efa1a7c7964f04679552d00020d9a7aa78
+  metadata.gz: 9bff80f924f018abcc0f67cf61568e29e7aff6e25c9e9c227aaa830290209918
+  data.tar.gz: 065ee72ad6e12c56d5dc4d6bd1e527e35a7e546a7c85cacbd5dedc13ecf64e9a
 SHA512:
-  metadata.gz: 7a8373f504fde389fd3e0202f3a08a1ea9e5a6af15dca997f8270e8dfcbca2cf5155a5f57a490392c6df1d3bc65f15a452b1c64ba3f96650b214007be5506623
-  data.tar.gz: 3f58fb48bd0a1a416e078f3e3bae0bb70e9e220c1cb93eaae25b2ec1c7710d56c9965e965fffa33f6d3922c132a120f8e0b554c18358d10eaa0787cebad0b778
+  metadata.gz: 7a362e27a106bd832c43c2c9a79989e38f26eeb7ce5c1027e2877a3e99ac0ca6f95dca653874bf9ec70edad261a68214e502d930c99f29238c67a2c4d755141c
+  data.tar.gz: 4367170dcd946c7f5e20c056f3596cad8a2a01c187aa67ebf582ae38d39c4e55c977b0f45ec1fb002bdafa9cbbbecb8aad32f7a4a7b005d9aa0e209cd98333ba

data/Rakefile

@@ -11,7 +11,12 @@ RuboCop::RakeTask.new(:lint)
 Bundler::Audit::Task.new
 RSpec::Core::RakeTask.new(:spec)
 
-task default: [:lint, :'bundle:audit:update', 'bundle:audit:check', :spec]
+desc "Run Brakeman static security analysis"
+task :brakeman do
+  sh "bundle exec brakeman -q --no-pager --force-scan --skip-files spec/ ."
+end
+
+task default: [:lint, :'bundle:audit:update', 'bundle:audit:check', :brakeman, :spec]
 
 desc "Run performance benchmarks"
 task :benchmark do

data/lib/rails_health_checks/check_registry.rb

@@ -51,9 +51,11 @@ module RailsHealthChecks
           t = check.timeout || timeout
           Concurrent::Future.execute { run_check(check, timeout: t) }
         end
-        checks.each do |name, check|
-          t = check.timeout || timeout
-          results[name] = futures[name].value(t + 1) || mark_critical(check, "timed out")
+        permit_concurrent_loads do
+          checks.each do |name, check|
+            t = check.timeout || timeout
+            results[name] = futures[name].value(t + 1) || mark_critical(check, "timed out")
+          end
         end
         if payload
           payload[:status] = overall_status(results)
@@ -69,21 +71,45 @@ module RailsHealthChecks
       if defined?(ActiveSupport::Notifications)
         ActiveSupport::Notifications.instrument("health_check.rails_health_checks", &block)
       else
-        # :nocov:
+        # simplecov:disable
         yield nil
-        # :nocov:
+        # simplecov:enable
       end
     end
 
     def self.run_check(check, timeout:)
-      Timeout.timeout(timeout) { check.call }
-      check
+      with_executor do
+        Timeout.timeout(timeout) { check.call }
+        check
+      end
     rescue Timeout::Error
       mark_critical(check, "timed out")
     rescue StandardError => e
       mark_critical(check, e.message)
     end
 
+    # Checks run on Concurrent's global pool, outside the request thread. Wrapping
+    # each one in the Rails executor returns any Active Record connections it
+    # leased (primary, cache, queue, ...) when the check finishes, including on
+    # timeout; otherwise they stay checked out by the long-lived pool thread.
+    def self.with_executor(&block)
+      if defined?(Rails) && Rails.application
+        Rails.application.executor.wrap(&block)
+      else
+        yield
+      end
+    end
+
+    # In development the request thread holds the autoload interlock while it
+    # waits on the futures; the check threads need it to load code, so let them.
+    def self.permit_concurrent_loads(&block)
+      if defined?(ActiveSupport::Dependencies) && ActiveSupport::Dependencies.respond_to?(:interlock)
+        ActiveSupport::Dependencies.interlock.permit_concurrent_loads(&block)
+      else
+        yield
+      end
+    end
+
     def self.mark_critical(check, message)
       check.instance_variable_set(:@status, "critical")
       check.instance_variable_set(:@message, message)
@@ -98,6 +124,6 @@ module RailsHealthChecks
       end
     end
 
-    private_class_method :run_check, :mark_critical, :overall_status, :instrument
+    private_class_method :run_check, :with_executor, :permit_concurrent_loads, :mark_critical, :overall_status, :instrument
   end
 end

data/lib/rails_health_checks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsHealthChecks
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_health_checks
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Chuck Smith