acidic_job 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb1de28508c8a662b772a9b9f8fb4046d8c2a64e242826ec92c1ecc820dbc18b
-  data.tar.gz: a0db4307ec7d7c971d9a5e1ff30ccb2243afa9ea35a7f17fe91f8c81d775a52b
+  metadata.gz: 1c51b3ed20bebb6322ab050f122c83d863fe16436e302b61f91eea84fd9cc117
+  data.tar.gz: 7f65a1d6c99d23930c4730557388833b3ebd277117394b18d6665978bf35119d
 SHA512:
-  metadata.gz: 0e39981533a09f2f197f8c047d057328be88c5a34666bd8520500a805bee7fb4d86ac74fdebe673cd67fe92c3faff072a3d62eef79e4e14b21ffdfb05b292e2b
-  data.tar.gz: b2eb0c3c2fe92b27fc065fc0a450261743b3b6b397c2212e1b46ed4773074342c64c8433930b71f4125a71b9c692f5baa1d29b3ec9d9fc6ac13905c1fe4e2d2f
+  metadata.gz: 3a1910297ba003ca354ede4dd5312d12af4f6662d8cb0eca451f4f01e51ba54d80f3f27632785d2ba7c69d5504da042861d122c7a81356d19ca04046097928cd
+  data.tar.gz: 6d57ce3ec53d5ed22bfd91f284611c505400ad7f524f0fbfe0bec4fbf335e94fd4c91781248980342d127186c5973dfed9cd32011c2e6b2e1c6ea72531247f87

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acidic_job (0.1.4)
+    acidic_job (0.1.5)
       activesupport
 
 GEM

data/README.md

@@ -1,8 +1,25 @@
 # AcidicJob
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/acidic_job`. To experiment with that code, run `bin/console` for an interactive prompt.
+### Idempotent operations for Rails apps, built on top of ActiveJob.
 
-TODO: Delete this and the text above, and describe your gem
+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`. With `ActiveJob`, 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 seemlessly.
+
+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):
+
+>As a general rule, a worker can be considered idempotent if:
+>  * It can safely run multiple times with the same arguments.
+>  * Application side-effects are expected to happen only once (or side-effects of a second run do not have an effect).
+
+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
+
+`AcididJob` brings these techniques and principles into the world of a standard Rails application.
 
 ## Installation
 
@@ -20,9 +37,45 @@ Or install it yourself as:
 
     $ gem install acidic_job
 
+Then, use the following command to copy over the AcidicJobKey migration.
+
+```
+rails generate acidic_job:key
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+`AcidicJob` is a concern that you `include` into your operation jobs which provides two public methods to help you make your jobs idempotent and robust—`idempotently` and `step`. You can see them "in action" in the example job below:
+
+```ruby
+class RideCreateJob < ActiveJob::Base
+  include AcidicJob
+
+  def perform(ride_params)
+    idempotently with: { user: current_user, params: ride_params, ride: nil } do
+      step :create_ride_and_audit_record
+      step :create_stripe_charge
+      step :send_receipt
+    end
+  end
+
+  def create_ride_and_audit_record
+    # ...
+  end
+
+  def create_stripe_charge
+    # ...
+  end
+
+  def send_receipt
+    # ...
+  end
+end
+```
+
+`idempotently` takes only the `with:` 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!
+
+So, how does `AcidicJob` make this operation idempotent and robust then? In simplest form, `AcidicJob` creates an "idempotency key" record for each job run, where it stores information about that job run, like the parameters passed in and the step the job is on. It then wraps each of your step methods in a database transaction to ensure that each step in the operation is transactionally secure. Finally, it handles a variety of edge-cases and error conditions for you as well. But, basically, by explicitly breaking your operation into steps and storing a record of each job run and updating its current step as it runs, we level up the `ActiveJob` retry mechanism to ensure that we don't retry already finished steps if something goes wrong and the job has to retry. Then, by wrapping each step in a transaction, we ensure each individual step is ACIDic. Taken together, these two strategies help us to ensure that our operational jobs are both idempotent and ACIDic.
 
 ## Development
 

data/lib/acidic_job.rb

@@ -37,18 +37,6 @@ module AcidicJob
     # retry_on ActiveRecord::SerializationFailure
   end
 
-  class_methods do
-    def required(*names)
-      required_attributes.push(*names)
-    end
-
-    def required_attributes
-      return @required_attributes if instance_variable_defined?(:@required_attributes)
-
-      @required_attributes = []
-    end
-  end
-
   # Number of seconds passed which we consider a held idempotency key lock to be
   # defunct and eligible to be locked again by a different API call. We try to
   # unlock keys on our various failure conditions, but software is buggy, and
@@ -67,8 +55,6 @@ module AcidicJob
     # to the step methods the job will have written
     define_accessors_for_passed_arguments(with)
 
-    validate_passed_arguments(with)
-
     # execute the block to gather the info on what phases are defined for this job
     defined_steps = yield
 
@@ -77,7 +63,7 @@ module AcidicJob
 
     # find or create an AcidicJobKey record to store all information about this job
     # side-effect: will set the @key instance variable
-    ensure_idempotency_key_record(job_id, with[:params], defined_steps.first)
+    ensure_idempotency_key_record(job_id, with, defined_steps.first)
 
     # if the key record is already marked as finished, immediately return its result
     return @key.succeeded? if @key.finished?
@@ -135,7 +121,7 @@ module AcidicJob
     end
   end
 
-  def ensure_idempotency_key_record(key_val, params, first_step)
+  def ensure_idempotency_key_record(key_val, job_args, first_step)
     # isolation_level = case ActiveRecord::Base.connection.adapter_name.downcase.to_sym
     #                   when :sqlite
     #                     :read_uncommitted
@@ -150,7 +136,7 @@ module AcidicJob
       if @key
         # Programs enqueuing multiple jobs with different parameters but the
         # same idempotency key is a bug.
-        raise MismatchedIdempotencyKeyAndJobArguments if @key.job_args != params.as_json
+        raise MismatchedIdempotencyKeyAndJobArguments if @key.job_args != job_args.as_json
 
         # Only acquire a lock if the key is unlocked or its lock has expired
         # because the original job was long enough ago.
@@ -166,7 +152,7 @@ module AcidicJob
           last_run_at: Time.current,
           recovery_point: first_step,
           job_name: self.class.name,
-          job_args: params.as_json
+          job_args: job_args.as_json
         )
       end
     end
@@ -183,17 +169,6 @@ module AcidicJob
     true
   end
 
-  def validate_passed_arguments(attributes)
-    missing_attributes = self.class.required_attributes.select do |required_attribute|
-      attributes[required_attribute].nil?
-    end
-
-    return if missing_attributes.empty?
-
-    raise MissingRequiredAttribute,
-          "The following required job parameters are missing: #{missing_attributes.to_sentence}"
-  end
-
   def define_atomic_phases(defined_steps)
     defined_steps << :FINISHED
 

data/lib/acidic_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AcidicJob
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acidic_job
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - fractaledmind
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport