hirefire-resource 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c981cc399cbd8abdb5a0416b0f05286621aef47c03db25fb646607f553976f6
-  data.tar.gz: '08047393729ab2f071e4d08cd49e5ca92e6cdeae1ed5875da52df996b6b7b358'
+  metadata.gz: 2472f4d981a95c1869a29eaa7b97429aa2f9f5d8e2a4e1858a167bfc916daee4
+  data.tar.gz: c97478c3f7632dc6ea0c514d6f34894ea0514a1f259c9685e62ed3a63bbba6af
 SHA512:
-  metadata.gz: 92e00b6fdc3d51f7a2f363b83b77e6c9da56f2d535e163f2e40fc6c0260bcfaadfea060f0ef3e03e4e19809698d1d898382625cb3f42dc30dd0ad00949b3943b
-  data.tar.gz: 3d9780fda27839409e76c48b66143fad5149d5e77217737c2a90004dfb3dea8018b24aad24e00be15030e73d8791c7e8b9126b85b4586e0f9b5242a3922b0923
+  metadata.gz: 2dc43ce87ea0435294d7f86d44a5e99a30e1a913d170fafadcd7292d061c9a8acdc3a9e3646467d789d32aa83becc40ee89a2b2048136e1badf993f4f9e3e25f
+  data.tar.gz: 90e56a5fdddeb1fdb98f891614fdb6cd66b7a6d07c6efd000ced14cb73de9aa44682d4772b6c4c12c1e114271b57600c7f578cb2a9439d79386d42fa2080d1e4

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v1.0.7
+
+* Add support for Sidekiq 8.
+
+## v1.0.6
+
+* Ensure that discarded jobs are not used when measuring queue size and latency with Good Job v3 and v4.
+
 ## v1.0.5
 
 * Increase process name length constraint from 30 to 63.

data/lib/hirefire/macro/bunny.rb

@@ -25,6 +25,16 @@ module HireFire
       #   with the accurate counting of jobs that are currently scheduled to run, leading to
       #   premature upscaling. If you want to be able to schedule jobs to run in the future,
       #   consider using the Delayed Message Plugin for RabbitMQ.
+      #
+      # @note The method relies on the `message_count` metric to determine the number of "Ready" messages
+      #   in the queue. When using auto-acknowledgment, messages are acknowledged immediately upon delivery,
+      #   causing the `message_count` to drop to zero, even if the consumer is processing messages. To ensure
+      #   accurate metrics:
+      #   - Enable manual acknowledgment (`manual_ack: true`) so that RabbitMQ tracks unacknowledged messages.
+      #   - Set a reasonable prefetch limit (`channel.prefetch(x)`) to control the number of messages delivered
+      #     to the consumer, allowing a measurable backlog to remain in the "Ready" state.
+      #   This configuration ensures accurate scaling metrics and prevents premature depletion of the queue.
+      #
       # @param queues [Array<String, Symbol>] Names of the queues for size measurement.
       # @param amqp_url [String, nil] (optional) RabbitMQ URL for establishing a new connection.
       # @return [Integer] Total job queue size.

data/lib/hirefire/macro/good_job.rb

@@ -28,6 +28,7 @@ module HireFire
         query = good_job_class
         query = query.where(queue_name: queues) if queues.any?
         query = query.where(performed_at: nil)
+        query = query.where.not(error_event: discarded_enum).or(query.where(error_event: nil)) if error_event_supported?
         query = query.where(scheduled_at: ..Time.now).or(query.where(scheduled_at: nil))
         query = query.order(scheduled_at: :asc, created_at: :asc)
 
@@ -55,6 +56,7 @@ module HireFire
         query = good_job_class
         query = query.where(queue_name: queues) if queues.any?
         query = query.where(performed_at: nil)
+        query = query.where.not(error_event: discarded_enum).or(query.where(error_event: nil)) if error_event_supported?
         query = query.where(scheduled_at: ..Time.now).or(query.where(scheduled_at: nil))
         query.count
       end

data/lib/hirefire/macro/helpers/good_job.rb

@@ -13,6 +13,21 @@ module HireFire
             ::GoodJob::Execution
           end
         end
+
+        def error_event_supported?
+          Gem::Version.new(::GoodJob::VERSION) >= Gem::Version.new("3.0.0")
+        end
+
+        [
+          :interrupted,
+          :unhandled,
+          :handled,
+          :retried,
+          :retry_stopped,
+          :discarded
+        ].each_with_index do |event, index|
+          define_method(:"#{event}_enum") { index }
+        end
       end
     end
   end

data/lib/hirefire/macro/sidekiq.rb

@@ -128,10 +128,15 @@ module HireFire
 
           max_latencies = oldest_jobs.map do |job_payload|
             job = job_payload ? JSON.parse(job_payload) : {}
