acidic_job 0.7.0 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6f61f9992e6528f4e7c1b6a5b774cd1fa1557b4f069fbd14b5e415298dbde15
-  data.tar.gz: 46e279aca2bdc5e2379b496374334f0687dff92c845c2c4725d7e7fa7b96b571
+  metadata.gz: 818fce6f9fefae6d2c56930eedcc683f0332f72acbc0ec9b181b1b0855addddb
+  data.tar.gz: 162262b51ac591fee5910b59cda3ebaeb045580e3390f889a37be35212a2a5aa
 SHA512:
-  metadata.gz: 8042feab92bccc37ad4006145c7c1c780da1eb94cf24f11dfc6808ce95edc18c986ca2424c4aa9c468444267da21ff103089ad0a7e9577a7e6f3e32d097daba7
-  data.tar.gz: fc7ea7a48fc6560c3984538d9c8d2dd681492f22bd60bd4104d4db39a1bed53b950a386384f4db43caf22bc72ab0c3c9b39c7e36eb4232f646ee6e1ef7885430
+  metadata.gz: be6dfa507ce2e6cb2e4bb00ae0b57fe7e227d9347ef4a64204c79c52c5b57ec66ec347e37113066b0c4583ddb9c1045fddf3fbf3eacd07942afc528451fa4cd7
+  data.tar.gz: 2c28797e665ce91181a11d20c5cf1183c2cc585cbe5602c5b8dcc870f0403d49c59232d9662b8fcc96926a0082baeea3251bbcb9ac086d6085fffd8d1ad74685

data/.github/workflows/main.yml

@@ -13,6 +13,6 @@ jobs:
         ruby-version: 2.7.1
     - name: Run the default task
       run: |
-        gem install bundler -v 2.2.5
+        gem install bundler -v 2.2.31
         bundle install
         bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acidic_job (0.7.0)
+    acidic_job (0.7.4)
       activerecord (>= 4.0.0)
       activesupport
 
@@ -62,8 +62,6 @@ GEM
     nokogiri (1.12.3)
       mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
-    nokogiri (1.12.3-x86_64-darwin)
-      racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
@@ -144,4 +142,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.5
+   2.2.31

data/README.md

@@ -57,14 +57,14 @@ It provides a suite of functionality that empowers you to create complex, robust
 
 ### Transactional Steps
 
-The first and foundational feature `acidic_job` provides is the `idempotently` method, which takes a block of transactional step methods (defined via the `step`) method:
+The first and foundational feature `acidic_job` provides is the `with_acidity` method, which takes a block of transactional step methods (defined via the `step`) method:
 
 ```ruby
 class RideCreateJob < ActiveJob::Base
   include AcidicJob
 
   def perform(ride_params)
-    idempotently with: { user: current_user, params: ride_params, ride: nil } do
+    with_acidity given: { user: current_user, params: ride_params, ride: nil } do
       step :create_ride_and_audit_record
       step :create_stripe_charge
       step :send_receipt
@@ -85,20 +85,20 @@ class RideCreateJob < ActiveJob::Base
 end
 ```
 
-`idempotently` takes only the `with:` named parameter and a block where you define the steps of this operation. `step` simply takes the name of a method available in the job. That's all!
+`with_acidity` takes only the `given:` named parameter and a block where you define the steps of this operation. `step` simply takes the name of a method available in the job. That's all!
 
 Now, each execution of this job will find or create an `AcidicJob::Key` record, which we leverage to wrap every step in a database transaction. Moreover, this database record allows `acidic_job` to ensure that if your job fails on step 3, when it retries, it will simply jump right back to trying to execute the method defined for the 3rd step, and won't even execute the first two step methods. This means your step methods only need to be idempotent on failure, not on success, since they will never be run again if they succeed.
 
 ### Persisted Attributes
 
-Any objects passed to the `with` option on the `idempotently` method are not just made available to each of your step methods, they are made available across retries. This means that you can set an attribute in step 1, access it in step 2, have step 2 fail, have the job retry, jump directly back to step 2 on retry, and have that object still accessible. This is done by serializing all objects to a field on the `AcidicJob::Key` and manually providing getters and setters that sync with the database record.
+Any objects passed to the `given` option on the `with_acidity` method are not just made available to each of your step methods, they are made available across retries. This means that you can set an attribute in step 1, access it in step 2, have step 2 fail, have the job retry, jump directly back to step 2 on retry, and have that object still accessible. This is done by serializing all objects to a field on the `AcidicJob::Key` and manually providing getters and setters that sync with the database record.
 
 ```ruby
 class RideCreateJob < ActiveJob::Base
   include AcidicJob
 
   def perform(ride_params)
-    idempotently with: { ride: nil } do
+    with_acidity given: { ride: nil } do
       step :create_ride_and_audit_record
       step :create_stripe_charge
       step :send_receipt
@@ -132,7 +132,7 @@ class RideCreateJob < ActiveJob::Base
   include AcidicJob
 
   def perform(ride_params)
-    idempotently with: { user: current_user, params: ride_params, ride: nil } do
+    with_acidity given: { user: current_user, params: ride_params, ride: nil } do
       step :create_ride_and_audit_record
       step :create_stripe_charge
       step :send_receipt
@@ -157,6 +157,8 @@ This allows `acidic_job` to use an `after_perform` callback to delete the `Acidi
 
 One final feature for those of you using Sidekiq Pro: an integrated DSL for Sidekiq Batches. By simply adding the `awaits` option to your step declarations, you can attach any number of additional, asynchronous workers to your step. This is profoundly powerful, as it means that you can define a workflow where step 2 is started _if and only if_ step 1 succeeds, but step 1 can have 3 different workers enqueued on 3 different queues, each running in parallel. Once all 3 workers succeed, `acidic_job` will move on to step 2. That's right, by leveraging the power of Sidekiq Batches, you can have workers that are executed in parallel, on separate queues, and asynchronously, but are still blocking—as a group—the next step in your workflow! This unlocks incredible power and flexibility for defining and structuring complex workflows and operations, and in my mind is the number one selling point for Sidekiq Pro.
 
+In my opinion, any commercial software using Sidekiq should get Sidekiq Pro; it is _absolutely_ worth the money. If, however, you are using `acidic_job` in a non-commercial application, you could use the open-source dropin replacement for this functionality: https://github.com/breamware/sidekiq-batch
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/acidic_job/deliver_transactionally_extension.rb

@@ -2,7 +2,8 @@
 
 module AcidicJob
   module DeliverTransactionallyExtension
-    def deliver_transactionally(options = {})
+    # rubocop:disable Metrics/MethodLength
+    def deliver_transactionally(_options = {})
       job = delivery_job_class
 
       attributes = {
@@ -11,14 +12,15 @@ module AcidicJob
       }
 
       job_args = if job <= ActionMailer::Parameterized::MailDeliveryJob
-        [@mailer_class.name, @action.to_s, "deliver_now", {params: @params, args: @args}]
-      else
-        [@mailer_class.name, @action.to_s, "deliver_now", @params, *@args]
-      end
+                   [@mailer_class.name, @action.to_s, "deliver_now", { params: @params, args: @args }]
+                 else
+                   [@mailer_class.name, @action.to_s, "deliver_now", @params, *@args]
+                 end
 
       attributes[:job_args] = job.new(job_args).serialize
 
       AcidicJob::Staged.create!(attributes)
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/acidic_job/errors.rb

@@ -16,4 +16,10 @@ module AcidicJob
   class UnknownJobAdapter < Error; end
 
   class NoDefinedSteps < Error; end
+
+  class SidekiqBatchRequired < Error; end
+
+  class TooManyParametersForStepMethod < Error; end
+
+  class TooManyParametersForParallelJob < Error; end
 end

data/lib/acidic_job/perform_wrapper.rb

@@ -18,7 +18,6 @@ module AcidicJob
 
     private
 
-    # rubocop:disable Metrics/AbcSize
     def set_arguments_for_perform(*args, **kwargs)
       # store arguments passed into `perform` so that we can later persist
       # them to `AcidicJob::Key#job_args` for both ActiveJob and Sidekiq::Worker
