acidic_job 1.0.0.rc3 → 1.0.0.rc5

data/lib/acidic_job.rb

@@ -9,6 +9,7 @@ require_relative "acidic_job/arguments"
 require_relative "acidic_job/plugin_context"
 require_relative "acidic_job/plugins/transactional_step"
 require_relative "acidic_job/log_subscriber"
+require_relative "acidic_job/serializer"
 require_relative "acidic_job/workflow"
 
 require "active_support"
@@ -21,6 +22,8 @@ module AcidicJob
 
   mattr_accessor :logger, default: DEFAULT_LOGGER
   mattr_accessor :connects_to
+  mattr_accessor :plugins, default: [Plugins::TransactionalStep]
+  mattr_accessor :clear_finished_executions_after, default: 1.week
 
   def instrument(channel, **options, &block)
     ActiveSupport::Notifications.instrument("#{channel}.acidic_job", **options.deep_symbolize_keys, &block)

data/lib/generators/acidic_job/install_generator.rb

@@ -12,13 +12,13 @@ module AcidicJob
 
       # Copies the migration template to db/migrate.
       def copy_acidic_job_runs_migration_files
-        migration_template "create_acidic_job_tables_migration.rb.erb",
-                           "db/migrate/create_acidic_job_tables.rb",
-                           migration_version: migration_version
+        migration_template(
+          "create_acidic_job_tables_migration.rb.erb",
+          "db/migrate/create_acidic_job_tables.rb",
+          migration_version: migration_version
+        )
       end
 
-      protected
-
       def migration_version
         "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end

data/lib/generators/acidic_job/templates/create_acidic_job_tables_migration.rb.erb

@@ -2,30 +2,30 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
   def change
     create_table :acidic_job_executions, force: true do |t|
       t.string      :idempotency_key, null: false,  index: { unique: true }
-      t.json        :serialized_job, 	null: false,  default: "{}"
+      t.json        :serialized_job, 	null: false
       t.datetime    :last_run_at, 		null: true
       t.datetime    :locked_at, 			null: true
       t.string      :recover_to, 	    null: true
-      t.json        :definition, 			null: true,   default: "{}"
+      t.text        :definition, 			null: true
 
       t.timestamps
     end
 
     create_table :acidic_job_entries do |t|
-      t.references :execution, null: false, foreign_key: { to_table: :acidic_job_executions }
+      t.references :execution, null: false, foreign_key: { to_table: :acidic_job_executions, on_delete: :cascade }
       t.string     :step,      null: false
       t.string     :action,    null: false
       t.datetime   :timestamp, null: false
-      t.json       :data,      null: true,  default: "{}"
+      t.text       :data,      null: true
 
       t.timestamps
     end
     add_index :acidic_job_entries, [:execution_id, :step, :action]
 
     create_table :acidic_job_values do |t|
-      t.references :execution, null: false, foreign_key: { to_table: :acidic_job_executions }
+      t.references :execution, null: false, foreign_key: { to_table: :acidic_job_executions, on_delete: :cascade }
       t.string     :key,       null: false
-      t.json       :value,     null: false, default: "{}"
+      t.text       :value,     null: false
 
       t.timestamps
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0.rc5
 platform: ruby
 authors:
 - fractaledmind
 bindir: exe
 cert_chain: []
-date: 2025-05-16 00:00:00.000000000 Z
+date: 2025-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -97,16 +97,16 @@ dependencies:
   name: chaotic_job
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -163,34 +163,6 @@ dependencies:
     - - ">="
       - !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'
-  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
@@ -226,33 +198,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codacy.yml"
-- ".github/FUNDING.yml"
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".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_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/arguments.rb
 - lib/acidic_job/builder.rb
@@ -262,6 +213,7 @@ files:
 - lib/acidic_job/log_subscriber.rb
 - lib/acidic_job/plugin_context.rb
 - lib/acidic_job/plugins/transactional_step.rb
