acidic_job 1.0.0.beta.10 → 1.0.0.pre1

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.10
+  version: 1.0.0.pre1
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-13 00:00:00.000000000 Z
+date: 2022-03-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activejob
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -52,174 +38,20 @@ dependencies:
     - - ">="
       - !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
-  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: net-smtp
-  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: noticed
-  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: railties
   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: rake
-  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: rubocop
-  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: rubocop-minitest
-  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: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !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
-    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: sqlite3
-  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'
+        version: 6.1.0
 description: Idempotent operations for Rails apps, built on top of ActiveJob.
 email:
 - stephen.margheim@gmail.com
@@ -227,61 +59,36 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".tool-versions"
+- ".ruby_version"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- UPGRADE_GUIDE.md
 - acidic_job.gemspec
 - bin/console
 - bin/setup
 - blog_post.md
-- combustion/log/test.log
-- gemfiles/rails_6.1_sidekiq_6.4.gemfile
-- gemfiles/rails_6.1_sidekiq_6.5.gemfile
-- gemfiles/rails_7.0_sidekiq_6.4.gemfile
-- gemfiles/rails_7.0_sidekiq_6.5.gemfile
-- gemfiles/rails_7.1_sidekiq_6.4.gemfile
-- gemfiles/rails_7.1_sidekiq_6.5.gemfile
 - lib/acidic_job.rb
-- lib/acidic_job/active_kiq.rb
-- lib/acidic_job/arguments.rb
-- lib/acidic_job/base.rb
+- lib/acidic_job/awaiting.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/logger.rb
-- lib/acidic_job/mixin.rb
 - lib/acidic_job/perform_wrapper.rb
-- lib/acidic_job/processor.rb
-- lib/acidic_job/rails.rb
 - lib/acidic_job/recovery_point.rb
 - lib/acidic_job/run.rb
-- lib/acidic_job/serializer.rb
-- lib/acidic_job/serializers/exception_serializer.rb
-- lib/acidic_job/serializers/finished_point_serializer.rb
-- lib/acidic_job/serializers/job_serializer.rb
-- lib/acidic_job/serializers/range_serializer.rb
-- lib/acidic_job/serializers/recovery_point_serializer.rb
-- lib/acidic_job/serializers/worker_serializer.rb
-- lib/acidic_job/test_case.rb
-- lib/acidic_job/testing.rb
+- lib/acidic_job/staging.rb
+- lib/acidic_job/step.rb
 - lib/acidic_job/version.rb
-- lib/acidic_job/workflow.rb
-- lib/acidic_job/workflow_builder.rb
-- lib/acidic_job/workflow_step.rb
-- lib/generators/acidic_job/drop_tables_generator.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_generator.rb
+- lib/generators/templates/create_acidic_job_runs_migration.rb.erb
 homepage: https://github.com/fractaledmind/acidic_job
 licenses:
 - MIT
@@ -289,7 +96,6 @@ metadata:
   homepage_uri: https://github.com/fractaledmind/acidic_job
   source_code_uri: https://github.com/fractaledmind/acidic_job
   changelog_uri: https://github.com/fractaledmind/acidic_job/CHANGELOG.md
-  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -305,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Idempotent operations for Rails apps, built on top of ActiveJob.

data/.github/FUNDING.yml

@@ -1,13 +0,0 @@
-# These are supported funding model platforms
-
-github: fractaledmind
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.tool-versions

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

data/UPGRADE_GUIDE.md

