Skip to content

fix(job): reclaim a job when its heartbeats stop, not only after 2x its timeout - #4507

Merged
bpamiri merged 1 commit into
developfrom
peter/job-heartbeat-grace
Oct 8, 2026
Merged

bpamiri merged 1 commit into
developfrom
peter/job-heartbeat-grace

Conversation

@bpamiri

@bpamiri bpamiri commented Oct 8, 2026

Copy link
Copy Markdown
Collaborator

Closes #4502

Problem

heartbeat() didn't change when a dead worker's job was reclaimed. A run is capped in-process at the job's timeout, and the reaper waits at least twice that (claimTimeout + Max(60, claimTimeout)) whether the job heartbeats or not. So a long job whose worker died sat for twice its timeout no matter how often it had heartbeated.

Change

A job that has heartbeated is now reclaimed once its heartbeats stop for its heartbeat grace, even inside its timeout. For a row with a heartbeatAt, the reaper uses the earlier of the claim window (unchanged) and the grace.

Rows that never heartbeat behave exactly as before.

The grace.

  • Setting. set(jobsHeartbeatGraceSeconds = n), default 300.
  • Turning it off. 0 turns it off.
  • Minimum. Values below 30 are raised to 30, so one slow heartbeat can't get a live job reclaimed.
  • Per job. A job can set its own this.heartbeatGrace, including 0. The reaper resolves it once per job class.

What a reclaim does. It is a normal reap with the usual outcome:

  • a retry (idempotent jobs);
  • interrupted (non-idempotent jobs);
  • failed, when retries are exhausted.

