sidekiq-job-signal 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1b1269d2b8a1f085d4e4d401395d9782183816d914f743fae1a0ed53a49fe67
-  data.tar.gz: 5b6c2f6a338cc074dae96217f46801fe8a388f8f89b115c07034be2b4abacffa
+  metadata.gz: aa69177da872fdf54f62d0834e9c91873e6b0d48482020eca1d47834bfcbe15f
+  data.tar.gz: 0ec3e0052920bc78933e024194624b17b771ecf5241cc890970e6dfdcbfdad1b
 SHA512:
-  metadata.gz: 6c967793f23972ec8d9ed9ba9745156cf10602218e5cec2cecea0537a9320bfd8aefac1c03ce37a8658e06b22a0dcf8d83e611ac4133373a70a0e2262b79a17c
-  data.tar.gz: 20ffd03cecc77dd267384c9d5e627cb726678cac7c00906325de05e7264f1e21a499253e490d314286b75607d3c31c8ba9ddf1827880aaa362378055e037bcdf
+  metadata.gz: 118bcc2de0547932c93a784345d45196034298e0181e3e3cfcbf638b914d74a80683b86f1e36ea46b9b760394adb07e44181664669663c3fc162b40aedd41fda
+  data.tar.gz: 8939c6978196a406867be42c898c6d7f03b31475213c8b1aacba892b12d5753577625fa9547c2c728a968108dd897b497d24b2731ea552bb1a08974ced89e1c5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq-job-signal (0.1.1)
+    sidekiq-job-signal (0.1.2)
       sidekiq (>= 6.5, < 7.0)
 
 GEM

data/README.md

@@ -8,6 +8,10 @@ Install the gem and add to the application's Gemfile by executing:
 
     $ bundle add sidekiq-job-signal
 
+In your Gemfile, specify the gem as:
+
+    gem "sidekiq-job-signal", require: "sidekiq/job_signal"
+
 If bundler is not being used to manage dependencies, install the gem by executing:
 
     $ gem install sidekiq-job-signal
@@ -16,14 +20,32 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ```rb
 Sidekiq::JobSignal.quit(jid: "12345")
+Sidekiq::JobSignal.quit(job_class: "ExampleJob")
 
 # log:
 #   Turned #{12345}:#{JobWorkerClass} into a no-op: [1,2,3]"
 
+# If you want to add the `quitting?` method to your job
+class ExampleJob
+  include Sidekiq::Job
+  include Sidekiq::JobSignal::Receiver
+
+  def perform
+    if quitting?
+      # finish early...
+    end
+  end
+end
+
 # middleware.rb
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
+    # Defaults to by_class: false, by_jid: true
     chain.add ::Sidekiq::JobSignal::ServerMiddleware
+    # OR
+    chain.add ::Sidekiq::JobSignal::ServerMiddleware, by_class: true
+    # OR
+    chain.add ::Sidekiq::JobSignal::ServerMiddleware, by_jid: false, by_class: true
   end
 
   Sidekiq::JobSignal.on_quit do |job|
@@ -33,7 +55,7 @@ Sidekiq.configure_server do |config|
 end
 ```
 
-If you like to enable the Sidekiq Web UI for quitting jobs, you can include the following in some kind of initialization file. This will enable a new "Signals" tab.
+If you'd like to enable the Sidekiq Web UI for quitting jobs, you can include the following in some kind of initialization file. This will enable a new "Signals" tab.
 
 ```rb
 Sidekiq::Web.register Sidekiq::JobSignal::Web

data/lib/sidekiq/job_signal/receiver.rb

@@ -2,9 +2,9 @@
 
 module Sidekiq
   module JobSignal
-    class Receiver
+    module Receiver
       def quitting?
-        ::Sidekiq::JobSignal.quitting?(jid: jid, worker_class: self.class.name)
+        ::Sidekiq::JobSignal.quitting?(jid: jid, job_class: self.class.name)
       end
     end
   end

data/lib/sidekiq/job_signal/server_middleware.rb

@@ -5,19 +5,36 @@ module Sidekiq
     class ServerMiddleware
       include ::Sidekiq::ServerMiddleware
 
-      def call(worker, _job, _queue)
-        signalled = ::Sidekiq::JobSignal.quitting?(worker_class: worker.class.name, jid: worker.jid)
-        logger.info "Sidekiq::JobSignal::ServerMiddleware.call: signalled=#{signalled}"
-        if signalled
-          def worker.perform(*args)
-            logger.info "Turned #{jid}:#{self.class} into a no-op: #{args.inspect}"
-          end
-        end
+      def initialize(options = {})
+        @by_jid = options.fetch(:by_jid, true)
+        @by_class = options.fetch(:by_class, false)
+      end
 
+      def call(job, job_payload, _queue)
+        signalled = ::Sidekiq::JobSignal.quitting?(**quit_options(job))
+        logger.debug "#{self.class}.call: signalled=#{signalled}"
+        noop_job(job) if signalled
         yield
       ensure
-        logger.info "Sidekiq::JobSignal::ServerMiddleware.call: ensure signalled=#{signalled}"
-        ::Sidekiq::JobSignal.handlers.each { |handler| handler.call(worker) } if signalled
+        logger.debug "#{self.class}.call: ensure signalled=#{signalled}"
+        ::Sidekiq::JobSignal.handlers.each { |handler| handler.call(job) } if signalled
+      end
+
+      private
+
+      attr_reader :by_jid, :by_class
+
+      def quit_options(job)
+        {}.tap do |options|
+          options[:job_class] = job.class.name if by_class
+          options[:jid] = job.jid if by_jid
+        end
+      end
+
+      def noop_job(job)
+        def job.perform(*args)
+          logger.info "Turned #{jid}:#{self.class} into a no-op: #{args.inspect}"
+        end
       end
     end
   end

data/lib/sidekiq/job_signal/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module JobSignal
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/sidekiq/job_signal/web.rb

@@ -18,4 +18,4 @@ module Sidekiq
       end
     end
   end
-end
+end

data/lib/sidekiq/job_signal.rb

@@ -17,29 +17,29 @@ module Sidekiq
         handlers << block
       end
 
-      def quit(worker_class: "", jid: "")
+      def quit(job_class: "", jid: "")
         ::Sidekiq.redis do |r|
           r.pipelined do |pipeline|
             pipeline.set "jobsignal-#{jid}", "quit", ex: 86_400 if jid && !jid.empty?
-            pipeline.set "jobsignal-#{worker_class}", "quit", ex: 86_400 if worker_class && !worker_class.empty?
+            pipeline.set "jobsignal-#{job_class}", "quit", ex: 86_400 if job_class && !job_class.empty?
           end
         end
       end
 
-      def delete_signal(worker_class: "", jid: "")
+      def delete_signal(job_class: "", jid: "")
         ::Sidekiq.redis do |r|
           r.pipelined do |pipeline|
             pipeline.del("jobsignal-#{jid}") if jid && !jid.empty?
-            pipeline.del("jobsignal-#{worker_class}") if worker_class && !worker_class.empty?
+            pipeline.del("jobsignal-#{job_class}") if job_class && !job_class.empty?
           end
         end
       end
 
-      def quitting?(worker_class: "", jid: "")
+      def quitting?(job_class: "", jid: "")
         results = ::Sidekiq.redis do |r|
           r.pipelined do |pipeline|
             pipeline.get("jobsignal-#{jid}") if jid && !jid.empty?
-            pipeline.get("jobsignal-#{worker_class}") if worker_class && !worker_class.empty?
+            pipeline.get("jobsignal-#{job_class}") if job_class && !job_class.empty?
           end
         end
         results.include?("quit")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-job-signal
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - JP Camara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-20 00:00:00.000000000 Z
+date: 2024-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Signal a job to quit, and block the job from executing through middleware.