job_contracts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ccfdc1005a713277b03897aaf58f87db30e04d9697e92f462c8712eeb4faf8d
+  data.tar.gz: 3f3a4d679a61701c986cd858ca259b1208a2f3d82bd94681b96e884252fb4403
+SHA512:
+  metadata.gz: 41d343fa07382f35997fe9a6a75410fcfaf8f599b42cf9421349ae4084ed49c5b5467579b83fd326992c27bf4d3ec64bbb38882ee370e297d8688dcd571131c4
+  data.tar.gz: 95336d3dd5464cbb7731ce25c946f5502a7cbc2158a7ea73ef727726b9226e7d660a735351bc5260f783cf6e3ab1a6bc93adeac7c15464a81288863cd70896f9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Hopsoft
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,12 @@
+# Job Contracts
+
+## Enforceable contracts for background jobs
+
+## Todos
+
+- [ ] Add documentation
+- [ ] Add automated tests
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/job_contracts/concerns/contractable.rb

@@ -0,0 +1,65 @@
+module JobContracts
+  # Universal mixin for jobs/workers
+  module Contractable
+    extend ActiveSupport::Concern
+
+    module Prepends
+      extend ActiveSupport::Concern
+
+      def perform(*args)
+        should_perform = true
+        self.class.contracts_to_enforce_before_perform.each do |contract|
+          contract.enforce! self
+          should_perform = false if contract.breached? && contract.halt?
+        end
+        super if should_perform
+        self.class.contracts_to_enforce_after_perform.each do |contract|
+          contract.enforce! self
+        end
+      end
+    end
+
+    module ClassMethods
+      attr_reader :after_contract_breach_callback
+
+      def contracts_to_enforce_before_perform
+        @contracts_to_enforce_before_perform ||= Set.new
+      end
+
+      def contracts_to_enforce_after_perform
+        @contracts_to_enforce_after_perform ||= Set.new
+      end
+
+      def after_contract_breach(value = nil, &block)
+        @after_contract_breach_callback = value || block
+      end
+
+      def add_contract(contract)
+        if contract.class.const_defined?(:ContractableIncludes)
+          include contract.class.const_get(:ContractableIncludes)
+        end
+
+        if contract.class.const_defined?(:ContractablePrepends)
+          prepend contract.class.const_get(:ContractablePrepends)
+        end
+
+        prepend JobContracts::Contractable::Prepends
+
+        if contract.trigger == :before
+          contracts_to_enforce_before_perform << contract
+        else
+          contracts_to_enforce_after_perform << contract
+        end
+      end
+    end
+
+    def after_contract_breach(contract)
+      method = self.class.after_contract_breach_callback
+      case method
+      when Proc then method.call(contract)
+      when String, Symbol then send(method, contract)
+      else raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/job_contracts/concerns/sidekiq_contractable.rb

@@ -0,0 +1,46 @@
+require_relative "contractable"
+
+module JobContracts
+  # Sidekiq mixin for jobs/workers
+  module SidekiqContractable
+    extend ActiveSupport::Concern
+    include Contractable
+
+    class MetadataNotFoundError < StandardError; end
+
+    def metadata
+      hit = nil
+      begin
+        attempts ||= 1
+        hit = Sidekiq::WorkSet.new.find do |_pid, _tid, work|
+          work.dig("payload", "jid") == jid
+        end
+        raise MetadataNotFoundError if hit.blank?
+      rescue MetadataNotFoundError
+        # 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
+
+    # Matches the ActiveJob API
+    def queue_name
+      metadata["queue"]
+    end
+
+    # Matches the ActiveJob API
+    def enqueued_at
+      seconds = metadata.dig("payload", "enqueued_at")
+      (seconds ? Time.at(seconds) : nil)&.iso8601.to_s
+    end
+  end
+end

data/lib/job_contracts/contracts/contract.rb

@@ -0,0 +1,49 @@
+require "observer"
+
+module JobContracts
+  class Contract
+    include Observable
+
+    attr_reader :trigger
+
+    def initialize(trigger: :after, halt: false, **kwargs)
+      @trigger = trigger.to_sym
+      @halt = halt
+      expect.merge! kwargs
+    end
+
+    def expect
+      @expect ||= HashWithIndifferentAccess.new
+    end
+
+    def actual
+      @actual ||= HashWithIndifferentAccess.new
+    end
+
+    # Method to be implemented by subclasses
+    # NOTE: subclasses should update `actual`, set `satisfied`, and call `super`
+    def enforce!(contractable)
+      add_observer contractable, :after_contract_breach
+      changed if breached?
+      notify_observers self
+    ensure
+      delete_observer contractable
+    end
+
+    def satisfied?
+      !!satisfied
+    end
+
+    def breached?
+      !satisfied?
+    end
+
+    def halt?
+      !!@halt
+    end
+
+    protected
+
+    attr_accessor :satisfied
+  end
+end

data/lib/job_contracts/contracts/duration_contract.rb

@@ -0,0 +1,15 @@
+require_relative "contract"
+
+module JobContracts
+  class DurationContract < Contract
+    def initialize(duration:)
+      super
+    end
+
+    def enforce!(contractable)
+      actual[:duration] = (Time.current - Time.parse(contractable.enqueued_at)).seconds
+      self.satisfied = actual[:duration] < expect[:duration].seconds
+      super
+    end
+  end
+end

data/lib/job_contracts/contracts/queue_name_contract.rb

@@ -0,0 +1,16 @@
+require_relative "contract"
+
+module JobContracts
+  class QueueNameContract < Contract
+    def initialize(queue_name:)
+      super trigger: :before, halt: true, queue_name: queue_name
+    end
+
+    def enforce!(contractable)
+      queue_name = contractable.queue_name
+      actual[:queue_name] = queue_name
+      self.satisfied = queue_name.to_s == expect[:queue_name].to_s
+      super
+    end
+  end
+end

data/lib/job_contracts/contracts/read_only_contract.rb

@@ -0,0 +1,36 @@
+require_relative "contract"
+
+module JobContracts
+  class ReadOnlyContract < Contract
+    module ContractablePrepends
+      extend ActiveSupport::Concern
+
+      def perform(*args)
+        ActiveRecord::Base.while_preventing_writes do
+          super
+        end
+      rescue ActiveRecord::ReadOnlyError => error
+        @read_only_error = error
+      end
+    end
+
+    module ContractableIncludes
+      extend ActiveSupport::Concern
+      included do
+        attr_reader :read_only_error
+      end
+    end
+
+    # def initialize
+    # super trigger: :before
+    # end
+
+    def enforce!(contractable)
+      if contractable.read_only_error.present?
+        actual[:error] = contractable.read_only_error.message
+        self.satisfied = false
+      end
+      super
+    end
+  end
+end

data/lib/job_contracts/railtie.rb

@@ -0,0 +1,4 @@
+module JobContracts
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/job_contracts/version.rb

@@ -0,0 +1,3 @@
+module JobContracts
+  VERSION = "0.1.0"
+end

data/lib/job_contracts.rb

@@ -0,0 +1,9 @@
+require "job_contracts/version"
+require "job_contracts/railtie"
+
+root = Pathname.new(File.dirname(File.absolute_path(__FILE__)))
+root.glob("**/*.rb").each { |file| require file }
+
+module JobContracts
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: job_contracts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Hopkins
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.2.3
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.1
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+description: Enforceable contracts for background jobs
+email:
+- natehop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/job_contracts.rb
+- lib/job_contracts/concerns/contractable.rb
+- lib/job_contracts/concerns/sidekiq_contractable.rb
+- lib/job_contracts/contracts/contract.rb
+- lib/job_contracts/contracts/duration_contract.rb
+- lib/job_contracts/contracts/queue_name_contract.rb
+- lib/job_contracts/contracts/read_only_contract.rb
+- lib/job_contracts/railtie.rb
+- lib/job_contracts/version.rb
+homepage: https://github.com/hopsoft/job_contracts
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hopsoft/job_contracts
+  source_code_uri: https://github.com/hopsoft/job_contracts
+  changelog_uri: https://github.com/hopsoft/job_contracts/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Enforceable contracts for background jobs
+test_files: []