+- lib/acidic_job/serializer.rb
 - lib/acidic_job/serializers/exception_serializer.rb
 - lib/acidic_job/serializers/job_serializer.rb
 - lib/acidic_job/serializers/new_record_serializer.rb

data/.codacy.yml

@@ -1,4 +0,0 @@
----
-exclude_paths:
-  - "**/*.md"
-  - "LICENSE"

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/.github/workflows/main.yml

@@ -1,38 +0,0 @@
-name: CI
-
-on: [push]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ["3.0", "3.1", "3.2", "3.3"]
-        rails: [ "7.1", "7.2", "8.0"]
-        exclude:
-          - ruby: "3.0"
-            rails: "8.0"
-          - ruby: "3.1"
-            rails: "8.0"
-          - ruby: "3.0"
-            rails: "7.2"
-
-    env:
-      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/rails_${{ matrix.rails }}.gemfile
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Ruby
-      # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-      # change this to (see https://github.com/ruby/setup-ruby#versioning):
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true # 'bundle install' and cache gems
-          ruby-version: ${{ matrix.ruby }}
-
-      - name: Run the default task
-        run: bundle exec rake
-        timeout-minutes: 2

data/.gitignore

@@ -1,18 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.DS_Store
-/test/database.sqlite
-slides.md
-/test/dummy
-/test/log
-/database.sqlite
-/test/combustion/database.sqlite*
-/test/combustion/log/test.log
-/test/combustion/tmp/*
-/gemfiles/*.lock

data/.rubocop.yml

@@ -1,83 +0,0 @@
-require:
- - rubocop-minitest
- - rubocop-rake
-
-AllCops:
-  Exclude:
-    - inline.rb
-    - test/simulation.rb
-    - vendor/bundle/**/*
-  TargetRubyVersion: 2.7
-  NewCops: enable
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
-
-Gemspec/DevelopmentDependencies:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Minitest/MultipleAssertions:
-  Enabled: false
-
-Style/ModuleFunction:
-  Enabled: false
-
-Style/RaiseArgs:
-  EnforcedStyle: compact
-
-Style/NegatedIf:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Exclude:
-    - test/**/*_test.rb
-
-Naming/VariableNumber:
-  Exclude:
-    - test/**/*_test.rb
-
-Style/SingleLineMethods:
-  Exclude:
-    - test/**/*_test.rb
-
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - test/**/*_test.rb
-
-Minitest/AssertTruthy:
-  Enabled: false
-
-Minitest/RefuteFalse:
-  Enabled: false

data/.ruby-version

@@ -1 +0,0 @@
-ruby-3.3.4

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec

data/Gemfile.lock