@@ -1,81 +0,0 @@
-# AcidicJob Upgrade Guide
-
-## 1. Update version requirements in `Gemfile`
-
-```diff
-- gem "acidic_job"
-+ gem "acidic_job", "~> 1.0.0.pre1"
-```
-
-result:
-```
-Installing acidic_job 1.0.0.pre4 (was 0.7.7)
-Bundle updated!
-```
-
-## 2. Generate migration for new `AcidicJob::Run` model
-
-```bash
-rails generate acidic_job
-```
-
-result:
-```
-create  db/migrate/#{yyyymmddhhmmss}_create_acidic_job_runs.rb
-```
-
-## 3. Delete any unneeded `AcidicJob::Key` records
-
-Typically, records that are already finished do not need to be retained. Sometimes, however, applications key finished records around for some amount of time for debugging or metrics aggregation. Whatever your application's logic is for whether or not an `AcidicJob::Key` record is still needed, for all unneeded records, delete them.
-
-For example, this would delete all finished `Key` records over 1 month old:
-
-```ruby
-AcidicJob::Key.where(recovery_point: AcidicJob::Key::RECOVERY_POINT_FINISHED, last_run_at: ..1.month.ago).delete_all
-```
-
-## 4. Migrate `AcidicJob::Key` to `AcidicJob::Run`
-
-`AcidicJob` ships with an upgrade module that provides a script to migrate older `Key` records to the new `Run` model.
-
-```ruby
-AcidicJob::UpgradeService.execute
-```
-
-This script will prepare an `insert_all` command for `Run` records by mapping the older `Key` data to the new `Run` schema. It also creates the new `Run` records with the same `id` as their `Key` counterparts, and then deletes all `Key` records successfully mapped over. Any `Key` records that were failed to be mapped over will be reported, along with the exception, in the `errored_keys` portion of the resulting hash.
-
-result:
-```
-{
-  run_records: <Integer>,
-  key_records: <Integer>,
-  errored_keys: <Array>
-}
-```
-
-## 5. Triage remaining `AcidicJob::Key` records
-
-If there were any `AcidicJob::Key` records that failed to be mapped to the new `Run` model, you will need to manually triage whatever the exception was. In all likelihood, the exception would be relating to the translation of the `Key#job_args` field to the `Run#serialized_job` field, as all other fields have a fairly straight-forward mapping. If you can't resolve the issue, please open an Issue in GitHub.
-
-## 6. Ensure all `AcidicJob::Staged` records are processed
-
-`AcidicJob` still ships with an upgrade module that provides the older `Key` and `Staged` records, so this functionality will still be present to handle any existing records in your database when you deploy the updated version.
-
-## 7. Remove the old tables
-
-Once you have successfully migrated everything over and the new system has been running smoothly for some time, you should drop the old `acidic_job_keys` and `staged_acidic_jobs` tables. We provide a migration generator just for this purpose:
-
-```bash
-rails generate acidic_job:drop_tables
-```
-
-result:
-```
-create  db/migrate/#{yyyymmddhhmmss}_drop_old_acidic_job_tables.rb
-```
-
-You can then run the migration to have those tables removed:
-
-```bash
-rails db:migrate
-```

data/gemfiles/rails_6.1_sidekiq_6.4.gemfile

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

data/gemfiles/rails_6.1_sidekiq_6.5.gemfile

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

data/gemfiles/rails_7.0_sidekiq_6.4.gemfile

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

data/gemfiles/rails_7.0_sidekiq_6.5.gemfile

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

data/gemfiles/rails_7.1_sidekiq_6.4.gemfile

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

data/gemfiles/rails_7.1_sidekiq_6.5.gemfile

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

