acidic_job 1.0.0.pre28 → 1.0.0.rc1

metadata

@@ -1,115 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre28
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2024-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: activejob
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: combustion
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '7.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: net-smtp
+  name: chaotic_job
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: noticed
+  name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,21 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: psych
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: railties
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -206,20 +164,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -248,20 +192,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: warning
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Idempotent operations for Rails apps, built on top of ActiveJob.
 email:
 - stephen.margheim@gmail.com
@@ -269,48 +199,48 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".ruby_version"
-- ".tool-versions"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- TODO
 - UPGRADE_GUIDE.md
 - acidic_job.gemspec
+- app/models/acidic_job/entry.rb
+- app/models/acidic_job/execution.rb
+- app/models/acidic_job/record.rb
+- app/models/acidic_job/value.rb
 - bin/console
 - bin/setup
+- bin/test_all
 - blog_post.md
 - combustion/log/test.log
-- gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.1.gemfile
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
 - lib/acidic_job.rb
-- lib/acidic_job/awaiting.rb
+- lib/acidic_job/arguments.rb
+- lib/acidic_job/builder.rb
+- lib/acidic_job/context.rb
+- lib/acidic_job/engine.rb
 - lib/acidic_job/errors.rb
-- lib/acidic_job/extensions/action_mailer.rb
-- lib/acidic_job/extensions/active_job.rb
-- lib/acidic_job/extensions/noticed.rb
-- lib/acidic_job/extensions/sidekiq.rb
-- lib/acidic_job/finished_point.rb
-- lib/acidic_job/idempotency_key.rb
-- lib/acidic_job/perform_wrapper.rb
-- lib/acidic_job/recovery_point.rb
-- lib/acidic_job/rspec_configuration.rb
-- lib/acidic_job/run.rb
-- lib/acidic_job/serializer.rb
-- lib/acidic_job/staging.rb
-- lib/acidic_job/step.rb
-- lib/acidic_job/test_case.rb
+- lib/acidic_job/log_subscriber.rb
+- lib/acidic_job/serializers/exception_serializer.rb
+- lib/acidic_job/serializers/job_serializer.rb
+- lib/acidic_job/serializers/new_record_serializer.rb
+- lib/acidic_job/serializers/range_serializer.rb
 - lib/acidic_job/testing.rb
-- lib/acidic_job/upgrade_service.rb
 - lib/acidic_job/version.rb
-- lib/generators/acidic_job/drop_tables_generator.rb
+- lib/acidic_job/workflow.rb
 - lib/generators/acidic_job/install_generator.rb
-- lib/generators/acidic_job/templates/create_acidic_job_runs_migration.rb.erb
-- lib/generators/acidic_job/templates/drop_acidic_job_keys_migration.rb.erb
+- lib/generators/acidic_job/templates/create_acidic_job_tables_migration.rb.erb
 homepage: https://github.com/fractaledmind/acidic_job
 licenses:
 - MIT
@@ -330,11 +260,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Idempotent operations for Rails apps, built on top of ActiveJob.

data/.ruby_version

@@ -1 +0,0 @@
-2.7.1

data/.tool-versions

@@ -1 +0,0 @@
-ruby 3.1.1

data/gemfiles/rails_6.1.gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "activemodel", "~> 6.1.0"
-gem "railties", "~> 6.1.0"
-
-gemspec path: "../"

data/lib/acidic_job/awaiting.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-
-module AcidicJob
-  module Awaiting
-    extend ActiveSupport::Concern
-
-    private
-
-    def was_awaited_job?
-      (acidic_job_run.present? && acidic_job_run.awaited_by.present?) ||
-        (staged_job_run.present? && staged_job_run.awaited_by.present?)
-    end
-
-    def reenqueue_awaited_by_job
-      run = staged_job_run&.awaited_by || acidic_job_run&.awaited_by
-
-      return unless run
-      return if run.batched_runs.outstanding.any?
-
-      current_step = run.workflow[run.recovery_point.to_s]
-      step_result = run.returning_to
-
-      job = run.job_class.constantize.deserialize(run.serialized_job)
-      # this needs to be explicitly set so that `was_workflow_job?` appropriately returns `true`
-      # which is what the `after_finish :reenqueue_awaited_by_job` check needs
-      job.instance_variable_set(:@acidic_job_run, run)
-
-      step = Step.new(current_step, run, job, step_result)
-      # TODO: WRITE REGRESSION TESTS FOR PARALLEL JOB FAILING AND RETRYING THE ORIGINAL STEP
-      step.progress
-
-      return if run.finished?
-
-      # when a batch of jobs for a step succeeds, we begin processing the `AcidicJob::Run` record again
-      # process_run(run)
-      run.update_column(:locked_at, nil)
-      job.enqueue
-    end
-
-    def enqueue_step_parallel_jobs(jobs_or_jobs_getter, run, step_result)
-      awaited_jobs = case jobs_or_jobs_getter
-                     when Array
-                       jobs_or_jobs_getter
-                     when Symbol, String
-                       method(jobs_or_jobs_getter).call
-                     end
-
-      AcidicJob::Run.transaction do
-        awaited_jobs.compact.each do |awaited_job|
-          worker_class, args, kwargs = job_args_and_kwargs(awaited_job)
-
-          job = worker_class.new(*args, **kwargs)
-
-          AcidicJob::Run.create!(
-            staged: true,
-            awaited_by: run,
-            job_class: worker_class,
-            serialized_job: job.serialize_job(*args, **kwargs),
-            idempotency_key: job.idempotency_key
-          )
-          run.update(returning_to: step_result)
-        end
-      end
-    end
-
-    def step_done(_status, options)
-      run = Run.find(options["run_id"])
-      current_step = run.workflow[run.recovery_point.to_s]
-      # re-hydrate the `step_result` object
-      step_result = YAML.safe_load(options["step_result_yaml"], permitted_classes: [RecoveryPoint, FinishedPoint])
-      step = Step.new(current_step, run, self, step_result)
-
-      # TODO: WRITE REGRESSION TESTS FOR PARALLEL JOB FAILING AND RETRYING THE ORIGINAL STEP
-      step.progress
-      # when a batch of jobs for a step succeeds, we begin processing the `AcidicJob::Run` record again
-      process_run(run)
-    end
-
-    def job_args_and_kwargs(job)
-      case job
-      when Class
-        [job, [], {}]
-      when String
-        [job.constantize, [], {}]
-      when Symbol
-        [job.to_s.constantize, [], {}]
-      else
-        [
-          job.class,
-          job.instance_variable_get(:@__acidic_job_args),
-          job.instance_variable_get(:@__acidic_job_kwargs)
-        ]
-      end
-    end
-  end
-end

data/lib/acidic_job/extensions/action_mailer.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-
-module AcidicJob
-  module Extensions
-    module ActionMailer
-      extend ActiveSupport::Concern
-
-      def deliver_acidicly(_options = {})
-        job_class = ::ActionMailer::MailDeliveryJob
-
-        job_args = [@mailer_class.name, @action.to_s, "deliver_now", @params, *@args]
-        # for Sidekiq, this depends on the Sidekiq::Serialization extension
-        serialized_job = job_class.new(job_args).serialize
-        acidic_identifier = job_class.respond_to?(:acidic_identifier) ? job_class.acidic_identifier : :job_id
-        key = IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
-
-        AcidicJob::Run.create!(
-          staged: true,
-          job_class: job_class.name,
-          serialized_job: serialized_job,
-          idempotency_key: key
-        )
-      end
-      alias deliver_transactionally deliver_acidicly
-    end
-  end
-end

data/lib/acidic_job/extensions/active_job.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-
-module AcidicJob
-  module Extensions
-    module ActiveJob
-      extend ActiveSupport::Concern
-
-      concerning :Serialization do
-        class_methods do
-          def serialize_with_arguments(*args, **kwargs)
-            job_or_instantiate(*args, **kwargs).serialize
-          end
-        end
-
-        def serialize_job(*_args, **_kwargs)
-          serialize
-        end
-      end
-
-      class_methods do
-        def perform_acidicly(*args, **kwargs)
-          raise UnsupportedExtension unless defined?(::ActiveJob) && self < ::ActiveJob::Base
-
-          serialized_job = serialize_with_arguments(*args, **kwargs)
-          key = IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
-
-          AcidicJob::Run.create!(
-            staged: true,
-            job_class: name,
-            serialized_job: serialized_job,
-            idempotency_key: key
-          )
-        end
-        alias_method :perform_transactionally, :perform_acidicly
-      end
-    end
-  end
-end

data/lib/acidic_job/extensions/noticed.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module AcidicJob
-  module Extensions
-    module Noticed
-      extend ActiveSupport::Concern
-
-      class_methods do
-        def deliver_acidicly(recipients)
-          new.deliver_acidicly(recipients)
-        end
-      end
-
-      def deliver_acidicly(recipients)
-        # THIS IS A HACK THAT COPIES AND PASTES KEY PARTS OF THE `Noticed::Base` CODE
-        # IN ORDER TO ALLOW US TO TRANSACTIONALLY DELIVER NOTIFICATIONS
-        # THIS IS THUS LIABLE TO BREAK WHENEVER THAT GEM IS UPDATED
-        delivery_methods = self.class.delivery_methods.dup
-
-        Array.wrap(recipients).uniq.each do |recipient|
-          if (index = delivery_methods.find_index { |m| m[:name] == :database })
-            database_delivery_method = delivery_methods.delete_at(index)
-            self.record = run_delivery_method(database_delivery_method,
-                                              recipient: recipient,
-                                              enqueue: false,
-                                              record: nil)
-          end
-
-          delivery_methods.map do |delivery_method|
-            job_class = delivery_method_for(delivery_method[:name], delivery_method[:options])
-            args = {
-              notification_class: self.class.name,
-              options: delivery_method[:options],
-              params: params,
-              recipient: recipient,
-              record: record
-            }
-            serialized_job = job_class.send(:job_or_instantiate, args).serialize
-            acidic_identifier = job_class.respond_to?(:acidic_identifier) ? job_class.acidic_identifier : :job_id
-            key = IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
-
-            AcidicJob::Run.create!(
-              staged: true,
-              job_class: job_class.name,
-              serialized_job: serialized_job,
-              idempotency_key: key
-            )
-          end
-        end
-      end
-      alias deliver_transactionally deliver_acidicly
-    end
-  end
-end

data/lib/acidic_job/extensions/sidekiq.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-require "active_support/callbacks"
-require "active_support/core_ext/module/concerning"
-
-module AcidicJob
-  module Extensions
-    module Sidekiq
-      extend ActiveSupport::Concern
-
-      concerning :Serialization do
-        class_methods do
-          # called only from `AcidicJob::Run#enqueue_staged_job`
-          def deserialize(serialized_job_hash)
-            klass = if serialized_job_hash["class"].is_a?(Class)
-                      serialized_job_hash["class"]
-                    else
-                      serialized_job_hash["class"].constantize
-                    end
-            worker = klass.new
-            worker.jid = serialized_job_hash["jid"]
-            worker.instance_variable_set(:@args, serialized_job_hash["args"])
-
-            worker
-          end
-
-          # called only from `AcidicJob::PerformAcidicly#perform_acidicly`
-          # and `AcidicJob::DeliverAcidicly#deliver_acidicly`
-          def serialize_with_arguments(args = [], _kwargs = nil)
-            # THIS IS A HACK THAT ESSENTIALLY COPIES THE CODE FROM THE SIDEKIQ CODEBASE TO MIMIC THE BEHAVIOR
-            # updated to handle Sidekiq v6.4.2 at latest
-            args = Array[args]
-            normalized_args = ::Sidekiq.load_json(::Sidekiq.dump_json(args))
-            item = { "class" => self, "args" => normalized_args }
-            dummy_sidekiq_client = ::Sidekiq::Client.new
-            normed = dummy_sidekiq_client.send :normalize_item, item
-            redis_pool = dummy_sidekiq_client.instance_variable_get(:@redis_pool)
-            dummy_sidekiq_client.middleware.invoke(normed["class"], normed, normed["queue"], redis_pool) do
-              normed
-            end
-          end
-        end
-
-        def serialize_job(*args, **kwargs)
-          # `@args` is only set via `deserialize`; it is not a standard Sidekiq thing
-          arguments = args || @args
-          arguments += [kwargs] unless kwargs.empty?
-          normalized_args = ::Sidekiq.load_json(::Sidekiq.dump_json(arguments))
-          item = { "class" => self.class.name, "args" => normalized_args, "jid" => jid }
-          sidekiq_options = sidekiq_options_hash || {}
-
-          sidekiq_options.merge(item)
-        end
-
-        # called only from `AcidicJob::Run#enqueue_staged_job`
-        def enqueue
-          ::Sidekiq::Client.push(
-            "class" => self.class,
-            "args" => @args,
-            "jid" => @acidic_job_run&.staged_job_id || @jid
-          )
-        end
-      end
-
-      concerning :PerformAcidicly do
-        class_methods do
-          def perform_acidicly(*args, **kwargs)
-            serialized_job = serialize_with_arguments(*args, **kwargs)
-            key = IdempotencyKey.new(acidic_identifier).value_for(serialized_job)
-
-            AcidicJob::Run.create!(
-              staged: true,
-              job_class: name,
-              serialized_job: serialized_job,
-              idempotency_key: key
-            )
-          end
-          alias_method :perform_transactionally, :perform_acidicly
-        end
-      end
-
-      # to balance `perform_async` class method
-      concerning :PerformSync do
-        class_methods do
-          def perform_sync(*args, **kwargs)
-            new.perform(*args, **kwargs)
-          end
-        end
-      end
-
-      # Following approach used by ActiveJob
-      # https://github.com/rails/rails/blob/93c9534c9871d4adad4bc33b5edc355672b59c61/activejob/lib/active_job/callbacks.rb
-      concerning :Callbacks do
-        class_methods do
-          def around_perform(*filters, &blk)
-            set_callback(:perform, :around, *filters, &blk)
-          end
-
-          def before_perform(*filters, &blk)
-            set_callback(:perform, :before, *filters, &blk)
-          end
-
-          def after_perform(*filters, &blk)
-            set_callback(:perform, :after, *filters, &blk)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/acidic_job/finished_point.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# Represents an action to set a new API response (which will be stored onto an
-# idempotency key). One  possible option for a return from an #atomic_phase
-# block.
-module AcidicJob
-  class FinishedPoint
-    def call(run:)
-      # Skip AR callbacks as there are none on the model
-      run.update_columns(
-        locked_at: nil,
-        recovery_point: Run::FINISHED_RECOVERY_POINT
-      )
-    end
-  end
-end