@@ -32,6 +31,5 @@ module AcidicJob
                                  []
                                end
     end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/acidic_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  VERSION = "0.7.0"
+  VERSION = "0.7.4"
 end

data/lib/acidic_job.rb

@@ -9,6 +9,7 @@ require_relative "acidic_job/key"
 require_relative "acidic_job/staged"
 require_relative "acidic_job/perform_wrapper"
 require_relative "acidic_job/perform_transactionally_extension"
+require_relative "acidic_job/deliver_transactionally_extension"
 require_relative "acidic_job/sidekiq_callbacks"
 require "active_support/concern"
 
@@ -24,9 +25,7 @@ module AcidicJob
     # Extend ActiveJob with `perform_transactionally` class method
     klass.include PerformTransactionallyExtension
 
-    if defined?(ActionMailer)
-      ActionMailer::Parameterized::MessageDelivery.include DeliverTransactionallyExtension
-    end
+    ActionMailer::Parameterized::MessageDelivery.include DeliverTransactionallyExtension if defined?(ActionMailer)
 
     # Ensure our `perform` method always runs first to gather parameters
     klass.prepend PerformWrapper
@@ -62,7 +61,7 @@ module AcidicJob
   IDEMPOTENCY_KEY_LOCK_TIMEOUT = 90
 
   # takes a block
-  def idempotently(with:)
+  def with_acidity(given:)
     # execute the block to gather the info on what steps are defined for this job workflow
     steps = yield || []
 
@@ -77,7 +76,7 @@ module AcidicJob
     # close proximity, one of the two will be aborted by Postgres because we're
     # using a transaction with SERIALIZABLE isolation level. It may not look
     # it, but this code is safe from races.
-    key = ensure_idempotency_key_record(idempotency_key_value, workflow, with)
+    key = ensure_idempotency_key_record(idempotency_key_value, workflow, given)
 
     # begin the workflow
     process_key(key)
@@ -94,7 +93,7 @@ module AcidicJob
       recovery_point = @key.recovery_point.to_s
       current_step = @key.workflow[recovery_point]
 
-      if recovery_point == Key::RECOVERY_POINT_FINISHED.to_s
+      if recovery_point == Key::RECOVERY_POINT_FINISHED.to_s # rubocop:disable Style/GuardClause
         break
       elsif current_step.nil?
         raise UnknownRecoveryPoint, "Defined workflow does not reference this step: #{recovery_point}"
@@ -181,7 +180,7 @@ module AcidicJob
         raise LockedIdempotencyKey if key.locked_at && key.locked_at > Time.current - IDEMPOTENCY_KEY_LOCK_TIMEOUT
 
         # Lock the key and update latest run unless the job is already finished.
-        key.update!(last_run_at: Time.current, locked_at: Time.current) unless key.finished?
+        key.update!(last_run_at: Time.current, locked_at: Time.current, workflow: workflow) unless key.finished?
       else
         key = Key.create!(
           idempotency_key: key_val,
@@ -277,8 +276,7 @@ module AcidicJob
                elsif callable.arity == 1
                  callable.call(key)
                else
-                 # TODO
-                 raise
+                 raise TooManyParametersForStepMethod
                end
 
       if result.is_a?(Response)
@@ -295,7 +293,7 @@ module AcidicJob
   def enqueue_step_parallel_jobs(jobs)
     # TODO: GIVE PROPER ERROR
     # `batch` is available from Sidekiq::Pro
-    raise unless defined?(Sidekiq::Batch)
+    raise SidekiqBatchRequired unless defined?(Sidekiq::Batch)
 
     batch.jobs do
       step_batch = Sidekiq::Batch.new
@@ -317,7 +315,7 @@ module AcidicJob
           elsif worker.instance_method(:perform).arity == 1
             worker.perform_async(key.id)
           else
-            raise
+            raise TooManyParametersForParallelJob
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.4
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Idempotent operations for Rails apps, built on top of ActiveJob.