acidic_job 1.0.0.rc4 → 1.0.0.rc5

data/.rubocop.yml

@@ -1,11 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.7
-  NewCops: enable
-  DisabledByDefault: true
-  SuggestExtensions: false
-
-inherit_from: "https://www.goodcop.style/base.yml"
-
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - 'test/**/*'

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,209 +0,0 @@
-PATH
-  remote: .
-  specs:
-    acidic_job (1.0.0.rc4)
-      activejob (>= 7.1)
-      activerecord (>= 7.1)
-      activesupport (>= 7.1)
-      json (>= 2.7.0)
-      railties (>= 7.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (8.0.2)
-      actionpack (= 8.0.2)
-      actionview (= 8.0.2)
-      activejob (= 8.0.2)
-      activesupport (= 8.0.2)
-      mail (>= 2.8.0)
-      rails-dom-testing (~> 2.2)
-    actionpack (8.0.2)
-      actionview (= 8.0.2)
-      activesupport (= 8.0.2)
-      nokogiri (>= 1.8.5)
-      rack (>= 2.2.4)
-      rack-session (>= 1.0.1)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-      useragent (~> 0.16)
-    actionview (8.0.2)
-      activesupport (= 8.0.2)
-      builder (~> 3.1)
-      erubi (~> 1.11)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    activejob (8.0.2)
-      activesupport (= 8.0.2)
-      globalid (>= 0.3.6)
-    activemodel (8.0.2)
-      activesupport (= 8.0.2)
-    activerecord (8.0.2)
-      activemodel (= 8.0.2)
-      activesupport (= 8.0.2)
-      timeout (>= 0.4.0)
-    activesupport (8.0.2)
-      base64
-      benchmark (>= 0.3)
-      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)
-      uri (>= 0.13.1)
-    ast (2.4.3)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.9)
-    builder (3.3.0)
-    chaotic_job (0.3.0)
-    combustion (1.5.0)
-      activesupport (>= 3.0.0)
-      railties (>= 3.0.0)
-      thor (>= 0.14.6)
-    concurrent-ruby (1.3.5)
-    connection_pool (2.5.3)
-    crass (1.0.6)
-    date (3.4.1)
-    docile (1.4.1)
-    drb (2.2.1)
-    erubi (1.13.1)
-    globalid (1.2.1)
-      activesupport (>= 6.1)
-    i18n (1.14.7)
-      concurrent-ruby (~> 1.0)
-    io-console (0.8.0)
-    irb (1.15.2)
-      pp (>= 0.6.0)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    json (2.12.0)
-    language_server-protocol (3.17.0.5)
-    lint_roller (1.1.0)
-    logger (1.7.0)
-    loofah (2.24.1)
-      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.9)
-    minitest (5.25.5)
-    net-imap (0.5.8)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.2)
-      timeout
-    net-smtp (0.5.1)
-      net-protocol
-    nokogiri (1.18.8)
-      mini_portile2 (~> 2.8.2)
-      racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-darwin)
-      racc (~> 1.4)
-    parallel (1.27.0)
-    parser (3.3.8.0)
-      ast (~> 2.4.1)
-      racc
-    pp (0.6.2)
-      prettyprint
-    prettyprint (0.2.0)
-    prism (1.4.0)
-    psych (5.2.6)
-      date
-      stringio
-    racc (1.8.1)
-    rack (3.1.15)
-    rack-session (2.1.1)
-      base64 (>= 0.1.0)
-      rack (>= 3.0.0)
-    rack-test (2.2.0)
-      rack (>= 1.3)
-    rackup (2.2.1)
-      rack (>= 3)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.2)
-      loofah (~> 2.21)
-      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (8.0.2)
-      actionpack (= 8.0.2)
-      activesupport (= 8.0.2)
-      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.13.1)
-      psych (>= 4.0.0)
-    regexp_parser (2.10.0)
-    reline (0.6.1)
-      io-console (~> 0.5)
-    rubocop (1.75.6)
-      json (~> 2.3)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.44.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.1)
-      parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    ruby-progressbar (1.13.0)
-    securerandom (0.4.1)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.1)
-    simplecov_json_formatter (0.1.4)
-    sqlite3 (2.6.0)
-      mini_portile2 (~> 2.8.0)
-    sqlite3 (2.6.0-x86_64-darwin)
-    stringio (3.1.7)
-    thor (1.3.2)
-    timeout (0.4.3)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    uri (1.0.3)
-    useragent (0.16.11)
-    zeitwerk (2.7.2)
-
-PLATFORMS
-  ruby
-  x86_64-darwin-17
-
-DEPENDENCIES
-  acidic_job!
-  actionmailer (>= 7.1)
-  chaotic_job
-  combustion
-  minitest
-  rake
-  rubocop
-  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

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/acidic_job.gemspec

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-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.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
-  spec.metadata["source_code_uri"] = "https://github.com/fractaledmind/acidic_job"
-  spec.metadata["changelog_uri"] = "https://github.com/fractaledmind/acidic_job/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  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.require_paths = ["lib"]
-
-  spec.add_dependency "json", ">= 2.7.0" # see: https://github.com/ruby/json/pull/519
-  ">= 7.1".tap do |rails_version|
-    spec.add_dependency "activejob", rails_version
-    spec.add_dependency "activerecord", rails_version
-    spec.add_dependency "activesupport", rails_version
-    spec.add_dependency "railties", rails_version
-    spec.add_development_dependency "actionmailer", rails_version
-  end
-
-  spec.add_development_dependency "chaotic_job"
-  spec.add_development_dependency "combustion"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "sqlite3"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-  spec.metadata["rubygems_mfa_required"] = "true"
-end

data/bin/console

@@ -1,21 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-require "combustion"
-require "sqlite3"
-Combustion.path = "test/combustion"
-Combustion.initialize! :active_record, :active_job
-
-require "acidic_job"
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/bin/test_all

@@ -1,26 +0,0 @@
-run_tests() {
-  if [ "$#" -ne 2 ]; then
-    echo "Usage: run_tests RUBY_VERSION RAILS_VERSION"
-    echo "Example: run_tests 3.0.7 7.1"
-    return 1
-  fi
-
-  local ruby="$1"
-  local gemfile="gemfiles/rails_$2.gemfile"
-
-  echo "**************************************************"
-  echo "Running tests with Ruby $1 and Rails $2..."
-  ASDF_RUBY_VERSION=$ruby BUNDLE_GEMFILE=$gemfile bundle check ||
-  ASDF_RUBY_VERSION=$ruby BUNDLE_GEMFILE=$gemfile bundle install &&
-  ASDF_RUBY_VERSION=$ruby BUNDLE_GEMFILE=$gemfile bundle exec rake
-}
-
-run_tests "3.0.7" "7.1"
-run_tests "3.1.6" "7.1"
-run_tests "3.1.6" "7.2"
-run_tests "3.2.5" "7.1"
-run_tests "3.2.5" "7.2"
-run_tests "3.2.5" "8.0"
-run_tests "3.3.5" "7.1"
-run_tests "3.3.5" "7.2"
-run_tests "3.3.5" "8.0"

data/blog_post.md

@@ -1,28 +0,0 @@
-# ACIDic Operations in Rails
-
-At the conceptual heart of basically any software are "operations"—the discrete actions the software performs. At the horizon of basically any software is the goal to make that sofware _robust_. Typically, one makes a software system robust by making each of its operations robust. Moreover, typically, robustness in software is considered as the software being "ACIDic"—atomic, consistent, isolated, durable.
-
-In a loosely collected series of articles, Brandur Leach lays out the core techniques and principles required to make an HTTP API properly ACIDic:
-
-1. https://brandur.org/acid
-2. https://brandur.org/http-transactions
-3. https://brandur.org/job-drain
-4. https://brandur.org/idempotency-keys
-
-With these techniques and principles in mind, our challenge is bring them into the world of a standard Rails application. This will require us to conceptually map the concepts of an HTTP request, an API server action, and an HTTP response into the world of a running Rails process.
-
-We can begin to make this mapping by observing that an API server action is a specific instantiation of the general concept of an "operation". Like all operations, it has a "trigger" (the HTTP request) and a "response" (the HTTP response). So, what we need is a foundation upon which to build our Rails "operations".
-
-In order to help us find that tool, let us consider the necessary characteristics we need. We need something that we can easily trigger from other Ruby code throughout our Rails application (controller actions, model methods, model callbacks, etc.). It should also be able to be run both synchronously (blocking execution and then returning its response to the caller) and asychronously (non-blocking and the caller doesn't know its response). It should then also be able to retry a specific operation (in much the way that an API consumer can "retry an operation" by hitting the same endpoint with the same request). 
-
-As we lay out these characteristics, I imagine your mind is going where mine went—`ActiveJob` gives us a solid foundation upon which we can build "ACIDic" operations.
-
-So, our challenge to build tooling which will allow us to make "operational" jobs _robust_.
-
-What we need primarily is to be able to make our jobs *idempotent*, and one of the simplest yet still most powerful tools for making an operation idempotent is the idempotency key. As laid out in the article linked above, an idempotency key is a record that we store in our database to uniquely identify a particular execution of an operation and a related "recovery point" for where we are in the process of that operation.
-
-
-
-
-
-

data/gemfiles/rails_7.0.gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "activejob", "~> 7.0.0"
-gem "activerecord", "~> 7.0.0"
-gem "activesupport", "~> 7.0.0"
-gem "railties", "~> 7.0.0"
-gem "sqlite3", "~> 1.7.3"
-
-gemspec path: "../"

data/gemfiles/rails_7.1.gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "activejob", "~> 7.1.0"
-gem "activerecord", "~> 7.1.0"
-gem "activesupport", "~> 7.1.0"
-gem "railties", "~> 7.1.0"
-gem "sqlite3", ">= 2.0.0"
-
-gemspec path: "../"

data/gemfiles/rails_7.2.gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "activejob", "~> 7.2.0"
-gem "activerecord", "~> 7.2.0"
-gem "activesupport", "~> 7.2.0"
-gem "railties", "~> 7.2.0"
-gem "sqlite3", ">= 2.0.0"
-
-gemspec path: "../"

data/gemfiles/rails_8.0.gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "activejob", "~> 8.0.0.rc1"
-gem "activerecord", "~> 8.0.0.rc1"
-gem "activesupport", "~> 8.0.0.rc1"
-gem "railties", "~> 8.0.0.rc1"
-gem "sqlite3", ">= 2.1.0"
-
-gemspec path: "../"