Claim fencing still stops the original attempt from completing over the new one. A final reclaim fires onFailure(isFinal = true) like any other reap (#4498).

Exclusive jobs (#4496). A heartbeat renews the lease to grace + Max(60, grace) from now, instead of the claim window. A job that stops heartbeating loses its lease on the same clock it is reclaimed on, so its retry isn't stuck behind a lease from the old claim window.

Scan floor. The reaper's candidate scan now starts at 30 seconds idle instead of 60, the smallest possible grace. The per-row windows are unchanged.

What heartbeat() doesn't do. It still never extends a job's timeout, which stays the hard cap on one attempt. Its docblock now says so, and says:

  • heartbeat at least every grace / 3;
  • a stopped heartbeat isn't proof that the worker died. A perform() stuck in a long call that can't heartbeat is reclaimed too, so either heartbeat around such calls or raise the grace.

Out of scope. Letting heartbeats extend the in-process deadline: an idle timeout with a separate hard maximum, as an opt-in this.timeoutMode = "idle" with this.maxRuntime. It's noted in #4502 as a possible later issue.

Tests

JobHeartbeatGraceSpec (7). Every row claims a one-hour timeout, so only the grace can reap it.

  • Stopped heartbeats: a job whose heartbeats stopped 10 minutes ago is reclaimed.
  • Recent heartbeat: one that heartbeated a minute ago isn't.
  • Never heartbeated: a job idle 10 minutes is left to its claim window, as before.
  • Turned off: with jobsHeartbeatGraceSeconds = 0 nothing is reclaimed by the grace.
  • Per-class: this.heartbeatGrace = 1200 and this.heartbeatGrace = 0 both override the setting.
  • Minimum: a grace below 30 is raised to 30.
  • Lease: renewal uses grace + Max(60, grace) with a grace set, and the lease's own window without one.

On develop:

  • 1 fails: the job whose heartbeats stopped isn't reclaimed.
  • 2 error: the grace API doesn't exist.

Local results:

  • Full core suite, Lucee 7 + SQLite: 7232 pass, 0 fail, 0 error.
  • Jobs specs, Lucee 7: green on all seven databases; PostgreSQL and CockroachDB also green on a second run against the same database.
  • Jobs specs, BoxLang: green on SQLite, PostgreSQL and CockroachDB.
  • Jobs specs, Adobe 2023: green on SQLite and MySQL.
  • Jobs specs, Adobe 2025: green on SQLite and SQL Server.
  • Complexity gate: passes.

Docs

The guide's heartbeat section (#4485) covers the grace, the cadence (grace / 3), the "not proof of death" caveat and the timeout staying the hard cap. Changelog fragment included.

🤖 Generated with Claude Code

…ts timeout

A job's run is capped at its timeout and the reaper waited at least twice that,
so heartbeat() never changed when a dead worker's job was reclaimed. A job that
has heartbeated is now reclaimed once its heartbeats stop for its heartbeat
grace (jobsHeartbeatGraceSeconds, default 300, minimum 30, 0 = off; or the
job's this.heartbeatGrace), even inside its timeout. Jobs that never heartbeat
keep the claim window. An exclusive job's heartbeat renews its lease by the
grace window, so the lease and the reclaim run on one clock.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
@bpamiri bpamiri added this to the v4.2.0 milestone Oct 8, 2026
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

Wheels Test Results

236 084 tests   230 841 ✅  1h 43m 42s ⏱️
 18 912 suites    5 243 💤
     32 files          0 ❌

Results for commit 0bc89af.

@bpamiri

bpamiri commented Oct 8, 2026 •

Copy link
Copy Markdown
Collaborator Author

rev1-r3 review @ 0bc89af: APPROVE

The change follows the agreed #4502 design.

  • Grace. jobsHeartbeatGraceSeconds (default 300, 0 = off, raised to a minimum of 30) or the class's own this.heartbeatGrace, resolved per class through $jobHeartbeatGrace(). That is memoised per worker, and a class that can't load falls back to the app setting.
  • Reclaim. A row that has heartbeated (hasBeat, read as a CASE flag so no timestamp is diffed in CFML) is reapable at Min(claim window, grace). A row that never heartbeated keeps the claim window alone. this.timeout stays the hard cap, because the grace can only shorten the window.
  • Lease. heartbeat() renews the feat(job): exclusive jobs and concurrency keys on a shared lease lock #4496 lease to now + grace + Max(60, grace), or the original window when the grace is off. A job that stops heartbeating therefore keeps its lease past the point it's reclaimed, and the retry defers on the lease until it lapses rather than overlapping.

Correctness checks:

  • No live job is reaped on its claim time. Every stale guard uses $lastSeenSql() (COALESCE(heartbeatAt, updatedAt)): the candidate SELECT, $scheduleRetry, $markFailed and $markInterrupted. So a job claimed an hour ago that heartbeated 40 s ago doesn't match a 300 s cutoff.
  • Only this attempt's heartbeats count. Both claim paths set heartbeatAt = NULL (JobWorker and Job.$processJob).
  • The lower floor (60 → 30 s) only widens the candidate set. Each row's own cutoff still decides.
  • Heartbeat-reaped final outcomes need no new wiring. They go through the reaper branches that feat(job): lifecycle hooks, an app-wide failure hook, and a stored result #4498 wired to onFailure(isFinal = true) ($markFailed, and $markInterrupted for non-idempotent jobs).
  • Upgrade impact: none. heartbeat() doesn't exist in v4.1.2, so no released app relies on the old "heartbeat more often than the timeout" advice.
  • Without a heartbeatAt column (an ALTER-blocked table), there's no hasBeat and the claim window applies, unchanged.

Matrix 37849369584 (full, on this head), read with my leg reader: 32 legs, all tests > 0 (7372–7389), 0 legs with fail or error. JobHeartbeatGraceSpec runs 7 specs on every leg, 0 bad. The existing JobHeartbeat* and JobLifecycleHooksSpec (15 each) are unchanged and green on every leg.

PR CI: 23 pass, 2 skipping, 0 fail. MERGEABLE. develop has moved by 5 commits since the base, all web/ blog and doc commits, with no overlap.

INFO, not blocking:

  • The 30 s floor has no positive spec. The "below 30 is raised to 30" spec checks that a row that heartbeated 15 s ago survives, which would also pass under the old 60 s floor. A row with grace 30 and its last beat about 45 s ago being reclaimed would pin the floor change itself.
  • The 4.2 guides don't document heartbeat() or the grace yet (no heartbeat hit under v4-2-0 outside channels). This belongs in the multi-server jobs guide fold (docs(web): add the 4.2 "Running Jobs on Multiple Servers" guide #4501), including the "heartbeat at least every grace / 3" guidance and the stuck-call caveat from the changelog.

@bpamiri
bpamiri merged commit a6c2d00 into develop Oct 8, 2026
63 checks passed
@bpamiri
bpamiri deleted the peter/job-heartbeat-grace branch October 8, 2026 22:12
bpamiri added a commit that referenced this pull request Oct 8, 2026
The groundwork the heartbeat section pointed at has landed: a job that
heartbeats is now reclaimed once its beats stop for a heartbeat grace,
even inside its timeout, instead of waiting out twice the timeout.

- Reframe the heartbeat section from "groundwork" to the real
  behaviour: the grace is jobsHeartbeatGraceSeconds (default 300, floor
  30, 0 = off) or this.heartbeatGrace; a job that never heartbeats
  keeps the full claim window; timeout stays the hard cap. Give the
  example a long timeout so the grace matters.
- The exclusive-job lease is renewed by the grace on each beat, so the
  lease and the reclaim run on one clock; retitle and update the aside.
- Drop the #4502 forward reference (it's this change) and add a 4.1 to
  4.2 upgrade entry.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
bpamiri added a commit that referenced this pull request Oct 8, 2026
Per rev1-r1 on the #4507 fold:
- MEDIUM: this.timeout is only the requested cap; the wheels jobs work
  worker caps every job at 300 s (Min(job, workerCap) with workerCap
  defaulting to 300 and this.perJobTimeout false), so a 3600 s job is
  still stopped at 300 s under the stock worker. Added a caution: run a
  long job through processQueue(timeout=) or JobRunner.tick(timeout=).
- LOW: the exclusive lease is renewed to grace + max(60, grace) (600 s
  at the default), which outlasts the reclaim grace (300 s), so the
  claim and the lease don't "lapse together" — the reclaim happens
  first and the old lease frees shortly after. Reworded the aside and
  the exclusive-jobs line.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
bpamiri added a commit that referenced this pull request Oct 9, 2026
* docs(web): add the 4.2 "Running Jobs on Multiple Servers" guide

A companion to Background Jobs for when several app servers process one
wheels_jobs table. It documents the multi-server features already on
develop and marks the parts still to come.

Covered (merged):
- the guarantees: one recorded outcome per attempt (per-claim fencing),
  at-least-once for idempotent jobs, and why perform() must be idempotent
- heartbeat() for long jobs, and Wheels.Job.Fenced
- this.idempotent and the interrupted status (at-most-once)
- set(jobsMaxConcurrentPerHost) and the host name override
- runner options: the CLI worker, a scheduled processQueue(), JobRunner.tick()
- draining a server before a deploy with wheels jobs drain --wait / resume
- the shared schema to apply by hand on a live multi-server database
- clock skew and NTP

Marked as not-yet-built, each with its tracking issue: the token-gated
/wheels/jobs/tick route, a single UTC database clock, recurring
schedules, exclusive jobs and concurrency keys, lifecycle hooks, and
wheels jobs install.

Links both ways with Background Jobs, adds the sidebar and index entries,
and records the heartbeat/idempotency, per-host cap, and jobs drain/resume
changes on the 4.1 to 4.2 upgrade guide.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): correct the multi-server jobs guide per accuracy review

Fixes from rev1-r1's pass on the new guide and the 4.1 to 4.2 upgrade
entry:

- heartbeat() does not extend a job's timeout. The timeout is a hard cap
  per attempt (perform() runs in a bounded thread and is stopped when it
  elapses); heartbeat() only records liveness. Reframed the section and
  the upgrade entry, and noted the lease-renewal (#4496) and
  dead-worker-detection (#4502) work that builds on it.
- The heartbeatAt column is TIMESTAMP on PostgreSQL, CockroachDB, Oracle
  and H2 (they have no DATETIME); the manual DDL now gives per-database
  types.
- Documented purge(status="interrupted") for pruning interrupted rows,
  instead of "use your own SQL".
- Job timestamps are written with each server's application clock
  (Now()), not the database clock; corrected the clocks section.
- Dropped "unless you turn it off" from the upgrade note: turning the
  auto-schema off needs jobsAutoCreateTables, which isn't built yet.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): fold the merged processQueue-through-worker change into the guide

processQueue() now runs through the job worker (#4495), so it reaps
stale jobs, honours the per-host cap, and stops starting new jobs on a
draining host. Document that as fact instead of a forward reference,
note that it still doesn't refresh the host registry's lastSeenAt the
way tick() does (its running count and drain state are read live), and
drop #4495 from the "Coming in 4.2" list now that it has landed.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): phrase the heartbeat lease-renewal note as forward-looking

#4496 as approved sets a job's lease expiry at acquire and does not
renew it from heartbeat() yet; the renewal is wired in #4496's develop
merge. Word the liveness aside as "once #4496 lands, heartbeat() also
renews an exclusive job's lease" so it's accurate until #4496 merges,
then it becomes plain fact.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): document recurring job schedules (#4493)

Fold the merged recurring-schedules feature into the multi-server jobs
guide as a full section, replacing the placeholder:

- The config/schedules.cfm DSL: schedule().job().cron() / .every(),
  .timezone(), .catchUp() / .catchUpWindow(), .queue()/.priority()/
  .data()/.enabled(). wheels new doesn't create the file.
- Running schedules with new wheels.JobScheduler().enqueueDue(): each
  slot carries a uniqueKey, so calling it on every server yields one job
  per slot.
- Catch-up ("latest" default within catchUpWindow, "none"), the
  wheels_job_schedules table, code-vs-db schedule sources, and the
  java.time/DST notes for non-UTC time zones.

Also correct the Background Jobs page, which said Wheels has no
recurring schedule, to point here, and add a 4.1 to 4.2 upgrade entry.
Remove recurring schedules from the "Coming in 4.2" list.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): mark the planned automatic schedule runner

enqueueDue() is called manually today. Note the planned schedule-runner
wiring: JobRunner.tick() and the CLI worker's poll will call it every
jobsScheduleCheckSeconds (default 30), so a running worker fires
schedules without a separate call. Clearly marked as not built yet.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): note the uniqueKey index on old SQL Server levels (#4494)

Fold in the improved SQL Server guidance: the filtered unique index
needs compatibility level 100 or higher. Below that, either raise the
level or use a plain unique index, but only once every server runs 4.2
(a plain index allows one NULL, so a 4.1 server writing NULL keys would
collide). The framework's warning and Wheels.Job.UniqueKeyUnavailable
now name the failed step and the per-database fix. Added to the guide's
schema section and the 4.1 to 4.2 upgrade entry; removed from
"Coming in 4.2".

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): correct processQueue's skipped claim and add the fenced count

Since #4495 routed processQueue() through the worker, a row another
poller claims first is no longer counted as skipped — the atomic claim
just fails and the loser moves on. Fix the stale "shows up in the
skipped count" parenthetical, and add the fenced count (a current
field) to the result-shape comment, with a pointer to the fencing
guarantee. (leasesLost and the redefined skipped come with #4496.)

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): document exclusive jobs and concurrency keys (#4496)

Fold in the merged lease-lock feature:

- New "Exclusive jobs and concurrency keys" section: this.exclusive,
  this.concurrencyKey, and concurrencyKeyFor(data) (the method wins),
  the wheels_job_locks lease, a busy lease putting the job back to
  pending (counted as skipped), leasesLost, and the never-making-
  progress caution.
- heartbeat() now renews an exclusive job's lease: flipped the
  forward-looking aside to plain fact.
- Background Jobs: processQueue()'s result gains leasesLost, and its
  skipped/fenced/leasesLost counts are explained with links.
- Added a 4.1 to 4.2 upgrade entry; noted wheels_job_locks and
  wheels_job_schedules as cheap auto-create tables; removed exclusive
  jobs from "Coming in 4.2".

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): correct the lease window source and soften the renewal wording

Per rev1-r1: the exclusive-job lease window is sized from the timeout
the job was CLAIMED with (the claimTimeout passed to $acquireJobLease),
not this.timeout — they coincide only under processQueue. Reword to
"the timeout it was claimed with plus the reap grace", matching the
reaper language. And because that window outlasts the hard per-attempt
timeout cap, the lease can't actually expire mid-run today, so drop the
"expire out from under it" framing: heartbeat lease renewal is
groundwork, like its effect on the reaper.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): document job lifecycle hooks and the failure hook (#4498)

Fold in the merged lifecycle-hooks feature:

- New "Lifecycle hooks and failure handling" section: beforePerform/
  afterPerform (run under the timeout; a throw fails the attempt),
  onSuccess(result) / onFailure(error, attempt, isFinal) (best-effort,
  after the outcome is recorded), isFinal covering reaped and
  interrupted jobs, the app-wide set(jobsOnFailure=...) hook with its
  data-free struct, and the stored wheels_jobs.result column.
- Added the result column to the schema table and DDL.
- Added a 4.1 to 4.2 upgrade entry.
- Removed the now-empty "Coming in 4.2" section (remaining placeholders
  live in their own inline asides).

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): fix jobsOnFailure signature, var scoping, and the result cap

Per rev1-r1 on the #4498 fold:
- jobsOnFailure is invoked with a named `event` argument, so the hook
  method must declare `function report(required struct event)`. Show
  the signature in the guide and note it in the upgrade entry.
- Use `var order` in the ChargeCardJob example.
- The stored result cap is 4000 characters on SQL Server but 4000 UTF-8
  bytes on VARCHAR / Oracle VARCHAR2; reword to say so.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): clarify the result cap is a byte bound, not VARCHAR byte semantics

Per rev1-r1: only Oracle VARCHAR2 counts bytes; PG/MySQL/SQLite VARCHAR count characters, and the code caps at 4000 UTF-8 bytes there as a safe bound.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): heartbeats shorten dead-worker detection (#4507)

The groundwork the heartbeat section pointed at has landed: a job that
heartbeats is now reclaimed once its beats stop for a heartbeat grace,
even inside its timeout, instead of waiting out twice the timeout.

- Reframe the heartbeat section from "groundwork" to the real
  behaviour: the grace is jobsHeartbeatGraceSeconds (default 300, floor
  30, 0 = off) or this.heartbeatGrace; a job that never heartbeats
  keeps the full claim window; timeout stays the hard cap. Give the
  example a long timeout so the grace matters.
- The exclusive-job lease is renewed by the grace on each beat, so the
  lease and the reclaim run on one clock; retitle and update the aside.
- Drop the #4502 forward reference (it's this change) and add a 4.1 to
  4.2 upgrade entry.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): qualify the long timeout and the lease-vs-reclaim windows

Per rev1-r1 on the #4507 fold:
- MEDIUM: this.timeout is only the requested cap; the wheels jobs work
  worker caps every job at 300 s (Min(job, workerCap) with workerCap
  defaulting to 300 and this.perJobTimeout false), so a 3600 s job is
  still stopped at 300 s under the stock worker. Added a caution: run a
  long job through processQueue(timeout=) or JobRunner.tick(timeout=).
- LOW: the exclusive lease is renewed to grace + max(60, grace) (600 s
  at the default), which outlasts the reclaim grace (300 s), so the
  claim and the lease don't "lapse together" — the reclaim happens
  first and the old lease frees shortly after. Reworded the aside and
  the exclusive-jobs line.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): sharpen the runner cap and lease-window details

Per rev1-r1:
- processQueue() already honours a job's own timeout (perJobTimeout
  mode), so the timeout= arg is optional and only lowers the cap; only
  wheels jobs work caps at 300. Reword and link #4517, which tracks the
  CLI cap.
- The exclusive lease renews to grace + max(60s, grace) — ~2x the grace
  (600s at the default), not "a little longer". After a reclaim the old
  lease frees about one grace later, and the retry waits deferred
  without spending an attempt. Reword the aside and the exclusive-jobs
  line.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): correct the schedule-runner placeholder default to 15

Per rev1-r1 reading the #4509 branch: jobsScheduleCheckSeconds defaults to 15, not 30; processQueue() also runs schedules (through the worker); and a draining host still enqueues due slots to run elsewhere. Still marked not-built-yet until #4509 merges.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): document wheels jobs install, and the fixed worker timeout

Two merged changes:

- #4499: wheels jobs install writes a migration that creates (or tops
  up) the job tables from the running app's own schema, and
  set(jobsAutoCreateTables = false) turns off runtime CREATE/ALTER
  (then a missing table throws Wheels.Job.SchemaMissing). Restructure
  "The shared schema" to lead with install + the setting as the
  recommended multi-server path, keeping the hand-written DDL as the
  fallback; replace the "planned" aside; add an upgrade entry.
- #4518 (fixes #4517): wheels jobs work now runs each job for its own
  timeout, with --job-timeout to cap, instead of stopping every job at
  300 s. Rewrite the long-timeout caution accordingly and add an
  upgrade entry.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): tighten the jobs-install schema notes

Per rev1-r1:
- Wheels.Job.SchemaMissing is thrown only for a missing wheels_jobs
  (and wheels_job_locks for exclusive jobs); a missing host-registry or
  schedules table just turns that feature off with a logged note.
- Warn that the install migration's down() is destructive: it drops all
  four job tables, including adopted ones, and every job in them.
- The --job-timeout note: --timeout stops the whole worker only on some
  CLI runtimes (where LuCLI's root option takes it), not universally.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): soften the --timeout worker note to runtime-dependent

The #4518 line in background-jobs.mdx said --timeout stops the whole worker outright; it only does so on CLI runtimes where LuCLI's root option takes it. Match the wording used in the multi-server guide and upgrade entry.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): document the /wheels/jobs/tick route (#4516)

Fold in the merged token-gated tick route, replacing the placeholder
with a real "Drive it over HTTP: the tick route" subsection:

- POST /wheels/jobs/tick runs one JobRunner.tick() and returns JSON.
- The token is the boundary: 404 until set(jobsRunnerToken = "..."),
  403 without the right X-Wheels-Jobs-Token (constant-time), ?token=
  only with jobsRunnerTokenInQuery; any forwarding header is refused, so
  it's called on the server itself, not through a proxy. Answered before
  routing; overlapping ticks skipped.
- wheels jobs tick runs one tick from the CLI.
- Add a 4.1 to 4.2 upgrade entry.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): schedules run from the worker (#4509); tick-route job limits

- #4509: a running worker checks schedules itself — wheels jobs work,
  processQueue() and JobRunner.tick() each enqueue due slots as they
  poll, at most once every jobsScheduleCheckSeconds (default 15, 0 =
  off) per application. Rewrite "Running the schedules" so enqueueDue()
  is only for when nothing polls the queue; note the draining-server
  behaviour and tick()'s scheduled count; update the upgrade entry.
- #4516 review (rev1-r1): the tick route calls tick() with no args, so
  each call reaps, enqueues due schedules and runs at most ONE job
  (capped at 300 s), with no request parameter for either — say so and
  point volume at wheels jobs work or a CFML tick(maxJobs=n). Note GET
  and POST are both accepted.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): link #4520 from the tick-route one-job-per-call note

The route runs one job per call today; #4520 will make its batch size and timeout configurable. Both orch1 and rev1-r1 asked for the forward link.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): job timestamps on the database's UTC clock (#4486)

The last multi-server piece. Rewrite "Clocks and skew" from "each
server's own clock, keep NTP tight" to the real behaviour: wheels.JobClock
keeps job timestamps on the database's UTC clock (read ~once a minute,
skew-corrected, compared in SQL), so skewed or differently-zoned servers
no longer disagree about stale/due. Document that H2 and SQLite use the
server's own UTC (H2 needs a UTC JVM); the CFML API stays local
(enqueueAt converts, status/stats convert back); and the install
migration converts pre-4.2 rows once via this.convertLocalOffsetMinutes
in one transaction with a marker (idempotent; SQLite skipped). Add the
upgrade entry.

With every placeholder now folded, this closes the guide.

Closes #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

* docs(web): spell out the UTC conversion upgrade path

Per rev1-r1, enrich the pre-4.2 timestamp conversion guidance (the
aside and the upgrade entry), from the generated migration comment and
#4521's changelog:

- The drain alternative: upgrade with the queue empty (no pending/
  processing jobs) and leave convertLocalOffsetMinutes at 0.
- The cost of doing neither on a non-UTC server: a delayed job runs
  early/late by the offset, and on a server behind UTC an in-flight job
  looks stale and is reclaimed and run again.
- Servers already on UTC (and SQLite) need neither.
- The offset sign: -300 for UTC-5, 60 for UTC+1.

Refs #4485

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>

---------

Signed-off-by: Peter Amiri <peter@alurium.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix(job): let heartbeats shorten dead-worker detection for long jobs

1 participant