sidekiq-alive-next 3.1.1 → 3.2.0

data/lib/sidekiq_alive/server/rack.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module SidekiqAlive
+  module Server
+    class Rack
+      extend Base
+
+      class << self
+        def run!
+          logger.info("[SidekiqAlive] Starting healthcheck '#{server}' server")
+          @server_pid = ::Process.fork do
+            @handler = handler
+            configure_shutdown_signal { @handler.shutdown }
+            configure_quiet_signal { @quiet = Time.now }
+
+            @handler.run(self, Port: port, Host: host, AccessLog: [], Logger: logger)
+          end
+          configure_shutdown
+
+          self
+        end
+
+        def call(env)
+          req = ::Rack::Request.new(env)
+
+          if req.path != path
+            logger.warn("[SidekiqAlive] Path '#{req.path}' not found")
+            return [404, {}, ["Not found"]]
+          end
+
+          if quiet?
+            logger.debug("[SidekiqAlive] [SidekiqAlive] Server in quiet mode, skipping alive key lookup!")
+            return [200, {}, ["Server is shutting down"]]
+          end
+
+          if SidekiqAlive.alive?
+            logger.debug("[SidekiqAlive] Found alive key!")
+            return [200, {}, ["Alive!"]]
+          end
+
+          response = "Can't find the alive key"
+          logger.error("[SidekiqAlive] #{response}")
+          [404, {}, [response]]
+        rescue StandardError => e
+          logger.error("[SidekiqAlive] #{response} looking for alive key. Error: #{e.message}")
+          [500, {}, ["Internal Server Error"]]
+        end
+
+        private
+
+        def quiet?
+          @quiet && (Time.now - @quiet) < SidekiqAlive.config.quiet_timeout
+        end
+
+        def handler
+          Helpers.use_rackup? ? ::Rackup::Handler.get(server) : ::Rack::Handler.get(server)
+        end
+
+        def server
+          SidekiqAlive.config.server
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_alive/server.rb

@@ -1,46 +1,30 @@
 # frozen_string_literal: true
 
-require "rack"
-require "rackup"
-
 module SidekiqAlive
-  class Server
+  module Server
     class << self
       def run!
-        handler = Rackup::Handler.get(server)
-
-        Signal.trap("TERM") { handler.shutdown }
-
-        handler.run(self, Port: port, Host: host, AccessLog: [], Logger: SidekiqAlive.logger)
+        server.run!
       end
 
-      def host
-        SidekiqAlive.config.host
-      end
+      private
 
-      def port
-        SidekiqAlive.config.port
+      def server
+        use_rack? ? Rack : Default
       end
 
-      def path
-        SidekiqAlive.config.path
-      end
+      def use_rack?
+        return false unless SidekiqAlive.config.server
 
-      def server
-        SidekiqAlive.config.server
+        Helpers.use_rackup? || Helpers.use_rack?
       end
 
-      def call(env)
-        if Rack::Request.new(env).path != path
-          [404, {}, ["Not found"]]
-        elsif SidekiqAlive.alive?
-          [200, {}, ["Alive!"]]
-        else
-          response = "Can't find the alive key"
-          SidekiqAlive.logger.error(response)
-          [404, {}, [response]]
-        end
+      def logger
+        SidekiqAlive.logger
       end
     end
   end
 end
+
+require_relative "server/default"
+require_relative "server/rack"

data/lib/sidekiq_alive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqAlive
-  VERSION = "3.1.1"
+  VERSION = "3.2.0"
 end

data/lib/sidekiq_alive/worker.rb

@@ -5,20 +5,16 @@ module SidekiqAlive
     include Sidekiq::Worker
     sidekiq_options retry: false
 
+    # Passing the hostname argument it's only for debugging enqueued jobs
     def perform(_hostname = SidekiqAlive.hostname)
       # Checks if custom liveness probe passes should fail or return false
       return unless config.custom_liveness_probe.call
 
       # Writes the liveness in Redis
       write_living_probe
+      remove_orphaned_queues
       # schedules next living probe
-      self.class.perform_in(config.time_to_live / 2, current_hostname)
-    end
-
-    def hostname_registered?(hostname)
-      SidekiqAlive.registered_instances.any? do |ri|
-        /#{hostname}/ =~ ri
-      end
+      self.class.perform_in(config.worker_interval, current_hostname)
     end
 
     def write_living_probe
@@ -34,6 +30,17 @@ module SidekiqAlive
       end
     end
 
+    # Removes orphaned Sidekiq queues left behind by unexpected instance shutdowns (e.g., due to OOM)
+    def remove_orphaned_queues
+      # If the worker isn't executed within this window, the lifeness key expires
+      latency_threshold = config.time_to_live - config.worker_interval
+      Sidekiq::Queue.all
+        .filter { |q| q.name.start_with?(config.queue_prefix.to_s) }
+        .filter { |q| q.latency > latency_threshold }
+        .filter { |q| q.size == 1 && q.all? { |job| job.klass == self.class.name } }
+        .each(&:clear)
+    end
+
     def current_hostname
       SidekiqAlive.hostname
     end

data/lib/sidekiq_alive.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require "base64"
+require "sidekiq"
+require "sidekiq/api"
+require "singleton"
+require "sidekiq_alive/version"
+require "sidekiq_alive/config"
+require "sidekiq_alive/helpers"
+require "sidekiq_alive/redis"
+
+module SidekiqAlive
+  HOSTNAME_REGISTRY = "sidekiq-alive-hostnames"
+  CAPSULE_NAME = "sidekiq-alive"
+
+  class << self
+    def start
+      Sidekiq.configure_server do |sq_config|
+        sq_config.on(:startup) do
+          SidekiqAlive::Worker.sidekiq_options(queue: current_queue)
+
+          if Helpers.sidekiq_7
+            sq_config.capsule(CAPSULE_NAME) do |cap|
+              cap.concurrency = config.concurrency
+              cap.queues = [current_queue]
+            end
+          else
+            (sq_config.respond_to?(:[]) ? sq_config[:queues] : sq_config.options[:queues]).unshift(current_queue)
+          end
+
+          logger.info("[SidekiqAlive] #{startup_info}")
+          register_current_instance
+          store_alive_key
+          # Passing the hostname argument it's only for debugging enqueued jobs
+          SidekiqAlive::Worker.perform_async(hostname)
+          @server = SidekiqAlive::Server.run!
+
+          logger.info("[SidekiqAlive] #{successful_startup_text}")
+        end
+
+        sq_config.on(:quiet) do
+          logger.info("[SidekiqAlive] #{shutdown_info}")
+          purge_pending_jobs
+          # set web server to quiet mode
+          @server&.quiet!
+        end
+
+        sq_config.on(:shutdown) do
+          remove_queue
+          # make sure correct redis connection pool is used
+          # sidekiq will terminate non internal capsules
+          Redis.adapter("internal").zrem(HOSTNAME_REGISTRY, current_instance_register_key)
+          config.shutdown_callback.call
+        end
+      end
+    end
+
+    def current_queue
+      "#{config.queue_prefix}-#{hostname}"
+    end
+
+    def register_current_instance
+      register_instance(current_instance_register_key)
+    end
+
+    def registered_instances
+      # before we return we make sure we expire old keys
+      expire_old_keys
+      redis.zrange(HOSTNAME_REGISTRY, 0, -1)
+    end
+
+    def purge_pending_jobs
+      schedule_set = Sidekiq::ScheduledSet.new
+      jobs = if Helpers.sidekiq_5
+        schedule_set.select { |job| job.klass == "SidekiqAlive::Worker" && job.queue == current_queue }
+      else
+        schedule_set.scan('"class":"SidekiqAlive::Worker"').select { |job| job.queue == current_queue }
+      end
+
+      unless jobs.empty?
+        logger.info("[SidekiqAlive] Purging #{jobs.count} pending jobs for #{hostname}")
+        jobs.each(&:delete)
+      end
+    end
+
+    def remove_queue
+      logger.info("[SidekiqAlive] Removing queue #{current_queue}")
+      Sidekiq::Queue.new(current_queue).clear
+    end
+
+    def current_instance_register_key
+      "#{config.registered_instance_key}::#{hostname}"
+    end
+
+    def current_instance_registered?
+      redis.get(current_instance_register_key)
+    end
+
+    def store_alive_key
+      redis.set(current_lifeness_key, time: Time.now.to_i, ex: config.time_to_live.to_i)
+    end
+
+    def redis
+      @redis ||= Redis.adapter
+    end
+
+    def alive?
+      redis.ttl(current_lifeness_key) != -2
+    end
+
+    # CONFIG ---------------------------------------
+
+    def setup
+      yield(config)
+    end
+
+    def logger
+      config.logger || Sidekiq.logger
+    end
+
+    def config
+      @config ||= SidekiqAlive::Config.instance
+    end
+
+    def current_lifeness_key
+      "#{config.liveness_key}::#{hostname}"
+    end
+
+    def hostname
+      ENV["HOSTNAME"] || "HOSTNAME_NOT_SET"
+    end
+
+    def shutdown_info
+      "Shutting down sidekiq-alive!"
+    end
+
+    def startup_info
+      info = {
+        hostname: hostname,
+        port: config.port,
+        ttl: config.time_to_live,
+        queue: current_queue,
+        register_set: HOSTNAME_REGISTRY,
+        liveness_key: current_lifeness_key,
+        register_key: current_instance_register_key,
+      }
+
+      "Starting sidekiq-alive: #{info}"
+    end
+
+    def successful_startup_text
+      "Successfully started sidekiq-alive, registered with key: " \
+        "#{current_instance_register_key} on set #{HOSTNAME_REGISTRY}"
+    end
+
+    def expire_old_keys
+      # we get every key that should be expired by now
+      keys_to_expire = redis.zrangebyscore(HOSTNAME_REGISTRY, 0, Time.now.to_i)
+      # then we remove it
+      keys_to_expire.each { |key| redis.zrem(HOSTNAME_REGISTRY, key) }
+    end
+
+    def register_instance(instance_name)
+      expiration = Time.now.to_i + config.registration_ttl.to_i
+      redis.zadd(HOSTNAME_REGISTRY, expiration, instance_name)
+      expire_old_keys
+    end
+  end
+end
+
+require "sidekiq_alive/worker"
+require "sidekiq_alive/server"
+
+SidekiqAlive.start unless ENV.fetch("DISABLE_SIDEKIQ_ALIVE", "").casecmp("true").zero?

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-alive-next
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Andrejs Cunskis
-- Artur Pañach
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-shopify
   requirement: !ruby/object:Gem::Requirement
@@ -110,93 +108,109 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.10'
 - !ruby/object:Gem::Dependency
-  name: solargraph
+  name: semver2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.2
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.2
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
+        version: 0.22.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
-  name: rackup
+  name: simplecov-cobertura
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
+        version: 2.1.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: solargraph
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 0.54.0
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: webrick
+  name: gserver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '9'
 description: |
   SidekiqAlive offers a solution to add liveness probe of a Sidekiq instance.
 
@@ -215,9 +229,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/sidekiq-alive-next.rb
+- lib/sidekiq_alive.rb
 - lib/sidekiq_alive/config.rb
+- lib/sidekiq_alive/helpers.rb
+- lib/sidekiq_alive/redis.rb
+- lib/sidekiq_alive/redis/base.rb
+- lib/sidekiq_alive/redis/redis_client_gem.rb
+- lib/sidekiq_alive/redis/redis_gem.rb
 - lib/sidekiq_alive/server.rb
+- lib/sidekiq_alive/server/base.rb
+- lib/sidekiq_alive/server/default.rb
+- lib/sidekiq_alive/server/http_server.rb
+- lib/sidekiq_alive/server/rack.rb
 - lib/sidekiq_alive/version.rb
 - lib/sidekiq_alive/worker.rb
 homepage: https://github.com/andrcuns/sidekiq-alive
@@ -227,9 +250,8 @@ metadata:
   homepage_uri: https://github.com/andrcuns/sidekiq-alive
   source_code_uri: https://github.com/andrcuns/sidekiq-alive
   changelog_uri: https://github.com/andrcuns/sidekiq-alive/releases
-  documentation_uri: https://github.com/andrcuns/sidekiq-alive/blob/v3.1.1/README.md
+  documentation_uri: https://github.com/andrcuns/sidekiq-alive/blob/v3.2.0/README.md
   bug_tracker_uri: https://github.com/andrcuns/sidekiq-alive/issues
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -237,15 +259,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Liveness probe for sidekiq on Kubernetes deployments.
 test_files: []