data/lib/acidic_job/active_kiq.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq"
-require "active_support/callbacks"
-require "active_support/core_ext/module/concerning"
-require_relative "mixin"
-
-module AcidicJob
-  class ActiveKiq
-    include ::Sidekiq::Worker
-    include ::Sidekiq::JobUtil
-    include ::ActiveSupport::Callbacks
-    define_callbacks :perform
-    include Mixin
-
-    concerning :Initializing do
-      included do
-        attr_accessor :arguments
-        attr_accessor :job_id
-        attr_accessor :queue_name
-        attr_accessor :sidekiq_options
-      end
-      ##
-      # Creates a new job instance.
-      # +args+ are the arguments, if any, that will be passed to the perform method
-      # +opts+ are any options to configure the job
-      def initialize(*arguments)
-        @arguments  = arguments
-        @job_id     = ::SecureRandom.uuid
-        @sidekiq_options = sidekiq_options_hash || ::Sidekiq.default_job_options
-        @queue_name = @sidekiq_options["queue"]
-      end
-
-      # Sidekiq sets the `jid` when it is processing jobs off of the Redis queue.
-      # We override the job identifier when staging jobs to encode the `Run` record global id.
-      # We also override how "ActiveKiq" instance's expose the job identifier to match ActiveJob.
-      # So, we need to ensure that when `jid=` is called, we set the `job_id` instead.
-      def jid=(value)
-        super
-        @job_id = value
-      end
-    end
-
-    concerning :Performing do
-      class_methods do
-        def perform_now(*args, **kwargs)
-          new.perform(*args, **kwargs)
-        end
-      end
-
-      def perform_now(*args, **kwargs)
-        perform(*args, **kwargs)
-      end
-
-      def enqueue
-        ::Sidekiq::Client.push(
-          "class" => self.class,
-          "args" => @arguments,
-          "jid" => @job_id,
-          "queue" => @queue_name
-        )
-      end
-    end
-
-    concerning :Serializing do
-      class_methods do
-        def deserialize(job_data)
-          job = job_data["job_class"].constantize.new
-          job.deserialize(job_data)
-          job
-        end
-      end
-
-      def serialize
-        return @serialize if defined? @serialize
-
-        item = @sidekiq_options.merge("class" => self.class.name, "args" => @arguments || [])
-        worker_hash = normalize_item(item)
-
-        @serialize = {
-          "job_class" => worker_hash["class"],
-          "job_id" => @job_id,
-          "queue_name" => worker_hash["queue"],
-          "arguments" => worker_hash["args"]
-        }.merge(worker_hash.except("class", "jid", "queue", "args"))
-      end
-
-      def deserialize(job_data)
-        self.job_id = job_data["job_id"]
-        self.queue_name = job_data["queue_name"]
-        self.arguments = job_data["arguments"]
-        self
-      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

data/lib/acidic_job/arguments.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require "active_job/arguments"
-
-module AcidicJob
-  module Arguments
-    include ActiveJob::Arguments
-    extend self # rubocop:disable Style/ModuleFunction
-
-    # `ActiveJob` will throw an error if it tries to deserialize a GlobalID record.
-    # However, this isn't the behavior that we want for our custom `ActiveRecord` serializer.
-    # Since `ActiveRecord` does _not_ reset instance record state to its pre-transactional state
-    # on a transaction ROLLBACK, we can have GlobalID entries in a serialized column that point to
-    # non-persisted records. This is ok. We should simply return `nil` for that portion of the
-    # serialized field.
-    def deserialize_global_id(hash)
-      GlobalID::Locator.locate hash[GLOBALID_KEY]
-    rescue ActiveRecord::RecordNotFound
-      nil
-    end
-  end
-end

data/lib/acidic_job/base.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "active_job/queue_adapters"
-require "active_job/base"
-require_relative "mixin"
-
-module AcidicJob
-  class Base < ActiveJob::Base
-    include Mixin
-  end
-end

data/lib/acidic_job/logger.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require "logger"
-require "active_support/tagged_logging"
-
-module AcidicJob
-  class Logger < ::Logger
-    def log_run_event(msg, job = nil, run = nil)
-      tags = [
-        run&.idempotency_key,
-        inspect_name(job)
-      ].compact
-
-      tagged(*tags) { debug(msg) }
-    end
-
-    def inspect_name(obj)
-      return if obj.nil?
-
-      obj.inspect.split.first.remove("#<")
-    end
-  end
-
-  def self.logger
-    @logger ||= ActiveSupport::TaggedLogging.new(AcidicJob::Logger.new($stdout, level: :debug))
-  end
-
-  def self.silence_logger!
-    @logger = ActiveSupport::TaggedLogging.new(AcidicJob::Logger.new(IO::NULL, level: :debug))
-  end
-end