job_contracts 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8f52af511321598aed75762fb9b133a2f92af32365148881b9ab5834399ed64
-  data.tar.gz: 8d1646b541bcbc1599b2d8a68d41d8b8e030c333d33acda8d1b5a473ce850a49
+  metadata.gz: d04fb7e6db54d4ed074bd176cd6a966f74ad964889c3970c542d921a1d605936
+  data.tar.gz: 3c3612c4dfb226a3155b0192c08e133b4610023f490f051e4cd12852df55ba45
 SHA512:
-  metadata.gz: 4572323c6a8aa24eba91c36111fb8155f442d265eea89e041b36b6e66e3ddd1367acd1ba340cc79281b33d365d010127e993170b2cb7b54f8712004dce9e7ba4
-  data.tar.gz: 66d24736ad86e8f787c2a3ea53f1c24b8d6527daa9b998f00efa4471196ebc85fee8bf01118821c3c2c9ac035c65a98f236867f44cea188f33407127dbb893be
+  metadata.gz: b56ddc45288e5b424e1844af3e4cde8d07fffa90a37c4236c8beef2f0654b27b13a760918fef9e338e69c3ffe1da0ea0978b7c195e02048ee3703295cd4f8dda
+  data.tar.gz: b560b5b6d179ca0d35f2b734600c265ec4c96526c18ca1f9df7d4d92a1f20bd7fa72b089a637a0807b416b43af64aeb31d9794d1a41912fcace75812b89b3079

data/README.md

@@ -1,6 +1,9 @@
 [![Lines of Code](http://img.shields.io/badge/lines_of_code-236-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
 [![Code Quality](https://app.codacy.com/project/badge/Grade/f604d4bc6db0474c802ef51182732488)](https://www.codacy.com/gh/hopsoft/job_contracts/dashboard?utm_source=github.com&utm_medium=referral&utm_content=hopsoft/job_contracts&utm_campaign=Badge_Grade)
-![tests](https://github.com/hopsoft/job_contracts/actions/workflows/test.yml/badge.svg)
+![Tests](https://github.com/hopsoft/job_contracts/actions/workflows/test.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/job_contracts.svg)](https://badge.fury.io/rb/job_contracts)
+[![Gem Downloads](https://img.shields.io/gem/dt/job_contracts)](https://rubygems.org/gems/job_contracts)
+[![Follow Hopsoft](https://img.shields.io/twitter/follow/hopsoft?style=social)](https://twitter.com/hopsoft)
 
 # Job Contracts
 
@@ -47,7 +50,6 @@ class ImportantJob < ApplicationJob
   include JobContracts::Contractable
 
   queue_as :default
-
   add_contract JobContracts::DurationContract.new(max: 5.seconds)
 
   def perform
@@ -97,7 +99,7 @@ Contracts support the following constructor arguments.
 
 ### Defining a Contract
 
-Here's a contrived but simple example that ensures the first argument to perform fits within a specific range of values.
+Here's a contrived, but simple, example that ensures the first argument passed to perform fits within a specific range of values.
 
 ```ruby
 # app/contracts/argument_contract.rb
@@ -203,7 +205,6 @@ class ImportantJob < ApplicationJob
   include JobContracts::Contractable
 
   queue_as :default
-
   on_contract_breach :take_action
   add_contract JobContracts::DurationContract.new(max: 5.seconds)
 
@@ -222,10 +223,7 @@ class ImportantJob < ApplicationJob
   include JobContracts::Contractable
 
   queue_as :default
-
-  on_contract_breach -> (contract) {
-    # take action...
-  }
+  on_contract_breach -> (contract) { # take action... }
 
   add_contract JobContracts::DurationContract.new(max: 5.seconds)
 
@@ -237,11 +235,26 @@ end
 
 ## Sidekiq
 
-Sidekiq jobs/workers are supported.
-Unfortunately this support comes with a performance penalty *(i.e. additional latency)* because executing
-Sidekiq jobs don't have access to their own metadata. To get around this, we wait to find job metadata in the active
-[`WorkSet`](https://github.com/hopsoft/job_contracts/blob/main/lib/job_contracts/concerns/sidekiq_contractable.rb#L23-L25)
-which is only updated [every 5 seconds](https://github.com/mperham/sidekiq/wiki/API#workers).
+`Sidekiq::Job`s are also supported.
+
+```ruby
+class ImportantJob
+  include Sidekiq::Job
+  include JobContracts::SidekiqContractable
+
+  sidekiq_options queue: :default
+  add_contract JobContracts::DurationContract.new(max: 1.second)
+
+  def perform
+    # logic...
+  end
+
+  # default callback that's invoked if the contract is breached
+  def contract_breached!(contract)
+    # handle breach...
+  end
+end
+```
 
 ## Todo
 

data/lib/job_contracts/concerns/contractable.rb

@@ -15,21 +15,16 @@ module JobContracts
         # fetch sidekiq job/worker metadata on main thread
         try :sidekiq_job_metadata
 
-        halted = false
-        contracts.select(&:before?).each do |contract|
-          contract.enforce! self unless halted
-          halted = true if contract.breached? && contract.halt?
-        end
+        halted = enforce_contracts!(contracts.select(&:before?))
         super unless halted
       ensure
-        # enforce after contracts in a separate thread to ensure that any perform related behavior
-        # defined in ContractablePrepends will finish executing before we invoke contract.enforce!
-        Thread.new do
-          sleep 0
-          synchronize do
-            contracts.select(&:after?).each do |contract|
-              contract.enforce! self unless halted
-            end
+        unless halted
+          # enforce after-contracts in a separate thread to ensure that any perform related behavior
+          # defined in ContractablePrepends will finish executing before we invoke contract.enforce!
+          # important when multiple contracts have been applied
+          Thread.new do
+            sleep 0
+            synchronize { enforce_contracts! contracts.select(&:after?) }
           end
         end
       end
@@ -75,5 +70,17 @@ module JobContracts
     def contract_breached!
       # noop / override in job subclasses
     end
+
+    private
+
+    def enforce_contracts!(contracts)
+      halted = false
+      contracts.each do |contract|
+        next if halted
+        contract.enforce! self
+        halted ||= contract.breached? && contract.halt?
+      end
+      halted
+    end
   end
 end

data/lib/job_contracts/concerns/sidekiq_contractable.rb

@@ -8,54 +8,32 @@ module JobContracts
     extend ActiveSupport::Concern
     include Contractable
 
-    class SidekiqJobMetadataNotFoundError < StandardError; end
-
     module ClassMethods
+      # Matches the ActiveJob API
       def queue_name
         sidekiq_options_hash["queue"]
       end
     end
 
-    def sidekiq_job_metadata
-      @sidekiq_job_metadata ||= begin
-        hit = nil
-        begin
-          attempts ||= 1
-          hit = Sidekiq::Workers.new.find do |_process_id, _thread_id, work|
-            work.dig("payload", "jid") == jid
-          end
-          raise SidekiqJobMetadataNotFoundError if hit.blank?
-        rescue SidekiqJobMetadataNotFoundError
-          # The WorkSet only updates every 5 seconds
-          # SEE: https://github.com/mperham/sidekiq/wiki/API#workers
-          # Re-attempt up to 10 times with a simple backoff strategy (up to 5.5 seconds)
-          # TODO: Is there a faster and more reliable way to fetch the job's metadata after perform has begun?
-          #       May need to query Redis directly if the data is still in there at this point
-          attempts += 1
-          if attempts <= 10
-            sleep 0.1 * attempts
-            retry
-          end
-        end
-
-        hit&.last || {}
-      end
+    # Metadata used to enqueue the job
+    def sidekiq_job_hash
+      @sidekiq_job_hash ||= {}
     end
 
     # Matches the ActiveJob API
     def queue_name
-      sidekiq_job_metadata["queue"]
+      sidekiq_job_hash["queue"]
     end
 
     # Matches the ActiveJob API
     def enqueued_at
-      seconds = sidekiq_job_metadata.dig("payload", "enqueued_at")
+      seconds = sidekiq_job_hash["enqueued_at"]
       (seconds ? Time.at(seconds) : nil)&.iso8601.to_s
     end
 
     # Matches the ActiveJob API
     def arguments
-      sidekiq_job_metadata.dig("payload", "args") || []
+      sidekiq_job_hash["args"] || []
     end
   end
 end

data/lib/job_contracts/railtie.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
+require "sidekiq"
+require_relative "sidekiq_job_hash_middleware"
+
 module JobContracts
   class Railtie < ::Rails::Railtie
+    initializer "job_contracts.register_sidekiq_middleware" do
+      Sidekiq.server_middleware.add SidekiqJobHashMiddleware
+    end
   end
 end

data/lib/job_contracts/sidekiq_job_hash_middleware.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module JobContracts
+  class SidekiqJobHashMiddleware
+    def call(worker, job, _queue)
+      worker.instance_variable_set :@sidekiq_job_hash, job
+      yield
+    end
+  end
+end

data/lib/job_contracts/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JobContracts
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: job_contracts
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.2.3
+        version: 6.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.2.3
+        version: 6.1.5
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.4.1
+        version: 6.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.4.1
+        version: 6.4.2
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +126,7 @@ files:
 - lib/job_contracts/contracts/queue_name_contract.rb
 - lib/job_contracts/contracts/read_only_contract.rb
 - lib/job_contracts/railtie.rb
+- lib/job_contracts/sidekiq_job_hash_middleware.rb
 - lib/job_contracts/version.rb
 homepage: https://github.com/hopsoft/job_contracts
 licenses: