stepped 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 138ce466c572a466794672101dcfeb6b42d8ac5d8e58b549692e0465fd5ea6ac
-  data.tar.gz: 75da7a33df486ea1bf72b468c81f2525a6ab9ea43d7bd2e3f7efc6bdfef2a561
+  metadata.gz: '0687ebc619500dd18bf435c8fb6a67a5523590b811bb51c6f8532f1411ebd93a'
+  data.tar.gz: 68d54113a3ef201aad85b083378848bfa633c5f5bbe41cdcd52e2a63a6b10f03
 SHA512:
-  metadata.gz: eb388ce39925a70731058f168a48f89a35565df3fa6c4368b89f4223c1ca1a709e56f86488c07a55d4d04f6078024f011db0a6a36276bee696f7dfefe655ddb6
-  data.tar.gz: ea2c14f6535dfe84f20fedbe887f27a0eede205e0547a92c6fecd79a8f461c6df365be43253ed27394c54c00b08e5e26d85587bcb60d01a6dc8ad205d20b51fa
+  metadata.gz: f975911ec89661747af26a32e98063e0e7c567a18c0d08e9f7113f7623cdba777a32a9e98af656612418a2e7640a9bbbe8bef3e415eb3f0189cd97bfbc54175e
+  data.tar.gz: 90064479821a90ff7d2c13c2925f6903e962987092b25ae23985d525e1e79acd2b63a4a28a12b5b9024913e1898918ade9f0c2c2c8870c6ec768e45e43dbd5e7

data/README.md

@@ -1 +1,313 @@
 # Stepped Actions
+
+Stepped is a Rails engine for orchestrating complex workflows as a tree of actions. Each action is persisted, runs through Active Job, and can fan out into more actions while keeping the parent action moving step-by-step as dependencies complete.
+
+The core ideas are:
+
+- **Action trees**: define a root action with multiple steps; each step can enqueue more actions and the step completes only once all the actions within it complete.
+- **Concurrency lanes**: actions with the same `concurrency_key` share a `Stepped::Performance`, so only one runs at a time while others queue up (with automatic superseding of older queued work).
+- **Reuse**: optional `checksum` lets Stepped skip work that is already achieved, or share a currently-performing action with multiple parents.
+- **Outbound completion**: actions can be marked outbound (or implemented as a job) and completed later by an external event.
+
+## Installation
+
+Add Stepped to your application (Rails `>= 8.1.1`):
+
+```ruby
+gem "stepped"
+```
+
+Then install and run the migrations:
+
+```bash
+bundle install
+bin/rails stepped:install
+bin/rails db:migrate
+```
+
+## Quick start
+
+Stepped hooks into Active Record automatically, so any model can declare actions.
+
+If you define an action without steps, Stepped generates a single step that calls the instance method with the same name:
+
+```ruby
+class Car < ApplicationRecord
+  stepped_action :drive
+
+  def drive(miles)
+    update!(mileage: mileage + miles)
+  end
+end
+
+car = Car.find(1)
+car.drive_later(5) # enqueues Stepped::ActionJob
+car.drive_now(5)   # runs synchronously (still uses the Stepped state machine)
+```
+
+Calling `*_now`/`*_later` creates a `Stepped::Action` and a `Stepped::Step` record behind the scenes. If the action finishes immediately, the associated `Stepped::Performance` (the concurrency “lane”) is created and destroyed within the same run. If the action is short-circuited (for example, cancelled/completed in `before`, or skipped due to a matching achievement), Stepped returns an action instance but does not create any database rows.
+
+## Concepts
+
+An action is represented by `Stepped::Action` (statuses include `pending`, `performing`, `succeeded`, `failed`, `cancelled`, `superseded`, `timed_out`, and `deadlocked`). Each action executes one step at a time; steps are stored in `Stepped::Step` and complete when all of their dependencies finish.
+
+Actions that share a `concurrency_key` are grouped under a `Stepped::Performance`. A performance behaves like a single-file queue: the current action performs, later actions wait as `pending`, and when the current action completes the performance advances to the next incomplete action.
+
+If you opt into reuse, successful actions write a `Stepped::Achievement` keyed by `checksum`. When an action is invoked again with the same `checksum`, Stepped can skip the work entirely.
+
+## Defining actions
+
+Define an action on an Active Record model with `stepped_action`. The block is a small DSL that lets you specify steps, hooks, and keys:
+
+```ruby
+class Car < ApplicationRecord
+  stepped_action :visit do
+    step do |step, location|
+      step.do :change_location, location
+    end
+
+    succeeded do
+      update!(last_visited_at: Time.current)
+    end
+  end
+
+  def change_location(location)
+    update!(location:)
+  end
+end
+```
+
+### Steps and action trees
+
+Each `step` block runs in the actor’s context (`self` is the model instance) and receives `(step, *arguments)`. Inside a step you typically enqueue more actions:
+
+```ruby
+stepped_action :park do
+  step do
+    honk
+  end
+
+  step do |step, miles|
+    step.do :honk
+    step.on [self, nil], :drive, miles
+  end
+end
+```
+
+`step.do` is shorthand for “run another action on the same actor”. `step.on` accepts a single actor or an array of actors; `nil` values are ignored. If a step enqueues work, the parent action will remain `performing` until those child actions finish and report back.
+
+To deliberately fail a step without raising, set `step.status = :failed` inside the step body.
+
+The code within the `step` block runs within the model instance context. Therefore you have flexibility to write any model code within this block, not just invoking actions.
+
+### Waiting
+
+Steps can also enqueue a timed wait:
+
+```ruby
+stepped_action :stopover do
+  step { |step| step.wait 5.seconds }
+  step { honk }
+end
+```
+
+### Before hooks and argument mutation
+
+`before` runs once, before any steps are performed. It can mutate `action.arguments`, or cancel/complete the action early:
+
+```ruby
+stepped_action :multiplied_drive do
+  before do |action, distance|
+    action.arguments = [distance * 2]
+  end
+
+  step do |step, distance|
+    step.do :drive, distance
+  end
+end
+```
+
+The checksum (if you define one) is computed after `before`, so it sees the updated arguments.
+
+### After callbacks
+
+After callbacks run when the action is completed. You can attach them inline (`succeeded`, `failed`, `cancelled`, `timed_out`) or later from elsewhere with `after_stepped_action`:
+
+```ruby
+Car.stepped_action :drive, outbound: true do
+  after :cancelled, :failed, :timed_out do
+    honk
+  end
+end
+
+Car.after_stepped_action :drive, :succeeded do |action, miles|
+  Rails.logger.info("Drove #{miles} miles")
+end
+```
+
+If an after callback raises and you’ve configured Stepped to handle that exception class, the action status is preserved but the callback is counted as failed and the action will not grant an achievement.
+
+## Concurrency, queueing, and superseding
+
+Every action runs under a `concurrency_key`. Actions with the same key share a performance and therefore run one-at-a-time, in order.
+
+By default, the key is scoped to the actor and action name (for example `Car/123/visit`). You can override it with `concurrency_key` to coordinate across records or across different actions:
+
+```ruby
+stepped_action :recycle, outbound: true do
+  concurrency_key { "Car/maintenance" }
+end
+
+stepped_action :paint, outbound: true do
+  concurrency_key { "Car/maintenance" }
+end
+```
+
+While one action is `performing`, later actions with the same key are queued as `pending`. If multiple pending actions build up, Stepped supersedes older pending actions in favor of the newest one, and transfers any parent-step dependencies to the newest action so waiting steps don’t get stuck.
+
+Stepped also protects you from deadlocks: if a descendant action tries to join the same `concurrency_key` as one of its ancestors, it is marked `deadlocked` and its parent step will fail.
+
+## Checksums and reuse (Achievements)
+
+Reuse is opt-in per action via `checksum`. When a checksum is present, Stepped stores the last successful checksum in `Stepped::Achievement` under `checksum_key` (which defaults to the action’s tenancy key).
+
+```ruby
+stepped_action :visit do
+  checksum { |location| location }
+
+  step do |step, location|
+    step.do :change_location, location
+  end
+end
+```
+
+With a checksum in place:
+
+1. If you invoke an action while an identical checksum is already performing under the same concurrency lane, Stepped returns the existing performing action and attaches the new parent step to it.
+2. If an identical checksum has already succeeded (an achievement exists), Stepped returns a `succeeded` action immediately without creating new records.
+3. If the checksum changes, Stepped performs the action and updates the stored achievement to the new checksum.
+
+Use `checksum_key` to control the scope of reuse. Returning an array joins parts with `/`:
+
+```ruby
+checksum_key { ["Car", "visit"] } # shared across all cars
+```
+
+## Outbound actions and external completion
+
+An outbound action runs its steps but does not complete automatically when the final step finishes. It stays `performing` until you explicitly complete it (for example, from a webhook handler or another system):
+
+```ruby
+stepped_action :charge_card, outbound: true do
+  step do |step, amount_cents|
+    # enqueue calls to external systems here
+  end
+end
+
+user.charge_card_later(1500)
+user.complete_stepped_action_later(:charge_card, :succeeded)
+```
+
+Under the hood, completion forwards to the current outbound action for that actor+name and advances its performance queue.
+
+## Job-backed actions
+
+If you prefer to implement an action as an Active Job, declare it with `job:`. Job-backed actions are treated as outbound and are expected to call `action.complete!` when finished:
+
+```ruby
+class TowJob < ActiveJob::Base
+  def perform(action)
+    car = action.actor
+    location = action.arguments.first
+    car.update!(location:)
+
+    action.complete!
+  end
+end
+
+class Car < ApplicationRecord
+  stepped_action :tow, job: TowJob
+end
+```
+
+You can extend existing actions (including job-backed ones) by prepending steps:
+
+```ruby
+Car.prepend_stepped_action_step :tow do
+  honk
+end
+```
+
+## Timeouts
+
+Set `timeout:` to enqueue a `Stepped::TimeoutJob` when the action starts. If the action is still `performing` after the timeout elapses, it completes as `timed_out`:
+
+```ruby
+stepped_action :change_location, outbound: true, timeout: 5.seconds
+```
+
+Timeouts propagate through the tree: a timed-out nested action fails its parent step, which fails the parent action.
+
+## Exception handling
+
+Stepped can either raise exceptions (letting your job backend retry) or treat specific exception classes as handled and turn them into action failure.
+
+Configure the handled exception classes in your application:
+
+```ruby
+# config/initializers/stepped.rb (or an environment file)
+Stepped::Engine.config.stepped_actions.handle_exceptions = [StandardError]
+```
+
+When an exception is handled, Stepped reports it via `Rails.error.report` and marks the action/step as `failed` instead of raising.
+
+## Testing
+
+Stepped ships with `Stepped::TestHelper` (require `"stepped/test_helper"`) which builds on Active Job’s test helpers to make it easy to drain the full action tree.
+
+```ruby
+# test/test_helper.rb
+require "stepped/test_helper"
+
+class ActiveSupport::TestCase
+  include ActiveJob::TestHelper
+  include Stepped::TestHelper
+
+  # If your workflows include outbound actions, complete them here so
+  # `perform_stepped_actions` can fully drain the tree.
+  def complete_stepped_outbound_performances
+    Stepped::Performance.outbounds.includes(:action).find_each do |performance|
+      action = performance.action
+      Stepped::Performance.outbound_complete(action.actor, action.name, :succeeded)
+    end
+  end
+end
+```
+
+In a test, you can perform Stepped jobs recursively:
+
+```ruby
+car.visit_later("London")
+perform_stepped_actions
+```
+
+To test failure behavior without bubbling exceptions, you can temporarily mark exception classes as handled:
+
+```ruby
+handle_stepped_action_exceptions(only: [StandardError]) do
+  car.visit_now("London")
+end
+```
+
+## Development
+
+Run the test suite:
+
+```sh
+bin/rails db:test:prepare
+bin/rails test
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"

data/app/jobs/stepped/action_job.rb

@@ -0,0 +1,10 @@
+class Stepped::ActionJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(actor, name, *arguments, parent_step: nil)
+    root = parent_step.nil?
+    action = Stepped::Action.new(actor:, name:, arguments:, root:)
+    action.parent_steps << parent_step if parent_step.present?
+    action.obtain_lock_and_perform
+  end
+end

data/app/jobs/stepped/complete_action_job.rb

@@ -0,0 +1,7 @@
+class Stepped::CompleteActionJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(actor, name, status = :succeeded)
+    Stepped::Performance.outbound_complete(actor, name, status)
+  end
+end

data/app/jobs/stepped/timeout_job.rb

@@ -0,0 +1,11 @@
+class Stepped::TimeoutJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(action)
+    return unless action.performing?
+
+    if action.started_at < action.timeout.ago
+      action.complete!(:timed_out)
+    end
+  end
+end

data/app/jobs/stepped/wait_job.rb

@@ -0,0 +1,7 @@
+class Stepped::WaitJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(step)
+    step.conclude_job
+  end
+end

data/app/models/concerns/stepped/actionable.rb

@@ -0,0 +1,37 @@
+module Stepped::Actionable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def stepped_action(name, outbound: false, timeout: nil, job: nil, &block)
+      Stepped::Registry.add(self, name, outbound:, timeout:, job:, &block)
+
+      define_method "#{name}_now" do |*arguments|
+        Stepped::ActionJob.perform_now(self, name, *arguments)
+      end
+
+      define_method "#{name}_later" do |*arguments|
+        Stepped::ActionJob.perform_later(self, name, *arguments)
+      end
+    end
+
+    def prepend_stepped_action_step(name, &step_block)
+      Stepped::Registry.prepend_step(self, name, &step_block)
+    end
+
+    def after_stepped_action(action_name, *statuses, &block)
+      Stepped::Registry.append_after_callback(self, action_name, *statuses, &block)
+    end
+  end
+
+  def stepped_action_tenancy_key(action_name)
+    [ self.class.name, id, action_name ].join("/")
+  end
+
+  def complete_stepped_action_now(name, status = :succeeded)
+    Stepped::CompleteActionJob.perform_now self, name, status
+  end
+
+  def complete_stepped_action_later(name, status = :succeeded)
+    Stepped::CompleteActionJob.perform_later self, name, status
+  end
+end

data/app/models/stepped/achievement.rb

@@ -0,0 +1,25 @@
+class Stepped::Achievement < ActiveRecord::Base
+  class << self
+    def exists_for?(action)
+      return false if action.checksum.nil?
+
+      exists? action.attributes.slice("checksum_key", "checksum")
+    end
+
+    def raise_if_exists_for?(action)
+      if exists_for?(action)
+        raise ExistsError
+      end
+    end
+
+    def grand_to(action)
+      create! action.attributes.slice("checksum_key", "checksum")
+    end
+
+    def erase_of(action)
+      where(action.attributes.slice("checksum_key")).destroy_all
+    end
+  end
+
+  class ExistsError < StandardError; end
+end