acidic_job 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b6e76d892b0953452781a38155801969acf50d81897fb78645b561280620ddc
-  data.tar.gz: 6640c17792135307d21d20f05b49136512368ff84ed748fb2b1ad98d552fc8fb
+  metadata.gz: 739d9a393b9dfcf91c6e941e188cab965a2800cf7a729e70a5d30542c76b1237
+  data.tar.gz: 6fb81e32e31e6db7001a11d607f33d3bc7f1cb5ddc147d48f8ead84ae15fc7d1
 SHA512:
-  metadata.gz: c489d047845c6fcd27482dfe1a3c0cae89a326cd3c81d4816ca9758c7db9e0edd09d954e719eedcc0d8b2a689137e21486482571bd05b7518af795152fc4bc61
-  data.tar.gz: ddc07f0514be3ad3f8fdec4ffd4bf350a039a4ad95f6b28984f1cb73f29d51ed3511df94eb628f8f336b81d4edae3d9b1c9af3a8b55ab5ac08efc015775c9249
+  metadata.gz: bc2d1796950ffb4640d49dc61e05771b2a72f6b6776d96dda4fa35f93720e0687102e08bc8ad39a176d44be828528048df03c4492cbd0b1d121865ef929e5b8f
+  data.tar.gz: 32db6d94ca8a8a70d48a7afa863f85f50ebdf05320c9461b1f8c647d4681e697d7d5bc814864fb8846b516482db7057e8659598387f661e43764115f1525e840

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acidic_job (0.5.2)
+    acidic_job (0.6.0)
       activerecord (>= 4.0.0)
       activesupport
 

data/bin/console

@@ -3,7 +3,8 @@
 
 require "bundler/setup"
 require "acidic_job"
-require_relative "../test/setup"
+require_relative "../test/support/setup"
+require_relative "../test/support/ride_create_job"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/acidic_job/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AcidicJob
   class Error < StandardError; end
 

data/lib/acidic_job/key.rb

@@ -10,6 +10,7 @@ module AcidicJob
 
     serialize :error_object
     serialize :job_args
+    store :attr_accessors
 
     validates :idempotency_key, presence: true, uniqueness: { scope: %i[job_name job_args] }
     validates :job_name, presence: true

data/lib/acidic_job/perform_transactionally_extension.rb

@@ -7,25 +7,27 @@ module AcidicJob
     extend ActiveSupport::Concern
 
     class_methods do
+      # rubocop:disable Metrics/MethodLength
       def perform_transactionally(*args)
-        attributes = if self < ActiveJob::Base
-          {
-            adapter: "activejob",
-            job_name: self.name,
-            job_args: job_or_instantiate(*args).serialize
-          }
-        elsif self.include? Sidekiq::Worker
-          {
-            adapter: "sidekiq",
-            job_name: self.name,
-            job_args: args
-          }
-        else
-          raise UnknownJobAdapter
-        end
+        attributes = if defined?(ActiveJob) && self < ActiveJob::Base
+                       {
+                         adapter: "activejob",
+                         job_name: name,
+                         job_args: job_or_instantiate(*args).serialize
+                       }
+                     elsif defined?(Sidekiq) && include?(Sidekiq::Worker)
+                       {
+                         adapter: "sidekiq",
+                         job_name: name,
+                         job_args: args
+                       }
+                     else
+                       raise UnknownJobAdapter
+                     end
 
         AcidicJob::Staged.create!(attributes)
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/acidic_job/perform_wrapper.rb

@@ -6,14 +6,14 @@ module AcidicJob
       # store arguments passed into `perform` so that we can later persist
       # them to `AcidicJob::Key#job_args` for both ActiveJob and Sidekiq::Worker
       @arguments_for_perform = if args.any? && kwargs.any?
-        args + [kwargs]
-      elsif args.any? && kwargs.none?
-        args
-      elsif args.none? && kwargs.any?
-        [kwargs]
-      else
-        []
-      end
+                                 args + [kwargs]
+                               elsif args.any? && kwargs.none?
+                                 args
+                               elsif args.none? && kwargs.any?
+                                 [kwargs]
+                               else
+                                 []
+                               end
 
       super
     end

data/lib/acidic_job/staged.rb

@@ -15,10 +15,11 @@ module AcidicJob
     after_create_commit :enqueue_job
 
     def enqueue_job
-      if adapter == "activejob"
+      case adapter
+      when "activejob"
         job = ActiveJob::Base.deserialize(job_args)
         job.enqueue
-      elsif adapter == "sidekiq"
+      when "sidekiq"
         Sidekiq::Client.push("class" => job_name, "args" => job_args)
       else
         raise UnknownJobAdapter.new(adapter: adapter)

data/lib/acidic_job/version.rb

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

data/lib/acidic_job.rb

@@ -33,6 +33,7 @@ module AcidicJob
   class_methods do
     def inherited(subclass)
       AcidicJob.wire_everything_up(subclass)
+      super
     end
   end
 
@@ -44,10 +45,6 @@ module AcidicJob
 
   # takes a block
   def idempotently(with:)
-    # set accessors for each argument passed in to ensure they are available
-    # to the step methods the job will have written
-    define_accessors_for_passed_arguments(with)
-
     # execute the block to gather the info on what phases are defined for this job
     defined_steps = yield
     # [:create_ride_and_audit_record, :create_stripe_charge, :send_receipt]
