geneva_drive 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd1756c2bb26aeb5fcf15ef77232f06314335ce3427aa6053085476e3cd78042
-  data.tar.gz: 0a445074432320b0040d6e9c69f6b77586cd3275a7bbf034096a5ef0dedc3334
+  metadata.gz: b415480aa40bc610a79bdc6802a636d70ac54dd6adddbd3d8b44d8afbb4a1e44
+  data.tar.gz: a7e729983cf52ad726d12ea83661b17da8d34413b03a8f349919e342dbfdac52
 SHA512:
-  metadata.gz: 1113718f861068971a284fcfd54ccabb2b9cdfc3fb7bbff6a75d505f9d5741ba0cdcbe0b3ce62d50b4441d5be8901e505d68bef2e95e197d7c00d7297a27e8b6
-  data.tar.gz: bbc4dc5c73a5c77d19725b60c2951fa1a7d4192cf97739d3cda4f021c4d892e05458df5feb6313372541d1f2a36e840ca51dfe7add125bb0b215cc5d9539392f
+  metadata.gz: 1c8c27663ca3f19cb671b0c5c16c62c96487059f823ce5a9dfc35a4366a31d01582ba9ced0fc4140f6fba542e0ede4046b0b5f92518555b1fac575875440fb71
+  data.tar.gz: b5d56f17405a2e032b3ef4f977bd38dc7dc071a7d2160811b996dabe0301bf6275ebb9c0b23aaee4c5cfce86403d8e76ce8b438e716bddd022d02248e9b95b5b

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## Unreleased
+
+## [0.9.0]
+
+- Run on Sidekiq without Active Job. `GenevaDrive.dispatcher = :sidekiq` pushes every step as `GenevaDrive::SidekiqPerformStepJob`, a plain `Sidekiq::Job` carrying the step execution id, through `Sidekiq::Client`. Client middleware applies, the jid lands in `job_id`, and jobs are tagged with the workflow class. Supported are Sidekiq 7.3 and later 7.x, and 8.x; with any other version the dispatcher raises at boot. The default dispatcher is still `:active_job`.
+- Sidekiq retries are off for step jobs, since exception policies already decide reattempts. The step's exception is still raised, so Sidekiq's error handlers report it.
+- The Sidekiq dispatcher pushes synchronously, bypassing `Sidekiq.transactional_push!`, which would defer the push a second time from inside GenevaDrive's own after-commit callback - the double deferral already fixed for Solid Queue.
+- `priority:` in job options raises under the Sidekiq dispatcher, as Sidekiq has queues with weights rather than priorities.
+- Add `GenevaDrive::SidekiqHousekeepingJob` for running housekeeping from Sidekiq Enterprise periodic jobs or sidekiq-cron.
+- The install generator writes `GenevaDrive.dispatcher = :sidekiq` into a new initializer when Active Job's adapter is `:sidekiq`. Nothing is detected at boot, so upgrading never switches an existing app.
+- `resume!` now records the id of the job it pushes for an execution that was paused while scheduled. The row used to keep the previous job's id, which could already have run and done nothing, so the job behind the execution could not be found from it.
+- Fix resumable steps not handing off when Sidekiq shuts down. The executor asked `Sidekiq::CLI.instance.stopping?`, a method the CLI does not have (only its launcher does), so inside a `sidekiq` process every interruption check of a resumable step raised `NoMethodError`. The engine now subscribes to Sidekiq's `:quiet` event, which fires on TSTP (what Enterprise rolling restarts send first) and at the start of every shutdown, and resumable steps checkpoint and continue in a successor execution. This applies with either dispatcher, including Active Job on the Sidekiq adapter.
+- Create `hero_id` as a string column when the application's tables use string primary keys. Key type detection only recognized `uuid`, `char(36)` and `varchar(36)` id columns, but on SQLite an `id: :string` table (for example with `primary_key_type: :string` and UUIDv7 ids) reports a bare `varchar` with no length. Detection fell through to `:bigint`, the workflows migration created an integer `hero_id`, and every string hero id was silently cast to an integer on assignment, pointing workflows at the wrong hero and colliding in the ongoing-uniqueness index. The workflows migration now uses a separate `geneva_drive_hero_key_type` helper that returns `:uuid`, `:string` or `:bigint` and treats `varchar`/`char(n)`/`text` ids of any length as string keys. GenevaDrive's own tables keep their bigint ids. Existing installs affected by this need to change `hero_id` to a string column themselves.
+
 ## [0.8.0]
 
 - Add `removed_step :name` for taking a step out of a workflow that has instances in flight. Deleting a `step` outright strands every workflow holding a scheduled execution for it: the executor finds no definition and pauses with `StepNotDefinedError`, which during a rolling deploy can hit every workflow sitting on that step at once. The gem cannot recover from this on its own — it knows the step is gone, but not whether the steps after it were ever meant to run, and a step's position says nothing about reachability (a `capture_payment` that normally ends the workflow by calling `finished!` sits directly before `refund`, so skipping forward would refund a payment that was never captured). `removed_step` is how the author of the removal records that judgement in advance: declared in the position the step used to occupy, it keeps the name resolvable so executions scheduled before the removal are skipped and the workflow continues to the next runnable step, while scheduling never spools an execution for the name again and `before_step:`/`after_step:` references keep working. An execution parked on the step waiting for a signal is released on `resume!` rather than waiting for an event that can no longer match. `Workflow.removed_steps_in_flight` reports which gravestones step execution rows still reference (ignoring finished and canceled workflows), so a `removed_step` line can be deleted once it comes back empty. The default for an undeclared removal is unchanged: the workflow still pauses.

data/MANUAL.md

@@ -85,6 +85,8 @@ If your application uses UUID primary keys, the migrations will detect this and
 
 Note that you don't want to mix integer IDs and UUIDs in the same application. geneva_drive uses a polymorphic relation for the `hero` of the workflow, which has a typed `hero_id` column. You will thus want either all of your models to be used as heroes to have UUID primary keys or bigint primary keys, but not mix the two.
 
+String primary keys (`id: :string`, for example with `primary_key_type: :string` in your generator config) are detected too: `hero_id` is then created as a string column, while the geneva_drive tables themselves keep bigint ids. If detection picks the wrong type for your heroes, edit the `hero_id` column in the generated workflows migration before running it.
+
 > [!WARNING]
 > If you are using UUIDs, we also strongly recommend adopting a lexicographically ordered UUID flavour, at least for the geneva_drive tables. Such flavours include [UUIDv7](https://github.com/seouri/rails-uuid-pk) and [tou](https://github.com/cheddar-me/tou) - you will want your primary keys to be pre-sorted for using the admin effectively, as well as for efficient `find_each` usage with the geneva_drive tables.
 
@@ -700,7 +702,7 @@ A step is interrupted when any of these happen:
 
 - `max_iterations:` is reached (`resumable_step :import, max_iterations: 10_000`)
 - `max_runtime:` is exceeded (`resumable_step :import, max_runtime: 5.minutes`)
-- The job queue signals shutdown (e.g. Sidekiq stopping)
+- The job queue signals shutdown (Sidekiq going quiet or stopping — see [Shutdowns and rolling restarts](#shutdowns-and-rolling-restarts))
 - The workflow is paused or canceled externally
 - The step calls `skip_to!` or `suspend!` explicitly
 
@@ -1583,7 +1585,7 @@ We recommend using a queue adapter that co-commits with your database:
 
 Co-committing matters because GenevaDrive relies on transactional guarantees. When a step completes and schedules the next step, both the state change and the job enqueue should be atomic. With co-committing adapters, if the transaction rolls back, the job is never enqueued.
 
-With non-transactional adapters (Sidekiq, Resque), there's a small window where the job is enqueued but the transaction hasn't committed. GenevaDrive handles this gracefully — the job will see the step execution in the wrong state and skip it — but you may see occasional log warnings.
+With a non-transactional adapter such as Resque, or Sidekiq behind Active Job, the job and the database are two systems, and the step execution row is what makes that safe: GenevaDrive enqueues only after the row has committed, and housekeeping re-enqueues any execution whose job got lost on the way. If your app writes Sidekiq jobs rather than Active Job ones, you do not have to go through Active Job at all — see [Running on Sidekiq](#running-on-sidekiq).
 
 ### Inline Enqueueing for Bulk Operations
 
@@ -1621,7 +1623,7 @@ The method is thread-safe and won't affect other concurrent requests.
 
 ### Custom Job Options
 
-You can override the Active Job settings used to enqueue a workflow's step jobs at three levels: for the entire workflow class, for an individual step, or for a specific workflow instance. All three accept the same keys that Active Job's `set` method understands: `:queue`, `:priority`, `:wait`, and `:wait_until`. Unknown keys are rejected at configuration time so that typos surface immediately instead of silently falling back to defaults.
+You can override the Active Job settings used to enqueue a workflow's step jobs at three levels: for the entire workflow class, for an individual step, or for a specific workflow instance. All three accept the same keys that Active Job's `set` method understands: `:queue`, `:priority`, `:wait`, and `:wait_until`. (On the Sidekiq dispatcher `:priority` is rejected, since Sidekiq has none — see [Queues instead of priorities](#queues-instead-of-priorities).) Unknown keys are rejected at configuration time so that typos surface immediately instead of silently falling back to defaults.
 
 ```ruby
 class HighPriorityWorkflow < GenevaDrive::Workflow
@@ -1633,7 +1635,7 @@ class HighPriorityWorkflow < GenevaDrive::Workflow
 end
 ```
 
-Options merge from lowest to highest precedence: **class defaults** (`set_step_job_options`) are overridden by **per-instance options** (`workflow.step_job_options = {...}`), which are in turn overridden by **per-step options** (`step ..., job_options: {...}`). The merged hash is passed straight to `PerformStepJob.set(...)` for every enqueue of that step, including reattempts and resume re-enqueueing.
+Options merge from lowest to highest precedence: **class defaults** (`set_step_job_options`) are overridden by **per-instance options** (`workflow.step_job_options = {...}`), which are in turn overridden by **per-step options** (`step ..., job_options: {...}`). The merged hash is handed to the dispatcher — with the default one, straight to `PerformStepJob.set(...)` — for every enqueue of that step, including reattempts and resume re-enqueueing.
 
 Per-instance options are stored in the workflow's `metadata` column, so they survive across step boundaries and are excluded from the dedupe uniqueness check — two workflows for the same hero cannot coexist just because their job options differ.
 
@@ -1681,6 +1683,197 @@ Workflows that have already extracted their artifact can now drain through `:pro
 
 The same pattern is useful whenever a later step releases a scarce resource (disk, external quota, a database lock) that earlier steps consume: give the release-work a higher priority than the acquire-work.
 
+## Running on Sidekiq
+
+Plenty of Rails apps never adopted Active Job. They have a `app/sidekiq` directory full of `include Sidekiq::Job` classes, a Sidekiq Pro or Enterprise license, a Web UI the on-call engineer knows by heart, and a set of client middleware that encrypts arguments or deduplicates pushes. For those apps, "steps run through Active Job" means a second job system bolted onto the first: another serialization format, another set of retry semantics, and jobs in the Busy page called `Sidekiq::ActiveJob::Wrapper` instead of anything you recognise.
+
+GenevaDrive does not actually need much from a job system. The step execution row is the durable record of what has to happen next; the job is only a wake-up call that carries the row's id. So we ship a dispatcher that pushes that wake-up call to Sidekiq directly:
+
+```ruby
+# config/initializers/geneva_drive.rb
+GenevaDrive.dispatcher = :sidekiq
+```
+
+That is the whole switch. Every step of every workflow is now pushed as a `GenevaDrive::SidekiqPerformStepJob` — a plain `Sidekiq::Job` — through `Sidekiq::Client`, with no Active Job in between. Set it in an initializer, so that it is in place before any workflow class loads: job options are checked against the dispatcher when a workflow class is defined.
+
+We support **Sidekiq 7.3 and later 7.x, and Sidekiq 8.x** — OSS, Pro and Enterprise alike — and test the oldest supported Sidekiq on the oldest supported Rails and the newest on the newest, against a real Redis. Sidekiq 9 is not supported until we have tested it. With any other version loaded, `GenevaDrive.dispatcher = :sidekiq` raises at boot, naming the version it found.
+
+#### What the installer picks
+
+When `bin/rails generate geneva_drive:install` writes `config/initializers/geneva_drive.rb`, it checks Active Job's adapter once. If the adapter is `:sidekiq` and a supported Sidekiq is loaded, the initializer gets an uncommented `GenevaDrive.dispatcher = :sidekiq`. Otherwise the line stays commented out. An unset adapter does not count: the generator runs in development, and an app that leaves development on `:async` may well run Solid Queue in production.
+
+Nothing is detected at boot. Without that line the dispatcher is `:active_job`, so upgrading the gem never switches an app that is already running workflows.
+
+### What the jobs look like
+
+A step job carries one argument, the step execution id, which is a plain integer (or string, with UUID keys) and therefore passes Sidekiq's strict argument checks. It is tagged `geneva_drive` plus the workflow class name, and the Web UI shows those tags next to each job:
+
+```ruby
+{
+  "class" => "GenevaDrive::SidekiqPerformStepJob",
+  "args" => [48213],
+  "queue" => "default",
+  "retry" => false,
+  "tags" => ["geneva_drive", "SubscriptionRenewalWorkflow"]
+}
+```
+
+While a step runs, the workflow id, step name and step execution id are added to `Sidekiq::Context`, so Sidekiq's own log lines for that job carry them. The jid is written to the step execution's `job_id`, the same as the Active Job id is with the default dispatcher, so you can go from a row in the database to the job in the Web UI and back.
+
+A step with `wait:` is pushed with an `at` timestamp and waits in Sidekiq's Scheduled set; a step that is due now goes straight onto its queue.
+
+### Retries belong to the step, not the job
+
+Sidekiq's default is to retry a failing job 25 times over three weeks. The step job switches that off with `retry: false`, and this is deliberate.
+
+GenevaDrive already decides what happens when a step raises: that is what [exception policies](#exception-handling) are for. A policy might reattempt the step in five minutes, pause the workflow for a human, or cancel it. Every one of those outcomes is committed to the step execution row before the job finishes. A reattempt is a *new* step execution with a job of its own. If Sidekiq also retried the original job, the retry would find the execution already settled and do nothing — so all a Sidekiq retry would add is ghost entries in the Retry set, and a Web UI that disagrees with the workflow about what failed.
+
+The exception is still raised out of the job once the executor has committed the step's state, so Sidekiq's error handlers — Sentry, Honeybadger, AppSignal, whatever you have configured — report it exactly as for any other failing job. Because the job is not retried, Sidekiq's death handlers see it too. Treat that as "this job is done", not "this workflow is dead": the step execution row is the ledger, and the workflow's state is the answer to "is this broken?".
+
+### Why we bypass transactional push
+
+If your app calls `Sidekiq.transactional_push!`, every `perform_async` is deferred until the surrounding Active Record transaction commits. That is a good default for application jobs, and the dispatcher deliberately does not use it.
+
+GenevaDrive already defers its push: it hands the step to the dispatcher from an `after_all_transactions_commit` callback, once the step execution row is visible to other connections. That callback runs after the SQL `COMMIT`, but possibly while the transaction is still unwinding on the Ruby side. A second deferral registered from inside it can be dropped on the floor — the step execution then has no job and sits in `scheduled` until housekeeping notices, 15 minutes later by default. We hit exactly this with Solid Queue (it is described at length in `PerformStepJob`), and the remedy is the same here: since we are already past the commit, push synchronously. The dispatcher builds its own `Sidekiq::Client` for that.
+
+Client middleware still runs on that push, so argument encryption, Enterprise unique jobs, and your own middleware all see GenevaDrive's jobs like any others. `Sidekiq::Client.via` sharding is honoured as well.
+
+### Queues instead of priorities
+
+Sidekiq has no job priority. It has queues, and a process works its queues either in strict order or by weight. So under the Sidekiq dispatcher `job_options: {priority: ...}` raises `StepConfigurationError` when the workflow class loads, rather than being silently ignored. `queue:`, `wait:` and `wait_until:` work as usual.
+
+The backlog problem from [Custom Job Options](#custom-job-options) — 50,000 fresh `:extract` steps crowding out the `:process` and `:cleanup` steps that free up disk — is solved with a queue that is worked first:
+
+```ruby
+class RubygemsWorkflow < GenevaDrive::Workflow
+  step :extract do
+    # Download a large tarball to local disk
+  end
+
+  step :process, job_options: {queue: :workflows_drain} do
+    # Do work on the extracted data
+  end
+
+  step :cleanup, job_options: {queue: :workflows_drain} do
+    # Delete the on-disk artifact
+  end
+end
+```
+
+```yaml
+# config/sidekiq.yml
+:queues:
+  - [workflows_drain, 5]
+  - [default, 1]
+```
+
+With weights, the drain queue is picked five times as often as `default`; list the queues without weights and Sidekiq works them strictly in order, so `default` only gets attention once the drain queue is empty.
+
+### Your own job class
+
+To carry options of your own — a dedicated queue, extra tags, Enterprise's `unique_for`, Pro's `expires_in` — subclass the step job and hand the subclass to the dispatcher:
+
+```ruby
+# app/sidekiq/workflow_step_job.rb
+class WorkflowStepJob < GenevaDrive::SidekiqPerformStepJob
+  sidekiq_options queue: "workflows", tags: ["geneva_drive", "billing"]
+end
+
+# config/initializers/geneva_drive.rb
+Rails.application.config.to_prepare do
+  GenevaDrive.dispatcher = GenevaDrive::SidekiqDispatcher.new(job_class: WorkflowStepJob)
+end
+```
+
+The `to_prepare` block is there because `WorkflowStepJob` lives in `app/`, and Rails does not let an initializer autoload it. `to_prepare` runs after the initializers but before eager loading, so workflow classes still see the dispatcher when they are defined. In development it also runs again on every code reload, so the dispatcher picks up the reloaded class. The plain `GenevaDrive.dispatcher = :sidekiq` needs none of this, as it refers to nothing in `app/`.
+
+Keep `retry: false` on the subclass for the reasons above. A queue set through `job_options:` on a workflow or step still wins over the class's queue.
+
+### Shutdowns and rolling restarts
+
+When Sidekiq is told to stop — or to go quiet, which is what Enterprise rolling restarts and most deploy scripts do first — it fires its `:quiet` event. GenevaDrive's engine subscribes to it whichever dispatcher you use, including Active Job on the Sidekiq adapter. From that moment every [resumable step](#resumable-steps) running in the process checkpoints its cursor at the end of the current iteration and hands off to a successor execution, which the next process picks up from where this one stopped.
+
+That only helps if an iteration is short enough to finish before Sidekiq gives up waiting, which is 25 seconds by default (`-t`). So the rule of thumb is: a step must either finish well within the shutdown timeout, or be a `resumable_step` whose single iteration does. A plain step that is still running when the timeout expires is killed; Sidekiq puts its job back on the queue (Sidekiq Pro's `super_fetch` does this even after a hard crash), but the step execution stays `in_progress`. When the re-delivered job arrives, the executor sees an execution that is no longer `scheduled` and skips it as a duplicate. Housekeeping then recovers the execution once it has been `in_progress` for longer than `stuck_in_progress_threshold`.
+
+Sidekiq 7.3 has iterable jobs of its own, and the two are worth comparing if you are deciding where a long iteration should live:
+
+| | `Sidekiq::IterableJob` | GenevaDrive `resumable_step` |
+|---|---|---|
+| Where the cursor lives | Redis, flushed about every 5 seconds and on error | the step execution row, written by `checkpoint!` or on every iteration |
+| After a crash | resumes from the last Redis flush | resumes from the last checkpoint, in the database your work writes to |
+| On shutdown | raises `Interrupted` and re-enqueues the same job | completes the execution as `continued` and schedules a successor |
+| What you can see | the job in the Web UI | every chunk as its own step execution, with the cursor it stopped at |
+
+### Pro and Enterprise features
+
+Several Sidekiq features fit workflows naturally.
+
+**Batches (Pro)** fan work out; [signals](#waiting-for-signals) bring the result back into a workflow. Park a step on a signal, run the batch, and let the batch's success callback deliver it:
+
+```ruby
+class InvoiceRunWorkflow < GenevaDrive::Workflow
+  step :render_invoices do
+    batch = Sidekiq::Batch.new
+    batch.description = "Invoices for #{hero.billing_period}"
+    batch.on(:success, InvoiceRunCallbacks, "workflow_id" => id)
+    batch.jobs do
+      hero.accounts.find_each { |account| RenderInvoiceJob.perform_async(account.id, hero.id) }
+    end
+  end
+
+  step :send_invoices, wait_for: :invoices_rendered do
+    InvoiceMailer.batch_ready(hero).deliver_later
+  end
+end
+
+class InvoiceRunCallbacks
+  def on_success(status, options)
+    workflow = GenevaDrive::Workflow.find(options["workflow_id"])
+    workflow.signal!(:invoices_rendered, idempotency_key: status.bid)
+  end
+end
+```
+
+The batch id makes the signal idempotent, so a callback Sidekiq delivers twice is harmless.
+
+**Rate limiters (Enterprise)** raise `Sidekiq::Limiter::OverLimit` when the limit is hit. Inside a step, turn that into a reattempt instead of a failure:
+
+```ruby
+class CrmSyncWorkflow < GenevaDrive::Workflow
+  CRM_LIMIT = Sidekiq::Limiter.window("crm-api", 100, :minute, wait_timeout: 0)
+
+  on_exception Sidekiq::Limiter::OverLimit, action: :reattempt!, wait: 1.minute, report: :never
+
+  step :push_contact do
+    CRM_LIMIT.within_limit { CrmClient.upsert_contact(hero) }
+  end
+end
+```
+
+**Periodic jobs (Enterprise)** and **sidekiq-cron** can schedule housekeeping through `GenevaDrive::SidekiqHousekeepingJob` — see [Running Housekeeping](#running-housekeeping).
+
+### Testing
+
+The [test helpers](#test-helpers) drive the executor directly, so `speedrun_workflow` and friends work the same with either dispatcher. To exercise the real push path, use Sidekiq's fake mode and drain the step job:
+
+```ruby
+test "renewal runs end to end through Sidekiq" do
+  workflow = SubscriptionRenewalWorkflow.create!(hero: subscriptions(:annual))
+
+  GenevaDrive::SidekiqPerformStepJob.drain
+
+  assert workflow.reload.finished?
+end
+```
+
+The fake queue ignores `at`, so steps with `wait:` run as soon as you drain.
+
+### Switching an existing app over
+
+Upgrading GenevaDrive leaves your dispatcher alone. When you re-run the installer to pick up new migrations, it asks before overwriting the initializer you already have - answer no, or pass `--skip`. To switch, add `GenevaDrive.dispatcher = :sidekiq` yourself. Tests that assert on enqueued `PerformStepJob`s will then need to look for `GenevaDrive::SidekiqPerformStepJob` in Sidekiq's fake mode instead.
+
+Changing the dispatcher only affects jobs pushed from then on. `PerformStepJob`s already queued through Active Job keep running on whatever adapter delivered them, and new steps go out as native Sidekiq jobs. Deploy the change, let the Active Job queue drain, and that is the migration.
+
 ## Housekeeping
 
 ### The Housekeeping Job
@@ -1722,6 +1915,24 @@ GoodJob::Cron.schedule(
 GenevaDrive::HousekeepingJob.perform_later
 ```
 
+On Sidekiq without Active Job, schedule `GenevaDrive::SidekiqHousekeepingJob` instead. It runs the same code in-process:
+
+```ruby
+# Sidekiq Enterprise periodic jobs
+Sidekiq.configure_server do |config|
+  config.periodic do |mgr|
+    mgr.register("*/30 * * * *", "GenevaDrive::SidekiqHousekeepingJob")
+  end
+end
+
+# sidekiq-cron
+Sidekiq::Cron::Job.create(
+  name: "GenevaDrive housekeeping",
+  cron: "*/30 * * * *",
+  class: "GenevaDrive::SidekiqHousekeepingJob"
+)
+```
+
 ## Testing
 
 ### Test Helpers

data/README.md

@@ -41,6 +41,19 @@ geneva_drive_housekeeping:
   class: "GenevaDrive::HousekeepingJob"
 ```
 
+### Sidekiq without Active Job
+
+If your app writes `Sidekiq::Job` classes rather than Active Job ones, steps can be pushed to Sidekiq directly:
+
+```ruby
+# config/initializers/geneva_drive.rb
+GenevaDrive.dispatcher = :sidekiq
+```
+
+The install generator writes this line for you when Active Job is already set up for Sidekiq. Supported: Sidekiq 7.3 and later 7.x, and 8.x, including Pro and Enterprise.
+
+Step jobs then run as `GenevaDrive::SidekiqPerformStepJob`, a plain Sidekiq job with Sidekiq retries switched off (exception policies decide reattempts), and housekeeping can be scheduled as `GenevaDrive::SidekiqHousekeepingJob`. See "Running on Sidekiq" in the manual for the details, including rolling restarts, Batches and rate limiters.
+
 
 
 ## Usage
@@ -172,7 +185,7 @@ class PremiumWorkflow < BaseWorkflow
 end
 ```
 
-Step job options override workflow defaults when the step is initially enqueued, reattempted, or resumed. Options are passed directly to Active Job's `set` method.
+Step job options override workflow defaults when the step is initially enqueued, reattempted, or resumed. With the default dispatcher, options are passed directly to Active Job's `set` method.
 
 ### Hero Deletion Handling
 

data/Rakefile

@@ -23,6 +23,20 @@ task :test do
   ruby "-Itest", "bin/test"
 end
 
+# The Sidekiq dispatcher's tests, and the installer that recommends it. Sidekiq
+# is only bundled by the sidekiq_* appraisals, so run this under one of them:
+#
+#   BUNDLE_GEMFILE=gemfiles/sidekiq_8.gemfile bundle exec rake test:sidekiq
+#
+# Set GENEVA_DRIVE_SIDEKIQ_REDIS_URL to include the tests against a real Redis.
+namespace :test do
+  desc "Run the Sidekiq tests (needs a sidekiq_* appraisal)"
+  task :sidekiq do
+    abort "Sidekiq is not in this bundle - use BUNDLE_GEMFILE=gemfiles/sidekiq_8.gemfile" unless Gem.loaded_specs["sidekiq"]
+    ruby "-Itest", "bin/test", "test/sidekiq", "test/generators"
+  end
+end
+
 # The root Gemfile resolves to the newest released Rails and the dummy app
 # defaults to SQLite, so a plain `rake` is the "latest Rails on SQLite" run.
 # The appraisal gemfiles cover the older Rails minors, and CI additionally

data/bin/matrix

@@ -12,7 +12,7 @@ cd "$(dirname "$0")/.."
 # The gemfiles are generated from Appraisals, which makes them the one place
 # the supported Rails versions are written down. CI reads the same list off
 # them, so neither side can drift from the other.
-RAILS_VERSIONS=${1:-$(ls gemfiles/*.gemfile | xargs -n1 basename | sed 's/\.gemfile$//' | tr '\n' ' ')}
+RAILS_VERSIONS=${1:-$(ls gemfiles/rails_*.gemfile | xargs -n1 basename | sed 's/\.gemfile$//' | tr '\n' ' ')}
 ENGINES=${2:-"sqlite postgres mysql mariadb"}
 
 for engine in $ENGINES; do

data/lib/generators/geneva_drive/install/templates/create_workflows_migration.rb

@@ -12,7 +12,7 @@ class CreateGenevaDriveWorkflows < ActiveRecord::Migration[7.2]
 
       # Polymorphic association to the hero of the workflow (optional)
       t.string :hero_type
-      t.column :hero_id, geneva_drive_key_type
+      t.column :hero_id, geneva_drive_hero_key_type
 
       # State machine
       t.string :state, null: false, default: "ready", index: true

data/lib/generators/geneva_drive/install/templates/initializer.rb.tt

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# How step jobs reach your queue.
+# - :active_job (the default) enqueues GenevaDrive::PerformStepJob through
+#   Active Job, onto whatever adapter the app uses.
+# - :sidekiq pushes GenevaDrive::SidekiqPerformStepJob, a plain Sidekiq::Job,
+#   straight through Sidekiq::Client - for apps that write Sidekiq jobs rather
+#   than Active Job ones. Schedule GenevaDrive::SidekiqHousekeepingJob then.
+#   Supports Sidekiq 7.3 and later 7.x, and 8.x.
+#
+<% if GenevaDrive::SidekiqDispatcher.recommended? -%>
+# Active Job was set up for Sidekiq when this file was generated.
+GenevaDrive.dispatcher = :sidekiq
+<% else -%>
+# GenevaDrive.dispatcher = :active_job
+<% end -%>
+
 # How long to keep completed/canceled workflows before automatic deletion.
 # Set to nil to disable automatic cleanup.
 # When enabled, finished and canceled workflows older than this threshold
@@ -7,12 +22,12 @@
 #
 # GenevaDrive.delete_completed_workflows_after = 30.days
 
-# How long a step execution can be in "executing" state before being
+# How long a step execution can be in "in_progress" state before being
 # considered stuck. This typically happens when a worker process crashes
 # mid-execution. The HousekeepingJob will recover these based on the
 # stuck_recovery_action setting.
 #
-# GenevaDrive.stuck_executing_threshold = 1.hour
+# GenevaDrive.stuck_in_progress_threshold = 1.hour
 
 # How long a step execution can be past its scheduled_for time while
 # still in "scheduled" state before being considered stuck. This can
@@ -39,6 +54,22 @@
 #
 # GenevaDrive.max_cursor_size = 128.kilobytes
 
+# Maximum size in bytes of a signal payload once serialized to JSON.
+# A payload describes an event (an order id, an amount, a decision), not the
+# data the step is going to work on - that belongs on the hero. Exceeding the
+# limit raises GenevaDrive::SignalPayloadTooLargeError from Workflow#signal!,
+# before anything is persisted. Set to nil to disable the check.
+#
+# GenevaDrive.max_signal_payload_size = 128.kilobytes
+
+# How long a step execution may sit in the "waiting" state before
+# housekeeping counts it in the geneva_drive.waiting_overdue gauge.
+# Waiting indefinitely is legitimate, so this is not a timeout - it keeps
+# a stalled rendezvous from going unnoticed. Alert on the overdue gauge.
+# Set to nil to disable the gauge.
+#
+# GenevaDrive.waiting_visibility_threshold = 7.days
+
 # Whether to defer job enqueueing until after the database transaction commits.
 # In production this ensures step execution records are visible to job workers
 # before the job runs. In test environments (the default when Rails.env.test?)

data/lib/geneva_drive/dispatchers/active_job_dispatcher.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Enqueues step jobs through Active Job, onto whatever adapter the app uses.
+# This is the default dispatcher.
+#
+# GenevaDrive calls the dispatcher from an `after_all_transactions_commit`
+# callback, once the step execution row is visible to other connections.
+# PerformStepJob opts out of Active Job's own transaction deferral for that
+# reason - see the comment there.
+#
+# @see GenevaDrive.dispatcher
+class GenevaDrive::ActiveJobDispatcher
+  # Enqueues the job that performs a step execution.
+  #
+  # @param step_execution_id [Integer, String] the step execution to perform
+  # @param job_options [Hash] validated `queue`, `priority`, `wait`, `wait_until`
+  # @param workflow_class_name [String, nil] unused here
+  # @return [String, nil] the Active Job job_id, or nil if the enqueue was aborted
+  def enqueue_step(step_execution_id, job_options, workflow_class_name: nil)
+    job = GenevaDrive::PerformStepJob.set(**job_options).perform_later(step_execution_id)
+    # perform_later returns false, not nil, when a callback aborts the enqueue
+    return nil unless job
+    job.job_id
+  end
+
+  # Every key GenevaDrive::JobOptions allows maps onto Active Job's `set`.
+  #
+  # @param options [Hash{Symbol=>Object}]
+  # @param context [String]
+  # @return [void]
+  def validate_job_options!(options, context:)
+  end
+end

data/lib/geneva_drive/dispatchers/sidekiq_dispatcher.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# Pushes step jobs straight to Sidekiq as GenevaDrive::SidekiqPerformStepJob,
+# a plain Sidekiq::Job, for apps that use Sidekiq without Active Job.
+#
+# Pushes go through a fresh Sidekiq::Client, never `perform_async`, so that
+# `Sidekiq.transactional_push!` cannot defer them a second time from inside
+# GenevaDrive's own after-commit callback - see PerformStepJob for why that
+# loses jobs. Client middleware still runs.
+#
+# @example config/initializers/geneva_drive.rb
+#   GenevaDrive.dispatcher = :sidekiq
+#
+# @see GenevaDrive.dispatcher
+class GenevaDrive::SidekiqDispatcher
+  # 7.3 and later 7.x, and 8.x - the versions CI runs. 9.0 stays out until tested.
+  SUPPORTED_SIDEKIQ_VERSIONS = Gem::Requirement.new(">= 7.3", "< 9")
+
+  # @return [Boolean] whether the loaded Sidekiq is a supported version
+  def self.supported_sidekiq_version?
+    SUPPORTED_SIDEKIQ_VERSIONS.satisfied_by?(Gem::Version.new(::Sidekiq::VERSION))
+  end
+
+  # Whether the install generator should write `GenevaDrive.dispatcher = :sidekiq`
+  # into the initializer it creates: a supported Sidekiq is loaded, and the app
+  # has pointed Active Job at Sidekiq. An unset adapter does not count - the
+  # generator runs in development, and production may well use another backend.
+  #
+  # @param adapter [Symbol, String, Object, nil] Active Job's configured adapter
+  # @return [Boolean]
+  def self.recommended?(adapter = Rails.application&.config&.active_job&.queue_adapter)
+    return false unless defined?(::Sidekiq::Client) && supported_sidekiq_version?
+
+    adapter.to_s == "sidekiq" || adapter.class.name.to_s.end_with?("SidekiqAdapter")
+  end
+
+  # @param job_class [Class, nil] a Sidekiq::Job that performs step executions,
+  #   GenevaDrive::SidekiqPerformStepJob by default
+  # @raise [LoadError] if Sidekiq is not loaded
+  # @raise [ArgumentError] if the loaded Sidekiq is not a supported version
+  def initialize(job_class: nil)
+    unless defined?(::Sidekiq::Client)
+      raise LoadError, "GenevaDrive::SidekiqDispatcher needs the sidekiq gem. Add it to your Gemfile."
+    end
+
+    unless self.class.supported_sidekiq_version?
+      raise ArgumentError,
+        "GenevaDrive::SidekiqDispatcher supports Sidekiq #{SUPPORTED_SIDEKIQ_VERSIONS}, " \
+        "but Sidekiq #{::Sidekiq::VERSION} is loaded. Use GenevaDrive.dispatcher = :active_job with this Sidekiq."
+    end
+
+    @job_class = job_class
+  end
+
+  # @return [Class] the Sidekiq::Job class step jobs are pushed as
+  def job_class
+    @job_class || GenevaDrive::SidekiqPerformStepJob
+  end
+
+  # Pushes the job that performs a step execution.
+  #
+  # @param step_execution_id [Integer, String] the step execution to perform
+  # @param job_options [Hash] validated `queue`, `wait`, `wait_until`
+  # @param workflow_class_name [String, nil] added to the job's tags, for the Web UI
+  # @return [String, nil] the jid, or nil if client middleware stopped the push
+  def enqueue_step(step_execution_id, job_options, workflow_class_name: nil)
+    item = {"class" => job_class, "args" => [step_execution_id]}
+    item["queue"] = job_options[:queue].to_s if job_options[:queue]
+
+    if (at = run_at(job_options))
+      item["at"] = at.to_f
+    end
+
+    if workflow_class_name
+      class_tags = Array(job_class.get_sidekiq_options["tags"])
+      item["tags"] = (class_tags + [workflow_class_name]).uniq
+    end
+
+    ::Sidekiq::Client.new.push(item)
+  end
+
+  # Sidekiq has queues with weights, not job priorities. Rejecting
+  # `priority:` keeps it from being ignored without anyone noticing.
+  #
+  # @param options [Hash{Symbol=>Object}]
+  # @param context [String]
+  # @return [void]
+  # @raise [GenevaDrive::StepConfigurationError] if `priority` is given
+  def validate_job_options!(options, context:)
+    return if options[:priority].nil?
+
+    raise GenevaDrive::StepConfigurationError,
+      "#{context} sets job_options[:priority], but Sidekiq has no job priority - it has queues with weights. " \
+      "Put the steps that must run first on a queue with a higher weight, e.g. `queue: :workflows_urgent`."
+  end
+
+  private
+
+  # Workflow already drops an overdue wait_until; this also covers callers that
+  # pass a time in the past, which would otherwise wait for the scheduled-set poller.
+  def run_at(job_options)
+    at = if job_options[:wait_until]
+      job_options[:wait_until]
+    elsif job_options[:wait]
+      Time.current + job_options[:wait]
+    end
+    return nil unless at
+
+    at = at.respond_to?(:to_time) ? at.to_time : Time.at(at.to_f)
+    (at > Time.current) ? at : nil
+  end
+end

data/lib/geneva_drive/engine.rb

@@ -1,3 +1,16 @@
 class GenevaDrive::Engine < ::Rails::Engine
   isolate_namespace GenevaDrive
+
+  # Sidekiq fires :quiet on TSTP (what Enterprise rolling restarts send first)
+  # and at the start of every shutdown. Resumable steps then checkpoint and
+  # hand off to a successor execution instead of being killed mid-iteration
+  # when the shutdown timeout runs out. Installed whichever dispatcher is in
+  # use - Active Job on the Sidekiq adapter needs it just as much.
+  initializer "geneva_drive.sidekiq_lifecycle" do
+    if defined?(::Sidekiq) && ::Sidekiq.respond_to?(:configure_server)
+      ::Sidekiq.configure_server do |config|
+        config.on(:quiet) { GenevaDrive.request_exit! }
+      end
+    end
+  end
 end

data/lib/geneva_drive/executor.rb

@@ -1079,11 +1079,13 @@ class GenevaDrive::Executor
 
   # Checks if the job should exit (e.g., Sidekiq shutdown).
   #
+  # The process-wide flag is raised by Sidekiq's :quiet event (see the
+  # engine). Asking Sidekiq::CLI directly does not work: the CLI has no
+  # stopping? of its own, only its launcher does.
+  #
   # @return [Boolean]
   def job_should_exit?
-    Thread.current[:geneva_drive_should_exit] ||
-      (defined?(Sidekiq) && Sidekiq.const_defined?(:CLI) &&
-       Sidekiq::CLI.instance&.stopping?)
+    Thread.current[:geneva_drive_should_exit] || GenevaDrive.exit_requested?
   end
 
   # Checks if the workflow has been externally paused or canceled.