acidic_job 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcdd5a6f2496a5764d0d0b07f1263653a299d2dd2594ac051393278466f59bd2
-  data.tar.gz: 25de84d0345eb47d2c1866b0f7e6824278214aeac1e212adad3504d9682c70a8
+  metadata.gz: 8aa8aee9c23bc58be992813f139864afdb057442ee9c359263f3ff45029e3f28
+  data.tar.gz: 9dbb8017fcbf91ce5cbcc5c96968e3b880340c1e1cc7a8c36cb11e744d6b405d
 SHA512:
-  metadata.gz: 64ddc179ec70f82ebce87438daad5d50a199daee773fd453f7dff27b21c26af5f7a35fe96f7167405b5a24eb275af6e9519cbe53018194ad9388ae0e2c276412
-  data.tar.gz: a960d42269f80fedcd3c913ce7398a8c456759c07c58710533476f3648e38acde98921bdc93a4d26be8fa4405852d20ffbd0685802c114d87e5b9a6650941f59
+  metadata.gz: 4bb2298f924a2aa2d5db31c7c05201188872333c36dd3e0bafb598ed087ec9a686695c27b1cdd2d33f067f2bbb47178c5bc700201406db856392997ef6605dbc
+  data.tar.gz: f842586dc2d669196ce58bcbc279bc2b967fd0c8973d296323622c993e8d08422ce65f55b85cf96407aa4a668af15dea005fdf3f8917e520ca020c2851dd4bfa

data/Gemfile

@@ -24,3 +24,5 @@ gem "sqlite3"
 gem "database_cleaner"
 
 gem "simplecov"
+
+gem "pry"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acidic_job (0.2.0)
+    acidic_job (0.3.1)
       activerecord (>= 4.0.0)
       activesupport
 
@@ -37,6 +37,7 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.2)
     builder (3.2.4)
+    coderay (1.1.3)
     concurrent-ruby (1.1.9)
     crass (1.0.6)
     database_cleaner (2.0.1)
@@ -65,6 +66,9 @@ GEM
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
@@ -123,6 +127,7 @@ DEPENDENCIES
   activerecord (~> 6.1.3.2)
   database_cleaner
   minitest (~> 5.0)
+  pry
   railties (>= 4.0)
   rake (~> 13.0)
   rubocop (~> 1.7)

data/README.md

@@ -33,9 +33,9 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Or simply execute to install the gem yourself:
 
-    $ gem install acidic_job
+    $ bundle add acidic_job
 
 Then, use the following command to copy over the AcidicJobKey migration.
 

data/acidic_job.gemspec

@@ -3,15 +3,15 @@
 require_relative "lib/acidic_job/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "acidic_job"
-  spec.version       = AcidicJob::VERSION
-  spec.authors       = ["fractaledmind"]
-  spec.email         = ["stephen.margheim@gmail.com"]
+  spec.name = "acidic_job"
+  spec.version = AcidicJob::VERSION
+  spec.authors = ["fractaledmind"]
+  spec.email = ["stephen.margheim@gmail.com"]
 
-  spec.summary       = "Idempotent operations for Rails apps, built on top of ActiveJob."
-  spec.description   = "Idempotent operations for Rails apps, built on top of ActiveJob."
-  spec.homepage      = "https://github.com/fractaledmind/acidic_job"
-  spec.license       = "MIT"
+  spec.summary = "Idempotent operations for Rails apps, built on top of ActiveJob."
+  spec.description = "Idempotent operations for Rails apps, built on top of ActiveJob."
+  spec.homepage = "https://github.com/fractaledmind/acidic_job"
+  spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"

data/lib/acidic_job/response.rb

@@ -8,7 +8,7 @@ module AcidicJob
     def call(key:)
       key.update!(
         locked_at: nil,
-        recovery_point: AcidicJobKey::RECOVERY_POINT_FINISHED
+        recovery_point: Key::RECOVERY_POINT_FINISHED
       )
     end
   end

data/lib/acidic_job/version.rb

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

data/lib/acidic_job.rb

@@ -18,6 +18,32 @@ module AcidicJob
 
   class SerializedTransactionConflict < StandardError; end
 
+  class Key < ActiveRecord::Base
+    RECOVERY_POINT_FINISHED = "FINISHED"
+
+    self.table_name = "acidic_job_keys"
+
+    serialize :error_object
+    serialize :job_args
+
+    validates :idempotency_key, presence: true, uniqueness: {scope: [:job_name, :job_args]}
+    validates :job_name, presence: true
+    validates :last_run_at, presence: true
+    validates :recovery_point, presence: true
+
+    def finished?
+      recovery_point == RECOVERY_POINT_FINISHED
+    end
+
+    def succeeded?
+      finished? && !failed?
+    end
+
+    def failed?
+      error_object.present?
+    end
+  end
+
   extend ActiveSupport::Concern
 
   included do
@@ -51,14 +77,14 @@ module AcidicJob
     phases = define_atomic_phases(defined_steps)
     # { create_ride_and_audit_record: <#Method >, ... }
 