@@ -1,201 +0,0 @@
-PATH
-  remote: .
-  specs:
-    acidic_job (1.0.0.rc3)
-      activejob (>= 7.1)
-      activerecord (>= 7.1)
-      activesupport (>= 7.1)
-      json (>= 2.7.0)
-      railties (>= 7.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (7.2.1.1)
-      actionpack (= 7.2.1.1)
-      actionview (= 7.2.1.1)
-      activejob (= 7.2.1.1)
-      activesupport (= 7.2.1.1)
-      mail (>= 2.8.0)
-      rails-dom-testing (~> 2.2)
-    actionpack (7.2.1.1)
-      actionview (= 7.2.1.1)
-      activesupport (= 7.2.1.1)
-      nokogiri (>= 1.8.5)
-      racc
-      rack (>= 2.2.4, < 3.2)
-      rack-session (>= 1.0.1)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-      useragent (~> 0.16)
-    actionview (7.2.1.1)
-      activesupport (= 7.2.1.1)
-      builder (~> 3.1)
-      erubi (~> 1.11)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    activejob (7.2.1.1)
-      activesupport (= 7.2.1.1)
-      globalid (>= 0.3.6)
-    activemodel (7.2.1.1)
-      activesupport (= 7.2.1.1)
-    activerecord (7.2.1.1)
-      activemodel (= 7.2.1.1)
-      activesupport (= 7.2.1.1)
-      timeout (>= 0.4.0)
-    activesupport (7.2.1.1)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.3.1)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      logger (>= 1.4.2)
-      minitest (>= 5.1)
-      securerandom (>= 0.3)
-      tzinfo (~> 2.0, >= 2.0.5)
-    ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
-    builder (3.3.0)
-    chaotic_job (0.3.0)
-    combustion (1.3.7)
-      activesupport (>= 3.0.0)
-      railties (>= 3.0.0)
-      thor (>= 0.14.6)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.0)
-    crass (1.0.6)
-    date (3.4.1)
-    docile (1.4.0)
-    drb (2.2.1)
-    erubi (1.13.0)
-    globalid (1.2.1)
-      activesupport (>= 6.1)
-    i18n (1.14.6)
-      concurrent-ruby (~> 1.0)
-    io-console (0.7.2)
-    irb (1.14.1)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    json (2.10.2)
-    logger (1.6.1)
-    loofah (2.22.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    mail (2.8.1)
-      mini_mime (>= 0.1.1)
-      net-imap
-      net-pop
-      net-smtp
-    mini_mime (1.1.5)
-    mini_portile2 (2.8.7)
-    minitest (5.25.1)
-    net-imap (0.5.1)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.2)
-      timeout
-    net-smtp (0.5.0)
-      net-protocol
-    nokogiri (1.16.7)
-      mini_portile2 (~> 2.8.2)
-      racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-darwin)
-      racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.2.2.0)
-      ast (~> 2.4.1)
-    psych (5.1.2)
-      stringio
-    racc (1.8.1)
-    rack (3.1.8)
-    rack-session (2.0.0)
-      rack (>= 3.0.0)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rackup (2.1.0)
-      rack (>= 3)
-      webrick (~> 1.8)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.0)
-      loofah (~> 2.21)
-      nokogiri (~> 1.14)
-    railties (7.2.1.1)
-      actionpack (= 7.2.1.1)
-      activesupport (= 7.2.1.1)
-      irb (~> 1.13)
-      rackup (>= 1.0.0)
-      rake (>= 12.2)
-      thor (~> 1.0, >= 1.2.2)
-      zeitwerk (~> 2.6)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    rdoc (6.7.0)
-      psych (>= 4.0.0)
-    regexp_parser (2.8.0)
-    reline (0.5.10)
-      io-console (~> 0.5)
-    rexml (3.2.5)
-    rubocop (1.50.2)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
-      parser (>= 3.2.1.0)
-    rubocop-minitest (0.30.0)
-      rubocop (>= 1.39, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    ruby-progressbar (1.13.0)
-    securerandom (0.3.1)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    sqlite3 (1.6.2)
-      mini_portile2 (~> 2.8.0)
-    sqlite3 (1.6.2-x86_64-darwin)
-    stringio (3.1.1)
-    thor (1.3.2)
-    timeout (0.4.1)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
-    useragent (0.16.10)
-    webrick (1.8.2)
-    zeitwerk (2.7.1)
-
-PLATFORMS
-  ruby
-  x86_64-darwin-17
-
-DEPENDENCIES
-  acidic_job!
-  actionmailer (>= 7.1)
-  chaotic_job
-  combustion
-  minitest
-  rake
-  rubocop
-  rubocop-minitest
-  rubocop-rake
-  simplecov
-  sqlite3
-
-BUNDLED WITH
-   2.5.21

data/Rakefile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]

data/TODO

@@ -1,77 +0,0 @@
-- [x] Track number of runs per execution (resolves #79)
-  This is accomplished with the new `entries` table, as proven by the `idempotency_check` feature, which only runs on a retry.
-
-- [x] Store errors with more context and without full error history (resolves #80)
-  This is also accomplished with the new `entries` table, by storing a separate error entry for any raised errors.
-
-- [x] All traversal over a collection added to the context within the workflow (resolves #81)
-  The new collection traversal logic resolves #81, as proven by the test case. You can traverse a key for a context value. For example,
-  ```ruby
-  execute :prepare_collection
-  traverse :collection, using: :process_item
-
-  def prepare_collection = @ctx[:collection] = 1..5
-  def process_item(item) = @processed_items << item
-  ```
-
-- [x] Handle case where non-idempotent external write succeeds but recording fails (resolves #82)
-  The new `idempotency_check` option accomplishes this, by allowing a step making external IO to define a method that checks if the write was already successfully made when re-running a step in a retry.
-
-- [x] Ensure any and all exceptions can be serialized and deserialized (resolves #83)
-  The original serializer was too naive and couldn't deserialize, for example, an `ActionView::Template::Error` which requires that `$!` be set when initializing the object.
-
-  The new `ExceptionSerializer` uses Ruby's built-in YAML encoding of exceptions to serialize and deserialize the objects, laying on Zlib to ensure compact byte storage.
-
-- [x] Handle duplicate workflow step names (resolves #87)
-  Adding a `DuplicateStepError` exception raised when building the workflow definition resolved this issue.
-
-- [ ] Add a `context` step type (resolves #89)
-  Use case: the workflow may or may not have the data it needs to proceed. If it doesn't, it should make an API call to fetch the data. The API call may take a while, so we should be able to handle that as well.
-
-  Example usage:
-  ```ruby
-  context :slack_author, fallback: :fetch_slack_author
-
-  def slack_author
-    Slack::Profile.find_by(uid: @user_uid)
-  end
-
-  def fetch_slack_author
-    api_response = Slack::Client.new().get_user(uid: @user_uid)
-    if api_response[:ok]
-      [Slack::ProcessProfileSlackJob.new(@installation, api_response[:user])]
-    else
-      raise DoNotRetryJob
-    end
-  end
-  ```
-
-  Psuedo code for implementation:
-  ```ruby
-  result = resolve_method(primary_method_name).call
-  if result
-    @ctx[primary_method_name] = result
-  else
-    fallback = resolve_method(fallback_method_name).call
-    case fallback
-    in ActiveJob::Base then awaits(fallback)
-    in Array[ActiveJob::Base] then awaits(fallback)
-    else @ctx[primary_method_name] = result
-    end
-  end
-  ```
-
-- [ ] Add documentation on how to "migrate" a workflow (resolves #90)
-  The v1 alpha already includes a check that the persisted workflow definition matches the job's current definition. This ensures that no job tries to run with an outdated definition. However, we should document the proper way to update a workflow definition.
-
-  The process can only be additive, like a strong migration. First, you create a new job with a new name that is a clone of the original job. Make the necessary changes to the new job. Update your codebase to only enqueue the new job. Deploy this change, where both the new job and the old jobs exist, but the application only enqueues the new job. Once deployed, wait until all currently running instances of the old job complete (provide some docs on how to check this). Once all old job instances are complete, you can safely delete the old job and deploy that change. This process ensures that no job is running with an outdated definition.
-
-- [ ] Automatically retry the serializable transaction for find/create the Run record (resolves #91)
-  Serializable transactions are prone to failure: https://stackoverflow.com/a/21715207/2884386
-
-  Currently, if the transaction fails, the job will fail. We need to build automatic retries into the gem, as this failure will naturally resolve. But, we should also add a limit to the number of retries to prevent infinite loops.
-
-- [ ] Ensure the gem works with GoodJob (resolves #92 and #94)
-  In the current version, GoodJob can't handle messing with the `job_id` and retrying a failed job raises a NoMethodError: "undefined method `utc' for an instance of Float".
-
-- [ ] Ensure users can transactionally enqueue other entities, like ActionMailer or Noticed objects