ae_active_job_state 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06a4c9233311e99e2aa3f14bcf7310c36ab0221ed9fe8cd01d0c9b660c9cd6f1
-  data.tar.gz: 4d15d5d24db0a18f773a05695e6139d3acfdbabdbdee91080b218e0eb31d00e1
+  metadata.gz: 438d235a0e744da0dbddf380bb9faeb2b53806b63f86b9a2097821ab3fc7d54a
+  data.tar.gz: 643996efa46db8ac41d16eb23968cee40647ec049fc3a852d2c2387ca7bc1693
 SHA512:
-  metadata.gz: afcf025d29e44a480b902a15e861821b2a93c2f1cb2f266a22783e036cdffa000c24f5f48942bd6b292f051cd7ad605d87e3a1cc3a40079de4f0562444735f9f
-  data.tar.gz: b0258ee0af5d7e4232e6a2e720789c43a8067dd0048d918f97ae031c5b85d11ac2f7af4efb36f6843ae3f2199d6d2b873447f60c8c531ab978a68268448ba0f6
+  metadata.gz: 3e1db6a2606eea617018f21e00294fcc4f04f9389d1ec0d66d303c2922cf2b9db0db254532667c1eae3cdd14b9658366462bc59ef5b79827b87382cc0ed71c3b
+  data.tar.gz: a2d8f37f0b39ec5c2771d30b1bc3260db7dbe7090d3a8818fcc5b04bee4d8d3a92e738cb57ac910e45cee148a8c42150439460a686b0e352ff5f0cfc9216f3ba

data/lib/ae_active_job_state/has_job_state.rb

@@ -13,19 +13,35 @@ module AeActiveJobState
       # `perform_now` would go directly to around_perform
       before_enqueue do |job|
         @job_state = AeActiveJobState::JobState.create!(status: 'pending', active_job_id: job.job_id,
-                                                        args: job.arguments)
+                                                        args: job.arguments, worker_class: job.class)
       end
 
       around_perform do |job, block|
-        @job_state = AeActiveJobState::JobState.find_by(active_job_id: job.job_id) ||
-                     AeActiveJobState::JobState.create!(status: 'pending', active_job_id: job.job_id,
-                                                        args: job.arguments)
-        job_state.run!
+        # This is effectively the same logic as #create_or_find_by!, the main difference is we also fail on
+        # RecordInvalid. This allows us to have additional uniqueness validations in the model and still fall back to
+        # the find_by.
+        #
+        # We do this here to prevent a race condition if the job is processed before the initial job state is created.
+        # This can occur in the case that the job is enqueued in a transaction and a worker picks up the work before the
+        # transaction commits. In this case, this create will now wait on the insertion intention lock on the
+        # active_job_id index created by the insert in before_enqueue, throw a record not unique, then find the correct
+        # state model.
+        #
+        # We continue to handle the case where the state was fully inserted before this callback is hit and the case
+        # where the job was never enqueued.
+        begin
+          @job_state = AeActiveJobState::JobState.create!(status: 'pending', active_job_id: job.job_id,
+                                                          args: job.arguments, worker_class: job.class)
+        rescue ActiveRecord::RecordNotUnique, ActiveRecord::RecordInvalid
+          @job_state = AeActiveJobState::JobState.find_by!(active_job_id: job.job_id)
+        end
+
+        job_state.running!
         job_state.reload
         block.call
-        job_state.finish!
+        job_state.finished!
       rescue StandardError => e
-        @job_state.fail!
+        @job_state.failed!
         raise e
       end
     end

data/lib/ae_active_job_state/job_state.rb

@@ -14,19 +14,16 @@ module AeActiveJobState
       state :finished
       state :failed
 
-      event :run do
-        transitions from: :pending, to: :running
-        after { update!(started_at: Time.now) }
+      event :running do
+        transitions to: :running, after: -> { self.started_at = Time.now }
       end
 
-      event :fail do
-        transitions from: :running, to: :failed
-        after { update!(failed_at: Time.now) }
+      event :failed do
+        transitions to: :failed, after: -> { self.failed_at = Time.now }
       end
 
-      event :finish do
-        transitions from: :running, to: :finished
-        after { update!(finished_at: Time.now) }
+      event :finished do
+        transitions to: :finished, after: -> { self.finished_at = Time.now }
       end
     end
   end

data/lib/ae_active_job_state/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AeActiveJobState
-  VERSION = '0.1.0'
+  VERSION = '1.0.1'
 end

data/lib/generators/ae_active_job_state/templates/add_worker_class_column_to_job_state_table.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddWorkerClassColumnToJobStateTable < ActiveRecord::Migration[6.0]
+  def change
+    change_table :ae_active_job_state_job_states do |t|
+      t.string :worker_class
+    end
+  end
+end

data/lib/generators/ae_active_job_state_generator.rb

@@ -6,8 +6,17 @@ class AeActiveJobStateGenerator < Rails::Generators::Base
   include ActiveRecord::Generators::Migration
 
   source_root File.expand_path('./ae_active_job_state/templates', __dir__)
+  class_option :since_version, default: '0.0.0'
+
+  MIGRATIONS = [
+    %w[0.1.0 create_ae_active_job_state_tables.rb],
+    %w[0.3.0 add_worker_class_column_to_job_state_table.rb]
+  ].freeze
 
   def copy_migrations
-    migration_template 'create_ae_active_job_state_tables.rb', 'db/migrate/create_ae_active_job_state_tables.rb'
+    since_version = Gem::Version.new(options['since_version'])
+    MIGRATIONS.each do |version, file|
+      migration_template file, "db/migrate/#{file}" if Gem::Version.new(version) > since_version
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ae_active_job_state
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - AppFolio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -97,6 +97,7 @@ files:
 - lib/ae_active_job_state/has_job_state.rb
 - lib/ae_active_job_state/job_state.rb
 - lib/ae_active_job_state/version.rb
+- lib/generators/ae_active_job_state/templates/add_worker_class_column_to_job_state_table.rb
 - lib/generators/ae_active_job_state/templates/create_ae_active_job_state_tables.rb
 - lib/generators/ae_active_job_state_generator.rb
 homepage: https://github.com/appfolio/ae_active_job_state
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Store ActiveJob status in ActiveRecord