acidic_job 0.7.6 → 1.0.0.beta.2

data/README.md

@@ -1,8 +1,11 @@
 # AcidicJob
 
-### Idempotent operations for Rails apps (for ActiveJob or Sidekiq)
+[![Gem Version](https://badge.fury.io/rb/acidic_job.svg)](https://badge.fury.io/rb/acidic_job)
+![main workflow](https://github.com/fractaledmind/acidic_job/actions/workflows/main.yml/badge.svg)
 
-At the conceptual heart of basically any software are "operations"—the discrete actions the software performs. Rails provides a powerful abstraction layer for building operations in the form of `ActiveJob`, or we Rubyists can use the tried and true power of pure `Sidekiq`. With either we can easily trigger from other Ruby code throughout our Rails application (controller actions, model methods, model callbacks, etc.); we can run operations both synchronously (blocking execution and then returning its response to the caller) and asychronously (non-blocking and the caller doesn't know its response); and we can also retry a specific operation if needed seamlessly.
+## Idempotent operations for Rails apps (for ActiveJob or Sidekiq)
+
+At the conceptual heart of basically any software are "operations"—the discrete actions the software performs. Rails provides a powerful abstraction layer for building operations in the form of `ActiveJob`, or we Rubyists can use the tried and true power of pure `Sidekiq`. With either we can easily trigger operations from other Ruby code throughout our Rails application (controller actions, model methods, model callbacks, etc.); we can run operations both synchronously (blocking execution and then returning its response to the caller) and asychronously (non-blocking and the caller doesn't know its response); and we can also retry a specific operation if needed seamlessly.
 
 However, in order to ensure that our operational jobs are _robust_, we need to ensure that they are properly [idempotent and transactional](https://github.com/mperham/sidekiq/wiki/Best-Practices#2-make-your-job-idempotent-and-transactional). As stated in the [GitLab Sidekiq Style Guide](https://docs.gitlab.com/ee/development/sidekiq_style_guide.html#idempotent-jobs):
 
@@ -12,14 +15,33 @@ However, in order to ensure that our operational jobs are _robust_, we need to e
 
 This is, of course, far easier said than done. Thus, `AcidicJob`.
 
-`AcidicJob` provides a framework to help you make your operational jobs atomic ⚛️, consistent 🤖, isolated 🕴🏼, and durable ⛰️. Its conceptual framework is directly inspired by a truly wonderful loosely collected series of articles written by Brandur Leach, which together lay out 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
-
-`AcidicJob` brings these techniques and principles into the world of a standard Rails application.
+`AcidicJob` provides a framework to help you make your operational jobs atomic ⚛️, consistent 🤖, isolated 🕴🏼, and durable ⛰️. Its conceptual framework is directly inspired by a truly wonderful loosely collected series of articles written by [Brandur Leach](https://twitter.com/brandur), which together lay out core techniques and principles required to make an HTTP API properly ACIDic:
+
+1. [Building Robust Systems with ACID and Constraints](https://brandur.org/acid)
+2. [Using Atomic Transactions to Power an Idempotent API](https://brandur.org/http-transactions)
+3. [Transactionally Staged Job Drains in Postgres](https://brandur.org/job-drain)
+4. [Implementing Stripe-like Idempotency Keys in Postgres](https://brandur.org/idempotency-keys)
+
+Seriously, go and read these articles. `AcidicJob` brings these techniques and principles into the world of a standard Rails application, treating your background jobs like an internal API of sorts. It provides a suite of functionality that empowers you to create complex, robust, and _acidic_ jobs.
+
+## Key Features
+
+* **Transactional Steps**  
+    break your job into a series of steps, each of which will be run within an acidic database transaction, allowing retries to jump back to the last "recovery point".
+* **Steps that Await Jobs**  
+    have workflow steps await other jobs, which will be enqueued and processed independently, and only when they all have finished will the parent job be re-enqueued to continue the workflow
+* **Iterable Steps**  
+    define steps that iterate over some collection fully until moving on to the next step
+* **Persisted Attributes**  
+    when retrying jobs at later steps, we need to ensure that data created in previous steps is still available to later steps on retry.
+* **Transactionally Staged Jobs**  
+    enqueue additional jobs within the acidic transaction safely
+* **Custom Idempotency Keys**  
+    use something other than the job ID for the idempotency key of the job run
+* **Sidekiq Callbacks**  
+    bring ActiveJob-like callbacks into your pure Sidekiq Workers
+* **Run Finished Callbacks**  
+    set callbacks for when a job run finishes fully
 
 ## Installation
 
@@ -37,40 +59,53 @@ Or simply execute to install the gem yourself:
 
     $ bundle add acidic_job
 
-Then, use the following command to copy over the `AcidicJob::Key` migration file as well as the `AcidicJob::Staged` migration file.
+Then, use the following command to copy over the `AcidicJob::Run` migration file.
 
 ```
-rails generate acidic_job
+rails generate acidic_job:install
 ```
 
 ## Usage
 
-`AcidicJob` is a concern that you `include` into your operation jobs.
+`AcidicJob` brings the most seamless experience when you inject it into every job in your application. This can be done most easily by simply having your `ApplicationJob` inherit from `AcidicJob::Base` (if using `ActiveJob`; inherit from `AcidicJob::ActiveKiq` if using pure Sidekiq workers):
+
+```ruby
+class ApplicationJob < AcidicJob::Base
+end
+```
+
+This is useful because the module needs to be mixed into any and all jobs that you want to either [1] make acidic or [2] enqueue acidicly.
+
+If you only want to inject `AcidicJob` into a single job, you can include our concern `AcidicJob::Mixin` instead:
 
 ```ruby
-class RideCreateJob < ActiveJob::Base
-  include AcidicJob
+class SomeJob < ApplicationJob
+  include AcidicJob::Mixin
 end
 ```
 
-It provides a suite of functionality that empowers you to create complex, robust, and _acidic_ jobs.
+## Key Features (in depth)
+
 
 ### Transactional Steps
 
-The first and foundational feature `acidic_job` provides is the `with_acidity` method, which takes a block of transactional step methods (defined via the `step`) method:
+The first and foundational feature `acidic_job` provides is the `with_acidic_workflow` method, which takes a block of transactional step methods (defined via the `step`) method:
 
 ```ruby
-class RideCreateJob < ActiveJob::Base
-  include AcidicJob
-
-  def perform(ride_params)
-    with_acidity given: { user: current_user, params: ride_params, ride: nil } do
-      step :create_ride_and_audit_record
-      step :create_stripe_charge
-      step :send_receipt
+class RideCreateJob < AcidicJob::Base
+  def perform(user_id, ride_params)
+    @user = User.find(user_id)
+    @params = ride_params
+
+    with_acidic_workflow persisting: { ride: nil } do |workflow|
+      workflow.step :create_ride_and_audit_record
+      workflow.step :create_stripe_charge
+      workflow.step :send_receipt
     end
   end
 
+  private
+
   def create_ride_and_audit_record
     # ...
   end
@@ -85,20 +120,114 @@ class RideCreateJob < ActiveJob::Base
 end
 ```
 
-`with_acidity` takes only the `given:` named parameter and a block where you define the steps of this operation. `step` simply takes the name of a method available in the job. That's all!
+`with_acidic_workflow` takes only the `persisting:` named parameter (optionally) and a block (required) where you define the steps of this operation. `step` simply takes the name of a method available in the job. That's all!
+
+Now, each execution of this job will find or create an `AcidicJob::Run` record, which we leverage to wrap every step in a database transaction. Moreover, this database record allows us to ensure that if your job fails on step 3, when it retries, it will simply jump right back to trying to execute the method defined for the 3rd step, _**and won't even execute the first two step methods**_. This means your step methods only need to be idempotent on failure, not on success, since they will never be run again if they succeed.
+
+
+### Steps that Await Jobs
+
+By simply adding the `awaits` option to your step declarations, you can attach any number of additional, asynchronous jobs to your step. This is profoundly powerful, as it means that you can define a workflow where step 2 is started _if and only if_ step 1 succeeds, but step 1 can have 3 different jobs enqueued on 3 different queues, each running in parallel. Once (and only once) all 3 jobs succeed, `AcidicJob` will re-enqueue the parent job and it will move on to step 2. That's right, you can have workers that are _executed in parallel_, **on separate queues**, and _asynchronously_, but are still **blocking**—as a group—the next step in your workflow! This unlocks incredible power and flexibility for defining and structuring complex workflows and operations.
+
+```ruby
+class RideCreateJob < AcidicJob::Base
+  def perform(user_id, ride_params)
+    @user = User.find(user_id)
+    @params = ride_params
+
+    with_acidic_workflow persisting: { ride: nil } do |workflow|
+      workflow.step :create_ride_and_audit_record, awaits: [SomeJob, AnotherJob]
+      workflow.step :create_stripe_charge
+      workflow.step :send_receipt
+    end
+  end
+end
+```
+
+If you need to await a job that takes arguments, you can prepare that job along with its arguments using the `with` class method that `AcidicJob` will add to your jobs:
+
+```ruby
+class RideCreateJob < AcidicJob::Base
+  def perform(user_id, ride_params)
+    @user = User.find(user_id)
+    @params = ride_params
+
+    with_acidic_workflow persisting: { ride: nil } do |workflow|
+      step :create_ride_and_audit_record, awaits: awaits: [SomeJob.with('argument_1', keyword: 'value'), AnotherJob.with(1, 2, 3, some: 'thing')]
+      step :create_stripe_charge
+      step :send_receipt
+    end
+  end
+end
+```
+
+If your step awaits multiple jobs (e.g. `awaits: [SomeJob, AnotherJob.with('argument_1', keyword: 'value')]`), your top level workflow job will only continue to the next step once **all** of the jobs in your `awaits` array have finished.
+
+In some cases, you may need to _dynamically_ determine the collection of jobs that the step should wait for; in these cases, you can pass the name of a method to the `awaits` option:
+
+```ruby
+class RideCreateJob < AcidicJob::Base
+  def perform(user_id, ride_params)
+    @user = User.find(user_id)
+    @params = ride_params
+
+    with_acidic_workflow persisting: { ride: nil } do |workflow|
+      step :create_ride_and_audit_record, awaits: :dynamic_awaits
+      step :create_stripe_charge
+      step :send_receipt
+    end
+  end
+
+  private
+
+  def dynamic_awaits
+    if @params["key"].present?
+      [SomeJob.with('argument_1', keyword: 'value')]
+    else
+      [AnotherJob.with(1, 2, 3, some: 'thing')]
+    end
+  end
+end
+```
+
+
+### Iterable Steps
+
+Sometimes our workflows have steps that need to iterate over a collection and perform an action for each item in the collection before moving on to the next step in the workflow. In these cases, we can use the `for_each` option when defining our step to bind that method to a specific the collection, and `AcidicJob` will pass each item into your step method for processing, keeping the same transactional guarantees as for any step. This means that if your step encounters an error in processing any item in the collection, when your job is retried, the job will jump right back to that step and right back to that item in the collection to try again.
+
+```ruby
+class ExampleJob < AcidicJob::Base
+  def perform(record:)
+    with_acidic_workflow persisting: { collection: [1, 2, 3, 4, 5] } do |workflow|
+      workflow.step :process_item, for_each: :collection
+      workflow.step :next_step
+    end
+  end
+
+  private
+
+  def process_item(item)
+    # do whatever work needs to be done with an individual item from `collection`
+  end
+end
+```
+
+**Note:** This feature relies on the "Persisted Attributes" feature detailed below. This means that you can only iterate over collections that ActiveJob can serialize. See [the Rails Guide on `ActiveJob`](https://edgeguides.rubyonrails.org/active_job_basics.html#supported-types-for-arguments) for more info.
 
-Now, each execution of this job will find or create an `AcidicJob::Key` record, which we leverage to wrap every step in a database transaction. Moreover, this database record allows `acidic_job` to ensure that if your job fails on step 3, when it retries, it will simply jump right back to trying to execute the method defined for the 3rd step, and won't even execute the first two step methods. This means your step methods only need to be idempotent on failure, not on success, since they will never be run again if they succeed.
 
 ### Persisted Attributes
 
-Any objects passed to the `given` option on the `with_acidity` method are not just made available to each of your step methods, they are made available across retries. This means that you can set an attribute in step 1, access it in step 2, have step 2 fail, have the job retry, jump directly back to step 2 on retry, and have that object still accessible. This is done by serializing all objects to a field on the `AcidicJob::Key` and manually providing getters and setters that sync with the database record.
+The `persisting` option on the `with_acidic_workflow` method allows you to create a cross-step, cross-retry context. This means that you can set an attribute in step 1, access it in step 2, have step 2 fail, have the job retry, jump directly back to step 2 on retry, and have that object still accessible. This is done by serializing all objects to a field on the `AcidicJob::Run` and manually persisting getters and setters that sync with the database record.
+
+The default pattern you should follow when defining your `perform` method is to make any values that your `step` methods need access to, but are present at the start of the `perform` method simply instance variables. You only need to mark attributes that will be set _during a step_ via `persisting`. This means, the initial value will almost always be `nil`. If you need a default initial value, however, you can always provide that value to `persisting`.
 
 ```ruby
-class RideCreateJob < ActiveJob::Base
-  include AcidicJob
+class RideCreateJob < AcidicJob::Base
+  def perform(user_id, ride_params)
+    @user = User.find(user_id)
+    @params = ride_params
 
-  def perform(ride_params)
-    with_acidity given: { ride: nil } do
+    with_acidic_workflow persisting: { ride: nil } do |workflow|
       step :create_ride_and_audit_record
       step :create_stripe_charge
       step :send_receipt
@@ -117,22 +246,24 @@ class RideCreateJob < ActiveJob::Base
 end
 ```
 
-**Note:** This does mean that you are restricted to objects that can be serialized by ActiveRecord, thus no Procs, for example.
+**Note:** This does mean that you are restricted to objects that can be serialized by **`ActiveJob`** (for more info, see [the Rails Guide on `ActiveJob`](https://edgeguides.rubyonrails.org/active_job_basics.html#supported-types-for-arguments)). This means you can persist ActiveRecord models, and any simple Ruby data types, but you can't persist things like Procs or custom class instances, for example.
+
+**Note:** You will note the use of `self.ride = ...` in the code sample above. In order to call the attribute setter method that will sync with the database record, you _must_ use this style. `@ride = ...` and/or `ride = ...` will both fail to sync the value with the database record.
 
-**Note:** You will note the use of `self.ride = ...` in the code sample above. In order to call the attribute setter method that will sync with the database record, you _must_ use this style. `@ride = ...` and/or `ride = ...` will both fail to sync the value with the datbase record.
 
 ### Transactionally Staged Jobs
 
 A standard problem when inside of database transactions is enqueuing other jobs. On the one hand, you could enqueue a job inside of a transaction that then rollbacks, which would leave that job to fail and retry and fail. On the other hand, you could enqueue a job that is picked up before the transaction commits, which would mean the records are not yet available to this job.
 
-In order to mitigate against such issues without forcing you to use a database-backed job queue, `acidic_job` provides `perform_transactionally` and `deliver_transactionally` methods to "transactionally stage" enqueuing other jobs from within a step (whether another ActiveJob or a Sidekiq::Worker or an ActionMailer delivery). These methods will create a new `AcidicJob::Staged` record, but inside of the database transaction of the `step`. Upon commit of that transaction, a model callback pushes the job to your actual job queue.  Once the job has been successfully performed, the `AcidicJob::Staged` record is deleted so that this table doesn't grow unbounded and unnecessarily.
+In order to mitigate against such issues without forcing you to use a database-backed job queue, `AcidicJob` provides `perform_acidicly` and `deliver_acidicly` methods to "transactionally stage" enqueuing other jobs from within a step (whether another `ActiveJob` or a `Sidekiq::Worker` or an `ActionMailer` delivery). These methods will create a new `AcidicJob::Run` record, but inside of the database transaction of the `step`. Upon commit of that transaction, a model callback pushes the job to your actual job queue.  Once the job has been successfully performed, the `AcidicJob::Run` record is deleted so that this table doesn't grow unbounded and unnecessarily.
 
 ```ruby
-class RideCreateJob < ActiveJob::Base
-  include AcidicJob
-
-  def perform(ride_params)
-    with_acidity given: { user: current_user, params: ride_params, ride: nil } do
+class RideCreateJob < AcidicJob::Base
+  def perform(user_id, ride_params)
+    @user = User.find(user_id)
+    @params = ride_params
+    
+    with_acidic_workflow persisting: { ride: nil } do |workflow|
       step :create_ride_and_audit_record
       step :create_stripe_charge
       step :send_receipt
@@ -142,22 +273,144 @@ class RideCreateJob < ActiveJob::Base
   # ...
 
   def send_receipt
-    RideMailer.with(ride: @ride, user: @user).confirm_charge.delivery_transactionally
+    RideMailer.with(user: @user, ride: @ride).confirm_charge.delivery_acidicly
+  end
+end
+```
+
+
+### Custom Idempotency Keys
+
+By default, `AcidicJob` uses the job identifier provided by the queueing system (ActiveJob or Sidekiq) as the idempotency key for the job run. The idempotency key is what is used to guarantee that no two runs of the same job occur. However, sometimes we need particular jobs to be idempotent based on some other criteria. In these cases, `AcidicJob` provides a collection of tools to allow you to ensure the idempotency of your jobs.
+
+Firstly, you can configure your job class to explicitly use either the job identifier or the job arguments as the foundation for the idempotency key. A job class that calls the `acidic_by_job_id` class method (which is the default behavior) will simply make the job run's idempotency key the job's identifier:
+
+```ruby
+class ExampleJob < AcidicJob::Base
+  acidic_by_job_id
+
+  def perform
+  end
+end
+```
+
+Conversely, a job class can use the `acidic_by_job_args` method to configure that job class to use the arguments passed to the job as the foundation for the job run's idempotency key:
+
+```ruby
+class ExampleJob < AcidicJob::Base
+  acidic_by_job_args
+
+  def perform(arg_1, arg_2)
+    # the idempotency key will be based on whatever the values of `arg_1` and `arg_2` are
+  end
+end
+```
+
+These options cover the two common situations, but sometimes our systems need finer-grained control. For example, our job might take some record as the job argument, but we need to use a combination of the record identifier and record status as the foundation for the idempotency key. In these cases you can pass a `Proc` to an `acidic_by` class method:
+
+```ruby
+class ExampleJob < AcidicJob::Base
+  acidic_by -> { [@record.id, @record.status] }
+
+  def perform(record:)
+    @record = record
+
+    # the idempotency key will be based on whatever the values of `@record.id` and `@record.status` are
+    with_acidic_workflow do |workflow|
+      workflow.step :do_something
+    end
   end
 end
 ```
 
+> **Note:** The `acidic_by` proc _will be executed in the context of the job instance_ at the moment the `with_acidic_workflow` method is called. This means it will have access to any instance variables defined in your `perform` method up to that point.
+
+
 ### Sidekiq Callbacks
 
-In order to ensure that `AcidicJob::Staged` records are only destroyed once the related job has been successfully performed, whether it is an ActiveJob or a Sidekiq Worker, `acidic_job` also extends Sidekiq to support the [ActiveJob callback interface](https://edgeguides.rubyonrails.org/active_job_basics.html#callbacks).
+In order to ensure that staged `AcidicJob::Run` records are only destroyed once the related job has been successfully performed, whether it is an ActiveJob or a Sidekiq Worker, `AcidicJob` also extends Sidekiq to support the [ActiveJob callback interface](https://edgeguides.rubyonrails.org/active_job_basics.html#callbacks).
+
+This allows us to use an `after_perform` callback to delete the `AcidicJob::Run` record, whether you are using the gem with ActiveJob or pure Sidekiq Workers. Of course, this means that you can add your own callbacks to any jobs or workers that include the `AcidicJob` module as well.
 
-This allows `acidic_job` to use an `after_perform` callback to delete the `AcidicJob::Staged` record, whether you are using the gem with ActiveJob or pure Sidekiq Workers. Of course, this means that you can add your own callbacks to any jobs or workers that include the `AcidicJob` module as well.
 
-### Sidekiq Batches
+### Run Finished Callbacks
 
-One final feature for those of you using Sidekiq Pro: an integrated DSL for Sidekiq Batches. By simply adding the `awaits` option to your step declarations, you can attach any number of additional, asynchronous workers to your step. This is profoundly powerful, as it means that you can define a workflow where step 2 is started _if and only if_ step 1 succeeds, but step 1 can have 3 different workers enqueued on 3 different queues, each running in parallel. Once all 3 workers succeed, `acidic_job` will move on to step 2. That's right, by leveraging the power of Sidekiq Batches, you can have workers that are executed in parallel, on separate queues, and asynchronously, but are still blocking—as a group—the next step in your workflow! This unlocks incredible power and flexibility for defining and structuring complex workflows and operations, and in my mind is the number one selling point for Sidekiq Pro.
+When working with workflow jobs that make use of the `awaits` feature for a step, it is important to remember that the `after_perform` callback will be called _as soon as the first `awaits` step has enqueued job_, and **not** when the entire job run has finished. `AcidicJob` allows the `perform` method to finish so that the queue for the workflow job is cleared to pick up new work while the `awaits` jobs are running. `AcidicJob` will automatically re-enqueue the workflow job and progress to the next step when all of the `awaits` jobs have successfully finished. However, this means that `after_perform` **is not necessarily** the same as `after_finish`. In order to provide the opportunity for you to execute callback logic _if and only if_ a job run has finished, we provide callback hooks for the `finish` event.
 
-In my opinion, any commercial software using Sidekiq should get Sidekiq Pro; it is _absolutely_ worth the money. If, however, you are using `acidic_job` in a non-commercial application, you could use the open-source dropin replacement for this functionality: https://github.com/breamware/sidekiq-batch
+For example, you could use this hook to immediately clean up the `AcidicJob::Run` database record whenever the workflow job finishes successfully like so:
+
+```ruby
+class RideCreateJob < AcidicJob::Base
+  set_callback :finish, :after, :delete_run_record
+
+  def perform(user_id, ride_params)
+    @user = User.find(user_id)
+    @params = ride_params
+
+    with_acidic_workflow persisting: { ride: nil } do |workflow|
+      step :create_ride_and_audit_record, awaits: [SomeJob.with('argument_1', keyword: 'value')]
+      step :create_stripe_charge, args: [1, 2, 3], kwargs: { some: 'thing' }
+      step :send_receipt
+    end
+  end
+
+  private
+
+  def delete_run_record
+    return unless acidic_job_run.succeeded?
+
+    acidic_job_run.destroy!
+  end
+end
+```
+
+
+## Testing
+
+When testing acidic jobs, you are likely to run into `ActiveRecord::TransactionIsolationError`s:
+
+```
+ActiveRecord::TransactionIsolationError: cannot set transaction isolation in a nested transaction
+```
+
+This error is thrown because by default RSpec and most MiniTest test suites use database transactions to keep the test database clean between tests. The database transaction that is wrapping all of the code executed in your test is run at the standard isolation level, but `AcidicJob` then tries to create another transaction at a more conservative isolation level. You cannot have a nested transaction that runs at a different isolation level, thus, this error. 
+
+In order to avoid this error, you need to ensure firstly that your tests that run your acidic jobs are not using a database transaction and secondly that they use some different strategy to keep your test database clean. The [DatabaseCleaner](https://github.com/DatabaseCleaner/database_cleaner) gem is a commonly used tool to manage different strategies for keeping your test database clean. As for which strategy to use, `truncation` and `deletion` are both safe, but their speed varies based on our app's table structure (see https://github.com/DatabaseCleaner/database_cleaner#what-strategy-is-fastest). Either is fine; use whichever is faster for your app.
+
+In order to make this test setup simpler, `AcidicJob` provides a `Testing` module that your job tests can include. It is simple; it sets `use_transactional_tests` to `false` (if the test is an `ActiveJob::TestCase`), and ensures a transaction-safe `DatabaseCleaner` strategy is run for each of your tests. Moreover, it ensures that the system's original DatabaseCleaner configuration is maintained, options included, except that any `transaction` strategies for any ORMs are replaced with a `deletion` strategy. It does so by storing whatever the system DatabaseCleaner configuration is at the start of `before_setup` phase in an instance variable and then restores that configuration at the end of `after_teardown` phase. In between, it runs the configuration thru a pipeline that selectively replaces any `transaction` strategies with a corresponding `deletion` strategy, leaving any other configured strategies untouched.
+
+For those of you using RSpec, you can require the `acidic_job/rspec_configuration` file, which will configure RSpec in the exact same way I have used in my RSpec projects to allow me to test acidic jobs with either the `deletion` strategy but still have all of my other tests use the fast `transaction` strategy:
+
+```ruby
+require "database_cleaner/active_record"
+
+# see https://github.com/DatabaseCleaner/database_cleaner#how-to-use
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with :truncation
+
+    # Here we are defaulting to :transaction but swapping to deletion for some specs;
+    # if your spec or its code-under-test uses
+    # nested transactions then specify :transactional e.g.:
+    #   describe "SomeWorker", :transactional do
+    #
+    DatabaseCleaner.strategy = :transaction
+
+    config.before(:context, transactional: true) { DatabaseCleaner.strategy = :deletion }
+    config.after(:context, transactional: true) { DatabaseCleaner.strategy = :transaction }
+    config.before(:context, type: :system) { DatabaseCleaner.strategy = :deletion }
+    config.after(:context, type: :system) { DatabaseCleaner.strategy = :transaction }
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end
+```
 
 ## Development
 

data/UPGRADE_GUIDE.md

@@ -0,0 +1,81 @@
+# 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

@@ -27,10 +27,23 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 4.0.0"
+  spec.add_dependency "activejob"
+  spec.add_dependency "activerecord"
   spec.add_dependency "activesupport"
-  spec.add_development_dependency "railties", ">= 4.0"
+  spec.add_development_dependency "combustion"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "net-smtp"
+  spec.add_development_dependency "noticed"
+  spec.add_development_dependency "railties"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-minitest"
+  spec.add_development_dependency "rubocop-rake"
+  spec.add_development_dependency "sidekiq"
+  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

@@ -3,12 +3,15 @@
 
 require "bundler/setup"
 require "acidic_job"
-require_relative "../test/support/setup"
-require_relative "../test/support/ride_create_job"
 
 # 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
+
 # (If you use this, don't forget to add pry to your Gemfile!)
 # require "pry"
 # Pry.start

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

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,10 @@
+# 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: "../"