acidic_job 1.0.0.pre11 → 1.0.0.pre12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53b5f12879bffb6a461e3574b96f8a41464ec83ce0a21eaa8e244261ce53a9be
-  data.tar.gz: 7b90c9864347564706466e62c61f08eb377d8e3a33475ad40ba559de59e7b70e
+  metadata.gz: 1af7bca23aa5ead8fed158fb73565736555236bf4515ab73f631a3013e138f12
+  data.tar.gz: cc1118240efe70d71dcd7c2eb07435f3e56934c2c3e8653848a9c3467dc60b83
 SHA512:
-  metadata.gz: '08b4a0bdd41ac80f8ac879003f455f577f93fc431acdb780dfd3e54260b07a61bf0557c3e7d99192e1ad809134b709211fd2c5efe581b797563187dcfbb34467'
-  data.tar.gz: 66e8b3bfe0226c3e1f5168d45431a01a36ee3dfb796c855c49fc009296cb223d33922bc2db5febbe6d6453b4a01c46661b805aa1e2c80a4e37f3dce183b5e748
+  metadata.gz: 90073b7d2964d65886ca2fd4320481455e04218db92ab3b2ccd65bdffc527b03f8c928c58590ed62cf7734c1702687978dd5f1406ea740f13f1fbccb7c27b48d
+  data.tar.gz: 9f2910c1620f489a1bb5a310821ead5363671aa0ffc9a21f909894f43c2de52b056ee096f17455fb8b34bd55d8f521ca71760df3959b8b0c1f90562c50129ff4

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acidic_job (1.0.0.pre11)
+    acidic_job (1.0.0.pre12)
       activerecord (>= 6.1.0)
       activesupport
 

data/README.md

@@ -1,5 +1,8 @@
 # AcidicJob
 
