Totoro 35cdcab1c5
feat(scheduled-tasks): signals, honest notices and fair queueing for server-started runs (RFC #6340, 2/2) (#6393)
* feat(scheduler): lifecycle rules, goal/limit parity and coded errors for scheduled tasks

- Migration 0031: nullable scheduled_tasks.unmet_streak_after_seq (internal
  streak boundary) and stop_condition (the user's stop rule, own column).
- Stop rule is normalized (stop_rule.py) and appended only at launch; the
  stored prompt never contains it. Wording adapts when scheduler.tool_enabled
  is off.
- Willem 1: page-created tasks get goal evaluation, <standing_notes>, the
  previous-run reference and own-schedule stop; request_stop and the
  scheduled capability no longer require an origin conversation.
- Repository: single reactivation choke point raising
  ScheduledTaskLimitsExhausted; streak boundary moves on goal/prompt/stop
  condition/note changes (not on resume); goal-check failures neither count
  nor reset the streak; pause of a finished task returns "finished"; trials
  on a paused task keep the host pause marker.
- New repository reads: automatic_runs_used_for, active_run_status_for,
  list_manageable_from_thread, thread_relation/thread_run on thread tasks,
  task_ids_for_thread, run_number, and run_number/total_tokens/summary on
  run history rows.
- REST: goal/max_runs/end_at/stop_condition on create and PATCH (null
  clears, naive end_at = task timezone), resume recomputes from now with an
  optional renewal body, once_time_passed, task_finished, limits_exhausted,
  scheduler_not_running on create, trigger returns outcome/existing/thread_id,
  task responses add automatic_runs_used and active_run_status.
- Coded errors {code, message, params} for routes, shared validation and the
  chat capability (scheduled_task_errors.py), pinned by
  contracts/scheduled_task_errors_contract.json; goal notes contract v2 with
  check_failure_codes, scheduled_origin_key and host_run_errors (host_notes.py).
- /api/features adds scheduled_tasks {available, running, tool_enabled,
  min_interval_seconds}; ScheduledTaskService.is_running.
- Docs: six README scheduler sections, API.md scheduled tasks section
  (breaking error shape), CONFIGURATION.md, AGENTS notes, CHANGELOGs.
- Tests: migration 0031, stop rule, error contract, run listing, lifecycle
  over HTTP, repository, service and capability cases; updated tests for the
  new error shape, finished-task pause and head revision.

* feat(scheduler): conversation update/resume, run-conversation authority and readable launches

- schedule_task: update and resume actions, stop_condition and clear_fields
  parameters, plain parameter types (value rules come back as coded results),
  rewritten docstrings for schedule_task and stop_scheduled_task.
- Capability: update/resume share the REST validation and error codes;
  interactive turns in a task's run conversation may manage that task;
  scheduled runs keep only own-stop; grants require a running scheduler.
- Results: compact JSON-safe task views with local times, display card/text,
  last run in list, timezone_source/browser_timezone, now_local; no ISO, user,
  lease or origin fields; stop_instructions removed.
- Timezone: explicit > browser (context.client_timezone, validated in
  start_run and never forwarded to the run config) > not needed for intervals
  and offset run_at > timezone_required.
- Trial gate accepts natural direct requests after acknowledgements and
  particles; trial results report thread_id and existing.
- Scheduled launches: stable message id scheduled-<task_run_id>, server-owned
  deerflow_scheduled_origin metadata with the user-language parts, run thread
  title for fresh-thread tasks.
- Worker records goal continuations in the verdict; lead prompt language rule
  covers stored task text and scheduled runs.
- Docs: six READMEs, CONFIGURATION, API, runtime/tools AGENTS, CHANGELOGs.

* feat(frontend): scheduled-task core types, formatting, errors and glossary

- throwGatewayApiError now throws GatewayApiError (status, code, params,
  rawMessage); message stays the string detail or detail.message
- scheduled-task types gain stop_condition, automatic_runs_used,
  active_run_status, origin/notes, run_number/total_tokens/summary, thread
  relation, trigger result, renewal and scheduled origin; isTaskBusy and
  hasActiveRun helpers
- api: fetchScheduledTask, resume with optional renewal body, typed trigger
  result and update payload with null clears
- hooks: polling at 3 s while a run is active (list, thread list, run
  history), useScheduledTask with live gating and final 404, useInView,
  localized error toasts; run history refreshes tasks when a run finishes
- new pure modules: errors.ts (contract code to localized copy), format.ts
  (relative task times, viewer time, display zone), status.ts, actions.ts,
  run-error.ts; describeTaskSchedule in cron.ts; goal-outcome adds unchecked
  goal checks, describeTaskOutcome and parseStopRunId
- features: scheduled_tasks block with defaults when missing
- buildRunContext sends client_timezone
- titleOfThread takes a localized untitled label; breadcrumb names scheduled
  tasks and agents; reference chips use the localized untitled label
- schedule input: shared browserTimeZone, labelled selects, aria-pressed
  type toggles, interval minimum from the hint template
- i18n: all PR1 scheduled-task keys in en-US and zh-CN, glossary fixes,
  recipe instructions moved into i18n
- e2e mocks follow the new task, trigger, resume, thread-task and features
  shapes; expectNoRawIdentifiers helpers for e2e and DOM tests
- tests for errors, format, cron, status, actions, goal outcome, run errors,
  hooks, run context, thread titles and features; scheduled e2e copy updated

* feat(frontend): list-first scheduled tasks page with outcomes and editable goals

- page.tsx is now a thin composition of components/workspace/scheduled-tasks:
  status tabs (All/Active/Paused/Finished) and search over the task list,
  ?task_id= deep link with router.replace on selection, ?thread_id= chip
  with Show all, empty state, scheduler-off notice and unavailable state
- task list rows show the schedule in words and one status line (next run,
  running now, paused by agent, auto-paused, finished by its cap)
- task detail: status badge, actions from availableActions with reasons,
  More actions menu (Duplicate, Copy task ID, Delete), outcome notice,
  Runs / Stops when / Each run's goal / Does / Notes from chat / History,
  origin chat link; success toasts for every action
- run rows: run number or Trial run, summary, goal and assumption badges,
  continuations, tokens, Open chat link; raw errors and the evaluator
  reason only behind Details
- create/edit/duplicate dialog with goal, stop condition, safety caps and
  advanced agent/context options; PATCH sends only changed fields, null
  clears a cap
- renew dialog raises or removes caps and resumes in one request; a
  limits_exhausted Resume opens it
- removed i18n keys the old page used; added feedback.resumedNoTime
- recorded en-3 and zh-1 page fixtures; scheduled e2e specs rewritten for
  the new page; DOM tests for the detail and the form dialog
- CHANGELOG entries and the frontend AGENTS.md scheduled-task note

* feat(frontend): live schedule card, run conversation provenance and header entry

- schedule_task results (create, update, pause, resume, trial, delete) become
  an assistant:scheduled-task message group rendered as a live card: schedule,
  next run, stop condition with the safety cap, goal, where results go, Run
  once now, Pause/Resume and Open task; the card polls the task only while it
  is on screen and shows deleted, scheduler-off and limits-exhausted states
- one card per task per assistant turn; the card group is not a turn boundary
  for usage, branching, editing, outline or skill attribution
- a human message with deerflow_scheduled_origin stays a human group with
  scheduledOrigin and renders as a "Scheduled run / Trial run" block with the
  task instructions, stop condition and notes collapsed; the launched text is
  never shown and the message is not editable
- readable step labels for schedule_task actions and stop_scheduled_task
- ThreadScheduledTasksButton replaces the header link: hidden without tasks,
  shows the count, links to the task (or the chat filter), and a run's chat
  links to its task
- recorded en-3 / zh-1 chat and run-thread fixtures; chat-card and run-thread
  e2e specs; unit and DOM tests for parsing, grouping, turn boundaries, card,
  run block, header button, step labels and reconnect hydration
- i18n: header.countLabelOne added, unused card.next removed; CHANGELOG and
  frontend AGENTS.md notes

* fix(scheduler): address verification findings

Move the scheduled-task lifecycle guidance from backend/AGENTS.md into the persistence guide and leave a one-line pointer, so the effective AGENTS.md chains for agents/middlewares, sandbox and subagents stay under the 98304-byte hard limit enforced by scripts/check_agent_guidance.py in lint-check.

* fix(scheduler): address review findings

* fix(gateway): no-transform on SSE responses

All four text/event-stream responses (thread run create stream, join,
existing-run GET/POST stream, stateless create stream) now take their
headers from app/gateway/sse_headers.py and send
Cache-Control: no-cache, no-transform, so compressing proxies such as
Next's rewrite proxy stop buffering streams. Content-Location and
X-Accel-Buffering are unchanged; scheduled and MCP-notification runs keep
stream_mode=None.

Tests pin the headers on every SSE route and fail on a literal no-cache
header left in routers. Docs: API.md SSE headers note, CHANGELOGs.

* feat(scheduler): per-owner run cap and fair queue selection

New scheduler.max_concurrent_runs_per_user (default 2, 0 = off, effective
min(cap, max_concurrent_runs)) caps launching/running scheduled runs per task
owner. claim_queued_run checks it right after the global count under the same
budget lock, so it is atomic across workers and Pods. list_queued_runs ranks
same-thread FIFO heads per owner with ROW_NUMBER() OVER (PARTITION BY owner)
and orders the batch by that rank, so the drain is owner-fair even with the
cap off; owners at their cap drop out before the batch limit. Orphan rows
(task deleted while queued) are never held back by the cap.

Gateway lifespan passes the startup value; the service constructor default
stays 0. Docs: config.example.yaml (config_version 54), CONFIGURATION.md,
the six READMEs, backend AGENTS.md, CHANGELOGs (behavior change flagged).
The live-task quota is untouched.

* feat(scheduler): durable lifecycle events for the originating chat

When a chat-created schedule is paused by the agent, auto-paused or finishes,
finalization now reports task_stopped / task_paused / task_finished, only on a
live -> paused/finished transition. The new finish_task_at_end_condition
replaces the three inline "mark completed" blocks (admission rejected as ended,
claim-time skip, complete_if_ended), so every site emits exactly once.

The scheduler's finalization observer is always installed. It writes
scheduled_task_events rows for the originating chat in the same transaction as
the state change, deduplicated on (task_id, anchor, event), with a title
snapshot, stop condition, run number, last run outcome and the chat's newest
run as placement anchor. Lookups fall back on bad stored data; only database
errors propagate. Manual trials drop only run_* events. The IM step keeps
PR1's selection until B4.

New GET /api/threads/{thread_id}/scheduled-task-events (owner check, caller's
rows, oldest first); rows survive task deletion and go with the chat.
Migration 0032_activity_and_task_events adds the events table plus the
run-origin column/index and read-state tables used later, each object guarded
on its own. Contract scheduled_goal_notes v3 pins the lifecycle vocabulary.
Docs: API.md, migrations chain, backend AGENTS.md, six READMEs, CHANGELOGs.

* feat(scheduler): honest, localized and self-contained IM notices

Every scheduled-task IM notice is now enqueued by the finalization observer
in the transaction that records the outcome, one message per occurrence
(task_stopped > task_paused > task_finished > run_failed > run_unmet >
run_completed; a once task sends only its run event). The merged auto-pause
replaces the separate unmet + pause messages, agent stops and finishes now
notify, and recovery-finalized runs notify exactly once. Idle finishes use a
deterministic idle: key derived from the lifecycle anchor. The old
non-transactional enqueue in handle_run_completion is removed.

New app/channels/capabilities.py holds CHANNEL_CAPABILITIES with a
proactive_notifications flag (adds the missing qq entry); only push-capable
providers (WeCom) get rows, /api/channels/providers returns the flag, and the
worker ends legacy rows for other providers as terminal failed.

New app/scheduler/notification_text.py renders en-US/zh-CN text: title, what
happened (plus the last run's outcome), the tasks page's one-line run summary
(redacted) when the agent replied, and a closing line. No IDs, no links, no
public_base_url. Locale is the owner's new `locale` preference, else the new
channel_connections.notification_locale (default en-US).

Docs: config.example.yaml (config_version 55), CONFIGURATION.md, API.md,
channels AGENTS.md, six READMEs, CHANGELOGs (behavior change flagged).

* feat(gateway): thread origin, activity feed and read markers for server-created threads

Runs started by the server for a user (scheduler, IM channels, GitHub
agents, extension handles, MCP notifications) now carry a server-owned
metadata.deerflow_origin {kind, provider?, namespace?} (new harness module
deerflow.runtime.run_origin, pinned by contracts/thread_origin_contract.json).
It is stamped only from request.state.run_origin or by the internal channel
caller; run admission drops client copies from both metadata and
config.metadata, and thread create/patch strip it. RunRepository derives
runs.origin_kind on put and on create_thread_operation_atomic (agent runs
only), and gains latest_change().

New ThreadReadRepository keeps a per-user, never-decreasing read position
(thread_read_markers) and a per-user read clock (thread_read_versions).
POST /api/threads/{id}/read marks a thread read, thread search items carry
unread, and thread delete removes the markers. GET /api/thread-activity pages
the caller's run changes over the run-change clock, returns only threads
changed by server-originated runs plus read_version, and 503s without SQL;
/api/features reports thread_activity.available.

Docs: API.md, gateway AGENTS.md (condensed to stay under its budget),
CHANGELOGs.

* fix(scheduler): adapt PR2 to PR1 follow-ups

PR1 moved the scheduled-task lifecycle rules out of backend/AGENTS.md into
the persistence guide and grew the sandbox AGENTS.md chain to within 267
bytes of its hard limit. The per-owner queue-fairness detail now lives in
the persistence guide next to the lifecycle rules (backend/AGENTS.md keeps
the cap and a link), so check_agent_guidance passes again.

PR1's goal-outcome unit test pinned scheduled_goal_notes_contract version 2;
PR2 bumps it to 3 (lifecycle vocabulary only, the v2 keys are unchanged).

* fix(scheduled-tasks): polish from live acceptance

- zh schedule wording: an interval of one unit reads 每分钟 / 每小时 / 每秒,
  and a saved interval of whole days reads 每天 / 每 2 天 (Every day / Every 2
  days) instead of 每 1 分钟 or 每 24 小时; several units keep the number
- zh spacing: 已于{time} 满足 and 在{time} 的运行中 now leave a space between
  the interpolated time and the Chinese after it; a copy test guards every
  scheduled-task zh string against a placeholder glued to Chinese
- run summary: when the first line of the final reply only leads in to a list
  (ends with ":" or ":"), the list items follow it as plain text (bullets,
  numbering, checkboxes, bold, code and links stripped), joined with ";" for
  CJK text and "; " otherwise, within the 160-character cap
- a schedule_task result (create, update, pause, resume, trial, delete) that
  arrives in a chat invalidates that chat's task list, the tasks list and the
  named task, so the header button and cards update without waiting for the
  idle poll; results already in the loaded history do not refetch
- e2e and unit fixtures are now the live acceptance recordings (DeepSeek
  Flash, demo data, fictional names): live-weekday.json (create, trial, edit,
  pause, resume in one zh chat) and live-minute.json (per-minute chat, run 1
  and run 2, paused by the agent), fetched with GET from the demo Gateway and
  trimmed; the hand-shaped en-3 / zh-1 fixtures are removed and the chat-card,
  run-thread and tasks-page specs run in both locales over the recorded data

* docs(changelog): reference #6378 for the scheduled-tasks entries

* docs(agents): shorten the scheduled-task pointer to stay under the guidance limit

* test(scheduled-tasks): pin the live takes to their recorded time zone

The live fixtures were recorded in Asia/Shanghai, and an interval task
reads in the viewer's zone, so the 16:48 assertions failed on UTC CI
runners. Pin the browser zone in the two live-take e2e specs and the
zh live-take unit test.

* feat(frontend): thread origin, activity polling, read markers and task events core

Frontend core for server-created threads and schedule lifecycle events
(PR2 F1); the sidebar markers (F2) and the chat event line (F3) build on it.

- core/threads/origin.ts: threadOriginOf reads metadata.deerflow_origin,
  then channel_source (github -> GitHub origin), then a legacy
  scheduled_task_id; key and kinds pinned to
  contracts/thread_origin_contract.json. labelOfThreadOrigin and the now
  exported labelOfChannelProvider(provider, t) use the new localized
  threads.origin.providers names (飞书, 企业微信, ...), with the English map
  (gaining GitHub) only as the fallback.
- core/threads/activity.ts: useThreadActivity polls /api/thread-activity
  every 15 s (focus refetch, never in the background, off unless
  features.thread_activity.available). The first response only seeds the
  cursor; server-origin threads, a truncated page or a higher read_version
  invalidate the thread lists, a scheduled thread also ["scheduled-tasks"];
  an invalid cursor re-seeds. useMarkThreadRead debounces POST /read by 1 s,
  skips a thread whose cached unread is false, patches the search and
  infinite caches optimistically and stores the returned read_version so a
  tab's own read does not refetch its lists. AgentThread gains unread.
- core/scheduled-tasks/events.ts: ScheduledTaskEvent, the events query
  (["scheduled-tasks","thread-events",id], one fetch per saved chat, not
  gated on the task list so a deleted task's lines stay, refetched when a
  task of the chat changes status or finishes a run), describeTaskEvent
  (en/zh copy, title and condition as segments, last-run suffix, See that
  run / Open task) and placeTaskEvents (end of the after_run_id turn, else
  the tail, ordered by created_at); lifecycle names pinned to contract v3.
- features: thread_activity (default unavailable); channels:
  proactive_notifications on providers.
- Locale sync: the I18nProvider reports the UI language and a signed-in
  preference session saves it as the new `locale` preference when the
  account's differs (and on every switch), so IM notices follow the UI
  language; nothing is written with auth disabled.
- i18n: threads.* (unread, origin labels, provider names),
  scheduledTasks.events.*, history.waitingForSlot (now shown for queued run
  rows), channels.scheduledUpdates.*.
- e2e mocks: thread activity feed and controller, POST /read, the events
  route, providers with proactive_notifications, search unread, features
  thread_activity (off by default). Preference e2e mocks return the UI
  locale so they keep asserting only their own edits.
- Docs: frontend AGENTS.md, CHANGELOGs.

* fix(scheduled-tasks): keep untouched end times and drop a chat filter the new task is not in

- The edit, duplicate and renew dialogs keep a stored end time's instant
  while its field still shows it. A minute-precision wall value cannot
  keep seconds or name the later 01:30 of a DST fall-back, so a
  title-only edit moved the cap an hour earlier, and raising the run
  limit re-sent the end time without its seconds.
- Creating or duplicating a task from a chat's task view drops the chat
  filter when the new task does not belong to that chat, instead of
  showing "This task isn't one of this chat's tasks".

* feat(frontend): origin markers and unread state in the thread lists

Server-created threads (PR2 F2) now say who created them and whether they
are new, in the sidebar and on the Chats page, and reach an open sidebar
without a reload.

- ThreadOriginIcon (thread-channel-source.tsx): clock for a scheduled run,
  the provider mark for IM threads, the GitHub mark (new in
  ChannelProviderIcon) for GitHub threads, a puzzle piece for extensions;
  the localized "Scheduled run" / "From Feishu" / "From GitHub" / "From an
  extension" label is its accessible name and tooltip. ThreadChannelIcon
  stays exported as a wrapper, and the provider chip tooltip is localized
  (no more "Feishu channel").
- Unread dot after the title (aria-hidden dot plus sr-only "Unread"); the
  row aria-label becomes "{title}, unread" / "{title},未读". Never shown for
  the open thread.
- WorkspaceSidebar mounts useThreadActivity once.
- useMarkOpenThreadRead (components/workspace/chats): the default and
  custom-agent chat pages mark the thread read once its metadata has
  loaded, when its cached unread flips to true while open, when the tab
  becomes visible, and from onFinish (a send or a joined run ended). Each
  trigger goes through useMarkThreadRead, so it is debounced and a no-op
  while the cached unread is false.
- Tests: thread-origin-icon and recent-chat-list DOM tests (en/zh, active
  row, no raw identifiers), use-mark-open-thread-read DOM tests,
  e2e thread-activity.spec.ts (new scheduled run appears unread within one
  fake-clock poll without a reload, opening it posts /read and clears the
  dot, a read on another device clears it, IM and GitHub markers, zh
  labels, the Chats page, no polling when unavailable);
  thread-history.spec.ts now finds the localized origin icon.
- Docs: frontend AGENTS.md, CHANGELOGs.

* feat(frontend): schedule event line in the originating chat and channel notice support

The chat that created a schedule now says when the schedule paused or
ended, and the channel cards say which apps receive scheduled task updates
(PR2 F3).

- ScheduledTaskEventLine (mockup m2, marker 4): a dashed, muted row with
  the describeTaskEvent text (title in <strong>, stop condition clamped to
  one line with the full text in its tooltip, last-run suffix), the time
  via formatTaskTime and a right-aligned "See that run" (run chat) or
  "Open task" link. PauseCircle for paused, CircleCheck for finished and
  once-done, CircleX for once-failed. role="note", aria-label "Scheduled
  task update" / "定时任务通知", data-task-id and data-event-id only.
- MessageList takes scheduledTaskEvents and renders placeTaskEvents output
  through a new VirtualMessageList.renderAfterGroup, so each line sits at
  the end of its after_run_id turn inside the group's measured row (also
  when the list virtualizes); lines with nowhere to go render at the tail.
- Both chat pages load useThreadScheduledTaskEvents (not gated on the task
  list, so the lines stay after a task is deleted). The custom-agent page
  passes its agent so "See that run" opens the run on that agent's route.
- ChannelScheduledUpdates: "Scheduled task updates: sent here" / "... not
  available for this app yet" (定时任务通知:会发送到这里 / 此应用暂不支持)
  on the Settings provider cards and under each sidebar channel row; nothing
  when an older backend does not report proactive_notifications.
- e2e mock controller: setScheduledTasks.
- Tests: scheduled-task-event-line and channel-scheduled-updates DOM tests
  (every kind in en and zh, hrefs, clamp, no raw identifiers, Chinese
  title), MessageList placement DOM tests; e2e
  scheduled-task-chat-events.spec.ts (the line appears with the card's
  "Paused by agent" without a reload, See that run opens the run chat,
  anchored vs tail placement, two events in time order, the line survives
  task deletion and Open task shows the task is gone; en-3 and zh-1) and
  channels.spec.ts (WeCom sent here, Feishu not yet; en and zh).
- Docs: frontend AGENTS.md, CHANGELOGs.

* fix(scheduled-tasks): tie pause notices to the pause they describe

- Paused by agent links and times only the run named in last_error. When
  that run is not loaded, the notice shows no link and the task's own time
  instead of an earlier run that also asked to stop.
- The outcome notice reads the latest history page whichever page is
  shown, so browsing older runs no longer swaps the auto-pause reason and
  "Open latest run" to an earlier miss. It shares that page's request.

* fix(scheduler): address PR2 review findings

- Event lines: hold an event whose anchor run is on an unloaded history
  page instead of placing it at the bottom (hasMoreHistory); tail fallback
  only for fully loaded (branched/pruned) history or no anchor.
- Idle-finish anchor follows its reason: end:<iso> only for an end_at
  finish, seq:<n> otherwise, so a later end-time finish is not deduplicated
  away by an earlier max_runs finish.
- Observer takes FOR SHARE on the originating threads_meta row, so a racing
  thread delete cannot leave an orphan event line.
- One taskPagePath (core), re-exported by the card.
- Notification locales derived from NotificationLocale; /preferences uses it.
- IM notices drop generic reasons (goal_not_met_yet, unknown) instead of
  repeating the sentence.
- Localized provider names on Settings cards, sidebar rows and setup dialog.
- zh event lines: no space after a Chinese title (Latin-aware gap).
- Unread row label keeps the origin marker; chats page keeps the time as a
  description.
- Sidebar shows the scheduled-updates line only for connected apps;
  Settings says "available after you connect" for unconnected push apps.
- Event line keeps a real space before the time.

* fix(scheduled-tasks): three lifecycle gaps found while re-checking review classes

- The edit form compares a cron in the form its schedule input emits, so an
  untouched "0 09 * * 0,6" is not re-sent as "0 9 * * 6,0" and a title-only
  edit no longer re-arms or refuses a finished task.
- Chat resume asks for a timezone, as update does, when a naive end_at would
  land in the UTC placeholder of a zone-free task.
- Re-arming a task clears a host pause marker, as resume does, so a later
  manual pause no longer reads as "Paused by agent".

* test(scheduler): consolidate PR2 backend test setup

- Fold the repeated task, origin-chat and observer setup of the
  lifecycle-event repository tests into one lifecycle_task builder.
- Build the per-owner-cap services through one _capped_service builder
  that keeps every cap explicit at the call site.
- Table the five SSE route header checks into one parametrized test with
  the same routes, bodies and Content-Location expectations.
- Reuse bind_wecom and hoist repeated local imports in the event tests.

Every case and assertion is kept; collected cases are unchanged.

* test(frontend): consolidate PR2 thread activity and origin test setup

Extract shared builders and helpers in the frontend tests PR2 adds, with
every case, input and assertion kept:

- activity.test.ts: seededClient/apply helpers and one LIST_KEYS constant
  replace the per-test seed, spy and apply boilerplate.
- mark-read.dom.test.tsx: newClient() and advance() replace the repeated
  QueryClient wrapper and fake-timer act blocks.
- origin.test.ts: the English and Chinese label checks become tables; the
  no-English-name check now runs on every Chinese row.
- thread-activity.spec.ts: a scheduledRun() builder replaces four inline
  copies of the scheduled run thread.
- channels.spec.ts: the PR2 block uses setLocaleCookie and one card helper.

Collected cases are unchanged (unit 211, e2e 60); no test was removed.

* fix(scheduled-tasks): keep the notice's latest-runs query from refreshing older pages

useLatestScheduledTaskRuns kept React Query's default refetch on mount,
focus and reconnect, so going offline and back while an older history page
was shown fetched the latest page again. Refreshing stays with the history,
which refreshes the latest page only while it is shown.

* fix(scheduler): two gaps found in live acceptance

- A fresh scheduled run thread is named when it launches. The worker
  copied the title to the thread list only when the run ended, so the
  sidebar, which now shows the new run thread at once, listed it as
  untitled while it ran.
- A task capped at one run finishes with "its one run is done" /
  "唯一一次运行已完成" in the chat event line and the IM notice, instead
  of "all 1 runs are done".

* test(scheduled-tasks): let the viewer's time carry its own day label

Between 16:00 and 24:00 UTC, UTC and Asia/Shanghai are on different days,
so the run prompt shows "Tomorrow 01:00 · Today 09:00 your time" and the
fixed "01:00 · 09:00 your time" assertion failed depending on the hour.

* test(scheduler): expect the one-run finish copy in service notices

* fix(gateway): create a scheduled run thread with its title

Pre-setting the name after start_run raced the thread row, which the run
worker creates asynchronously: live, one of two run threads still reached
the sidebar untitled. Run admission now creates a new thread with the title
its run input carries, which the worker would copy only at run end.

* docs(changelog): reference #6393 for the scheduled-task signal entries

* fix(scheduled-tasks): route event-line run links by the agent that ran them

The originating chat's agent was used for "See that run", but a task's
agent can change after the chat created it, so the link could open the run
chat on another agent's route. Lifecycle events now record run_agent_name,
the task's agent when the run finished (edits are refused while a run is
active), and the line routes by it.

* fix(scheduled-tasks): load up to the route's maximum of chat event lines

The chat loads its lifecycle events once, and the route's default of 50
would silently drop the oldest lines of a chat with many schedules. Ask
for the maximum, 200.

* fix(threads): keep activity reads and the first cursor in step with the lists

- Accepting the first activity cursor refreshes the thread lists once. The
  lists load on their own, possibly before a run the seed already counts,
  and later polls start after it, so such a thread never appeared.
- A local read whose returned read clock jumps past that one read also
  covers reads on other devices; the lists are refreshed instead of the
  clock silently skipping those threads' stale unread dots.
- An invalid cursor re-seeds through the same path, so it refreshes once.

* docs(agents): bring the middlewares guidance chain back under the hard limit

#6378 and #6363 each fit the budget, but together the middlewares AGENTS.md
chain on main is 98,425 bytes, 121 over the 98,304 hard limit, so Lint
Check fails on main. Move the scheduled-task recovery, launch-update and
queue-timeout rules from backend/AGENTS.md into the persistence guide's
lifecycle section, which backend/AGENTS.md already points to. The chain is
now 98,067 bytes.

* fix(helm): bump the chart's config_version to 55

config.example.yaml moved to 55 in this PR, so the Helm chart's
validate-chart drift check failed. The chart's embedded config needs no
field changes: the new scheduler and channel keys have defaults.

---------

Co-authored-by: Totoro-qaq <279883115+Totoro-qaq@users.noreply.github.com>
Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
2026-10-07 10:22:15 +08:00

1058 lines
49 KiB
Python

from __future__ import annotations
import asyncio
import hashlib
import logging
import socket
import uuid
from datetime import UTC, datetime, timedelta
from typing import Any, Literal
from zoneinfo import ZoneInfo
from fastapi import HTTPException
from sqlalchemy import select
from app.channels.capabilities import supports_proactive_notifications
from app.scheduler.notification_text import NOTIFICATION_LOCALES
from deerflow.persistence.channel_connections.model import ChannelConnectionRow
from deerflow.persistence.run.model import RunRow
from deerflow.persistence.scheduled_task_events import ScheduledTaskEventRepository
from deerflow.persistence.scheduled_task_runs import ActiveScheduledRunConflict, ScheduledTaskAdmissionRejected
from deerflow.persistence.scheduled_task_runs.finalization import LIFECYCLE_EVENTS, RUN_EVENT_BY_STATUS, lifecycle_anchor, lifecycle_reason
from deerflow.persistence.scheduled_task_runs.model import ScheduledTaskRunRow
from deerflow.persistence.scheduled_task_runs.sql import run_number_expression
from deerflow.persistence.thread_meta.model import ThreadMetaRow
from deerflow.persistence.user.model import UserPreferenceRow
from deerflow.runtime import ConflictError, RunRecord
from deerflow.scheduler.host_notes import RUN_ERROR_DELETED_WHILE_QUEUED, RUN_ERROR_INTERRUPTED, RUN_ERROR_LEASE_LOST, RUN_ERROR_PAUSED_WHILE_QUEUED, RUN_ERROR_QUEUE_TIMEOUT, RUN_ERROR_RESTARTED
from deerflow.scheduler.schedules import next_run_at
from deerflow.scheduler.stop_rule import launch_prompt
from deerflow.trace_context import ensure_trace_context
from deerflow.utils.thread_id import validate_thread_id
logger = logging.getLogger(__name__)
def _zone_is_placeholder(task: dict[str, Any]) -> bool:
"""Whether the stored "UTC" only means "no zone was needed" (timezone_source not_needed).
A chat can save an interval task, or a one-time task whose run_at carries
an offset, without knowing the user's zone; it stores "UTC". Those times
are shown in the viewer's zone, so a UTC wall-clock time must not appear
in the run conversation's title.
"""
if task.get("timezone") != "UTC":
return False
if task.get("schedule_type") == "interval":
return True
if task.get("schedule_type") == "once":
run_at = (task.get("schedule_spec") or {}).get("run_at")
try:
return isinstance(run_at, str) and datetime.fromisoformat(run_at).tzinfo is not None
except ValueError:
return False
return False
def _as_utc(value: datetime | str | None) -> datetime | None:
"""A stored timestamp (ISO string from the repository, or a datetime) as aware UTC."""
if value is None:
return None
if isinstance(value, str):
value = datetime.fromisoformat(f"{value[:-1]}+00:00" if value.endswith("Z") else value)
return value.replace(tzinfo=UTC) if value.tzinfo is None else value.astimezone(UTC)
def _as_utc_or_none(value: object) -> datetime | None:
"""A datetime as aware UTC; anything else (or an unusable value) is None."""
if not isinstance(value, datetime):
return None
try:
return value.replace(tzinfo=UTC) if value.tzinfo is None else value.astimezone(UTC)
except (ValueError, OverflowError):
return None
def _int_or_none(value: object) -> int | None:
try:
return int(value) if value is not None else None
except (TypeError, ValueError):
return None
def _chat_event_payload(task, occurrence, event: str, *, run_number: int | None) -> dict[str, Any]:
"""Display snapshot of a lifecycle event (survives task deletion and edits).
``run_thread_id`` is set only when the occurrence launched a run (a skipped
occurrence's thread was never created). ``latest_reason_code`` is the
unmet reason of that run. Never raises for bad stored values.
"""
title = task.title.strip() if isinstance(task.title, str) else ""
stop_condition = getattr(task, "stop_condition", None)
end_at = _as_utc_or_none(getattr(task, "end_at", None))
run_status = getattr(occurrence, "status", None) if occurrence is not None else None
launched = occurrence is not None and occurrence.run_id is not None
# The agent that ran it (edits are refused while a run is active), so the
# run link opens on that agent's route, not the originating chat's.
agent = getattr(task, "assistant_id", None)
return {
"task_title": title or None,
"stop_condition": stop_condition if event == "task_stopped" and isinstance(stop_condition, str) and stop_condition.strip() else None,
"run_thread_id": occurrence.thread_id if launched else None,
"run_agent_name": agent.strip() if launched and isinstance(agent, str) and agent.strip() else None,
"run_number": run_number,
"run_status": run_status,
"latest_reason_code": occurrence.error if run_status == "unmet" and isinstance(occurrence.error, str) else None,
"max_runs": _int_or_none(getattr(task, "max_runs", None)),
"end_at": end_at.isoformat() if end_at is not None else None,
"schedule_type": task.schedule_type if isinstance(task.schedule_type, str) else None,
}
def _origin_thread_share_lock(thread_id: str):
"""``SELECT ... FOR SHARE`` on the originating chat's ``threads_meta`` row.
The share lock makes a concurrent thread delete wait until this
finalization commits (Postgres; SQLite already serializes writers), so the
delete's later ``delete_by_thread`` step removes the line written here. A
delete that committed first leaves no row to lock, and no line is written.
"""
return select(ThreadMetaRow.thread_id).where(ThreadMetaRow.thread_id == thread_id).with_for_update(read=True)
def _event_time(task, occurrence) -> datetime:
"""When the reported transition happened (for the ``end_at`` / ``max_runs`` reason)."""
return _as_utc_or_none(getattr(occurrence, "finished_at", None)) or _as_utc_or_none(getattr(task, "updated_at", None)) or datetime.now(UTC)
# One IM message per occurrence (or idle finish): the first event of this
# order that the transition produced. A once task's ``task_finished`` is never
# the message (its run event says the same thing), see ``_notice_event``.
_NOTICE_PRIORITY: tuple[str, ...] = ("task_stopped", "task_paused", "task_finished", "run_failed", "run_unmet", "run_completed")
NOTIFICATION_PAYLOAD_VERSION = 2
def _notice_event(task, occurrence, events: tuple[str, ...], *, now: datetime) -> tuple[str, str | None] | None:
"""The single event an IM notice reports, with its lifecycle reason (None for run events)."""
for event in _NOTICE_PRIORITY:
if event not in events:
continue
if event == "task_finished":
reason = lifecycle_reason(task, event, now=now, occurrence=occurrence)
if reason.startswith("once_"):
continue
return event, reason
if event in LIFECYCLE_EVENTS:
return event, lifecycle_reason(task, event, now=now, occurrence=occurrence)
return event, None
return None
def _idle_notice_key(task_id: str, anchor: str) -> str:
"""Outbox ``task_run_id`` of a finish without an occurrence (fits the 64-char column).
Derived from the lifecycle anchor, so re-running ``complete_if_ended`` for
the same end dedupes, and page-created tasks (no event row) get one too.
"""
digest = hashlib.sha256(f"{task_id}\x00{anchor}".encode()).hexdigest()
return f"idle:{digest[:48]}"
def _notice_payload(task, occurrence, event: str, reason: str | None, *, locale: str | None) -> dict[str, Any]:
"""Payload v2 of an IM notice (rendered by ``app.scheduler.notification_text``).
No thread or run ids: notices carry no links. ``task_id`` stays for
diagnostics only. Never raises for bad stored values.
"""
title = task.title.strip() if isinstance(task.title, str) else ""
run_status = getattr(occurrence, "status", None) if occurrence is not None else None
occurrence_error = getattr(occurrence, "error", None) if occurrence is not None else None
unmet_reason = occurrence_error if run_status == "unmet" and isinstance(occurrence_error, str) else None
payload: dict[str, Any] = {
"payload_version": NOTIFICATION_PAYLOAD_VERSION,
"task_id": task.id,
"task_title": title or None,
"locale": locale,
"reason_code": unmet_reason if event == "run_unmet" else reason,
"latest_reason_code": unmet_reason,
"run_status": run_status if isinstance(run_status, str) else None,
}
verdict = getattr(occurrence, "goal_verdict", None) if occurrence is not None else None
if run_status == "success" and getattr(occurrence, "goal_objective", None) is not None and isinstance(verdict, dict) and verdict.get("satisfied") is True:
# Present only when a goal was met; True when it relied on an assumption.
payload["relied_on_assumption"] = verdict.get("relied_on_assumption") is True
stop_condition = getattr(task, "stop_condition", None)
if event == "task_stopped" and isinstance(stop_condition, str) and stop_condition.strip():
payload["stop_condition"] = stop_condition
if event == "task_finished":
payload["max_runs"] = _int_or_none(getattr(task, "max_runs", None))
return payload
# Shared so the active-row fast path and the atomic-admission conflict path
# return byte-identical outcomes for the same active-occurrence condition.
_ACTIVE_RUN_CONFLICT_ERROR = "task already has an active run"
# A manual trigger whose task changed between read and admission. The REST
# trigger and the chat trial map this exact outcome error to ``task_changed``.
TASK_CHANGED_ERROR = "scheduled task changed before trigger admission"
_RESTART_RECOVERY_ERROR = RUN_ERROR_RESTARTED
_LEASE_RECOVERY_ERROR = RUN_ERROR_LEASE_LOST
_QUEUE_TIMEOUT_ERROR = RUN_ERROR_QUEUE_TIMEOUT
class ScheduledTaskService:
def __init__(
self,
*,
task_repo,
task_run_repo,
launch_run,
poll_interval_seconds: int,
lease_seconds: int,
max_concurrent_runs: int,
max_concurrent_runs_per_user: int = 0,
queue_timeout_seconds: int = 3600,
multi_instance: bool = False,
run_lease_grace_seconds: int = 10,
connection_repo=None,
notification_repo=None,
own_stop_available: bool | None = None,
) -> None:
self._task_repo = task_repo
self._task_run_repo = task_run_repo
self._launch_run = launch_run
self._poll_interval_seconds = poll_interval_seconds
self._lease_seconds = lease_seconds
self._max_concurrent_runs = max_concurrent_runs
# Per-owner cap on launching/running rows (0 = off). It never exceeds
# the global cap, so with the defaults (3 global, 2 per owner) one
# owner always leaves a slot for everyone else.
self._max_concurrent_runs_per_user = min(max_concurrent_runs_per_user, max_concurrent_runs) if max_concurrent_runs_per_user > 0 else 0
self._queue_timeout_seconds = queue_timeout_seconds
self._multi_instance = multi_instance
self._run_lease_grace_seconds = run_lease_grace_seconds
# Notification outbox wiring (issue #4254): both repos must be present
# for IM notices. The finalization observer stages them in the outcome's
# transaction (it reads bindings in that session); the delivery worker
# sends. Either being None sends no IM notices.
self._connection_repo = connection_repo
self._notification_repo = notification_repo
# Whether scheduled runs get stop_scheduled_task (scheduler.tool_enabled).
# Decides how a launch phrases the user's stop rule (stop_rule.launch_prompt).
# None (production) reads the live config at each launch, the same source
# the run itself uses to grant the tool; a bool is a fixed test override.
self._own_stop_available = own_stop_available
self._lease_owner = f"{socket.gethostname()}:{uuid.uuid4().hex}"
self._task: asyncio.Task | None = None
self._stop = asyncio.Event()
self._skip_next_lease_reconciliation = False
self._install_finalization_observers()
async def _can_stop_itself(self) -> bool:
"""Whether the launched run will be given stop_scheduled_task.
Read per launch from the live config, like ``start_run`` (which decides
whether the run gets the tool) and ``/api/features``, so a config reload
never tells a run to call a tool it does not have.
"""
if self._own_stop_available is not None:
return self._own_stop_available
from deerflow.config.app_config import get_app_config
from deerflow.scheduler.runtime import scheduler_tools_enabled
try:
return scheduler_tools_enabled(await asyncio.to_thread(get_app_config))
except Exception:
logger.warning("Could not read the scheduler tool setting; phrasing the stop rule without the tool", exc_info=True)
return False
@property
def is_running(self) -> bool:
"""Whether this process's poller is running (automatic runs fire here)."""
return self._task is not None and not self._task.done()
def _install_finalization_observers(self) -> None:
# Always installed: chat events need no outbox. The IM step checks the
# outbox wiring at call time, so a detached outbox keeps chat events.
for repository in (self._task_repo, self._task_run_repo):
register = getattr(repository, "set_finalization_observer", None)
if callable(register):
register(self._on_finalization)
async def _on_finalization(self, session, task, occurrence, *, events: tuple[str, ...]) -> None:
"""Stage lifecycle obligations in the transaction that finalizes them.
Called by ``finalize_occurrence`` and ``finish_task_at_end_condition``
under the parent lock, before their commit, so every row written here
commits or rolls back with the state change it reports (also during
crash and lease recovery). ``occurrence`` is None for an idle finish.
1. A manual trial drops only its ``run_*`` events (the user is watching
it); lifecycle events are one-time transitions and are kept.
2. Lifecycle events become rows for the originating chat.
3. One IM notice per occurrence (only while the outbox is wired).
Lookups never raise for bad data (see ``_record_chat_events``); only
database errors propagate, because swallowing them would break the
same-transaction guarantee.
"""
if occurrence is not None and occurrence.trigger == "manual":
events = tuple(event for event in events if event not in RUN_EVENT_BY_STATUS.values())
lifecycle = tuple(event for event in events if event in LIFECYCLE_EVENTS)
if lifecycle:
await self._record_chat_events(session, task, occurrence, lifecycle)
if self._notification_repo is not None and self._connection_repo is not None:
await self._enqueue_notice(session, task, occurrence, events)
async def _record_chat_events(self, session, task, occurrence, events: tuple[str, ...]) -> None:
"""Write one display-only event row per lifecycle event for the originating chat.
Page-created tasks have no originating chat, and a deleted chat gets no
new rows. Bad stored data falls back (blank title -> None, unreadable
end time -> ``max_runs`` / ``seq:`` anchor, missing run -> None).
"""
origin_thread_id = getattr(task, "origin_thread_id", None)
if not isinstance(origin_thread_id, str) or not origin_thread_id:
return
if await session.scalar(_origin_thread_share_lock(origin_thread_id)) is None:
return
now = _event_time(task, occurrence)
anchor = lifecycle_anchor(task, occurrence, now=now)
after_run_id = await session.scalar(select(RunRow.run_id).where(RunRow.thread_id == origin_thread_id, RunRow.operation_kind == "run").order_by(RunRow.created_at.desc(), RunRow.run_id.desc()).limit(1))
run_number = None
if occurrence is not None:
value = await session.scalar(select(run_number_expression(ScheduledTaskRunRow)).where(ScheduledTaskRunRow.id == occurrence.id))
run_number = _int_or_none(value)
for event in events:
reason = lifecycle_reason(task, event, now=now, occurrence=occurrence)
await ScheduledTaskEventRepository.record_in_session(
session,
user_id=task.user_id,
task_id=task.id,
thread_id=origin_thread_id,
occurrence_id=occurrence.id if occurrence is not None else None,
anchor=anchor,
event=event,
reason_code=reason,
after_run_id=after_run_id,
payload=_chat_event_payload(task, occurrence, event, run_number=run_number),
)
async def _enqueue_notice(self, session, task, occurrence, events: tuple[str, ...]) -> None:
"""Stage the occurrence's one IM notice for each push-capable binding of the owner.
Rows are deduplicated on ``(task_run_id, event, provider, target)``,
so recovery re-finalizing nothing (``finalize_occurrence`` returns
False) and a replayed idle finish (same anchor) add nothing. Providers
without proactive push get no row. Plain manual trials reach here
without run events and send nothing; interrupted runs have no event.
"""
now = _event_time(task, occurrence)
selected = _notice_event(task, occurrence, events, now=now)
if selected is None:
return
event, reason = selected
bindings = [
binding
for binding in await session.scalars(select(ChannelConnectionRow).where(ChannelConnectionRow.owner_user_id == task.user_id, ChannelConnectionRow.status == "connected"))
if binding.provider and binding.external_account_id and supports_proactive_notifications(binding.provider)
]
if not bindings:
return
payload = _notice_payload(task, occurrence, event, reason, locale=await self._owner_locale(session, task.user_id))
task_run_id = occurrence.id if occurrence is not None else _idle_notice_key(task.id, lifecycle_anchor(task, occurrence, now=now))
for binding in bindings:
await self._notification_repo.enqueue_in_session(
session,
task_id=task.id,
task_run_id=task_run_id,
run_id=occurrence.run_id if occurrence is not None else None,
event=event,
provider=binding.provider,
target=binding.external_account_id,
owner_user_id=task.user_id,
payload=payload,
)
@staticmethod
async def _owner_locale(session, user_id: str) -> str | None:
"""The owner's UI language preference, or None (= ``channel_connections.notification_locale``).
A missing, invalid or unreadable stored value falls back instead of
raising (liveness rule: the observer must not wedge recovery). Database
errors still propagate.
"""
try:
value = await session.scalar(select(UserPreferenceRow.value).where(UserPreferenceRow.user_id == user_id, UserPreferenceRow.key == "locale"))
except (ValueError, TypeError, KeyError):
# Undecodable stored JSON (json.JSONDecodeError is a ValueError).
return None
return value if isinstance(value, str) and value in NOTIFICATION_LOCALES else None
def detach_notification_outbox(self) -> None:
"""Stop enqueueing run notifications (issue #4254).
The Gateway calls this when the delivery side cannot start, so the outbox
does not fill with rows nothing will send.
"""
self._connection_repo = None
self._notification_repo = None
self._install_finalization_observers()
async def run_once(self, *, now: datetime) -> None:
if self._multi_instance:
if self._skip_next_lease_reconciliation:
self._skip_next_lease_reconciliation = False
else:
await self._reconcile_active_state(now=now)
else:
await self._task_run_repo.recover_expired_launch_claims(
error=_LEASE_RECOVERY_ERROR,
now=now,
)
await self._expire_waiting_runs(now=now)
await self._drain_queue(now=now)
# Admission and execution capacity are separate. Due occurrences are
# persisted even when all execution slots are busy; claim_queued_run()
# applies the global launch budget under the database lock.
claimed = await self._task_repo.claim_due_tasks(
now=now,
lease_owner=self._lease_owner,
lease_seconds=self._lease_seconds,
limit=self._max_concurrent_runs,
)
for task in claimed:
await self.dispatch_task(task, now=now, trigger="scheduled")
@staticmethod
def _is_overlap_conflict(exc: Exception) -> bool:
if isinstance(exc, ConflictError):
return True
return isinstance(exc, HTTPException) and exc.status_code == 409
@staticmethod
def _task_status_for_failure(task: dict[str, Any], *, trigger: str) -> str:
if trigger == "manual":
# A failed manual trigger must not consume the task's scheduled
# future: a `once` task with run_at still ahead would otherwise be
# flipped to "failed" and never claimed again.
return task.get("status") or "enabled"
if task["schedule_type"] == "once":
return "failed"
return "enabled"
@staticmethod
def _task_status_for_launch(task: dict[str, Any], *, trigger: str) -> str:
# The task-level status to write once _launch_run has produced a live
# run. A `once` task stays "running" until handle_run_completion
# observes the real terminal outcome; declaring "completed" at launch
# would stick if the run fails or the process dies (startup
# reconciliation is cancel_stuck_once_tasks).
if task["schedule_type"] == "once":
return "running"
if trigger == "manual" and task.get("status") == "paused":
return "paused"
return "enabled"
async def dispatch_task(
self,
task: dict[str, Any],
*,
now: datetime,
trigger: str,
) -> dict[str, Any]:
end_check = getattr(self._task_repo, "complete_if_ended", None)
if trigger == "scheduled" and callable(end_check) and await end_check(task["id"], user_id=task.get("user_id"), now=now):
return {"outcome": "completed", "task_run_id": None, "run_id": None, "thread_id": task.get("thread_id"), "error": None}
expected_lease_owner = self._lease_owner if trigger == "scheduled" else None
execution_thread_id = task.get("thread_id")
if task.get("context_mode") == "fresh_thread_per_run" or execution_thread_id is None:
execution_thread_id = str(uuid.uuid4())
try:
validate_thread_id(execution_thread_id)
except ValueError as exc:
# Rows persisted before the thread-id contract was centralized may
# hold IDs that were valid then (dots, unlimited length) but fail
# the canonical pattern now. Route through the normal failure
# bookkeeping instead of raising: an uncaught ValueError here would
# surface as HTTP 500 on manual trigger and, in the poller, abort
# the rest of the claimed batch every cycle while the task itself
# is never marked with last_error.
task_status = self._task_status_for_failure(task, trigger=trigger)
await self._task_repo.update_after_launch(
task["id"],
status=task_status,
next_run_at=next_run_at(
task["schedule_type"],
task["schedule_spec"],
task["timezone"],
now=now,
),
last_run_at=now,
last_run_id=None,
last_thread_id=execution_thread_id,
last_error=str(exc),
increment_run_count=False,
expected_lease_owner=expected_lease_owner,
)
return {
"outcome": "failed",
"task_run_id": None,
"run_id": None,
"thread_id": execution_thread_id,
"error": str(exc),
}
active = await self._task_run_repo.get_active_run(task["id"])
if active is not None:
if trigger == "scheduled":
await self._release_admission_lease(task, trigger=trigger)
return self._existing_active_result(active, execution_thread_id, trigger=trigger)
task_run_id = f"task-run-{uuid.uuid4().hex}"
try:
await self._task_run_repo.create(
run_record_id=task_run_id,
task_id=task["id"],
thread_id=execution_thread_id,
scheduled_for=now,
trigger=trigger,
status="queued",
coordinate_with_task=True,
expected_task_user_id=task.get("user_id"),
expected_task_status=task.get("status") if trigger == "manual" else None,
expected_task_updated_at=task.get("updated_at") if trigger == "manual" else None,
expected_task_lease_owner=self._lease_owner if trigger == "scheduled" else None,
release_task_lease_status="enabled" if trigger == "scheduled" else None,
)
except ActiveScheduledRunConflict:
active = await self._task_run_repo.get_active_run(task["id"])
if trigger == "scheduled":
await self._release_admission_lease(task, trigger=trigger)
if active is None:
return self._active_run_conflict_result(execution_thread_id)
return self._existing_active_result(active, execution_thread_id, trigger=trigger)
except ScheduledTaskAdmissionRejected as exc:
if exc.reason == "ended":
return {"outcome": "completed", "task_run_id": None, "run_id": None, "thread_id": execution_thread_id, "error": None}
if exc.reason == "not_found":
return {
"outcome": "not_found",
"task_run_id": None,
"run_id": None,
"thread_id": execution_thread_id,
"error": "scheduled task no longer exists",
}
return {
"outcome": "conflict",
"task_run_id": None,
"run_id": None,
"thread_id": execution_thread_id,
"error": TASK_CHANGED_ERROR,
}
# Scheduled admission inserted the queue row and released its parent
# lease in one transaction. Manual admission verified that this task
# snapshot was still current under the same parent lock.
queued = {
"id": task_run_id,
"task_id": task["id"],
"thread_id": execution_thread_id,
"trigger": trigger,
}
return await self._attempt_queued_run(task, queued, now=now)
async def _release_admission_lease(self, task: dict[str, Any], *, trigger: str) -> None:
status = "enabled" if trigger == "scheduled" else (task.get("status") or "enabled")
await self._task_repo.release_dispatch_lease(
task["id"],
expected_lease_owner=self._lease_owner if trigger == "scheduled" else None,
status=status,
)
async def _attempt_queued_run(
self,
task: dict[str, Any],
queued: dict[str, Any],
*,
now: datetime,
) -> dict[str, Any]:
"""Turn one queued occurrence into a live run under its own trace scope.
The poller is a non-HTTP entry point, so no ``TraceMiddleware`` has
bound anything: each occurrence opens its own scope rather than
sharing one id across a whole poll cycle. A manual trigger arrives
inside a Gateway request and keeps that request's trace instead, so
the launched run stays correlated with the call that asked for it.
"""
with ensure_trace_context():
return await self._launch_queued_occurrence(task, queued, now=now)
async def _launch_queued_occurrence(
self,
task: dict[str, Any],
queued: dict[str, Any],
*,
now: datetime,
) -> dict[str, Any]:
task_run_id = queued["id"]
execution_thread_id = queued["thread_id"]
trigger = queued["trigger"]
claimed = await self._task_run_repo.claim_queued_run(
task_run_id,
lease_owner=self._lease_owner,
now=now,
lease_seconds=self._lease_seconds,
global_max_concurrent_runs=self._max_concurrent_runs,
per_user_max_concurrent_runs=self._max_concurrent_runs_per_user,
)
if claimed is None:
return self._queued_result(task_run_id, execution_thread_id)
# Track whether _launch_run has produced a live run. A bookkeeping
# failure after launch must retain the non-terminal slot so a later
# poll cannot start the same occurrence twice.
launched_run_id: str | None = None
launched_thread_id: str | None = None
launch_succeeded = False
try:
# Goals, notes, the stop rule and the previous-run reference apply
# to every task, whether a chat or the tasks page created it.
metadata = {"scheduled_task_id": task["id"], "scheduled_task_run_id": task_run_id, "scheduled_trigger": trigger, "scheduled_context_mode": task.get("context_mode")}
if task.get("origin_thread_id") is not None:
metadata["scheduled_tool_created"] = True # informational only
# The stop rule is composed only here, never stored in the prompt.
prompt = launch_prompt(task["prompt"], task.get("stop_condition"), can_stop=await self._can_stop_itself())
notes = task.get("standing_notes") or []
if notes:
prompt += "\n\n<standing_notes>\n" + "\n".join(f"- {note}" for note in notes) + "\n</standing_notes>"
if task.get("goal_objective") is not None:
metadata["scheduled_goal_objective"] = task["goal_objective"]
previous_lookup = getattr(self._task_run_repo, "previous_occurrence", None)
if task.get("context_mode") == "fresh_thread_per_run" and task["schedule_type"] != "once" and callable(previous_lookup):
previous = await previous_lookup(task["id"], before_task_run_id=task_run_id)
if previous is not None and previous.get("thread_id") != execution_thread_id:
metadata["scheduled_previous_thread_id"] = previous["thread_id"]
origin, title = await self._launch_provenance(task, queued, now=now)
result = await self._launch_run(
thread_id=execution_thread_id,
assistant_id=task.get("assistant_id"),
prompt=prompt,
owner_user_id=task.get("user_id"),
metadata=metadata,
origin=origin,
title=title,
)
launch_succeeded = True
launched_run_id = result["run_id"]
launched_thread_id = result["thread_id"]
next_at = next_run_at(
task["schedule_type"],
task["schedule_spec"],
task["timezone"],
now=now,
)
task_status = self._task_status_for_launch(task, trigger=trigger)
await self._record_launched_run(
task_run_id=task_run_id,
task_id=task["id"],
run_id=launched_run_id,
started_at=now,
)
await self._task_repo.update_after_launch(
task["id"],
status=task_status,
next_run_at=next_at,
last_run_at=now,
last_run_id=launched_run_id,
last_thread_id=launched_thread_id,
last_error=None,
increment_run_count=True,
task_run_id=task_run_id,
# Same race as the run-row write above: a fast-failing run's
# completion hook may have already finalized a `once` task.
protect_terminal=True,
)
return {
"outcome": "launched",
"task_run_id": task_run_id,
"run_id": launched_run_id,
"thread_id": launched_thread_id,
"error": None,
}
except Exception as exc:
if not launch_succeeded and self._is_overlap_conflict(exc):
await self._task_run_repo.requeue_claimed_run(
task_run_id,
lease_owner=self._lease_owner,
error=str(exc),
)
return self._queued_result(task_run_id, execution_thread_id, error=str(exc))
next_at = next_run_at(
task["schedule_type"],
task["schedule_spec"],
task["timezone"],
now=now,
)
if launch_succeeded:
# _launch_run succeeded, so a run is live even though
# post-launch bookkeeping raised. Keep the task-run row
# "running" so it keeps holding the task's single active slot
# (preventing a duplicate launch on the next dispatch) and
# persist the run_id on the parent task for recovery /
# reconciliation / cancellation. These writes are best-effort:
# if the DB is still down the row stays "queued" -- still
# active, still holding the slot -- so we log and still report
# the run as launched so callers know a run is in flight.
task_status = self._task_status_for_launch(task, trigger=trigger)
try:
await self._record_launched_run(
task_run_id=task_run_id,
task_id=task["id"],
run_id=launched_run_id,
started_at=now,
)
except Exception:
logger.exception(
"Scheduled task-run %s: post-launch bookkeeping failed; run %s is still live (task %s)",
task_run_id,
launched_run_id,
task["id"],
)
try:
await self._task_repo.update_after_launch(
task["id"],
status=task_status,
next_run_at=next_at,
last_run_at=now,
last_run_id=launched_run_id,
last_thread_id=launched_thread_id,
# The bookkeeping exception is an infrastructure-level
# transient, not a run-level failure: the run launched
# and is still in flight. Clear last_error like the
# success path so the task list does not show an error
# on a task whose run is actively running; the real
# terminal outcome is written by handle_run_completion.
# The transient itself is logged above.
last_error=None,
increment_run_count=True,
task_run_id=task_run_id,
protect_terminal=True,
)
except Exception:
logger.exception(
"Scheduled task %s: post-launch update failed; run %s is still live",
task["id"],
launched_run_id,
)
return {
"outcome": "launched",
"task_run_id": task_run_id,
"run_id": launched_run_id,
"thread_id": launched_thread_id,
"error": str(exc),
}
# _launch_run itself failed (or a step before it did): no live run
# was created, so it is safe to release the active slot.
finalized = await self._task_run_repo.fail_launching_run(
task_run_id,
task_id=task["id"],
lease_owner=self._lease_owner,
error=str(exc),
now=now,
)
if not finalized:
logger.warning(
"Scheduled task-run %s lost its launch claim before failure bookkeeping; leaving recovery-owned state unchanged",
task_run_id,
)
return self._queued_result(task_run_id, execution_thread_id, error=str(exc))
return {
"outcome": "failed",
"task_run_id": task_run_id,
"run_id": None,
"thread_id": execution_thread_id,
"error": str(exc),
}
async def _launch_provenance(self, task: dict[str, Any], queued: dict[str, Any], *, now: datetime) -> tuple[dict[str, Any], str | None]:
"""What the run thread shows about this launch, and its title.
``origin`` carries the user-language parts (instructions, stop
condition, notes) so the run thread never has to show the launched
text, which also holds host-written English. The run number is the
one the run row shows once the launch is accounted.
"""
trigger = queued["trigger"]
scheduled_for = _as_utc(queued.get("scheduled_for")) if trigger == "scheduled" else None
scheduled_for = scheduled_for or now
run_number = None
number_lookup = getattr(self._task_run_repo, "run_number", None)
if trigger == "scheduled" and callable(number_lookup):
try:
run_number = await number_lookup(queued["id"])
except Exception:
logger.warning("Scheduled task-run %s: run number lookup failed", queued["id"], exc_info=True)
origin = {
"task_id": task["id"],
"task_run_id": queued["id"],
"trigger": trigger,
"run_number": run_number,
"scheduled_for": scheduled_for.isoformat(),
"timezone": task["timezone"],
"schedule_type": task.get("schedule_type"),
"task_title": task.get("title") or "",
"instructions": task["prompt"],
"stop_condition": task.get("stop_condition"),
"standing_notes": list(task.get("standing_notes") or []),
}
title = None
if task.get("context_mode") == "fresh_thread_per_run":
title = origin["task_title"][:80]
if not _zone_is_placeholder(task):
title = f"{title} · {scheduled_for.astimezone(ZoneInfo(task['timezone'])):%m-%d %H:%M}"
elif run_number is not None:
# No zone the reader would recognise: name the run, not a UTC time.
title = f"{title} · #{run_number}"
return origin, title
async def _record_launched_run(
self,
*,
task_run_id: str,
task_id: str,
run_id: str,
started_at: datetime,
) -> None:
updated = await self._task_run_repo.update_status(
task_run_id,
status="running",
run_id=run_id,
started_at=started_at,
protect_terminal=True,
expected_lease_owner=self._lease_owner,
)
if updated:
return
reconciled = await self._task_run_repo.reconcile_launched_run(
task_run_id,
task_id=task_id,
run_id=run_id,
started_at=started_at,
)
if not reconciled:
logger.error(
"Scheduled task-run %s launched durable run %s but could not restore its occurrence association",
task_run_id,
run_id,
)
def _active_run_conflict_result(self, thread_id: str) -> dict[str, Any]:
"""Manual-trigger response when the task already has an active run.
Nothing was scheduled to happen, so no run-history row is recorded; the
router maps this to a 409.
"""
return {
"outcome": "conflict",
"task_run_id": None,
"run_id": None,
"thread_id": thread_id,
"error": _ACTIVE_RUN_CONFLICT_ERROR,
}
def _existing_active_result(
self,
active: dict[str, Any],
thread_id: str,
*,
trigger: str,
) -> dict[str, Any]:
if active["status"] == "queued":
# No new occurrence was admitted; the caller reports the waiting one.
return self._queued_result(active["id"], active["thread_id"], existing=True)
return self._active_run_conflict_result(thread_id)
@staticmethod
def _queued_result(
task_run_id: str,
thread_id: str,
*,
error: str | None = None,
existing: bool = False,
) -> dict[str, Any]:
return {
"outcome": "queued",
"task_run_id": task_run_id,
"run_id": None,
"thread_id": thread_id,
"error": error,
"existing": existing,
}
async def _drain_queue(self, *, now: datetime) -> None:
queued_rows = await self._task_run_repo.list_queued_runs(
limit=max(16, self._max_concurrent_runs * 4),
per_user_max_concurrent_runs=self._max_concurrent_runs_per_user,
)
for queued in queued_rows:
await self._task_repo.release_queued_admission_lease(queued["task_id"])
task = await self._task_repo.get_internal(queued["task_id"])
if task is None:
await self._task_run_repo.update_status(
queued["id"],
status="interrupted",
error=RUN_ERROR_DELETED_WHILE_QUEUED,
finished_at=now,
)
continue
# Pausing suppresses automatic occurrences, but a manual trigger is
# an explicit request and has always been allowed to run without
# resuming the schedule. A later pause still cancels an already
# queued manual row atomically in pause_with_queue_cancellation().
if task.get("status") == "paused" and queued["trigger"] != "manual":
await self._task_run_repo.update_status(
queued["id"],
status="interrupted",
error=RUN_ERROR_PAUSED_WHILE_QUEUED,
finished_at=now,
)
continue
await self._attempt_queued_run(task, queued, now=now)
async def _expire_waiting_runs(self, *, now: datetime) -> None:
await self._task_run_repo.expire_queued_runs(
created_before=now - timedelta(seconds=self._queue_timeout_seconds),
error=_QUEUE_TIMEOUT_ERROR,
now=now,
)
async def handle_run_completion(self, record: RunRecord) -> None:
metadata = record.metadata or {}
task_id = metadata.get("scheduled_task_id")
task_run_id = metadata.get("scheduled_task_run_id")
user_id = record.user_id
if not isinstance(task_id, str) or not isinstance(task_run_id, str) or not user_id:
return
terminal_status: Literal["success", "failed", "interrupted", "unmet"] | None
if record.status.value == "success":
terminal_status = "success"
error = None
verdict = getattr(record, "goal_verdict", None)
if metadata.get("scheduled_goal_objective") is not None and (not isinstance(verdict, dict) or verdict.get("satisfied") is not True):
terminal_status = "unmet"
error = (verdict.get("stand_down_reason") if isinstance(verdict, dict) else None) or "no_verdict"
elif record.status.value == "interrupted":
# Distinct from "failed": an interrupt (user cancel, same-thread
# takeover) carries no error and is not an execution failure.
terminal_status = "interrupted"
error = record.error or RUN_ERROR_INTERRUPTED
elif record.status.value in {"error", "timeout"}:
terminal_status = "failed"
error = record.error
else:
terminal_status = None
error = record.error
if terminal_status is None:
return
completion_kwargs = {}
if metadata.get("scheduled_goal_objective") is not None:
completion_kwargs["goal_verdict"] = getattr(record, "goal_verdict", None)
# The outcome and its notices (chat event, IM outbox row) commit in one
# transaction: the finalization observer stages them. A completion
# that recorded nothing (another run's occurrence, already finalized
# by recovery) announces nothing.
await self._task_repo.complete_run(
task_id,
user_id=user_id,
task_run_id=task_run_id,
run_id=record.run_id,
status=terminal_status,
error=error,
finished_at=datetime.now(UTC),
**completion_kwargs,
)
async def start(self) -> None:
if self._task is not None:
return
restart_error = _RESTART_RECOVERY_ERROR
if self._multi_instance:
await self._reconcile_active_state(now=datetime.now(UTC))
self._skip_next_lease_reconciliation = True
else:
# This destructive sweep is safe only while Gateway lifespan awaits
# start(): no request or poll admission can create a run owned by
# this process yet. Complete occurrence -> parent recovery before
# returning; moving either pass into run_once() can interrupt live
# work or race manual admission.
try:
stale = await self._task_run_repo.mark_stale_active_runs(error=restart_error)
if stale:
logger.warning("Marked %d stale scheduled task run(s) as interrupted after restart", stale)
except Exception:
logger.exception("Failed to sweep stale scheduled task runs at startup")
raise
try:
# The run rows above are only half the story: a launched `once`
# task is parked in "running" until the (now dead) completion hook
# would have finalized it.
stuck = await self._task_repo.cancel_stuck_once_tasks(error=restart_error)
if stuck:
logger.warning("Reconciled %d stuck once task(s) after restart", stuck)
except Exception:
logger.exception("Failed to reconcile stuck once tasks at startup")
raise
self._stop.clear()
self._task = asyncio.create_task(self._run_loop())
async def _reconcile_active_state(self, *, now: datetime) -> None:
error = _LEASE_RECOVERY_ERROR
try:
stale = await self._task_run_repo.reconcile_active_runs(
error=error,
now=now,
lease_grace_seconds=self._run_lease_grace_seconds,
)
if stale:
logger.warning("Marked %d stale scheduled task run(s) as interrupted after lease reconciliation", stale)
except Exception:
logger.exception("Failed to reconcile scheduled task runs with leases")
try:
stuck = await self._task_repo.reconcile_stuck_once_tasks(
error=error,
now=now,
lease_grace_seconds=self._run_lease_grace_seconds,
)
if stuck:
logger.warning("Reconciled %d stuck once task(s) after lease reconciliation", stuck)
except Exception:
logger.exception("Failed to reconcile once tasks with leases")
async def stop(self) -> None:
if self._task is None:
return
self._stop.set()
await self._task
self._task = None
async def _run_loop(self) -> None:
while not self._stop.is_set():
try:
await self.run_once(now=datetime.now(UTC))
except Exception:
# A transient DB error (e.g. SQLite "database is locked") must
# not kill the poller task for the rest of the process life.
logger.exception("Scheduled task poll failed; retrying next interval")
try:
await asyncio.wait_for(
self._stop.wait(),
timeout=self._poll_interval_seconds,
)
except TimeoutError:
continue