@@ -68,6 +65,11 @@ module AcidicJob
     # if the key record is already marked as finished, immediately return its result
     return @key.succeeded? if @key.finished?
 
+    # set accessors for each argument passed in to ensure they are available
+    # to the step methods the job will have written
+    # THIS HAPPENS OUTSIDE OF ANY TRANSACTION
+    define_accessors_for_passed_arguments(with, @key)
+
     # otherwise, we will enter a loop to process each required step of the job
     phases.size.times do
       # our `phases` hash uses Symbols for keys
@@ -115,16 +117,16 @@ module AcidicJob
       rescued_error = e
       raise e
     ensure
-      return unless rescued_error
-
-      # If we're leaving under an error condition, try to unlock the idempotency
-      # key right away so that another request can try again.3
-      begin
-        key.update_columns(locked_at: nil, error_object: rescued_error)
-      rescue StandardError => e
-        # We're already inside an error condition, so swallow any additional
-        # errors from here and just send them to logs.
-        puts "Failed to unlock key #{key.id} because of #{e}."
+      if rescued_error
+        # If we're leaving under an error condition, try to unlock the idempotency
+        # key right away so that another request can try again.3
+        begin
+          key.update_columns(locked_at: nil, error_object: rescued_error)
+        rescue StandardError => e
+          # We're already inside an error condition, so swallow any additional
+          # errors from here and just send them to logs.
+          puts "Failed to unlock key #{key.id} because of #{e}."
+        end
       end
     end
   end
@@ -140,18 +142,14 @@ module AcidicJob
     ActiveRecord::Base.transaction(isolation: isolation_level) do
       @key = Key.find_by(idempotency_key: key_val)
 
-      if @key
+      if @key.present?
         # Programs enqueuing multiple jobs with different parameters but the
         # same idempotency key is a bug.
-        if @key.job_args != @arguments_for_perform
-          raise MismatchedIdempotencyKeyAndJobArguments
-        end
+        raise MismatchedIdempotencyKeyAndJobArguments if @key.job_args != @arguments_for_perform
 
         # Only acquire a lock if the key is unlocked or its lock has expired
         # because the original job was long enough ago.
-        if @key.locked_at && @key.locked_at > Time.current - IDEMPOTENCY_KEY_LOCK_TIMEOUT
-          raise LockedIdempotencyKey
-        end
+        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?
@@ -168,12 +166,27 @@ module AcidicJob
     end
   end
 
-  def define_accessors_for_passed_arguments(passed_arguments)
-    passed_arguments.each do |accessor, value|
+  def define_accessors_for_passed_arguments(passed_arguments, key)
+    # first, get the current state of all accessors for both previously persisted and initialized values
+    current_accessors = passed_arguments.stringify_keys.merge(key.attr_accessors)
+
+    # next, ensure that `Key#attr_accessors` is populated with initial values
+    key.update_column(:attr_accessors, current_accessors)
+
+    current_accessors.each do |accessor, value|
       # the reader method may already be defined
       self.class.attr_reader accessor unless respond_to?(accessor)
       # but we should always update the value to match the current value
       instance_variable_set("@#{accessor}", value)
+      # and we overwrite the setter to ensure any updates to an accessor update the `Key` stored value
+      # Note: we must define the singleton method on the instance to avoid overwriting setters on other
+      # instances of the same class
+      define_singleton_method("#{accessor}=") do |current_value|
+        instance_variable_set("@#{accessor}", current_value)
+        key.attr_accessors[accessor] = current_value
+        key.save!(validate: false)
+        current_value
+      end
     end
 
     true
@@ -185,9 +198,11 @@ module AcidicJob
     {}.tap do |phases|
       defined_steps.each_cons(2).map do |enter_method, exit_method|
         phases[enter_method] = lambda do
-          method(enter_method).call
+          result = method(enter_method).call
 
-          if exit_method.to_s == Key::RECOVERY_POINT_FINISHED
+          if result.is_a?(Response)
+            result
+          elsif exit_method.to_s == Key::RECOVERY_POINT_FINISHED
             Response.new
           else
             RecoveryPoint.new(exit_method)
@@ -201,8 +216,7 @@ module AcidicJob
     return job_id if defined?(job_id) && !job_id.nil?
     return jid if defined?(jid) && !jid.nil?
 
-    require 'securerandom'
-    SecureRandom.hex
+    Digest::SHA1.hexdigest [self.class.name, arguments_for_perform].flatten.join
   end
 end
 # rubocop:enable Metrics/ModuleLength, Metrics/AbcSize, Metrics/MethodLength

data/lib/generators/templates/create_acidic_job_keys_migration.rb.erb

@@ -8,6 +8,7 @@ class CreateAcidicJobKeys < <%= migration_class %>
       t.datetime :locked_at, null: true
       t.string :recovery_point, null: false
       t.text :error_object
+      t.text :attr_accessors
       t.timestamps
 
       t.index %i[idempotency_key job_name job_args],

data/lib/generators/templates/create_staged_acidic_jobs_migration.rb.erb

@@ -4,6 +4,7 @@ class CreateStagedAcidicJobs < <%= migration_class %>
       t.string :adapter, null: false
       t.string :job_name, null: false
       t.text :job_args, null: true
+      t.timestamps
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord