feat: add durable leased task engine
This commit is contained in:
@@ -0,0 +1,32 @@
|
||||
ALTER TABLE tasks
|
||||
ADD COLUMN task_type text NOT NULL DEFAULT 'generic',
|
||||
ADD COLUMN progress integer NOT NULL DEFAULT 0 CHECK (progress BETWEEN 0 AND 100),
|
||||
ADD COLUMN result jsonb,
|
||||
ADD COLUMN error text,
|
||||
ADD COLUMN worker_id text,
|
||||
ADD COLUMN lease_expires_at timestamptz,
|
||||
ADD COLUMN cancel_requested boolean NOT NULL DEFAULT false,
|
||||
ADD COLUMN idempotency_key text UNIQUE,
|
||||
ADD COLUMN attempt integer NOT NULL DEFAULT 0,
|
||||
ADD CONSTRAINT tasks_status_check CHECK (status IN ('queued', 'running', 'success', 'error', 'cancelled'));
|
||||
CREATE INDEX tasks_claim_idx ON tasks(status, lease_expires_at, created_at);
|
||||
CREATE TABLE resource_locks (
|
||||
resource_key text PRIMARY KEY,
|
||||
task_id uuid NOT NULL UNIQUE REFERENCES tasks(id) ON DELETE CASCADE,
|
||||
acquired_at timestamptz NOT NULL DEFAULT now()
|
||||
);
|
||||
CREATE TABLE task_logs (
|
||||
task_id uuid NOT NULL REFERENCES tasks(id) ON DELETE CASCADE,
|
||||
sequence bigint GENERATED ALWAYS AS IDENTITY,
|
||||
created_at timestamptz NOT NULL DEFAULT now(),
|
||||
message text NOT NULL,
|
||||
PRIMARY KEY (task_id, sequence)
|
||||
);
|
||||
CREATE TABLE task_events (
|
||||
task_id uuid NOT NULL REFERENCES tasks(id) ON DELETE CASCADE,
|
||||
sequence bigint GENERATED ALWAYS AS IDENTITY,
|
||||
created_at timestamptz NOT NULL DEFAULT now(),
|
||||
kind text NOT NULL,
|
||||
data jsonb NOT NULL DEFAULT '{}'::jsonb,
|
||||
PRIMARY KEY (task_id, sequence)
|
||||
);
|
||||
+22
-1
@@ -2,8 +2,10 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
from collections.abc import AsyncIterator, Callable
|
||||
from contextlib import AbstractAsyncContextManager, asynccontextmanager
|
||||
from typing import Protocol
|
||||
|
||||
from fastapi import FastAPI
|
||||
|
||||
@@ -14,7 +16,20 @@ DatabaseFactory = Callable[[Settings], Database]
|
||||
Lifespan = Callable[[FastAPI], AbstractAsyncContextManager[None]]
|
||||
|
||||
|
||||
def create_lifespan(settings: Settings, database_factory: DatabaseFactory) -> Lifespan:
|
||||
class LifespanWorker(Protocol):
|
||||
async def run(self) -> None: ...
|
||||
|
||||
def stop(self) -> None: ...
|
||||
|
||||
|
||||
WorkerFactory = Callable[[Database], LifespanWorker]
|
||||
|
||||
|
||||
def create_lifespan(
|
||||
settings: Settings,
|
||||
database_factory: DatabaseFactory,
|
||||
worker_factories: tuple[WorkerFactory, ...] = (),
|
||||
) -> Lifespan:
|
||||
"""Build a lifespan context so tests can inject a database implementation."""
|
||||
|
||||
@asynccontextmanager
|
||||
@@ -22,9 +37,15 @@ def create_lifespan(settings: Settings, database_factory: DatabaseFactory) -> Li
|
||||
database = database_factory(settings)
|
||||
await database.connect()
|
||||
app.state.database = database
|
||||
workers = tuple(factory(database) for factory in worker_factories)
|
||||
worker_tasks = tuple(asyncio.create_task(worker.run()) for worker in workers)
|
||||
try:
|
||||
yield
|
||||
finally:
|
||||
for worker in workers:
|
||||
worker.stop()
|
||||
if worker_tasks:
|
||||
await asyncio.gather(*worker_tasks)
|
||||
await database.close()
|
||||
|
||||
return lifespan
|
||||
|
||||
+3
-2
@@ -10,7 +10,7 @@ from app.api.registry import HandlerRegistry, register_contract_routes
|
||||
from app.compatibility import build_report
|
||||
from app.config import Settings, get_settings
|
||||
from app.contracts.model import Snapshot
|
||||
from app.lifespan import DatabaseFactory, create_lifespan, default_database_factory
|
||||
from app.lifespan import DatabaseFactory, WorkerFactory, create_lifespan, default_database_factory
|
||||
from app.logging import configure_logging
|
||||
from app.observability.health import router as health_router
|
||||
|
||||
@@ -19,6 +19,7 @@ def create_app(
|
||||
settings: Settings | None = None,
|
||||
database_factory: DatabaseFactory = default_database_factory,
|
||||
handlers: HandlerRegistry | None = None,
|
||||
worker_factories: tuple[WorkerFactory, ...] = (),
|
||||
) -> FastAPI:
|
||||
"""Create an isolated application instance with explicit resource factories."""
|
||||
|
||||
@@ -27,7 +28,7 @@ def create_app(
|
||||
app = FastAPI(
|
||||
title=resolved.app_name,
|
||||
version="0.0.1",
|
||||
lifespan=create_lifespan(resolved, database_factory),
|
||||
lifespan=create_lifespan(resolved, database_factory, worker_factories),
|
||||
)
|
||||
app.add_middleware(RequestContextMiddleware, header_name=resolved.request_id_header)
|
||||
app.add_exception_handler(Exception, unhandled_exception_handler)
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
"""Durable asynchronous task engine."""
|
||||
@@ -0,0 +1,185 @@
|
||||
"""PostgreSQL repository for durable leased tasks."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import uuid
|
||||
from dataclasses import dataclass
|
||||
from typing import Any
|
||||
|
||||
import asyncpg # type: ignore[import-untyped] # noqa: F401
|
||||
from asyncpg import Pool, Record
|
||||
|
||||
from app.db.primitives import ConflictError, require_affected, transaction
|
||||
|
||||
|
||||
@dataclass(frozen=True, slots=True)
|
||||
class Task:
|
||||
id: uuid.UUID
|
||||
upid: str
|
||||
task_type: str
|
||||
status: str
|
||||
payload: dict[str, Any]
|
||||
progress: int
|
||||
cancel_requested: bool
|
||||
attempt: int
|
||||
|
||||
|
||||
def _task(row: Record) -> Task:
|
||||
return Task(
|
||||
id=row["id"],
|
||||
upid=str(row["upid"]),
|
||||
task_type=str(row["task_type"]),
|
||||
status=str(row["status"]),
|
||||
payload=json.loads(row["payload"])
|
||||
if isinstance(row["payload"], str)
|
||||
else dict(row["payload"]),
|
||||
progress=int(row["progress"]),
|
||||
cancel_requested=bool(row["cancel_requested"]),
|
||||
attempt=int(row["attempt"]),
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True, slots=True)
|
||||
class TaskRepository:
|
||||
pool: Pool
|
||||
|
||||
async def create(
|
||||
self,
|
||||
*,
|
||||
upid: str,
|
||||
task_type: str,
|
||||
payload: dict[str, Any],
|
||||
resource_key: str | None = None,
|
||||
idempotency_key: str | None = None,
|
||||
) -> Task:
|
||||
task_id = uuid.uuid4()
|
||||
async with transaction(self.pool) as connection:
|
||||
if idempotency_key is not None:
|
||||
existing = await connection.fetchrow(
|
||||
"SELECT * FROM tasks WHERE idempotency_key=$1", idempotency_key
|
||||
)
|
||||
if existing is not None:
|
||||
return _task(existing)
|
||||
row = await connection.fetchrow(
|
||||
"""INSERT INTO tasks(id, upid, task_type, status, payload, idempotency_key)
|
||||
VALUES($1,$2,$3,'queued',$4::jsonb,$5) RETURNING *""",
|
||||
task_id,
|
||||
upid,
|
||||
task_type,
|
||||
json.dumps(payload),
|
||||
idempotency_key,
|
||||
)
|
||||
if resource_key is not None:
|
||||
try:
|
||||
await connection.execute(
|
||||
"INSERT INTO resource_locks(resource_key, task_id) VALUES($1,$2)",
|
||||
resource_key,
|
||||
task_id,
|
||||
)
|
||||
except Exception as error:
|
||||
raise ConflictError(f"resource is locked: {resource_key}") from error
|
||||
await connection.execute(
|
||||
"INSERT INTO task_events(task_id, kind) VALUES($1,'created')", task_id
|
||||
)
|
||||
if row is None:
|
||||
raise RuntimeError("task insert returned no row")
|
||||
return _task(row)
|
||||
|
||||
async def claim(self, worker_id: str, lease_seconds: float) -> Task | None:
|
||||
async with transaction(self.pool) as connection:
|
||||
row = await connection.fetchrow(
|
||||
"""WITH candidate AS (
|
||||
SELECT id FROM tasks
|
||||
WHERE status='queued' OR (status='running' AND lease_expires_at < now())
|
||||
ORDER BY created_at FOR UPDATE SKIP LOCKED LIMIT 1
|
||||
) UPDATE tasks SET status='running', worker_id=$1,
|
||||
lease_expires_at=now() + $2 * interval '1 second', attempt=attempt+1,
|
||||
updated_at=now()
|
||||
WHERE id=(SELECT id FROM candidate) RETURNING *""",
|
||||
worker_id,
|
||||
lease_seconds,
|
||||
)
|
||||
if row is None:
|
||||
return None
|
||||
await connection.execute(
|
||||
"INSERT INTO task_events(task_id, kind, data) VALUES($1,'claimed',$2::jsonb)",
|
||||
row["id"],
|
||||
json.dumps({"worker": worker_id}),
|
||||
)
|
||||
return _task(row)
|
||||
|
||||
async def heartbeat(self, task_id: uuid.UUID, worker_id: str, lease_seconds: float) -> None:
|
||||
status = await self.pool.execute(
|
||||
"""UPDATE tasks SET lease_expires_at=now()+$3*interval '1 second', updated_at=now()
|
||||
WHERE id=$1 AND worker_id=$2 AND status='running'""",
|
||||
task_id,
|
||||
worker_id,
|
||||
lease_seconds,
|
||||
)
|
||||
require_affected(status)
|
||||
|
||||
async def progress(self, task_id: uuid.UUID, worker_id: str, value: int) -> None:
|
||||
status = await self.pool.execute(
|
||||
"""UPDATE tasks SET progress=$3, updated_at=now()
|
||||
WHERE id=$1 AND worker_id=$2 AND status='running'""",
|
||||
task_id,
|
||||
worker_id,
|
||||
value,
|
||||
)
|
||||
require_affected(status)
|
||||
|
||||
async def append_log(self, task_id: uuid.UUID, message: str) -> None:
|
||||
await self.pool.execute(
|
||||
"INSERT INTO task_logs(task_id, message) VALUES($1,$2)", task_id, message
|
||||
)
|
||||
|
||||
async def request_cancel(self, task_id: uuid.UUID) -> None:
|
||||
status = await self.pool.execute(
|
||||
"""UPDATE tasks SET cancel_requested=true, updated_at=now()
|
||||
WHERE id=$1 AND status IN ('queued','running')""",
|
||||
task_id,
|
||||
)
|
||||
require_affected(status)
|
||||
|
||||
async def finish(
|
||||
self,
|
||||
task_id: uuid.UUID,
|
||||
worker_id: str,
|
||||
*,
|
||||
status: str,
|
||||
result: dict[str, Any] | None = None,
|
||||
error: str | None = None,
|
||||
) -> None:
|
||||
if status not in {"success", "error", "cancelled"}:
|
||||
raise ValueError("invalid terminal task status")
|
||||
async with transaction(self.pool) as connection:
|
||||
command = await connection.execute(
|
||||
"""UPDATE tasks SET status=$3, result=$4::jsonb, error=$5,
|
||||
progress=CASE WHEN $3='success' THEN 100 ELSE progress END,
|
||||
lease_expires_at=NULL, updated_at=now()
|
||||
WHERE id=$1 AND worker_id=$2 AND status='running'""",
|
||||
task_id,
|
||||
worker_id,
|
||||
status,
|
||||
json.dumps(result) if result is not None else None,
|
||||
error,
|
||||
)
|
||||
require_affected(command)
|
||||
await connection.execute("DELETE FROM resource_locks WHERE task_id=$1", task_id)
|
||||
await connection.execute(
|
||||
"INSERT INTO task_events(task_id, kind, data) VALUES($1,$2,$3::jsonb)",
|
||||
task_id,
|
||||
status,
|
||||
json.dumps({"error": error} if error else {}),
|
||||
)
|
||||
|
||||
async def get(self, task_id: uuid.UUID) -> Task | None:
|
||||
row = await self.pool.fetchrow("SELECT * FROM tasks WHERE id=$1", task_id)
|
||||
return _task(row) if row is not None else None
|
||||
|
||||
async def logs(self, task_id: uuid.UUID) -> tuple[str, ...]:
|
||||
rows = await self.pool.fetch(
|
||||
"SELECT message FROM task_logs WHERE task_id=$1 ORDER BY sequence", task_id
|
||||
)
|
||||
return tuple(str(row["message"]) for row in rows)
|
||||
@@ -0,0 +1,59 @@
|
||||
"""Proxmox-compatible unique process/task identifiers."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
from dataclasses import dataclass
|
||||
|
||||
UPID_RE = re.compile(
|
||||
r"^UPID:(?P<node>[A-Za-z0-9][A-Za-z0-9_-]*):"
|
||||
r"(?P<pid>[0-9A-Fa-f]{8}):(?P<pstart>[0-9A-Fa-f]{8}):"
|
||||
r"(?P<start>[0-9A-Fa-f]{8}):(?P<type>[A-Za-z0-9_-]+):"
|
||||
r"(?P<task_id>[^:]*):(?P<user>[^:]+):$"
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True, slots=True)
|
||||
class Upid:
|
||||
node: str
|
||||
pid: int
|
||||
process_start: int
|
||||
start_time: int
|
||||
task_type: str
|
||||
task_id: str
|
||||
user: str
|
||||
|
||||
def __post_init__(self) -> None:
|
||||
for name, value in (
|
||||
("pid", self.pid),
|
||||
("process_start", self.process_start),
|
||||
("start_time", self.start_time),
|
||||
):
|
||||
if not 0 <= value <= 0xFFFFFFFF:
|
||||
raise ValueError(f"{name} is outside the 32-bit UPID range")
|
||||
if not self.node or ":" in self.node or not self.task_type or ":" in self.task_type:
|
||||
raise ValueError("invalid UPID node or task type")
|
||||
if ":" in self.task_id or not self.user or ":" in self.user:
|
||||
raise ValueError("invalid UPID task id or user")
|
||||
|
||||
def __str__(self) -> str:
|
||||
return (
|
||||
f"UPID:{self.node}:{self.pid:08X}:{self.process_start:08X}:"
|
||||
f"{self.start_time:08X}:{self.task_type}:{self.task_id}:{self.user}:"
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def parse(cls, value: str) -> Upid:
|
||||
match = UPID_RE.fullmatch(value)
|
||||
if match is None:
|
||||
raise ValueError("invalid UPID")
|
||||
values = match.groupdict()
|
||||
return cls(
|
||||
node=values["node"],
|
||||
pid=int(values["pid"], 16),
|
||||
process_start=int(values["pstart"], 16),
|
||||
start_time=int(values["start"], 16),
|
||||
task_type=values["type"],
|
||||
task_id=values["task_id"],
|
||||
user=values["user"],
|
||||
)
|
||||
@@ -0,0 +1,90 @@
|
||||
"""Bounded durable task worker with cooperative cancellation."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
from collections.abc import Awaitable, Callable
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Any
|
||||
|
||||
from app.tasks.repository import Task, TaskRepository
|
||||
|
||||
TaskHandler = Callable[[Task], Awaitable[dict[str, Any] | None]]
|
||||
|
||||
|
||||
@dataclass(slots=True)
|
||||
class TaskWorker:
|
||||
repository: TaskRepository
|
||||
worker_id: str
|
||||
handlers: dict[str, TaskHandler]
|
||||
concurrency: int = 2
|
||||
lease_seconds: float = 30.0
|
||||
poll_seconds: float = 0.1
|
||||
_running: set[asyncio.Task[None]] = field(default_factory=set, init=False)
|
||||
_stopping: asyncio.Event = field(default_factory=asyncio.Event, init=False)
|
||||
|
||||
async def run(self) -> None:
|
||||
self._stopping.clear()
|
||||
try:
|
||||
while not self._stopping.is_set():
|
||||
self._reap()
|
||||
if len(self._running) >= self.concurrency:
|
||||
await asyncio.sleep(self.poll_seconds)
|
||||
continue
|
||||
task = await self.repository.claim(self.worker_id, self.lease_seconds)
|
||||
if task is None:
|
||||
await asyncio.sleep(self.poll_seconds)
|
||||
continue
|
||||
execution = asyncio.create_task(self._execute(task))
|
||||
self._running.add(execution)
|
||||
finally:
|
||||
if self._running:
|
||||
await asyncio.gather(*self._running, return_exceptions=True)
|
||||
self._running.clear()
|
||||
|
||||
def stop(self) -> None:
|
||||
self._stopping.set()
|
||||
|
||||
def _reap(self) -> None:
|
||||
self._running = {task for task in self._running if not task.done()}
|
||||
|
||||
async def _execute(self, task: Task) -> None:
|
||||
handler = self.handlers.get(task.task_type)
|
||||
if handler is None:
|
||||
await self.repository.finish(
|
||||
task.id, self.worker_id, status="error", error="unsupported task type"
|
||||
)
|
||||
return
|
||||
try:
|
||||
current = await self.repository.get(task.id)
|
||||
if current is not None and current.cancel_requested:
|
||||
await self.repository.finish(task.id, self.worker_id, status="cancelled")
|
||||
return
|
||||
execution: asyncio.Future[dict[str, Any] | None] = asyncio.ensure_future(handler(task))
|
||||
heartbeat = asyncio.create_task(self._heartbeat(task))
|
||||
try:
|
||||
while not execution.done():
|
||||
await asyncio.sleep(self.poll_seconds)
|
||||
current = await self.repository.get(task.id)
|
||||
if current is not None and current.cancel_requested:
|
||||
execution.cancel()
|
||||
await asyncio.gather(execution, return_exceptions=True)
|
||||
await self.repository.finish(task.id, self.worker_id, status="cancelled")
|
||||
return
|
||||
result = await execution
|
||||
finally:
|
||||
heartbeat.cancel()
|
||||
await asyncio.gather(heartbeat, return_exceptions=True)
|
||||
await self.repository.finish(task.id, self.worker_id, status="success", result=result)
|
||||
except asyncio.CancelledError:
|
||||
raise
|
||||
except Exception as error: # task failures are persisted, not leaked
|
||||
await self.repository.finish(
|
||||
task.id, self.worker_id, status="error", error=type(error).__name__
|
||||
)
|
||||
|
||||
async def _heartbeat(self, task: Task) -> None:
|
||||
interval = max(self.lease_seconds / 3, 0.01)
|
||||
while True:
|
||||
await asyncio.sleep(interval)
|
||||
await self.repository.heartbeat(task.id, self.worker_id, self.lease_seconds)
|
||||
Reference in New Issue
Block a user