acidic_job 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed6991438cd55a757d0c3606591dd3e39cf470a2fca7486afea1d9efbb948aa6
-  data.tar.gz: d5f078c2111b538ebc7b16df70b2986fa7e1c958716806ad4778c81817b9d3f4
+  metadata.gz: 82e7abf5e57a4a6b68691e3c6c69ee8a6bbc2eabcedb69a3ef29e91ac0e99e8c
+  data.tar.gz: b73584561b8a558529b2e057e449896dedfff2c21ab859dacf82b070f75c7910
 SHA512:
-  metadata.gz: 24aa6c22959133bd68f3947bd15a742b6b314e7fb174b45fede5b598a85a63f04c2ba95a96e53ad3167fbfa1b9c9dcb981c7d59786be87d36520bab825255605
-  data.tar.gz: 02fad1948a7a17b81c2a6be0e48c271563fc7ce84a8de5ec5b84d3e1bb2ca65dbe6e838c4f4eb3c05eb2497424fe33fb5ea0e2c8e1001861ec75cb0c835a153a
+  metadata.gz: 6e42251e87faff4790ecfba572eca0dd70251fc58a4293b906560b526efa4bc14db00e01ee0e90c43a0d3f3dc355b36b8db3a4be5129529c071711f3a0b2506f
+  data.tar.gz: 167aa9f07dd033a5a3646edcff171a8dffea485d9cbb943c230526214c6d4eaa68761418321cc4e7795a0326361699181bd142377516ceadaa430d286628aea5

data/.rubocop.yml

@@ -12,3 +12,6 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Style/Documentation:
+  Enabled: false

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.1)
+    acidic_job (0.4.0)
       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/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,12 +23,12 @@ 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"
   spec.add_dependency "activerecord", ">= 4.0.0"
+  spec.add_dependency "activesupport"
   spec.add_development_dependency "railties", ">= 4.0"
 
   # For more information and examples about making a new gem, checkout our

data/lib/acidic_job/key.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module AcidicJob
+  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: %i[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
+end

data/lib/acidic_job/staging.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AcidicJob
+  class Staging < ActiveRecord::Base
+    self.table_name = "acidic_job_stagings"
+
+    validates :serialized_params, presence: true
+
+    serialize :serialized_params
+
+    after_create_commit :enqueue_job
+
+    def enqueue_job
+      job = ActiveJob::Base.deserialize(serialized_params)
+      job.enqueue
+      delete
+    end
+  end
+end

data/lib/acidic_job/version.rb

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

data/lib/acidic_job.rb

@@ -4,9 +4,11 @@ require_relative "acidic_job/version"
 require_relative "acidic_job/no_op"
 require_relative "acidic_job/recovery_point"
 require_relative "acidic_job/response"
+require_relative "acidic_job/key"
+require_relative "acidic_job/staging"
 require "active_support/concern"
 
-# rubocop:disable Metrics/ModuleLength, Style/Documentation, Metrics/AbcSize, Metrics/MethodLength
+# rubocop:disable Metrics/ModuleLength, Metrics/AbcSize, Metrics/MethodLength
 module AcidicJob
   class MismatchedIdempotencyKeyAndJobArguments < StandardError; end
 
@@ -18,44 +20,27 @@ module AcidicJob
 
   class SerializedTransactionConflict < StandardError; end
 
-  class Key < ActiveRecord::Base
-    RECOVERY_POINT_FINISHED = "FINISHED"
-
-    self.table_name = "acidic_job_keys"
-
-    serialize :job_args, Hash
-    serialize :error_object
-
-    validates :job_name, presence: true
-    validates :job_args, presence: true
-    validates :idempotency_key, presence: true
-    validates :last_run_at, presence: true
-    validates :recovery_point, presence: true
-
-    def finished?
-      recovery_point == RECOVERY_POINT_FINISHED
-    end
+  extend ActiveSupport::Concern
 
-    def succeeded?
-      finished? && !failed?
-    end
+  module ActiveJobExtension
+    extend ActiveSupport::Concern
 
-    def failed?
-      error_object.present?
+    class_methods do
+      def perform_transactionally(*args)
+        AcidicJob::Staging.create!(
+          serialized_params: job_or_instantiate(*args).serialize
+        )
+      end
     end
   end
 
-  extend ActiveSupport::Concern
-
   included do
     attr_reader :key
 
-    # discard_on MismatchedIdempotencyKeyAndJobArguments
-    # discard_on UnknownRecoveryPoint
-    # discard_on UnknownAtomicPhaseType
-    # discard_on MissingRequiredAttribute
-    # retry_on LockedIdempotencyKey
-    # retry_on ActiveRecord::SerializationFailure
+    # Extend ActiveJob only once it has been loaded
+    ActiveSupport.on_load(:active_job) do
+      send(:include, ActiveJobExtension)
+    end
   end
 
   # Number of seconds passed which we consider a held idempotency key lock to be
@@ -65,7 +50,8 @@ module AcidicJob
   IDEMPOTENCY_KEY_LOCK_TIMEOUT = 90
 
   # &block
-  def idempotently(with:) # &block
+  # &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)
@@ -85,7 +71,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.
-    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?
@@ -143,13 +129,14 @@ 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
+    serialized_job_info = serialize
 
     ActiveRecord::Base.transaction(isolation: isolation_level) do
       @key = Key.find_by(idempotency_key: key_val)
@@ -157,7 +144,7 @@ module AcidicJob
       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.
@@ -171,8 +158,8 @@ module AcidicJob
           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
@@ -207,4 +194,4 @@ module AcidicJob
     end
   end
 end
-# rubocop:enable Metrics/ModuleLength, Style/Documentation, Metrics/AbcSize, Metrics/MethodLength
+# rubocop:enable Metrics/ModuleLength, Metrics/AbcSize, Metrics/MethodLength

data/lib/generators/acidic_job_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/generators"
 require "rails/generators/active_record"
 
@@ -22,16 +24,17 @@ class AcidicJobGenerator < ActiveRecord::Generators::Base
 
   # Copies the migration template to db/migrate.
   def copy_files
-    migration_template "migration.rb",
+    migration_template "migration.rb.erb",
                        "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 → migration.rb.erb}

@@ -3,15 +3,19 @@ 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"
+
+    create_table :acidic_job_stagings do |t|
+      t.text :serialized_params, null: false
     end
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -72,12 +72,14 @@ files:
 - bin/console
 - bin/setup
 - lib/acidic_job.rb
+- lib/acidic_job/key.rb
 - lib/acidic_job/no_op.rb
 - lib/acidic_job/recovery_point.rb
 - lib/acidic_job/response.rb
+- lib/acidic_job/staging.rb
 - lib/acidic_job/version.rb
 - lib/generators/acidic_job_generator.rb
-- lib/generators/templates/migration.rb
+- lib/generators/templates/migration.rb.erb
 homepage: https://github.com/fractaledmind/acidic_job
 licenses:
 - MIT