job_enqueue_logger 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bd89f4945224bc0c74d429110323c609a26c63f1eef1202c588d58d9a90bb13
-  data.tar.gz: 4bda89a97eb8c1afc974edf24e37b4685ea1b354a184e782bd10e80fd383c8b3
+  metadata.gz: dea7d0e16e19e83d6a41a6ac12dfb637670b6c2767ffd859a65c33eb1fe6fb1b
+  data.tar.gz: 44da64bbfc0bcc1984dff1bb971768d0ebec961e4eefba46b9223c38115f6376
 SHA512:
-  metadata.gz: fe5c00d27ef14b4c7da8458cd3500b8dda2af19bdb56f1829588abe3f0a6634f284e8e46b5ca92cdbb2f16a4ed89e1a3be3f9cb578dbd942066b8da809cf11d0
-  data.tar.gz: cc5b8a0463f46332cb03bb5cadd3aeb4b2de8aa6b3f5cd4fbca7c9fe730e5d18f82e95a656683dc5d83daa7eb2ca664c32c63386ff99bded51f40cff1ad5e9fb
+  metadata.gz: 2b20c92834369550756fe71f0f27c76dca198fe267fad432765740bbcf3a1ed034e89aa126fb2acf6e76978f632813241176af77a7d139762ffd4d7ba9f4c2e5
+  data.tar.gz: e5ef769550740936181d7fa72b78bc6c132542095e0bb66f7c4973bf90298bc6ffed1d168e4aa553f4b60ae8266fc8221dbfa611fc02c1855ffa48a110157592

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## master (unreleased)
 
-## 0.1.0 (2023-03-29)
+## 0.3.0 (2023-11-09)
+
+- Truncate long string arguments in log output
+- Add ability to set logger
+- Prefix this gem log lines with `[JobEnqueueLogger]`
+
+## 0.2.0 (2023-04-04)
+
+- Support `que`
+- Support `sucker_punch`
+
+## 0.1.0 (2023-03-30)
 
 - First release

data/README.md

@@ -11,13 +11,13 @@ This is very much a development and debugging tool; it is not recommended to use
 When the job is enqueued within the guts of the application, the log line is generated:
 
 ```
-Enqueued AvatarThumbnailsJob (jid=578b3d10fc5403f97ee0a8e1) to Sidekiq(default) with arguments: 1092412064
+[JobEnqueueLogger] Enqueued AvatarThumbnailsJob (jid=578b3d10fc5403f97ee0a8e1) to Sidekiq(default) with arguments: 1092412064
 ```
 
 Or with backtraces enabled:
 
 ```
-Enqueued AvatarThumbnailsJob (jid=578b3d10fc5403f97ee0a8e1) to Sidekiq(default) with arguments: 1092412064
+[JobEnqueueLogger] Enqueued AvatarThumbnailsJob (jid=578b3d10fc5403f97ee0a8e1) to Sidekiq(default) with arguments: 1092412064
 ↳ app/models/user.rb:421:in `generate_avatar_thumbnails'
   app/services/user_creator.rb:21:in `call'
   app/controllers/users_controller.rb:49:in `create'
@@ -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).
 
@@ -69,13 +71,15 @@ JobEnqueueLogger.configure do |config|
   # Controls whether to print backtraces. Set to `true` to print backtraces, or
   # a number to limit how many lines to print.
   config.backtrace = false
+
+  # The logger to log to.
+  # Is set to Rails.logger by default, when the gem is used in the Rails app.
+  config.logger = nil
 end
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing

data/lib/job_enqueue_logger/delayed_job_adapter.rb

@@ -34,8 +34,8 @@ module JobEnqueueLogger
       alias server? server
 
       def logger
-        if !server? && defined?(Rails)
-          Rails.logger
+        if !server? && JobEnqueueLogger.logger
+          JobEnqueueLogger.logger
         else
           Delayed::Worker.logger
         end

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 && JobEnqueueLogger.logger
+        JobEnqueueLogger.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/railtie.rb

@@ -6,6 +6,7 @@ module JobEnqueueLogger
   class Railtie < Rails::Railtie
     initializer "job_enqueue_logger.backtrace_cleaner" do
       JobEnqueueLogger.backtrace_cleaner = Rails.backtrace_cleaner
+      JobEnqueueLogger.logger = Rails.logger
     end
   end
 end

data/lib/job_enqueue_logger/resque_adapter.rb

@@ -41,8 +41,8 @@ module JobEnqueueLogger
       alias server? server
 
       def logger
-        if !server? && defined?(Rails)
-          Rails.logger
+        if !server? && JobEnqueueLogger.logger
+          JobEnqueueLogger.logger
         else
           Resque.logger
         end

data/lib/job_enqueue_logger/sidekiq_adapter.rb

@@ -47,8 +47,8 @@ module JobEnqueueLogger
     end
 
     def self.logger
-      if !Sidekiq.server? && defined?(Rails)
-        Rails.logger
+      if !Sidekiq.server? && JobEnqueueLogger.logger
+        JobEnqueueLogger.logger
       else
         Sidekiq.logger
       end

data/lib/job_enqueue_logger/sucker_punch_adapter.rb

@@ -0,0 +1,36 @@
+# 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
+      JobEnqueueLogger.logger || SuckerPunch.logger
+    end
+  end
+end
+
+SuckerPunch::Job::ClassMethods.prepend(JobEnqueueLogger::SuckerPunchAdapter::Job)

data/lib/job_enqueue_logger/utils.rb

@@ -3,6 +3,7 @@
 module JobEnqueueLogger
   module Utils
     def self.log_job_enqueue(logger, message)
+      message = "[JobEnqueueLogger] #{message}"
       return logger.info(message) unless JobEnqueueLogger.backtrace
 
       backtrace = caller
@@ -19,10 +20,19 @@ module JobEnqueueLogger
 
     def self.args_info(args)
       if Array(args).any?
-        " with arguments: #{Array(args).map(&:inspect).join(', ')}"
+        " with arguments: #{Array(args).map { |arg| format_arg(arg).inspect }.join(', ')}"
       else
         ""
       end
     end
+
+    def self.format_arg(arg)
+      case arg
+      when String
+        arg.size > 100 ? "#{arg[0, 100]}…" : arg
+      else
+        arg
+      end
+    end
   end
 end

data/lib/job_enqueue_logger/version.rb

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

data/lib/job_enqueue_logger.rb

@@ -16,7 +16,7 @@ module JobEnqueueLogger
         end
     end
 
-    attr_accessor :backtrace
+    attr_accessor :backtrace, :logger
 
     def configure
       yield self
@@ -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.3.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-11-08 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
@@ -52,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Log background jobs enqueued by your application (additionally with backtraces).