simple-module-background-tasks 0.0.30__tar.gz → 0.0.31__tar.gz

{simple_module_background_tasks-0.0.30 → simple_module_background_tasks-0.0.31}/.gitignore

@@ -63,3 +63,4 @@ Thumbs.db
 host/client_app/.playwright-cli/*
 .superpowers/
 .qa/
+.verify/

{simple_module_background_tasks-0.0.30 → simple_module_background_tasks-0.0.31}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: simple_module_background_tasks
-Version: 0.0.30
+Version: 0.0.31
 Summary: Celery + Redis task queue with admin UI for monitoring and retrying failed/stuck tasks
 Project-URL: Homepage, https://github.com/antosubash/simple_module_python
 Project-URL: Repository, https://github.com/antosubash/simple_module_python
@@ -23,10 +23,10 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Requires-Dist: celery[redis]>=5.4
 Requires-Dist: redis>=5
-Requires-Dist: simple-module-core==0.0.30
-Requires-Dist: simple-module-db==0.0.30
-Requires-Dist: simple-module-hosting==0.0.30
-Requires-Dist: simple-module-settings==0.0.30
+Requires-Dist: simple-module-core==0.0.31
+Requires-Dist: simple-module-db==0.0.31
+Requires-Dist: simple-module-hosting==0.0.31
+Requires-Dist: simple-module-settings==0.0.31
 Description-Content-Type: text/markdown
 
 # simple_module_background_tasks

{simple_module_background_tasks-0.0.30 → simple_module_background_tasks-0.0.31}/background_tasks/endpoints/views.py

@@ -37,10 +37,12 @@ async def index(
         page=page,
         per_page=PER_PAGE,
     )
+    counts = await service.status_counts(task_name=task_name or None)
     return await inertia.render(
         "BackgroundTasks/Index",
         {
             "executions": [i.model_dump(mode="json") for i in response.items],
+            "status_counts": {s.value: counts.get(s.value, 0) for s in TaskStatus},
             "pagination": {
                 "page": response.page,
                 "per_page": response.per_page,

{simple_module_background_tasks-0.0.30 → simple_module_background_tasks-0.0.31}/background_tasks/module.py

@@ -8,6 +8,7 @@ from pathlib import Path
 from typing import TYPE_CHECKING
 
 from fastapi import APIRouter
+from simple_module_core.audit_links import AuditLinkRegistry
 from simple_module_core.menu import MenuItem, MenuRegistry, MenuSection
 from simple_module_core.module import ModuleBase, ModuleMeta
 from simple_module_core.permissions import PermissionRegistry
@@ -69,6 +70,20 @@ class BackgroundTasksModule(ModuleBase):
     def register_permissions(self, registry: PermissionRegistry) -> None:
         registry.add_group(PERM_GROUP, [PERM_VIEW, PERM_MANAGE])
 
+    def register_audit_links(self, registry: AuditLinkRegistry) -> None:
+        from simple_module_core.audit_links import AuditLink
+
+        from background_tasks.models import TaskExecution
+
+        registry.register(
+            AuditLink(
+                # Class name, not __tablename__ — see AuditLink.entity_type.
+                entity_type=TaskExecution.__name__,
+                url_template=f"{VIEW_PREFIX}/{{id}}",
+                label="Task execution",
+            )
+        )
+
     def register_menu_items(self, registry: MenuRegistry) -> None:
         registry.add(
             MenuItem(

{simple_module_background_tasks-0.0.30 → simple_module_background_tasks-0.0.31}/background_tasks/pages/Index.tsx

@@ -23,6 +23,7 @@ import { AuthenticatedLayout } from '@simple-module-py/ui/layouts/AuthenticatedL
 import { Activity, Search, ServerCog } from 'lucide-react';
 import { useEffect, useState } from 'react';
 import { ExecutionRow, statusLabel } from './components/ExecutionRow';
+import { type StatusCounts, StatusStrip } from './components/StatusStrip';
 import { STATUS_ORDER, VIEW_BASE } from './constants';
 import { type Execution, retryExecution } from './retry';
 
@@ -36,6 +37,7 @@ interface Props {
   executions: Execution[];
   pagination: Pagination;
   filters: { status: string; task_name: string };
+  status_counts: StatusCounts;
 }
 
 const STATUS_ALL = '__all__';
@@ -53,6 +55,7 @@ function Index() {
     executions,
     pagination,
     filters: initialFilters,
+    status_counts: statusCounts,
   } = usePage<{ props: Props }>().props as unknown as Props;
 
   const { can } = usePermissions();
@@ -75,7 +78,9 @@ function Index() {
 
   async function handleRetry(execution: Execution) {
     const created = await retryExecution(execution);
-    if (created) router.reload({ only: ['executions', 'pagination'] });
+    // status_counts feeds the strip above the table — a retry moves a row out
+    // of "failed", so leaving it out of the reload leaves the tile lying.
+    if (created) router.reload({ only: ['executions', 'pagination', 'status_counts'] });
   }
 
   return (
@@ -85,6 +90,12 @@ function Index() {
         title="Background Tasks"
         description="Monitor task executions and retry failed or stuck jobs."
       >
+        <StatusStrip
+          counts={statusCounts ?? {}}
+          active={initialFilters.status ?? ''}
+          onSelect={(status) => pushFilters({ status, task_name: search }, 1)}
+        />
+
         <div className="mb-4 flex flex-col sm:flex-row items-stretch sm:items-center justify-between gap-3">
           <div className="relative flex-1 max-w-sm">
             <Search className="absolute left-3 top-1/2 -translate-y-1/2 size-4 text-muted-foreground" />

simple_module_background_tasks-0.0.31/background_tasks/pages/components/StatusStrip.tsx

@@ -0,0 +1,66 @@
+import { TASK_STATUS, type TaskStatus } from '../constants';
+import { statusLabel } from './ExecutionRow';
+
+export type StatusCounts = Partial<Record<TaskStatus, number>>;
+
+interface Props {
+  counts: StatusCounts;
+  /** Currently filtered status, or '' for all. */
+  active: string;
+  onSelect: (status: string) => void;
+}
+
+/**
+ * Statuses worth a dedicated tile, in the order an operator triages them.
+ * Failed and stuck lead because they are the reason anyone opens this page.
+ */
+const TILES: TaskStatus[] = [
+  TASK_STATUS.FAILED,
+  TASK_STATUS.STUCK,
+  TASK_STATUS.RETRYING,
+  TASK_STATUS.RUNNING,
+  TASK_STATUS.PENDING,
+  TASK_STATUS.SUCCESS,
+];
+
+/** Tiles that mean "someone needs to look at this" get an alarm colour, but
+ *  only when they are non-zero — a permanently red zero trains people to
+ *  ignore it. */
+const ALARMING = new Set<TaskStatus>([TASK_STATUS.FAILED, TASK_STATUS.STUCK]);
+
+export function StatusStrip({ counts, active, onSelect }: Props) {
+  return (
+    <div className="mb-4 grid grid-cols-3 gap-2 sm:grid-cols-6">
+      {TILES.map((status) => {
+        const count = counts[status] ?? 0;
+        const isActive = active === status;
+        const alarm = ALARMING.has(status) && count > 0;
+        return (
+          <button
+            key={status}
+            type="button"
+            aria-pressed={isActive}
+            // Clicking the tile you already filtered by clears the filter,
+            // so the strip can undo itself without reaching for the dropdown.
+            onClick={() => onSelect(isActive ? '' : status)}
+            className={[
+              'rounded-lg border px-3 py-2 text-left transition-colors',
+              isActive
+                ? 'border-primary bg-accent'
+                : 'border-border bg-card hover:border-primary/40 hover:bg-accent/50',
+            ].join(' ')}
+          >
+            <div
+              className={`text-lg font-semibold tabular-nums leading-tight ${
+                alarm ? 'text-red-600 dark:text-red-400' : 'text-foreground'
+              }`}
+            >
+              {count}
+            </div>
+            <div className="truncate text-[11px] text-muted-foreground">{statusLabel(status)}</div>
+          </button>
+        );
+      })}
+    </div>
+  );
+}

{simple_module_background_tasks-0.0.30 → simple_module_background_tasks-0.0.31}/background_tasks/service.py

@@ -82,6 +82,26 @@ class BackgroundTaskService:
             task_name=task_name,
         )
 
+    async def status_counts(self, *, task_name: str | None = None) -> dict[str, int]:
+        """Count executions per status for the ops strip above the table.
+
+        Deliberately ignores the status filter — the strip is how the operator
+        picks a status, so it has to keep showing the ones they aren't looking
+        at. It does honour ``task_name`` so the counts describe the same
+        result set the table is paging through.
+
+        Statuses with no rows are omitted; callers fill in zeros.
+        """
+        query = select(TaskExecution.status, func.count().label("n"))
+        if task_name:
+            query = query.where(TaskExecution.task_name.ilike(f"%{task_name}%"))
+        query = query.group_by(TaskExecution.status)
+
+        rows = (await self.db.execute(query)).all()
+        # `status` is a TaskStatus (StrEnum) on Postgres but comes back as a
+        # plain str on SQLite; normalise so the JSON keys match either way.
+        return {str(getattr(row[0], "value", row[0])): int(row[1]) for row in rows}
+
     async def get(self, execution_id: uuid.UUID) -> TaskExecutionDetail | None:
         row = await self.db.get(TaskExecution, execution_id)
         if row is None:

{simple_module_background_tasks-0.0.30 → simple_module_background_tasks-0.0.31}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simple_module_background_tasks"
-version = "0.0.30"
+version = "0.0.31"
 description = "Celery + Redis task queue with admin UI for monitoring and retrying failed/stuck tasks"
 readme = "README.md"
 license = "MIT"
@@ -21,10 +21,10 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "simple_module_core==0.0.30",
-    "simple_module_db==0.0.30",
-    "simple_module_hosting==0.0.30",
-    "simple_module_settings==0.0.30",
+    "simple_module_core==0.0.31",
+    "simple_module_db==0.0.31",
+    "simple_module_hosting==0.0.31",
+    "simple_module_settings==0.0.31",
     "celery[redis]>=5.4",
     "redis>=5",
 ]

{simple_module_background_tasks-0.0.30 → simple_module_background_tasks-0.0.31}/tests/test_bg_service.py

@@ -99,6 +99,46 @@ class TestList:
         assert [i.task_name for i in resp.items] == ["orders.send_receipt"]
 
 
+class TestStatusCounts:
+    """Feeds the failed/stuck ops strip above the executions table."""
+
+    async def test_counts_are_grouped_by_status(
+        self, db_session: AsyncSession, service: BackgroundTaskService
+    ):
+        for status in (TaskStatus.FAILED, TaskStatus.FAILED, TaskStatus.SUCCESS):
+            db_session.add(_make_row(status=status))
+        await db_session.flush()
+
+        counts = await service.status_counts()
+        assert counts[TaskStatus.FAILED.value] == 2
+        assert counts[TaskStatus.SUCCESS.value] == 1
+
+    async def test_empty_table_yields_no_counts(self, service: BackgroundTaskService):
+        assert await service.status_counts() == {}
+
+    async def test_search_narrows_the_counts(
+        self, db_session: AsyncSession, service: BackgroundTaskService
+    ):
+        """The strip must describe the same rows the table is paging through."""
+        db_session.add(_make_row(task_name="orders.send_receipt", status=TaskStatus.FAILED))
+        db_session.add(_make_row(task_name="users.sync", status=TaskStatus.FAILED))
+        await db_session.flush()
+
+        counts = await service.status_counts(task_name="receipt")
+        assert counts == {TaskStatus.FAILED.value: 1}
+
+    async def test_counts_keys_are_plain_strings(
+        self, db_session: AsyncSession, service: BackgroundTaskService
+    ):
+        """Postgres hands back the enum, SQLite a str — the page needs one shape."""
+        db_session.add(_make_row(status=TaskStatus.STUCK))
+        await db_session.flush()
+
+        counts = await service.status_counts()
+        assert all(type(key) is str for key in counts)
+        assert "stuck" in counts
+
+
 class TestGet:
     async def test_returns_none_for_missing_id(self, service: BackgroundTaskService):
         assert await service.get(uuid.uuid4()) is None