+[![Gem Version](https://badge.fury.io/rb/acidic_job.svg)](https://badge.fury.io/rb/acidic_job)
+![main workflow](https://github.com/fractaledmind/acidic_job/actions/workflows/main.yml/badge.svg)
+
 ### Idempotent operations for Rails apps (for ActiveJob or Sidekiq)
 
 At the conceptual heart of basically any software are "operations"—the discrete actions the software performs. Rails provides a powerful abstraction layer for building operations in the form of `ActiveJob`, or we Rubyists can use the tried and true power of pure `Sidekiq`. With either we can easily trigger from other Ruby code throughout our Rails application (controller actions, model methods, model callbacks, etc.); we can run operations both synchronously (blocking execution and then returning its response to the caller) and asychronously (non-blocking and the caller doesn't know its response); and we can also retry a specific operation if needed seamlessly.
@@ -193,16 +196,20 @@ class ExampleJob < ActiveJob::Base
 end
 ```
 
-These options cover the two common situations, but sometimes our systems need finer-grained control. For example, our job might take some record as the job argument, but we need to use a combination of the record identifier and record status as the foundation for the idempotency key. In these cases we can't configure the idempotency key logic at the class level, so instead we can provide the logic when enqueuing the job itself.
-
-When you call any `deliver_acidicly` or `perform_acidicly` method you can pass an optional `unique_by` argument which will be used to generate the idempotency key:
+These options cover the two common situations, but sometimes our systems need finer-grained control. For example, our job might take some record as the job argument, but we need to use a combination of the record identifier and record status as the foundation for the idempotency key. In these cases you can pass a `Proc` to an `acidic_by` class method:
 
 ```ruby
-ExampleJob.perform_acidicly(unique_by: { id: record.id, status: record.status })
-UserMailer.with(user, record).deliver_acidicly(unique_by: [user.id, record.id, record.status])
+class ExampleJob < ActiveJob::Base
+  include AcidicJob
+  acidic_by ->(record:) { [record.id, record.status] }
+
+  def perform(record:)
+    # the idempotency key will be based on whatever the values of `record.id` and `record.status` are
+  end
+end
 ```
 
-As you see, the value to the `unique_by` option can be a Hash or an Array or even a simple scalar value.
+> **Note:** The signature of the `acidic_by` proc _needs to match the signature_ of the job's `perform` method.
 
 
 ### Sidekiq Callbacks

data/lib/acidic_job/extensions/action_mailer.rb

@@ -7,19 +7,14 @@ module AcidicJob
     module ActionMailer
       extend ActiveSupport::Concern
 
-      def deliver_acidicly(_options = {}, unique_by: nil)
+      def deliver_acidicly(_options = {})
         job_class = ::ActionMailer::MailDeliveryJob
 
         job_args = [@mailer_class.name, @action.to_s, "deliver_now", @params, *@args]
         # for Sidekiq, this depends on the Sidekiq::Serialization extension
         serialized_job = job_class.new(job_args).serialize
         acidic_identifier = job_class.respond_to?(:acidic_identifier) ? job_class.acidic_identifier : :job_id
-        # use either [1] provided uniqueness constraint or [2] computed key
-        key = if unique_by
-                IdempotencyKey.generate(unique_by: unique_by, job_class: job_class.name)
-              else
-                IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
-              end
+        key = IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
 
         AcidicJob::Run.create!(
           staged: true,

data/lib/acidic_job/extensions/active_job.rb

@@ -24,13 +24,7 @@ module AcidicJob
           raise UnsupportedExtension unless defined?(::ActiveJob) && self < ::ActiveJob::Base
 
           serialized_job = serialize_with_arguments(*args, **kwargs)
-          # use either [1] provided uniqueness constraint or [2] computed key
-          key = if kwargs.key?(:unique_by) || kwargs.key?("unique_by")
-                  unique_by = [kwargs[:unique_by], kwargs["unique_by"]].compact.first
-                  IdempotencyKey.generate(unique_by: unique_by, job_class: name)
-                else
-                  IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
-                end
+          key = IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
 
           AcidicJob::Run.create!(
             staged: true,

data/lib/acidic_job/extensions/noticed.rb

@@ -6,12 +6,12 @@ module AcidicJob
       extend ActiveSupport::Concern
 
       class_methods do
-        def deliver_acidicly(recipients, unique_by: nil)
-          new.deliver_acidicly(recipients, unique_by: unique_by)
+        def deliver_acidicly(recipients)
+          new.deliver_acidicly(recipients)
         end
       end
 
-      def deliver_acidicly(recipients, unique_by: nil)
+      def deliver_acidicly(recipients)
         # THIS IS A HACK THAT COPIES AND PASTES KEY PARTS OF THE `Noticed::Base` CODE
         # IN ORDER TO ALLOW US TO TRANSACTIONALLY DELIVER NOTIFICATIONS
         # THIS IS THUS LIABLE TO BREAK WHENEVER THAT GEM IS UPDATED
@@ -37,12 +37,7 @@ module AcidicJob
             }
             serialized_job = job_class.send(:job_or_instantiate, args).serialize
             acidic_identifier = job_class.respond_to?(:acidic_identifier) ? job_class.acidic_identifier : :job_id
-            # use either [1] provided uniqueness constraint or [2] computed key
-            key = if unique_by
-                    IdempotencyKey.generate(unique_by: unique_by, job_class: job_class.name)
-                  else
-                    IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
-                  end
+            key = IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
 
             AcidicJob::Run.create!(
               staged: true,

data/lib/acidic_job/extensions/sidekiq.rb

@@ -34,9 +34,10 @@ module AcidicJob
           end
         end
 
-        def serialize_job(args = [], _kwargs = nil)
+        def serialize_job(*args, **kwargs)
           # `@args` is only set via `deserialize`; it is not a standard Sidekiq thing
           arguments = args || @args
+          arguments += [kwargs] unless kwargs.empty?
           normalized_args = ::Sidekiq.load_json(::Sidekiq.dump_json(arguments))
           item = { "class" => self.class, "args" => normalized_args, "jid" => jid }
           sidekiq_options = sidekiq_options_hash || {}
@@ -58,13 +59,7 @@ module AcidicJob
         class_methods do
           def perform_acidicly(*args, **kwargs)
             serialized_job = serialize_with_arguments(*args, **kwargs)
-            # use either [1] provided uniqueness constraint or [2] computed key
-            key = if kwargs.key?(:unique_by) || kwargs.key?("unique_by")
-                    unique_by = [kwargs[:unique_by], kwargs["unique_by"]].compact.first
-                    IdempotencyKey.generate(unique_by: unique_by, job_class: name)
-                  else
-                    IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
-                  end
+            key = IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
 
             AcidicJob::Run.create!(
               staged: true,

data/lib/acidic_job/idempotency_key.rb

@@ -2,21 +2,22 @@
 
 module AcidicJob
   class IdempotencyKey
-    def self.generate(unique_by:, job_class:)
-      new(:job_args).value_for({ "job_class" => job_class }, Marshal.dump(unique_by))
-    end
-
     def initialize(identifier = :job_id)
       @identifier = identifier
     end
 
     def value_for(hash_or_job, *args, **kwargs)
-      return value_from_job_args(hash_or_job, *args, **kwargs) if @identifier == :job_args
-
-      value = if hash_or_job.is_a?(Hash)
-                value_from_job_id_for_hash(hash_or_job)
+      value = case @identifier
+              when Proc
+                value_from_proc(hash_or_job, *args, **kwargs)
+              when :job_args
+                value_from_job_args(hash_or_job, *args, **kwargs)
               else
-                value_from_job_id_for_obj(hash_or_job)
+                if hash_or_job.is_a?(Hash)
+                  value_from_job_id_for_hash(hash_or_job)
+                else
+                  value_from_job_id_for_obj(hash_or_job)
+                end
               end
 
       value || value_from_job_args(hash_or_job, *args, **kwargs)
@@ -62,5 +63,12 @@ module AcidicJob
 
       Digest::SHA1.hexdigest [worker_class, args, kwargs].flatten.join
     end
+
+    def value_from_proc(_hash_or_job, *args, **kwargs)
+      return if args.empty? && kwargs.empty?
+
+      idempotency_args = Array(@identifier.call(*args, **kwargs))
+      Digest::SHA1.hexdigest idempotency_args.flatten.join
+    end
   end
 end

data/lib/acidic_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  VERSION = "1.0.0.pre11"
+  VERSION = "1.0.0.pre12"
 end

data/lib/acidic_job.rb

@@ -50,6 +50,7 @@ module AcidicJob
     klass.instance_variable_set(:@acidic_identifier, :job_id)
     klass.define_singleton_method(:acidic_by_job_id) { @acidic_identifier = :job_id }
     klass.define_singleton_method(:acidic_by_job_args) { @acidic_identifier = :job_args }
+    klass.define_singleton_method(:acidic_by) { |proc| @acidic_identifier = proc }
   end
 
   included do
@@ -67,6 +68,19 @@ module AcidicJob
     end
   end
 
+  def initialize(*args, **kwargs)
+    # ensure this instance variable is always defined
+    @__acidic_job_steps = []
+    @__acidic_job_args = args
+    @__acidic_job_kwargs = kwargs
+
+    if method(__method__).super_method.arity.zero?
+      super()
+    else
+      super(*args, **kwargs)
+    end
+  end
+
   def with_acidity(providing: {})
     # ensure this instance variable is always defined
     @__acidic_job_steps = []
@@ -107,7 +121,7 @@ module AcidicJob
 
     acidic_identifier = self.class.acidic_identifier
     @__acidic_job_idempotency_key ||= IdempotencyKey.new(acidic_identifier)
-                                                    .value_for(self, @__acidic_job_args, @__acidic_job_kwargs)
+                                                    .value_for(self, *@__acidic_job_args, **@__acidic_job_kwargs)
   end
   # rubocop:enable Naming/MemoizedInstanceVariableName
 
@@ -191,7 +205,7 @@ module AcidicJob
 
     ActiveRecord::Base.transaction(isolation: isolation_level) do
       run = Run.find_by(idempotency_key: idempotency_key)
-      serialized_job = serialize_job(@__acidic_job_args, @__acidic_job_kwargs)
+      serialized_job = serialize_job(*@__acidic_job_args, **@__acidic_job_kwargs)
 
       if run.present?
         # Programs enqueuing multiple jobs with different parameters but the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre11
+  version: 1.0.0.pre12
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -63,6 +63,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby_version"
+- ".tool-versions"
 - Gemfile
 - Gemfile.lock
 - LICENSE