-            job["enqueued_at"] ? Time.now.to_f - job["enqueued_at"] : 0.0
+
+            if Gem::Version.new(::Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
+              job["enqueued_at"] ? Time.now.to_i - job["enqueued_at"] / 1000 : 0
+            else
+              job["enqueued_at"] ? Time.now.to_f - job["enqueued_at"] : 0.0
+            end
           end
 
-          max_latencies.max || 0.0
+          Integer(max_latencies.max || 0)
         end
 
         def set_latency(set, queues)
@@ -157,80 +162,6 @@ module HireFire
         extend HireFire::Utility
         extend self
 
-        def call(*queues, server: false, **options)
-          require "sidekiq/api"
-
-          queues = normalize_queues(queues, allow_empty: true)
-
-          if server
-            server_lookup(queues, **options)
-          else
-            client_lookup(queues, **options)
-          end
-        end
-
-        private
-
-        def client_lookup(queues, skip_retries: false, skip_scheduled: false, skip_working: false, max_scheduled: nil)
-          size = enqueued_size(queues)
-          size += scheduled_size(queues, max_scheduled) unless skip_scheduled
-          size += retry_size(queues) unless skip_retries
-          size += working_size(queues) unless skip_working
-          size
-        end
-
-        def enqueued_size(queues)
-          queues = registered_queues if queues.empty?
-
-          ::Sidekiq.redis do |conn|
-            conn.pipelined do |pipeline|
-              queues.each { |name| pipeline.llen("queue:#{name}") }
-            end
-          end.sum
-        end
-
-        def scheduled_size(queues, max = nil)
-          size, now = 0, Time.now
-
-          find_each_in_set(::Sidekiq::ScheduledSet.new) do |job|
-            if job.at > now || max && size >= max
-              break
-            elsif queues.empty? || queues.include?(job["queue"])
-              size += 1
-            end
-          end
-
-          size
-        end
-
-        def retry_size(queues)
-          size = 0
-          now = Time.now
-
-          find_each_in_set(::Sidekiq::RetrySet.new) do |job|
-            if job.at > now
-              break
-            elsif queues.empty? || queues.include?(job["queue"])
-              size += 1
-            end
-          end
-
-          size
-        end
-
-        def working_size(queues)
-          now = Time.now
-          now_as_i = now.to_i
-
-          ::Sidekiq::Workers.new.count do |key, tid, job|
-            if job.is_a?(Hash) # Sidekiq < 7.2.1
-              (queues.empty? || queues.include?(job["queue"])) && job["run_at"] <= now_as_i
-            else # Sidekiq >= 7.2.1
-              (queues.empty? || queues.include?(job.queue)) && job.run_at <= now
-            end
-          end
-        end
-
         SERVER_SIDE_SCRIPT = <<~LUA
           local tonumber = tonumber
           local cjson_decode = cjson.decode
@@ -330,6 +261,80 @@ module HireFire
 
         SERVER_SIDE_SCRIPT_SHA = Digest::SHA1.hexdigest(SERVER_SIDE_SCRIPT).freeze
 
+        def call(*queues, server: false, **options)
+          require "sidekiq/api"
+
+          queues = normalize_queues(queues, allow_empty: true)
+
+          if server
+            server_lookup(queues, **options)
+          else
+            client_lookup(queues, **options)
+          end
+        end
+
+        private
+
+        def client_lookup(queues, skip_retries: false, skip_scheduled: false, skip_working: false, max_scheduled: nil)
+          size = enqueued_size(queues)
+          size += scheduled_size(queues, max_scheduled) unless skip_scheduled
+          size += retry_size(queues) unless skip_retries
+          size += working_size(queues) unless skip_working
+          size
+        end
+
+        def enqueued_size(queues)
+          queues = registered_queues if queues.empty?
+
+          ::Sidekiq.redis do |conn|
+            conn.pipelined do |pipeline|
+              queues.each { |name| pipeline.llen("queue:#{name}") }
+            end
+          end.sum
+        end
+
+        def scheduled_size(queues, max = nil)
+          size, now = 0, Time.now
+
+          find_each_in_set(::Sidekiq::ScheduledSet.new) do |job|
+            if job.at > now || max && size >= max
+              break
+            elsif queues.empty? || queues.include?(job["queue"])
+              size += 1
+            end
+          end
+
+          size
+        end
+
+        def retry_size(queues)
+          size = 0
+          now = Time.now
+
+          find_each_in_set(::Sidekiq::RetrySet.new) do |job|
+            if job.at > now
+              break
+            elsif queues.empty? || queues.include?(job["queue"])
+              size += 1
+            end
+          end
+
+          size
+        end
+
+        def working_size(queues)
+          now = Time.now
+          now_as_i = now.to_i
+
+          ::Sidekiq::Workers.new.count do |key, tid, job|
+            if job.is_a?(Hash) # Sidekiq < 7.2.1
+              (queues.empty? || queues.include?(job["queue"])) && job["run_at"] <= now_as_i
+            else # Sidekiq >= 7.2.1
+              (queues.empty? || queues.include?(job.queue)) && job.run_at <= now
+            end
+          end
+        end
+
         def server_lookup(queues, skip_scheduled: false, skip_retries: false, skip_working: false, max_scheduled: 0)
           ::Sidekiq.redis do |connection|
             now = Time.now.to_i

data/lib/hirefire/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HireFire
-  VERSION = "1.0.5"
+  VERSION = "1.0.7"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hirefire-resource
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Michael van Rooijen
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-15 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -24,7 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-description: 
 email:
 - support@hirefire.io
 executables: []
@@ -72,7 +70,6 @@ metadata:
   changelog_uri: https://github.com/hirefire/hirefire-resource-ruby/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/hirefire/hirefire-resource-ruby
   bug_tracker_uri: https://github.com/hirefire/hirefire-resource-ruby/issues
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: HireFire integration library for Ruby applications
 test_files: []