♻️ 📝 refactors and docs long running tasks (ITISFoundation#3253)

Author: pcrespov

packages/service-library/src/servicelib/aiohttp/long_running_tasks/_dependencies.py

@@ -1,8 +1,8 @@
 from aiohttp import web
 
-from ...long_running_tasks._task import TaskManager
+from ...long_running_tasks._task import TasksManager
 from ._constants import APP_LONG_RUNNING_TASKS_MANAGER_KEY
 
 
-def get_task_manager(app: web.Application) -> TaskManager:
+def get_tasks_manager(app: web.Application) -> TasksManager:
     return app[APP_LONG_RUNNING_TASKS_MANAGER_KEY]

packages/service-library/src/servicelib/aiohttp/long_running_tasks/_routes.py

@@ -6,7 +6,8 @@
 
 from ...json_serialization import json_dumps
 from ...long_running_tasks._models import TaskId, TaskResult, TaskStatus
-from ._dependencies import get_task_manager
+from ...mimetype_constants import MIMETYPE_APPLICATION_JSON
+from ._dependencies import get_tasks_manager
 
 log = logging.getLogger(__name__)
 routes = web.RouteTableDef()
@@ -19,27 +20,27 @@ class _PathParam(BaseModel):
 @routes.get("/{task_id}", name="get_task_status")
 async def get_task_status(request: web.Request) -> web.Response:
     path_params = parse_request_path_parameters_as(_PathParam, request)
-    log.debug("getting task status: %s", f"{path_params.task_id=}")
-    task_manager = get_task_manager(request.app)
-    task_status: TaskStatus = task_manager.get_status(task_id=path_params.task_id)
+    tasks_manager = get_tasks_manager(request.app)
+
+    task_status: TaskStatus = tasks_manager.get_task_status(task_id=path_params.task_id)
     return web.json_response({"data": task_status}, dumps=json_dumps)
 
 
 @routes.get("/{task_id}/result", name="get_task_result")
 async def get_task_result(request: web.Request) -> web.Response:
     path_params = parse_request_path_parameters_as(_PathParam, request)
-    task_manager = get_task_manager(request.app)
+    tasks_manager = get_tasks_manager(request.app)
 
-    task_result: TaskResult = task_manager.get_result(task_id=path_params.task_id)
+    task_result: TaskResult = tasks_manager.get_task_result(task_id=path_params.task_id)
     # NOTE: we do not reraise here, in case the result returned an error,
     # but we still want to remove the task
-    await task_manager.remove(path_params.task_id, reraise_errors=False)
+    await tasks_manager.remove_task(path_params.task_id, reraise_errors=False)
     return web.json_response({"data": task_result}, dumps=json_dumps)
 
 
 @routes.delete("/{task_id}", name="cancel_and_delete_task")
 async def cancel_and_delete_task(request: web.Request) -> web.Response:
     path_params = parse_request_path_parameters_as(_PathParam, request)
-    task_manager = get_task_manager(request.app)
-    await task_manager.remove(path_params.task_id)
-    raise web.HTTPNoContent(content_type="application/json")
+    tasks_manager = get_tasks_manager(request.app)
+    await tasks_manager.remove_task(path_params.task_id)
+    raise web.HTTPNoContent(content_type=MIMETYPE_APPLICATION_JSON)

packages/service-library/src/servicelib/aiohttp/long_running_tasks/_server.py

@@ -4,7 +4,7 @@
 from aiohttp import web
 from pydantic import PositiveFloat
 
-from ...long_running_tasks._task import TaskManager
+from ...long_running_tasks._task import TasksManager
 from ._constants import APP_LONG_RUNNING_TASKS_MANAGER_KEY, MINUTE
 from ._error_handlers import base_long_running_error_handler
 from ._routes import routes
@@ -15,7 +15,7 @@
 def setup(
     app: web.Application,
     *,
-    router_prefix: str = "",
+    router_prefix: str,
     stale_task_check_interval_s: PositiveFloat = 1 * MINUTE,
     stale_task_detect_timeout_s: PositiveFloat = 5 * MINUTE,
 ) -> None:
@@ -43,7 +43,7 @@ async def on_startup(app: web.Application) -> AsyncGenerator[None, None]:
         # add components to state
         app[
             APP_LONG_RUNNING_TASKS_MANAGER_KEY
-        ] = long_running_task_manager = TaskManager(
+        ] = long_running_task_manager = TasksManager(
             stale_task_check_interval_s=stale_task_check_interval_s,
             stale_task_detect_timeout_s=stale_task_detect_timeout_s,
         )

packages/service-library/src/servicelib/aiohttp/long_running_tasks/server.py

@@ -5,29 +5,30 @@
 The server only has to return a `TaskId` in the handler creating the long
 running task.
 """
-
 from ...long_running_tasks._task import (
     TaskAlreadyRunningError,
     TaskCancelledError,
     TaskId,
-    TaskManager,
     TaskProgress,
     TaskResult,
+    TasksManager,
     TaskStatus,
     start_task,
 )
-from ._dependencies import get_task_manager
+from ._dependencies import get_tasks_manager
 from ._server import setup
 
 __all__: tuple[str, ...] = (
-    "get_task_manager",
+    "get_tasks_manager",
     "setup",
     "start_task",
     "TaskAlreadyRunningError",
     "TaskCancelledError",
     "TaskId",
-    "TaskManager",
+    "TasksManager",
     "TaskProgress",
     "TaskResult",
     "TaskStatus",
 )
+
+# nopycln: file

packages/service-library/src/servicelib/fastapi/long_running_tasks/_dependencies.py

@@ -1,7 +1,7 @@
 from fastapi import Request
 
-from ...long_running_tasks._task import TaskManager
+from ...long_running_tasks._task import TasksManager
 
 
-def get_task_manager(request: Request) -> TaskManager:
+def get_tasks_manager(request: Request) -> TasksManager:
     return request.app.state.long_running_task_manager

packages/service-library/src/servicelib/fastapi/long_running_tasks/_routes.py

@@ -1,9 +1,9 @@
 from fastapi import APIRouter, Depends, Request, status
 
 from ...long_running_tasks._models import TaskId, TaskResult, TaskStatus
-from ...long_running_tasks._task import TaskManager
+from ...long_running_tasks._task import TasksManager
 from ..requests_decorators import cancel_on_disconnect
-from ._dependencies import get_task_manager
+from ._dependencies import get_tasks_manager
 
 router = APIRouter(prefix="/task")
 
@@ -18,10 +18,10 @@
 async def get_task_status(
     request: Request,
     task_id: TaskId,
-    task_manager: TaskManager = Depends(get_task_manager),
+    task_manager: TasksManager = Depends(get_tasks_manager),
 ) -> TaskStatus:
     assert request  # nosec
-    return task_manager.get_status(task_id=task_id)
+    return task_manager.get_task_status(task_id=task_id)
 
 
 @router.get(
@@ -37,12 +37,12 @@ async def get_task_status(
 async def get_task_result(
     request: Request,
     task_id: TaskId,
-    task_manager: TaskManager = Depends(get_task_manager),
+    task_manager: TasksManager = Depends(get_tasks_manager),
 ) -> TaskResult:
     assert request  # nosec
 
-    task_result = task_manager.get_result(task_id=task_id)
-    await task_manager.remove(task_id, reraise_errors=False)
+    task_result = task_manager.get_task_result(task_id=task_id)
+    await task_manager.remove_task(task_id, reraise_errors=False)
 
     return task_result
 
@@ -60,7 +60,7 @@ async def get_task_result(
 async def cancel_and_delete_task(
     request: Request,
     task_id: TaskId,
-    task_manager: TaskManager = Depends(get_task_manager),
+    task_manager: TasksManager = Depends(get_tasks_manager),
 ) -> None:
     assert request  # nosec
-    await task_manager.remove(task_id)
+    await task_manager.remove_task(task_id)

packages/service-library/src/servicelib/fastapi/long_running_tasks/_server.py

@@ -4,7 +4,7 @@
 from pydantic import PositiveFloat
 
 from ...long_running_tasks._errors import BaseLongRunningError
-from ...long_running_tasks._task import TaskManager
+from ...long_running_tasks._task import TasksManager
 from ._error_handlers import base_long_running_error_handler
 from ._routes import router
 
@@ -35,7 +35,7 @@ async def on_startup() -> None:
         app.include_router(main_router)
 
         # add components to state
-        app.state.long_running_task_manager = TaskManager(
+        app.state.long_running_task_manager = TasksManager(
             stale_task_check_interval_s=stale_task_check_interval_s,
             stale_task_detect_timeout_s=stale_task_detect_timeout_s,
         )
@@ -45,7 +45,7 @@ async def on_startup() -> None:
 
     async def on_shutdown() -> None:
         if app.state.long_running_task_manager:
-            task_manager: TaskManager = app.state.long_running_task_manager
+            task_manager: TasksManager = app.state.long_running_task_manager
             await task_manager.close()
 
     app.add_event_handler("startup", on_startup)

packages/service-library/src/servicelib/fastapi/long_running_tasks/server.py

@@ -10,25 +10,26 @@
     TaskAlreadyRunningError,
     TaskCancelledError,
     TaskId,
-    TaskManager,
     TaskProgress,
     TaskResult,
+    TasksManager,
     TaskStatus,
     start_task,
 )
-from ._dependencies import get_task_manager
+from ._dependencies import get_tasks_manager
 from ._server import setup
 
-
 __all__: tuple[str, ...] = (
-    "get_task_manager",
+    "get_tasks_manager",
     "setup",
     "start_task",
     "TaskAlreadyRunningError",
     "TaskCancelledError",
     "TaskId",
-    "TaskManager",
+    "TasksManager",
     "TaskProgress",
     "TaskResult",
     "TaskStatus",
 )
+
+# nopycln: file

packages/service-library/src/servicelib/long_running_tasks/_models.py

@@ -26,8 +26,8 @@ class TaskProgress(BaseModel):
     defined as a float bound between 0.0 and 1.0
     """
 
-    message: ProgressMessage
-    percent: ProgressPercent
+    message: ProgressMessage = Field(default="")
+    percent: ProgressPercent = Field(default=0.0)
 
     def publish(
         self,
@@ -58,7 +58,7 @@ class TrackedTask(BaseModel):
 
     started: datetime = Field(default_factory=datetime.utcnow)
     last_status_check: Optional[datetime] = Field(
-        None,
+        default=None,
         description=(
             "used to detect when if the task is not actively "
             "polled by the client who created it"