-    # find or create an AcidicJobKey record (our idempotency key) to store all information about this job
+    # find or create an Key record (our idempotency key) to store all information about this job
     # side-effect: will set the @key instance variable
     #
     # A key concept here is that if two requests try to insert or update within
     # 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.
-    ensure_idempotency_key_record(job_id, with, defined_steps.first)
+    ensure_idempotency_key_record(job_id, defined_steps.first)
 
     # if the key record is already marked as finished, immediately return its result
     return @key.succeeded? if @key.finished?
@@ -69,7 +95,7 @@ module AcidicJob
       recovery_point = @key.recovery_point.to_sym
 
       case recovery_point
-      when AcidicJobKey::RECOVERY_POINT_FINISHED.to_sym
+      when Key::RECOVERY_POINT_FINISHED.to_sym
         break
       else
         raise UnknownRecoveryPoint unless phases.key? recovery_point
@@ -100,7 +126,7 @@ module AcidicJob
 
         phase_result.call(key: key)
       end
-    rescue StandardError => e
+    rescue => e
       error = e
       raise e
     ensure
@@ -108,7 +134,7 @@ module AcidicJob
       # key right away so that another request can try again.
       begin
         key.update_columns(locked_at: nil, error_object: error) if error.present?
-      rescue StandardError => e
+      rescue => 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}."
@@ -116,21 +142,22 @@ module AcidicJob
     end
   end
 
-  def ensure_idempotency_key_record(key_val, job_args, first_step)
+  def ensure_idempotency_key_record(key_val, first_step)
     isolation_level = case ActiveRecord::Base.connection.adapter_name.downcase.to_sym
                       when :sqlite
                         :read_uncommitted
                       else
                         :serializable
-                      end
+    end
+    serialized_job_info = serialize
 
     ActiveRecord::Base.transaction(isolation: isolation_level) do
-      @key = AcidicJobKey.find_by(idempotency_key: key_val)
+      @key = Key.find_by(idempotency_key: key_val)
 
       if @key
         # Programs enqueuing multiple jobs with different parameters but the
         # same idempotency key is a bug.
-        raise MismatchedIdempotencyKeyAndJobArguments if @key.job_args != job_args.as_json
+        raise MismatchedIdempotencyKeyAndJobArguments if @key.job_args != serialized_job_info["arguments"]
 
         # Only acquire a lock if the key is unlocked or its lock has expired
         # because the original job was long enough ago.
@@ -139,13 +166,13 @@ module AcidicJob
         # 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?
       else
-        @key = AcidicJobKey.create!(
+        @key = Key.create!(
           idempotency_key: key_val,
           locked_at: Time.current,
           last_run_at: Time.current,
           recovery_point: first_step,
-          job_name: self.class.name,
-          job_args: job_args.as_json
+          job_name: serialized_job_info["job_class"],
+          job_args: serialized_job_info["arguments"]
         )
       end
     end
@@ -163,14 +190,14 @@ module AcidicJob
   end
 
   def define_atomic_phases(defined_steps)
-    defined_steps << AcidicJobKey::RECOVERY_POINT_FINISHED
+    defined_steps << Key::RECOVERY_POINT_FINISHED
 
     {}.tap do |phases|
       defined_steps.each_cons(2).map do |enter_method, exit_method|
         phases[enter_method] = lambda do
           method(enter_method).call
 
-          if exit_method.to_s == AcidicJobKey::RECOVERY_POINT_FINISHED
+          if exit_method.to_s == Key::RECOVERY_POINT_FINISHED
             Response.new
           else
             RecoveryPoint.new(exit_method)

data/lib/generators/acidic_job_generator.rb

@@ -23,15 +23,16 @@ class AcidicJobGenerator < ActiveRecord::Generators::Base
   # Copies the migration template to db/migrate.
   def copy_files
     migration_template "migration.rb",
-                       "db/migrate/create_acidid_job_keys.rb"
+      "db/migrate/create_acidic_job_keys.rb"
   end
 
   protected
-    def migration_class
-      if ActiveRecord::VERSION::MAJOR >= 5
-        ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
-      else
-        ActiveRecord::Migration
-      end
+
+  def migration_class
+    if ActiveRecord::VERSION::MAJOR >= 5
+      ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"]
+    else
+      ActiveRecord::Migration
     end
+  end
 end

data/lib/generators/templates/migration.rb

@@ -3,15 +3,16 @@ class CreateAcidicJobKeys < <%= migration_class %>
     create_table :acidic_job_keys do |t|
       t.string :idempotency_key, null: false
       t.string :job_name, null: false
-      t.text :job_args, null: false
+      t.text :job_args, null: true
       t.datetime :last_run_at, null: false, default: -> { "CURRENT_TIMESTAMP" }
       t.datetime :locked_at, null: true
       t.string :recovery_point, null: false
       t.text :error_object
       t.timestamps
 
-      t.index %i[idempotency_key job_name job_args], unique: true,
-                                                     name: "idx_acidic_job_keys_on_idempotency_key_n_job_name_n_job_args"
+      t.index %i[idempotency_key job_name job_args],
+        unique: true,
+        name: "idx_acidic_job_keys_on_idempotency_key_n_job_name_n_job_args"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport