job_contracts 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3409ea614e4698241974af1291cac6b6e2fc0cf75c45af5d7d5ea61cde545998
-  data.tar.gz: 7a59f4f8408f9d0c7963578b411bc5425da56e7138cb35e7cd0ee938f342dc58
+  metadata.gz: 5bcafda35a29dbc6cb71004f638807b9634658e3eb50cd13f9ebd4274709f03c
+  data.tar.gz: 6a6a0e43df2db48f77525ac3ceae7bb26b36cd300becee484b65b14caec3c703
 SHA512:
-  metadata.gz: 6e3329c2fb4ff9a4a898c44453504259b211389f8f2d57a6a6ba1a0722da414ad843030e8c1991e79ba28dfe71abedad9ef016f130ba469a5dc37c23c441572a
-  data.tar.gz: 40be8734e8791531b7b03fde19f89697a10744ec0f77e688a091090df9a998bffd8aa3d70c95bd1e31aba024f10338a4aa7fdea712cef9f8eeaefb4beb2fbc45
+  metadata.gz: 799d3d7aa098fe1775a7ec0e36d210ae25713ccb96c2ab5bd8962298097b7754fb5805f4c99267111aabe19f20caf47e64671806410ffd2af5c11a757121e9a1
+  data.tar.gz: ecef09781a6b2833d30c6e8c1ee2dcf3d32c3a500df0f1b1cab60e4cf8490eeda1b294a77263ffdc9039adec10740b68396e7d292542e75e245a405f3ec59ea0

data/README.md

@@ -1,6 +1,8 @@
-[![Lines of Code](http://img.shields.io/badge/lines_of_code-240-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
+[![Lines of Code](http://img.shields.io/badge/lines_of_code-232-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)
+[![Follow Hopsoft](https://img.shields.io/twitter/follow/hopsoft?style=social)](https://twitter.com/hopsoft)
 
 # Job Contracts
 
@@ -47,7 +49,6 @@ class ImportantJob < ApplicationJob
   include JobContracts::Contractable
 
   queue_as :default
-
   add_contract JobContracts::DurationContract.new(max: 5.seconds)
 
   def perform
@@ -97,7 +98,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 +204,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 +222,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 +234,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

@@ -75,11 +75,5 @@ module JobContracts
     def contract_breached!
       # noop / override in job subclasses
     end
-
-    def on_contract_breach(contract)
-      breached_contracts << contract
-      method = self.class.on_contract_breach_callback
-      method.is_a?(Proc) ? method.call(contract) : send(method.to_s, contract)
-    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/contracts/contract.rb

@@ -1,11 +1,7 @@
 # frozen_string_literal: true
 
-require "observer"
-
 module JobContracts
   class Contract
-    include Observable
-
     attr_reader :trigger, :queues
 
     def initialize(trigger: :after, halt: false, queues: [], expected: {})
@@ -32,11 +28,9 @@ module JobContracts
     # NOTE: subclasses should update `actual`, set `satisfied`, and call `super`
     def enforce!(contractable)
       return unless should_enforce?(contractable)
-      add_observer contractable, :on_contract_breach
-      changed if breached?
-      notify_observers self
-    ensure
-      delete_observer contractable
+      return if satisfied?
+      contractable.breached_contracts << self
+      invoke_contract_breach_callback contractable
     end
 
     def satisfied?
@@ -73,5 +67,11 @@ module JobContracts
     protected
 
     attr_accessor :satisfied
+
+    def invoke_contract_breach_callback(contractable)
+      callback = contractable.class.on_contract_breach_callback
+      callback = contractable.method(callback.to_sym) unless callback.is_a?(Proc)
+      callback.call self
+    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.1"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: job_contracts
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 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,42 +16,42 @@ 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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: magic_frozen_string_literal
   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: