deer-flow/backend/tests/test_scheduled_task_service.py
Totoro b57fa6fb9e
feat(scheduler): push scheduled task results to IM channels via a notification outbox (#6135)
* feat(persistence): add notification delivery outbox for scheduled task IM push

New notification_deliveries table and repository (migration 0012) backing
the outbox pattern for issue #4254: idempotent enqueue keyed on task_run_id
plus event plus provider plus target, atomic claim of due rows, and
exponential-backoff retry state moving pending to sending to sent or failed.
Execution status stays in scheduled_task_runs; delivery status lives here.

* feat(scheduler): enqueue and deliver scheduled-task notifications over IM channels

Closes the loop for issue #4254. On run completion the scheduler writes
outbox rows for the task owner's connected channel identities (success and
failure events; interrupts stay silent), and a new NotificationDeliveryWorker
polls due rows and pushes them through the channel's proactive send path.
Channel gains send_notification; WeCom implements it via the WS client's
send_message with errcode checking, the base class raises for providers
without proactive push.

Delivery is best-effort and never shadows execution status: enqueue and send
failures are logged and recorded in the outbox, which retries with backoff.
Channel liveness is re-checked at delivery time, and the worker stops before
the channel service on shutdown. Feature activates only when channel
connections are enabled; no new dependencies.

Verified end to end against a live WeCom bot: scheduled run completion
produced an outbox row that was delivered in under one second.

* feat(scheduler): include scheduled run result summary in IM notifications

The v1 notification only carried the run outcome skeleton (status, task id,
run id). Completed runs now include the agent's final answer so the IM push
is actually useful headlessly.

- The delivery worker accepts an optional resolve_run_summary(run_id,
  user_id) resolver; for run_completed events it enriches the rendered text
  with a "Result:" line (bounded to 1000 chars). The lookup is best-effort:
  resolver failures or missing summaries degrade to the skeleton text and
  never block or fail the delivery.
- The summary is read at delivery time from runs.last_ai_message (the
  convenience column written on run completion), not snapshotted into the
  outbox payload; retried deliveries re-read the freshest value and the
  outbox row payload stays skeleton-only. The claimed outbox row is never
  mutated in place.
- Gateway wiring scopes the read to the outbox row's owner_user_id so a
  stale row cannot pull another user's run content.
- Failed runs keep the error-only skeleton: a partial answer on a failed
  run would be misleading.

Tests: 9 new worker cases (rendering incl. truncation, sync/async
resolvers, failure/missing fallbacks, no resolver call for failed runs).
Full scheduled + outbox + channels regression green (441 passed), ruff
check + format clean.

* fix(scheduler): address review feedback on notification delivery reliability

Review follow-ups for the scheduled-task IM notification outbox:

1. Crash recovery for "sending" rows: claim now stamps updated_at and the
   worker reconciles rows stuck in "sending" past a 10-minute lease back to
   "pending" before every claim. Per-row try/except isolates a crashing
   delivery from the rest of the claimed batch.
2. Double-send race under multiple workers: claim returns exactly the rows
   its own UPDATE...RETURNING flipped (guarded by status='pending'), so a
   rival worker's concurrent claim can no longer be handed out twice.
3. Restore non-ASCII comments and drop the BOM accidentally introduced in
   test_scheduled_task_service.py.
4. Manual "run now" completions no longer enqueue IM notifications; the
   user is already watching the UI. Missing trigger metadata fails safe
   towards notifying.
5. Channel-outage failures no longer consume the retry budget: they are
   parked with count_attempt=False on a flat 15-minute backoff so an
   hours-long outage cannot exhaust retries and drop the notification.

Tests: repository 16, worker 21, scheduled-task service 31; targeted
regression across notification/scheduler/channel suites: 511 passed.

* fix(scheduler): address round-2 review on IM notification delivery

Park WeCom transport/outage failures without burning retries, bound worker stop, include task titles, align enqueue with delivery, and document the IM push behavior.

Co-authored-by: Cursor <cursoragent@cursor.com>

* docs(scheduler): complete IM notification docs and drop unused list API

Add backend/channels/migrations AGENTS notes, CHANGELOG and config.example hints for the outbox push path, and remove the unused list_by_task_run repository method flagged in review.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scheduler): address round-3 review on IM notification delivery

Cap channel-down parking by row age and parked attempts, redact IM egress
content, narrow WeCom transport exceptions, add lifespan wiring tests, and
run ruff format so lint-backend passes.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(scheduler): redact entire PEM blocks in IM egress text

The previous BEGIN-only pattern left key material and the END marker in notifications.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(persistence): align 0014 parked_attempts with bootstrap schema tests

Backfill existing rows with a temporary server default, then drop it so create_all matches Alembic, and move HEAD anchors to 0014.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(persistence): format notification tests and shorten alembic revision id

ruff format --check failed on test_notification_delivery_worker.py.
0015_notification_delivery_parked_attempts exceeds alembic_version.version_num
(VARCHAR 32) and truncates on Postgres CI; use 0015_parked_attempts instead.

* test: fix post-merge CI failures after migration renumber

Update migration 0015 test HEAD expectation to 0017_parked_attempts and add queue_timeout_seconds to the lifespan notification worker mock scheduler config.

* fix(persistence): chain the notification outbox migrations after 0026

Main's head moved from 0016 to 0026_mcp_task_lease_tokens, so the two
outbox revisions are renumbered and re-parented:

- 0017_notification_deliveries -> 0027_notification_deliveries
- 0018_parked_attempts -> 0028_parked_attempts

Only the revision ids, parents and the migration guide change.

* fix(scheduler): adapt the notification hook and its docs to main

- tests: the completion tests assert on the atomic complete_run record;
  new cases cover a completion that was not recorded, a task deleted
  meanwhile, a failed task read, and the outbox being off.
- AGENTS.md: drop the root note and shorten the backend note to a pointer;
  the two notes pushed two effective guidance chains past the 96 KiB limit.
- CHANGELOG: move the entry from the released 2.1.0 section to Unreleased
  and add its link references.

* test(persistence): move the chain-head pin to the outbox migrations

test_migration_0026 pinned 0026 as the head, so it failed once the outbox
revisions chained after it. It now checks chain membership like the older
migration tests, and a new test file owns the head pin, checks the parents
and the 32-character revision id limit, and runs the upgrade and downgrade.

* fix(gateway): wire scheduled-task notifications after the channel service starts

The outbox wiring sat in the scheduler block and asked for the running
channel service there. #5035 moved the channel service start to after the
scheduler, and the two changes merged without a conflict, so on every
startup the lookup returned None and the feature disabled itself with the
"write-only outbox" warning. The lifespan tests patched the lookup to a
constant and kept passing.

The wiring now runs in its own step after the channel service start. The
scheduler is built as on main, and ScheduledTaskService gains
attach_notification_outbox() so the enqueue side is enabled once the
delivery worker is running. The guard, the worker and the shutdown order
are unchanged.

Tests: the lifespan helper can model the real accessor (None until the
channel service has started); a new case fails without this fix.

* fix(scheduler): enqueue from scheduler start and keep the push when the title read fails

Follow-up to the startup-order fix, from review.

- The enqueue side is wired with the scheduler again (it only needs the
  durable table), and only the delivery worker waits for the channel
  service. Attaching it later left a window after the scheduler started in
  which a finished run wrote no outbox row. If the channel service is
  missing or the worker cannot start, the enqueue side is detached, so the
  outbox still never becomes write-only.
- A failed task read after complete_run no longer drops the notification:
  the title is optional and the message falls back to the task id. A task
  deleted meanwhile still stays silent.

* fix(channels): park WeCom notifications while the SDK socket is closed

The WeCom SDK raises a plain RuntimeError when its socket is not open, and
send_notification only mapped ConnectionError, TimeoutError and OSError to
ChannelUnavailable. A disconnect therefore spent the counted retry budget
and settled the row as failed after about 15 minutes, although the docs
say transport outages park without consuming retries.

send_notification now asks the client's is_connected first. The new test
uses a real, never-connected SDK client: it raised RuntimeError after three
retries before, and parks now.

* docs(scheduler): describe which outcomes notify; mirror the changelog entry

- README (en/zh) and CONFIGURATION.md: only runs that finish as success or
  failed notify; occurrences that end without a finished run (launch error,
  queue timeout, restart recovery) do not. Parking lasts up to about a day.
- CHANGELOG: cite the issue as text like the rest of the file, and add the
  entry and link reference to CHANGELOG_zh.md.
- AGENTS.md: drop the backend pointer so this branch adds nothing to the
  guidance chains closest to their size limit; the scheduler-side rules
  and the lifespan order now live in app/channels/AGENTS.md.

* docs(changelog): cite #6135 next to #4843 for the notification outbox entry

* fix(scheduler,channels): re-check the IM binding at delivery time; park WeCom transport errors, count its rejections

Review round 1 on #6135.

The delivery worker now takes resolve_connections (the Gateway wires
ChannelConnectionRepository.list_connections) and, before the channel
liveness check and the summary read, requires the row's owner to still
hold a connected (provider, external_account_id). A disconnected target
is finalized with mark_failed(terminal=True); a lookup failure or an
unexpected result shape parks the row. Terminal outbox rows ignore
later status writes.

WeCom: the SDK raises RuntimeError from send_message for a socket that
is not open and for a dropped connection, but also for a platform
rejection ("Reply ack error: errcode=..."). Only that prefix keeps
counting; other RuntimeErrors, ConnectionError/TimeoutError/OSError and
websockets' ConnectionClosed park the row as ChannelUnavailable.

* fix(channels): treat a WeCom ACK rejection as proof the transport is up; pin the rejection prefix through the retry branch and the real connection-row shape

---------

Co-authored-by: GaoTianyuanhr <75788039+GaoTianyuanhr@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: GaoTianyuanhr <GaoTianyuanhr@users.noreply.github.com>
Co-authored-by: Totoro-qaq <279883115+Totoro-qaq@users.noreply.github.com>
2026-10-01 17:59:30 +08:00

1497 lines
51 KiB
Python

import asyncio
from datetime import UTC, datetime, timedelta
import pytest
from app.scheduler.service import ScheduledTaskService
from deerflow.runtime import ConflictError, RunStatus
from deerflow.runtime.runs.manager import RunRecord
from deerflow.runtime.runs.schemas import DisconnectMode
class DummyTaskRepo:
def __init__(self, rows):
self.rows = rows
self.claimed = False
self.updated = None
self.completions = []
self.release_calls = []
self.cancelled_stuck_once = None
self.reconciled_stuck_once = None
async def cancel_stuck_once_tasks(self, *, error):
self.cancelled_stuck_once = error
return 0
async def reconcile_stuck_once_tasks(self, **kwargs):
self.reconciled_stuck_once = kwargs
return 0
async def claim_dispatch_lease(self, task_id, **_kwargs):
return next((dict(row) for row in self.rows if row["id"] == task_id), None)
async def release_queued_admission_lease(self, task_id):
return False
async def release_dispatch_lease(self, task_id, **kwargs):
self.release_calls.append((task_id, kwargs))
return True
async def claim_due_tasks(self, **_kwargs):
if self.claimed:
return []
self.claimed = True
return self.rows
async def update_after_launch(self, *args, **kwargs):
self.updated = (args, kwargs)
async def complete_run(self, task_id, **kwargs):
self.completions.append((task_id, kwargs))
return True
async def get(self, task_id: str, *, user_id: str):
row = next((item for item in self.rows if item["id"] == task_id and item["user_id"] == user_id), None)
return dict(row) if row is not None else None
async def get_internal(self, task_id: str):
row = next((item for item in self.rows if item["id"] == task_id), None)
return dict(row) if row is not None else None
async def update(self, task_id: str, *, user_id: str, updates):
row = next((item for item in self.rows if item["id"] == task_id and item["user_id"] == user_id), None)
if row is None:
return None
row.update(updates)
return dict(row)
class DummyRunRepo:
def __init__(self, *, active=False, active_count=0):
self.created = None
self.updated = []
self.active = active
self.active_count = active_count
self.stale_marked = None
self.reconciled = None
self.reconcile_count = 0
async def count_active_runs(self):
return self.active_count
async def list_queued_runs(self, *, limit):
return []
async def expire_queued_runs(self, **_kwargs):
return []
async def recover_expired_launch_claims(self, **_kwargs):
return 0
async def get_active_run(self, task_id):
if not self.active:
return None
return {
"id": "task-run-active",
"task_id": task_id,
"thread_id": "thread-active",
"status": "running",
}
async def claim_queued_run(self, run_record_id, *, global_max_concurrent_runs, **_kwargs):
if self.active_count >= global_max_concurrent_runs:
return None
return {"id": run_record_id, "status": "launching"}
async def requeue_claimed_run(self, run_record_id, **kwargs):
self.updated.append((run_record_id, {"status": "queued", **kwargs}))
return True
async def create(self, **kwargs):
self.created = kwargs
return {"id": kwargs["run_record_id"]}
async def update_status(self, run_record_id, **kwargs):
self.updated.append((run_record_id, kwargs))
return True
async def reconcile_launched_run(self, run_record_id, **kwargs):
self.updated.append((run_record_id, {"reconciled": True, **kwargs}))
return True
async def fail_launching_run(self, run_record_id, **kwargs):
self.updated.append((run_record_id, {"status": "failed", **kwargs}))
return True
async def has_active_runs(self, task_id):
return self.active
async def mark_stale_active_runs(self, *, error):
self.stale_marked = error
return 0
async def reconcile_active_runs(self, **kwargs):
self.reconcile_count += 1
self.reconciled = kwargs
return 0
@pytest.mark.asyncio
async def test_service_claims_and_dispatches_due_task():
async def fake_launch(**kwargs):
assert kwargs["owner_user_id"] == "user-1"
assert kwargs["metadata"]["scheduled_task_id"] == "task-1"
assert kwargs["metadata"]["scheduled_trigger"] == "scheduled"
return {"run_id": "run-1", "thread_id": kwargs["thread_id"]}
task_repo = DummyTaskRepo(
[
{
"id": "task-1",
"user_id": "user-1",
"thread_id": "thread-1",
"context_mode": "reuse_thread",
"assistant_id": "lead_agent",
"prompt": "Summarize thread",
"schedule_type": "once",
"schedule_spec": {"run_at": "2026-07-02T01:00:00+00:00"},
"timezone": "UTC",
}
]
)
run_repo = DummyRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
await service.run_once(now=datetime.now(UTC) + timedelta(days=1))
assert run_repo.created["task_id"] == "task-1"
assert run_repo.updated[0][1]["status"] == "running"
assert run_repo.updated[0][1]["protect_terminal"] is True
# `once` terminal status is owned by handle_run_completion, not the launch.
assert task_repo.updated[1]["status"] == "running"
@pytest.mark.asyncio
async def test_manual_trigger_keeps_paused_cron_task_paused():
async def fake_launch(**kwargs):
return {"run_id": "run-2", "thread_id": kwargs["thread_id"]}
task_repo = DummyTaskRepo(
[
{
"id": "task-2",
"user_id": "user-1",
"thread_id": "thread-1",
"context_mode": "reuse_thread",
"assistant_id": "lead_agent",
"prompt": "Summarize thread",
"schedule_type": "cron",
"schedule_spec": {"cron": "0 9 * * *"},
"timezone": "UTC",
"status": "paused",
}
]
)
run_repo = DummyRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
await service.dispatch_task(
task_repo.rows[0],
now=datetime.now(UTC),
trigger="manual",
)
assert task_repo.updated[1]["status"] == "paused"
@pytest.mark.asyncio
async def test_fresh_thread_per_run_creates_new_execution_thread():
async def fake_launch(**kwargs):
assert kwargs["thread_id"] != "thread-template"
return {"run_id": "run-3", "thread_id": kwargs["thread_id"]}
task_repo = DummyTaskRepo(
[
{
"id": "task-3",
"user_id": "user-1",
"thread_id": "thread-template",
"context_mode": "fresh_thread_per_run",
"assistant_id": "lead_agent",
"prompt": "Summarize thread",
"schedule_type": "cron",
"schedule_spec": {"cron": "0 9 * * *"},
"timezone": "UTC",
"status": "enabled",
}
]
)
run_repo = DummyRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
await service.dispatch_task(
task_repo.rows[0],
now=datetime.now(UTC),
trigger="scheduled",
)
assert run_repo.created["thread_id"] != "thread-template"
assert task_repo.updated[1]["last_thread_id"] == run_repo.created["thread_id"]
@pytest.mark.asyncio
async def test_scheduled_overlap_conflict_is_kept_in_queue():
async def fake_launch(**_kwargs):
raise ConflictError("Thread thread-1 already has an active run")
task_repo = DummyTaskRepo(
[
{
"id": "task-4",
"user_id": "user-1",
"thread_id": "thread-1",
"context_mode": "reuse_thread",
"assistant_id": "lead_agent",
"prompt": "Summarize thread",
"schedule_type": "cron",
"schedule_spec": {"cron": "0 9 * * *"},
"timezone": "UTC",
"status": "running",
"overlap_policy": "enqueue",
"last_run_id": "run-old",
"last_thread_id": "thread-1",
"last_run_at": "2026-07-01T00:00:00+00:00",
}
]
)
run_repo = DummyRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
result = await service.dispatch_task(
task_repo.rows[0],
now=datetime.now(UTC),
trigger="scheduled",
)
assert result["outcome"] == "queued"
assert run_repo.created["status"] == "queued"
assert run_repo.updated[-1][1]["status"] == "queued"
assert task_repo.updated is None
@pytest.mark.asyncio
async def test_manual_overlap_conflict_is_kept_in_queue():
async def fake_launch(**_kwargs):
raise ConflictError("Thread thread-1 already has an active run")
task_repo = DummyTaskRepo(
[
{
"id": "task-5",
"user_id": "user-1",
"thread_id": "thread-1",
"context_mode": "reuse_thread",
"assistant_id": "lead_agent",
"prompt": "Summarize thread",
"schedule_type": "cron",
"schedule_spec": {"cron": "0 9 * * *"},
"timezone": "UTC",
"status": "enabled",
"overlap_policy": "enqueue",
}
]
)
run_repo = DummyRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
result = await service.dispatch_task(
task_repo.rows[0],
now=datetime.now(UTC),
trigger="manual",
)
assert result["outcome"] == "queued"
assert run_repo.updated[-1][1]["status"] == "queued"
assert task_repo.release_calls == []
@pytest.mark.asyncio
async def test_dispatch_task_records_failure_for_legacy_invalid_thread_id():
"""Rows persisted before the thread-id contract was centralized may store
IDs that fail the canonical pattern (dots, >64 chars). Dispatch must record
the failure through normal bookkeeping instead of raising — an uncaught
ValueError surfaces as HTTP 500 on manual trigger and, in the poller,
aborts the rest of the claimed batch every cycle."""
async def fake_launch(**_kwargs):
raise AssertionError("launch_run must not be called for an invalid thread_id")
task_repo = DummyTaskRepo(
[
{
"id": "task-legacy",
"user_id": "user-1",
"thread_id": "thread.with.dot",
"context_mode": "reuse_thread",
"assistant_id": "lead_agent",
"prompt": "Summarize thread",
"schedule_type": "cron",
"schedule_spec": {"cron": "0 9 * * *"},
"timezone": "UTC",
"status": "enabled",
}
]
)
run_repo = DummyRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
result = await service.dispatch_task(
task_repo.rows[0],
now=datetime.now(UTC),
trigger="scheduled",
)
assert result["outcome"] == "failed"
assert result["task_run_id"] is None
assert result["run_id"] is None
assert "Invalid thread_id" in result["error"]
assert run_repo.created is None
assert task_repo.updated[1]["last_error"] == result["error"]
assert task_repo.updated[1]["last_thread_id"] == "thread.with.dot"
assert task_repo.updated[1]["increment_run_count"] is False
@pytest.mark.asyncio
async def test_run_once_continues_batch_after_invalid_thread_id():
"""A poison legacy row must not prevent later claimed tasks from dispatching."""
launched = []
async def fake_launch(**kwargs):
launched.append(kwargs)
return {"run_id": "run-ok", "thread_id": kwargs["thread_id"]}
task_repo = DummyTaskRepo(
[
{
"id": "task-legacy",
"user_id": "user-1",
"thread_id": "thread.with.dot",
"context_mode": "reuse_thread",
"assistant_id": "lead_agent",
"prompt": "Summarize thread",
"schedule_type": "cron",
"schedule_spec": {"cron": "0 9 * * *"},
"timezone": "UTC",
"status": "enabled",
},
{
"id": "task-valid",
"user_id": "user-1",
"thread_id": "thread-ok",
"context_mode": "reuse_thread",
"assistant_id": "lead_agent",
"prompt": "Summarize thread",
"schedule_type": "cron",
"schedule_spec": {"cron": "0 9 * * *"},
"timezone": "UTC",
"status": "enabled",
},
]
)
run_repo = DummyRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
await service.run_once(now=datetime.now(UTC))
assert len(launched) == 1
assert launched[0]["thread_id"] == "thread-ok"
@pytest.mark.asyncio
async def test_handle_run_completion_uses_atomic_repository_boundary():
task_repo = DummyTaskRepo(
[
{
"id": "task-6",
"user_id": "user-1",
"thread_id": None,
"context_mode": "fresh_thread_per_run",
"assistant_id": "lead_agent",
"prompt": "Summarize thread",
"schedule_type": "cron",
"schedule_spec": {"cron": "0 9 * * *"},
"timezone": "UTC",
"status": "enabled",
}
]
)
run_repo = DummyRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=lambda **_kwargs: None,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
record = RunRecord(
run_id="run-6",
thread_id="thread-6",
assistant_id="lead_agent",
status=RunStatus.success,
on_disconnect=DisconnectMode.continue_,
metadata={
"scheduled_task_id": "task-6",
"scheduled_task_run_id": "task-run-6",
},
user_id="user-1",
)
await service.handle_run_completion(record)
assert len(task_repo.completions) == 1
task_id, completion = task_repo.completions[0]
assert task_id == "task-6"
assert completion["user_id"] == "user-1"
assert completion["task_run_id"] == "task-run-6"
assert completion["run_id"] == "run-6"
assert completion["status"] == "success"
assert completion["error"] is None
assert completion["finished_at"].tzinfo == UTC
assert run_repo.updated == []
def _make_service(task_repo, run_repo):
return ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=lambda **_kwargs: None,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
def _once_task_row(task_id="task-once", status="running"):
return {
"id": task_id,
"user_id": "user-1",
"thread_id": None,
"context_mode": "fresh_thread_per_run",
"assistant_id": "lead_agent",
"title": "Once summary",
"prompt": "Summarize thread",
"schedule_type": "once",
"schedule_spec": {"run_at": "2026-07-02T01:00:00+00:00"},
"timezone": "UTC",
"status": status,
}
def _completion_record(status, *, task_id="task-once", error=None, trigger="scheduled"):
return RunRecord(
run_id="run-x",
thread_id="thread-x",
assistant_id="lead_agent",
status=status,
on_disconnect=DisconnectMode.continue_,
metadata={
"scheduled_task_id": task_id,
"scheduled_task_run_id": "task-run-x",
"scheduled_trigger": trigger,
},
user_id="user-1",
error=error,
)
@pytest.mark.asyncio
@pytest.mark.parametrize(
("run_status", "error", "occurrence_status", "expected_error"),
[
(RunStatus.success, None, "success", None),
(RunStatus.error, "boom", "failed", "boom"),
(RunStatus.timeout, "time limit", "failed", "time limit"),
(RunStatus.interrupted, None, "interrupted", "run was interrupted before completion"),
(RunStatus.interrupted, "cancelled by user", "interrupted", "cancelled by user"),
],
)
async def test_handle_run_completion_forwards_terminal_outcome(run_status, error, occurrence_status, expected_error):
task_repo = DummyTaskRepo([_once_task_row()])
run_repo = DummyRunRepo()
service = _make_service(task_repo, run_repo)
await service.handle_run_completion(_completion_record(run_status, error=error))
assert len(task_repo.completions) == 1
task_id, completion = task_repo.completions[0]
assert task_id == "task-once"
assert completion["status"] == occurrence_status
assert completion["error"] == expected_error
assert run_repo.updated == []
@pytest.mark.asyncio
async def test_existing_running_occurrence_blocks_duplicate_fresh_thread_run():
launched = []
async def fake_launch(**kwargs):
launched.append(kwargs)
return {"run_id": "run-9", "thread_id": kwargs["thread_id"]}
row = _once_task_row(task_id="task-9")
row.update({"schedule_type": "cron", "schedule_spec": {"cron": "* * * * *"}, "status": "running", "overlap_policy": "enqueue"})
task_repo = DummyTaskRepo([row])
run_repo = DummyRunRepo(active=True)
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
result = await service.dispatch_task(row, now=datetime.now(UTC), trigger="scheduled")
assert result["outcome"] == "conflict"
assert launched == []
assert run_repo.created is None
@pytest.mark.asyncio
async def test_startup_sweep_reconciles_stale_runs_and_stuck_once_tasks():
task_repo = DummyTaskRepo([])
run_repo = DummyRunRepo()
service = _make_service(task_repo, run_repo)
await service.start()
await service.stop()
assert run_repo.stale_marked is not None
assert task_repo.cancelled_stuck_once == run_repo.stale_marked
@pytest.mark.parametrize("failure_stage", ["occurrence", "parent"])
@pytest.mark.asyncio
async def test_single_instance_start_fails_closed_before_polling(failure_stage):
order = []
class StartupTaskRepo(DummyTaskRepo):
def __init__(self):
super().__init__([])
self.recovery_attempts = 0
async def cancel_stuck_once_tasks(self, *, error):
self.recovery_attempts += 1
order.append("parent")
assert service._task is None
if failure_stage == "parent" and self.recovery_attempts == 1:
raise RuntimeError("simulated parent recovery failure")
return await super().cancel_stuck_once_tasks(error=error)
class StartupRunRepo(DummyRunRepo):
def __init__(self):
super().__init__()
self.recovery_attempts = 0
async def mark_stale_active_runs(self, *, error):
self.recovery_attempts += 1
order.append("occurrence")
assert service._task is None
if failure_stage == "occurrence" and self.recovery_attempts == 1:
raise RuntimeError("simulated occurrence recovery failure")
return await super().mark_stale_active_runs(error=error)
task_repo = StartupTaskRepo()
run_repo = StartupRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=lambda **_kwargs: None,
poll_interval_seconds=0,
lease_seconds=120,
max_concurrent_runs=3,
)
async def parked_run_loop():
await service._stop.wait()
service._run_loop = parked_run_loop
try:
with pytest.raises(RuntimeError, match=f"simulated {failure_stage} recovery failure"):
await service.start()
assert run_repo.recovery_attempts == 1
assert task_repo.recovery_attempts == (0 if failure_stage == "occurrence" else 1)
assert order == (["occurrence"] if failure_stage == "occurrence" else ["occurrence", "parent"])
assert service._task is None
assert task_repo.claimed is False
finally:
await service.stop()
@pytest.mark.asyncio
async def test_multi_instance_start_uses_lease_aware_reconciliation():
task_repo = DummyTaskRepo([])
run_repo = DummyRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=lambda **_kwargs: None,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
multi_instance=True,
run_lease_grace_seconds=17,
)
await service.start()
await asyncio.sleep(0)
await service.stop()
assert run_repo.reconcile_count == 1
assert run_repo.reconciled is not None
assert run_repo.reconciled["lease_grace_seconds"] == 17
assert task_repo.reconciled_stuck_once is not None
assert task_repo.reconciled_stuck_once["lease_grace_seconds"] == 17
assert task_repo.cancelled_stuck_once is None
@pytest.mark.asyncio
async def test_manual_trigger_with_active_run_returns_conflict_without_launching():
launched = []
async def fake_launch(**kwargs):
launched.append(kwargs)
return {"run_id": "run-x", "thread_id": kwargs["thread_id"]}
row = _once_task_row(task_id="task-manual-busy")
row.update({"schedule_type": "cron", "schedule_spec": {"cron": "* * * * *"}, "status": "enabled", "overlap_policy": "enqueue"})
task_repo = DummyTaskRepo([row])
run_repo = DummyRunRepo(active=True)
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
result = await service.dispatch_task(row, now=datetime.now(UTC), trigger="manual")
assert result["outcome"] == "conflict"
assert launched == []
# Nothing was scheduled to happen, so no run-history row is recorded.
assert run_repo.created is None
assert result["task_run_id"] is None
@pytest.mark.asyncio
async def test_run_once_admits_due_occurrences_independently_of_execution_budget():
claim_limits = []
class BudgetTaskRepo(DummyTaskRepo):
async def claim_due_tasks(self, **kwargs):
claim_limits.append(kwargs["limit"])
return []
task_repo = BudgetTaskRepo([])
run_repo = DummyRunRepo(active_count=2)
service = _make_service(task_repo, run_repo)
await service.run_once(now=datetime.now(UTC))
assert claim_limits == [3]
run_repo.active_count = 3
await service.run_once(now=datetime.now(UTC))
assert claim_limits == [3, 3]
@pytest.mark.asyncio
async def test_launch_bookkeeping_passes_protect_terminal():
async def fake_launch(**kwargs):
return {"run_id": "run-pt", "thread_id": kwargs["thread_id"]}
task_repo = DummyTaskRepo([_once_task_row(task_id="task-pt", status="enabled")])
run_repo = DummyRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
await service.dispatch_task(task_repo.rows[0], now=datetime.now(UTC), trigger="scheduled")
assert task_repo.updated[1]["protect_terminal"] is True
class _StatefulRunRepo:
"""Stateful fake ``ScheduledTaskRunRepository`` for the #4452 tests.
Mirrors just enough of the real repository to let a second dispatch
observe the active slot held by the first:
* ``create()`` tracks each row by id, carrying its ``status`` and
``run_id``;
* with ``fail_first_update=True`` the very FIRST ``update_status()``
call raises, simulating a transient DB failure on the
``queued -> running`` write that fires right after ``_launch_run``
returns a live ``run_id``; every later ``update_status()`` applies;
* ``has_active_runs()`` reflects whether any tracked row for the task
is still in an active status (``queued``/``running``), exactly like
the partial unique index ``uq_scheduled_task_run_active``.
"""
_ACTIVE = {"queued", "launching", "running"}
def __init__(self, *, fail_first_update: bool = False, fail_updates: int = 0) -> None:
self.created: list[dict] = []
self.updates: list[tuple[str, dict]] = []
self.rows: dict[str, dict] = {}
self._fail_updates = max(fail_updates, 1 if fail_first_update else 0)
self._updates_raised = 0
async def count_active_runs(self) -> int:
return sum(1 for row in self.rows.values() if row["status"] in {"launching", "running"})
async def list_queued_runs(self, *, limit: int) -> list[dict]:
return []
async def expire_queued_runs(self, **_kwargs) -> list[dict]:
return []
async def create(self, **kwargs) -> dict:
self.created.append(kwargs)
self.rows[kwargs["run_record_id"]] = {
"id": kwargs["run_record_id"],
"task_id": kwargs["task_id"],
"thread_id": kwargs["thread_id"],
"trigger": kwargs["trigger"],
"status": kwargs["status"],
"run_id": None,
}
return {"id": kwargs["run_record_id"]}
async def get_active_run(self, task_id: str) -> dict | None:
return next(
(dict(row) for row in self.rows.values() if row["task_id"] == task_id and row["status"] in self._ACTIVE),
None,
)
async def claim_queued_run(self, run_record_id: str, **_kwargs) -> dict | None:
row = self.rows.get(run_record_id)
if row is None or row["status"] != "queued":
return None
row["status"] = "launching"
return dict(row)
async def requeue_claimed_run(self, run_record_id: str, **_kwargs) -> bool:
row = self.rows.get(run_record_id)
if row is None or row["status"] != "launching":
return False
row["status"] = "queued"
return True
async def update_status(self, run_record_id: str, **kwargs) -> bool:
self.updates.append((run_record_id, kwargs))
if self._updates_raised < self._fail_updates:
# The launch-path queued->running write fails AFTER _launch_run has
# already returned a live run_id. Some tests fail both attempts to
# pin the last-resort active-slot behavior.
self._updates_raised += 1
raise RuntimeError("simulated transient DB error on queued->running write")
row = self.rows.get(run_record_id)
if row is None:
return False
if "status" in kwargs:
row["status"] = kwargs["status"]
if kwargs.get("run_id") is not None:
row["run_id"] = kwargs["run_id"]
return True
async def reconcile_launched_run(self, run_record_id: str, **kwargs) -> bool:
row = self.rows.get(run_record_id)
if row is None:
return False
row["status"] = "running"
row["run_id"] = kwargs["run_id"]
return True
async def fail_launching_run(self, run_record_id: str, **kwargs) -> bool:
row = self.rows.get(run_record_id)
if row is None or row["status"] != "launching":
return False
row["status"] = "failed"
return True
async def has_active_runs(self, task_id: str) -> bool:
return any(row["task_id"] == task_id and row["status"] in self._ACTIVE for row in self.rows.values())
async def mark_stale_active_runs(self, *, error: str) -> int:
return 0
@pytest.mark.asyncio
async def test_post_launch_bookkeeping_failure_does_not_release_active_slot():
"""Regression for issue #4452.
A transient failure in the ``queued -> running`` bookkeeping write
(after ``_launch_run`` has already returned a live ``run_id``) must NOT
flip the task-run row to ``failed``: ``failed`` is outside the partial
unique index ``uq_scheduled_task_run_active``, so releasing the slot
would let the next dispatch launch a DUPLICATE run. The fix keeps the
row ``running`` with the launched ``run_id`` retained for recovery,
reconciliation, and cancellation.
"""
launched: list[dict] = []
async def fake_launch(**kwargs):
launched.append(kwargs)
return {"run_id": f"run-{len(launched)}", "thread_id": kwargs["thread_id"]}
task_repo = DummyTaskRepo(
[
{
"id": "task-4452",
"user_id": "user-1",
"thread_id": None,
"context_mode": "fresh_thread_per_run",
"assistant_id": "lead_agent",
"prompt": "do the thing",
"schedule_type": "cron",
"schedule_spec": {"cron": "*/5 * * * *"},
"timezone": "UTC",
"status": "enabled",
"overlap_policy": "enqueue",
}
]
)
run_repo = _StatefulRunRepo(fail_first_update=True)
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
now = datetime.now(UTC)
task = dict(task_repo.rows[0])
first = await service.dispatch_task(task, now=now, trigger="scheduled")
# The run launched despite the post-launch bookkeeping error; the
# outcome and run_id reflect that a live run is in flight.
assert first["outcome"] == "launched"
assert first["run_id"] == "run-1"
assert first["error"] is not None # the bookkeeping error is surfaced, not hidden
# Second dispatch must observe the active slot held by run-1 and NOT
# launch a duplicate. On main (bug) this would launch run-2 here.
second = await service.dispatch_task(task, now=now, trigger="scheduled")
assert len(launched) == 1, launched
assert second["outcome"] == "conflict", second
# The launched run_id is retained on the task-run row (status "running",
# not "failed") so reconciliation / cancellation can still reach it.
first_row_id = run_repo.created[0]["run_record_id"]
assert run_repo.rows[first_row_id]["status"] == "running"
assert run_repo.rows[first_row_id]["run_id"] == "run-1"
# The bookkeeping transient is NOT surfaced as the parent task's
# last_error: the run launched and is still in flight, so the task list
# must not show an error on an actively running task (matching the
# success path's clear-on-launch model). The real terminal outcome is
# written by handle_run_completion.
assert task_repo.updated[1]["last_error"] is None
@pytest.mark.asyncio
async def test_both_post_launch_association_writes_can_fail_without_releasing_slot():
launched: list[dict] = []
async def fake_launch(**kwargs):
launched.append(kwargs)
return {"run_id": "run-live", "thread_id": kwargs["thread_id"]}
class FailingTaskRepo(DummyTaskRepo):
def __init__(self, rows):
super().__init__(rows)
self.failures_remaining = 1
async def update_after_launch(self, *args, **kwargs):
if self.failures_remaining:
self.failures_remaining -= 1
raise RuntimeError("simulated parent bookkeeping failure")
await super().update_after_launch(*args, **kwargs)
task = {
"id": "task-double-failure",
"user_id": "user-1",
"thread_id": None,
"context_mode": "fresh_thread_per_run",
"assistant_id": "lead_agent",
"prompt": "do the thing",
"schedule_type": "cron",
"schedule_spec": {"cron": "*/5 * * * *"},
"timezone": "UTC",
"status": "enabled",
"overlap_policy": "enqueue",
}
task_repo = FailingTaskRepo([task])
run_repo = _StatefulRunRepo(fail_updates=2)
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
now = datetime.now(UTC)
first = await service.dispatch_task(dict(task), now=now, trigger="scheduled")
assert first["outcome"] == "launched"
first_row_id = run_repo.created[0]["run_record_id"]
assert run_repo.rows[first_row_id]["task_id"] == "task-double-failure"
assert run_repo.rows[first_row_id]["status"] == "launching"
assert run_repo.rows[first_row_id]["run_id"] is None
second = await service.dispatch_task(dict(task), now=now, trigger="scheduled")
assert len(launched) == 1
assert second["outcome"] == "conflict"
@pytest.mark.asyncio
async def test_pre_launch_failure_still_releases_active_slot():
"""Complement to the #4452 fix: when ``_launch_run`` itself fails (no run
was ever started), the task-run row is marked ``failed`` and the active
slot is released as before -- the post-launch retention path does not
apply because there is no live run to protect.
"""
launched: list[dict] = []
async def fake_launch(**kwargs):
launched.append(kwargs)
raise RuntimeError("runtime refused to start the run")
task_repo = DummyTaskRepo(
[
{
"id": "task-4452-pre",
"user_id": "user-1",
"thread_id": None,
"context_mode": "fresh_thread_per_run",
"assistant_id": "lead_agent",
"prompt": "do the thing",
"schedule_type": "cron",
"schedule_spec": {"cron": "*/5 * * * *"},
"timezone": "UTC",
"status": "enabled",
"overlap_policy": "enqueue",
}
]
)
run_repo = _StatefulRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
result = await service.dispatch_task(dict(task_repo.rows[0]), now=datetime.now(UTC), trigger="scheduled")
assert result["outcome"] == "failed"
assert result["run_id"] is None
# launch was attempted (and raised), so exactly one launch attempt, and
# the row is terminal -> the slot is released for the next dispatch.
assert len(launched) == 1
first_row_id = run_repo.created[0]["run_record_id"]
assert run_repo.rows[first_row_id]["status"] == "failed"
assert run_repo.rows[first_row_id]["run_id"] is None
@pytest.mark.asyncio
async def test_malformed_launch_result_still_retains_active_slot():
"""Defense-in-depth for the #4452 invariant.
If ``_launch_run`` returns a malformed result (e.g. missing ``run_id``),
the unpacking line raises AFTER a live run was already created. The
dispatch must still take the retention path (keep the row active so the
slot stays held and no duplicate launches) rather than the pre-launch
generic-failure path, which would mark the row ``failed`` and release
the slot while a run is in flight. Keyed off ``launch_succeeded``, not
``launched_run_id is not None``.
"""
launched: list[dict] = []
async def fake_launch(**kwargs):
launched.append(kwargs)
# Live run started, but the result payload is malformed.
return {"thread_id": kwargs["thread_id"]}
task_repo = DummyTaskRepo(
[
{
"id": "task-4452-malformed",
"user_id": "user-1",
"thread_id": None,
"context_mode": "fresh_thread_per_run",
"assistant_id": "lead_agent",
"prompt": "do the thing",
"schedule_type": "cron",
"schedule_spec": {"cron": "*/5 * * * *"},
"timezone": "UTC",
"status": "enabled",
"overlap_policy": "enqueue",
}
]
)
run_repo = _StatefulRunRepo()
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
now = datetime.now(UTC)
task = dict(task_repo.rows[0])
first = await service.dispatch_task(task, now=now, trigger="scheduled")
# Launch succeeded, so the outcome is "launched" (a run is in flight)
# even though the result unpacking raised; run_id is unknown.
assert first["outcome"] == "launched"
assert first["run_id"] is None
# Second dispatch must observe the active slot still held (row stays in
# an active status, NOT "failed") and NOT launch a duplicate.
second = await service.dispatch_task(task, now=now, trigger="scheduled")
assert len(launched) == 1, launched
assert second["outcome"] == "conflict", second
first_row_id = run_repo.created[0]["run_record_id"]
assert run_repo.rows[first_row_id]["status"] == "running"
@pytest.mark.asyncio
async def test_manual_trigger_is_queued_when_global_budget_exhausted():
launched = []
async def fake_launch(**kwargs):
launched.append(kwargs)
return {"run_id": "run-budget", "thread_id": kwargs["thread_id"]}
row = _once_task_row(task_id="task-budget", status="enabled")
row.update({"schedule_type": "cron", "schedule_spec": {"cron": "* * * * *"}, "overlap_policy": "enqueue"})
task_repo = DummyTaskRepo([row])
# active_count equals max_concurrent_runs → budget is exhausted
run_repo = DummyRunRepo(active_count=3)
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
result = await service.dispatch_task(row, now=datetime.now(UTC), trigger="manual")
assert result["outcome"] == "queued"
assert launched == []
assert run_repo.created["status"] == "queued"
@pytest.mark.asyncio
async def test_manual_trigger_proceeds_when_global_budget_available():
"""Manual trigger must launch when active count is below max_concurrent_runs."""
launched = []
async def fake_launch(**kwargs):
launched.append(kwargs)
return {"run_id": "run-ok", "thread_id": kwargs["thread_id"]}
row = _once_task_row(task_id="task-ok", status="enabled")
row.update({"schedule_type": "cron", "schedule_spec": {"cron": "* * * * *"}, "overlap_policy": "enqueue"})
task_repo = DummyTaskRepo([row])
# active_count is 2, max_concurrent_runs is 3 → one slot left
run_repo = DummyRunRepo(active_count=2)
service = ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=fake_launch,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
)
result = await service.dispatch_task(row, now=datetime.now(UTC), trigger="manual")
assert result["outcome"] == "launched"
assert len(launched) == 1
# ---------------------------------------------------------------------------
# Notification enqueue on completion (issue #4254): the hook writes durable
# outbox rows; a separate delivery worker does the actual IM send.
# ---------------------------------------------------------------------------
class DummyConnectionRepo:
def __init__(self, connections):
self.connections = connections
async def list_connections(self, owner_user_id):
return [dict(connection, owner_user_id=owner_user_id) for connection in self.connections]
class DummyNotificationRepo:
def __init__(self, *, fail=False):
self.enqueued = []
self.fail = fail
async def enqueue(self, **kwargs):
if self.fail:
raise RuntimeError("delivery backend unavailable")
self.enqueued.append(kwargs)
return {"id": f"delivery-{len(self.enqueued)}", **kwargs}
def _make_notifying_service(task_repo, run_repo, *, connection_repo, notification_repo):
return ScheduledTaskService(
task_repo=task_repo,
task_run_repo=run_repo,
launch_run=lambda **_kwargs: None,
poll_interval_seconds=5,
lease_seconds=120,
max_concurrent_runs=3,
connection_repo=connection_repo,
notification_repo=notification_repo,
)
@pytest.mark.asyncio
async def test_completion_enqueues_run_completed_for_connected_channels():
task_repo = DummyTaskRepo([_once_task_row()])
run_repo = DummyRunRepo()
connection_repo = DummyConnectionRepo(
[
{"provider": "wecom", "external_account_id": "GaoZhiChao", "status": "connected"},
]
)
notification_repo = DummyNotificationRepo()
service = _make_notifying_service(
task_repo,
run_repo,
connection_repo=connection_repo,
notification_repo=notification_repo,
)
await service.handle_run_completion(_completion_record(RunStatus.success))
assert len(notification_repo.enqueued) == 1
enqueued = notification_repo.enqueued[0]
assert enqueued["event"] == "run_completed"
assert enqueued["provider"] == "wecom"
assert enqueued["target"] == "GaoZhiChao"
assert enqueued["task_id"] == "task-once"
assert enqueued["task_run_id"] == "task-run-x"
assert enqueued["run_id"] == "run-x"
assert enqueued["owner_user_id"] == "user-1"
assert enqueued["payload"]["run_status"] == "success"
assert enqueued["payload"]["error"] is None
assert enqueued["payload"]["task_title"] == "Once summary"
@pytest.mark.asyncio
async def test_completion_enqueues_run_failed_event_on_error():
task_repo = DummyTaskRepo([_once_task_row()])
run_repo = DummyRunRepo()
connection_repo = DummyConnectionRepo(
[
{"provider": "wecom", "external_account_id": "GaoZhiChao", "status": "connected"},
]
)
notification_repo = DummyNotificationRepo()
service = _make_notifying_service(
task_repo,
run_repo,
connection_repo=connection_repo,
notification_repo=notification_repo,
)
await service.handle_run_completion(_completion_record(RunStatus.error, error="boom"))
assert len(notification_repo.enqueued) == 1
enqueued = notification_repo.enqueued[0]
assert enqueued["event"] == "run_failed"
assert enqueued["payload"]["run_status"] == "failed"
assert enqueued["payload"]["error"] == "boom"
@pytest.mark.asyncio
async def test_completion_does_not_notify_for_interrupted_runs():
task_repo = DummyTaskRepo([_once_task_row()])
run_repo = DummyRunRepo()
connection_repo = DummyConnectionRepo(
[
{"provider": "wecom", "external_account_id": "GaoZhiChao", "status": "connected"},
]
)
notification_repo = DummyNotificationRepo()
service = _make_notifying_service(
task_repo,
run_repo,
connection_repo=connection_repo,
notification_repo=notification_repo,
)
await service.handle_run_completion(_completion_record(RunStatus.interrupted))
# An interrupt is a user-initiated cancel; the user is already aware.
assert notification_repo.enqueued == []
@pytest.mark.asyncio
async def test_completion_does_not_notify_for_manual_triggers():
"""A manual "run now" happens with the user watching the UI; pushing the
same outcome to IM is noise, so only scheduled firings notify."""
task_repo = DummyTaskRepo([_once_task_row()])
run_repo = DummyRunRepo()
connection_repo = DummyConnectionRepo(
[
{"provider": "wecom", "external_account_id": "GaoZhiChao", "status": "connected"},
]
)
notification_repo = DummyNotificationRepo()
service = _make_notifying_service(
task_repo,
run_repo,
connection_repo=connection_repo,
notification_repo=notification_repo,
)
await service.handle_run_completion(_completion_record(RunStatus.success, trigger="manual"))
# Execution status is still recorded; only the IM push is suppressed.
assert task_repo.completions[-1][1]["status"] == "success"
assert notification_repo.enqueued == []
@pytest.mark.asyncio
async def test_completion_still_notifies_when_trigger_metadata_is_missing():
"""Fail safe: an untagged completion (older rows, unexpected paths) keeps
notifying -- dropping a push silently is worse than a rare extra one."""
task_repo = DummyTaskRepo([_once_task_row()])
run_repo = DummyRunRepo()
connection_repo = DummyConnectionRepo(
[
{"provider": "wecom", "external_account_id": "GaoZhiChao", "status": "connected"},
]
)
notification_repo = DummyNotificationRepo()
service = _make_notifying_service(
task_repo,
run_repo,
connection_repo=connection_repo,
notification_repo=notification_repo,
)
record = _completion_record(RunStatus.success)
record.metadata.pop("scheduled_trigger")
await service.handle_run_completion(record)
assert len(notification_repo.enqueued) == 1
@pytest.mark.asyncio
async def test_completion_skips_unusable_connections():
task_repo = DummyTaskRepo([_once_task_row()])
run_repo = DummyRunRepo()
connection_repo = DummyConnectionRepo(
[
{"provider": "wecom", "external_account_id": "revoked-user", "status": "revoked"},
{"provider": "wecom", "external_account_id": None, "status": "connected"},
{"provider": "wecom", "external_account_id": "GaoZhiChao", "status": "connected"},
]
)
notification_repo = DummyNotificationRepo()
service = _make_notifying_service(
task_repo,
run_repo,
connection_repo=connection_repo,
notification_repo=notification_repo,
)
await service.handle_run_completion(_completion_record(RunStatus.success))
assert [item["target"] for item in notification_repo.enqueued] == ["GaoZhiChao"]
@pytest.mark.asyncio
async def test_completion_notification_failure_does_not_break_status_writes():
task_repo = DummyTaskRepo([_once_task_row()])
run_repo = DummyRunRepo()
connection_repo = DummyConnectionRepo(
[
{"provider": "wecom", "external_account_id": "GaoZhiChao", "status": "connected"},
]
)
notification_repo = DummyNotificationRepo(fail=True)
service = _make_notifying_service(
task_repo,
run_repo,
connection_repo=connection_repo,
notification_repo=notification_repo,
)
await service.handle_run_completion(_completion_record(RunStatus.success))
# Execution status is written regardless: delivery is best-effort and must
# never shadow the run outcome (execution/delivery status separation).
assert task_repo.completions[-1][1]["status"] == "success"
def _notifying_service_with_wecom(task_repo, notification_repo):
connection_repo = DummyConnectionRepo([{"provider": "wecom", "external_account_id": "GaoZhiChao", "status": "connected"}])
return _make_notifying_service(task_repo, DummyRunRepo(), connection_repo=connection_repo, notification_repo=notification_repo)
@pytest.mark.asyncio
async def test_detached_outbox_stops_the_enqueue():
# The Gateway detaches the outbox when the delivery side cannot start.
task_repo = DummyTaskRepo([_once_task_row()])
notification_repo = DummyNotificationRepo()
service = _notifying_service_with_wecom(task_repo, notification_repo)
await service.handle_run_completion(_completion_record(RunStatus.success))
assert [row["event"] for row in notification_repo.enqueued] == ["run_completed"]
service.detach_notification_outbox()
await service.handle_run_completion(_completion_record(RunStatus.success))
assert len(notification_repo.enqueued) == 1
assert len(task_repo.completions) == 2
@pytest.mark.asyncio
async def test_completion_that_was_not_recorded_does_not_notify():
# complete_run returns False for a missing occurrence, another run's occurrence or another owner.
class RejectingTaskRepo(DummyTaskRepo):
async def complete_run(self, task_id, **kwargs):
await super().complete_run(task_id, **kwargs)
return False
task_repo = RejectingTaskRepo([_once_task_row()])
notification_repo = DummyNotificationRepo()
await _notifying_service_with_wecom(task_repo, notification_repo).handle_run_completion(_completion_record(RunStatus.success))
assert len(task_repo.completions) == 1
assert notification_repo.enqueued == []
@pytest.mark.asyncio
async def test_completion_for_a_task_deleted_meanwhile_does_not_notify():
task_repo = DummyTaskRepo([])
notification_repo = DummyNotificationRepo()
await _notifying_service_with_wecom(task_repo, notification_repo).handle_run_completion(_completion_record(RunStatus.success))
assert task_repo.completions[-1][1]["status"] == "success"
assert notification_repo.enqueued == []
@pytest.mark.asyncio
async def test_completion_still_notifies_when_the_task_read_fails():
class UnreadableTaskRepo(DummyTaskRepo):
async def get(self, task_id, *, user_id):
raise RuntimeError("database unavailable")
task_repo = UnreadableTaskRepo([_once_task_row()])
notification_repo = DummyNotificationRepo()
await _notifying_service_with_wecom(task_repo, notification_repo).handle_run_completion(_completion_record(RunStatus.success))
assert task_repo.completions[-1][1]["status"] == "success"
# The title is optional: the push still goes out and falls back to the task id.
assert [row["payload"]["task_title"] for row in notification_repo.enqueued] == [None]
@pytest.mark.asyncio
async def test_completion_without_the_outbox_does_not_read_the_task():
class CountingTaskRepo(DummyTaskRepo):
reads = 0
async def get(self, task_id, *, user_id):
self.reads += 1
return await super().get(task_id, user_id=user_id)
task_repo = CountingTaskRepo([_once_task_row()])
service = _make_notifying_service(task_repo, DummyRunRepo(), connection_repo=None, notification_repo=None)
await service.handle_run_completion(_completion_record(RunStatus.success))
assert task_repo.completions[-1][1]["status"] == "success"
assert task_repo.reads == 0