job_enqueue_logger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bd89f4945224bc0c74d429110323c609a26c63f1eef1202c588d58d9a90bb13
-  data.tar.gz: 4bda89a97eb8c1afc974edf24e37b4685ea1b354a184e782bd10e80fd383c8b3
+  metadata.gz: 8d4b7eb9d105f9c73af421299c43d70573c5ac5b519cf5a334d0a78ed2b704f9
+  data.tar.gz: efe3b6d93873f70676e6c7b9cd085328332fda9cba8fcad99007f4151f3e253c
 SHA512:
-  metadata.gz: fe5c00d27ef14b4c7da8458cd3500b8dda2af19bdb56f1829588abe3f0a6634f284e8e46b5ca92cdbb2f16a4ed89e1a3be3f9cb578dbd942066b8da809cf11d0
-  data.tar.gz: cc5b8a0463f46332cb03bb5cadd3aeb4b2de8aa6b3f5cd4fbca7c9fe730e5d18f82e95a656683dc5d83daa7eb2ca664c32c63386ff99bded51f40cff1ad5e9fb
+  metadata.gz: 523da331a92ea785d6a58ce1fbd3e4bcbc9dbbe1a8f3f2974ee2bb0b581a805e100f7e4d0f225710e7e83bf699916514b84e163ba7bec1e302bfcb143752e858
+  data.tar.gz: 2c2b9128d579945615e85eebdd71531e64027b82ad9e16bbff4d1203a96c875f237a977e3b33aaa7f65ea41b433f4cee8abbaba81201c622383e9336ca47663b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## master (unreleased)
 
-## 0.1.0 (2023-03-29)
+## 0.2.0 (2023-04-04)
+
+- Support `que`
+- Support `sucker_punch`
+
+## 0.1.0 (2023-03-30)
 
 - First release

data/README.md

@@ -32,6 +32,8 @@ This gem supports most common job queuing backends:
 * [Sidekiq](https://github.com/sidekiq/sidekiq) >= 6.5.0
 * [Resque](https://github.com/resque/resque) >= 2.0.0
 * [DelayedJob](https://github.com/collectiveidea/delayed_job) >= 4.1.5
+* [SuckerPunch](https://github.com/brandonhilkert/sucker_punch) >= 3.0.0
+* [Que](https://github.com/que-rb/que) >= 2.0.0
 
 If you need support for older rubies or older versions of queuing backends (or additional backends), [open an issue](https://github.com/fatkodima/job_enqueue_logger/issues/new).
 

data/lib/job_enqueue_logger/que_adapter.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module JobEnqueueLogger
+  module QueAdapter
+    module Job
+      def enqueue(*)
+        job = super
+        unless Thread.current[:que_jobs_to_bulk_insert]
+          job_attrs = job.que_attrs
+          job_class = job_attrs[:job_class]
+          args = job_attrs[:args]
+          args << job_attrs[:kwargs] unless job_attrs[:kwargs].empty?
+
+          if (id = job_attrs[:id])
+            message = "Enqueued #{job_class} (id=#{id}) to Que(#{job_attrs[:queue]})"
+
+            run_at = job_attrs[:run_at].utc
+            message += " at #{run_at}" if run_at > Time.now.utc
+            message += Utils.args_info(args)
+          else
+            # Job performed inline.
+            message = "Performed inline #{job_class}" + Utils.args_info(args)
+          end
+          Utils.log_job_enqueue(QueAdapter.logger, message)
+        end
+        job
+      end
+      ruby2_keywords(:enqueue)
+
+      def bulk_enqueue(**)
+        jobs = super
+        if jobs.any?
+          job_attrs = jobs.first.que_attrs
+          job_class = job_attrs[:job_class]
+
+          if job_attrs[:id]
+            run_at = job_attrs[:run_at].utc
+
+            message = "Enqueued"
+            message += " #{jobs.size}" if jobs.size > 1
+            message += " #{job_class} to Que(#{job_attrs[:queue]})"
+            message += " at #{run_at}" if run_at > Time.now.utc
+          else
+            message = "Performed inline"
+            message += " #{jobs.size}" if jobs.size > 1
+            message += " #{job_class}"
+          end
+
+          Utils.log_job_enqueue(QueAdapter.logger, message)
+        end
+        jobs
+      end
+    end
+
+    def self.logger
+      # Que.server? is defined in the newest version of Que - https://github.com/que-rb/que/pull/382
+      is_server = defined?(Que::CommandLineInterface)
+
+      if !is_server && defined?(Rails)
+        Rails.logger
+      elsif Que.logger.respond_to?(:call)
+        Que.logger.call
+      else
+        Que.logger
+      end
+    end
+  end
+end
+
+Que::Job.singleton_class.prepend(JobEnqueueLogger::QueAdapter::Job)

data/lib/job_enqueue_logger/sucker_punch_adapter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module JobEnqueueLogger
+  # There is no easy way to detect if the job is performed inline,
+  # so extend only enqueuing methods.
+  module SuckerPunchAdapter
+    module Job
+      def perform_async(*args)
+        enqueued = super
+        if enqueued
+          message = "Enqueued #{name} to SuckerPunch" + Utils.args_info(args)
+          Utils.log_job_enqueue(SuckerPunchAdapter.logger, message)
+        end
+        enqueued
+      end
+      ruby2_keywords(:perform_async)
+
+      def perform_in(interval, *args)
+        enqueued = super
+        if enqueued
+          at = (Time.now + interval).utc
+          message = "Enqueued #{name} to SuckerPunch in #{interval} seconds (at #{at})" + Utils.args_info(args)
+          Utils.log_job_enqueue(SuckerPunchAdapter.logger, message)
+        end
+        enqueued
+      end
+      ruby2_keywords(:perform_in)
+    end
+
+    def self.logger
+      if defined?(Rails)
+        Rails.logger
+      else
+        SuckerPunch.logger
+      end
+    end
+  end
+end
+
+SuckerPunch::Job::ClassMethods.prepend(JobEnqueueLogger::SuckerPunchAdapter::Job)

data/lib/job_enqueue_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JobEnqueueLogger
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/job_enqueue_logger.rb

@@ -30,4 +30,6 @@ end
 require_relative "job_enqueue_logger/sidekiq_adapter" if defined?(Sidekiq)
 require_relative "job_enqueue_logger/resque_adapter" if defined?(Resque)
 require_relative "job_enqueue_logger/delayed_job_adapter" if defined?(Delayed::Job)
+require_relative "job_enqueue_logger/sucker_punch_adapter" if defined?(SuckerPunch)
+require_relative "job_enqueue_logger/que_adapter" if defined?(Que)
 require_relative "job_enqueue_logger/railtie" if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: job_enqueue_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Log background jobs enqueued by your application (additionally with backtraces).
@@ -25,9 +25,11 @@ files:
 - README.md
 - lib/job_enqueue_logger.rb
 - lib/job_enqueue_logger/delayed_job_adapter.rb
+- lib/job_enqueue_logger/que_adapter.rb
 - lib/job_enqueue_logger/railtie.rb
 - lib/job_enqueue_logger/resque_adapter.rb
 - lib/job_enqueue_logger/sidekiq_adapter.rb
+- lib/job_enqueue_logger/sucker_punch_adapter.rb
 - lib/job_enqueue_logger/utils.rb
 - lib/job_enqueue_logger/version.rb
 homepage: https://github.com/fatkodima/job_enqueue_logger