♻️ Towards a common long_running_tasks interface (#7833)

Co-authored-by: Andrei Neagu <[email protected]>

Author: GitHK

api/specs/web-server/_long_running_tasks.py

@@ -10,7 +10,7 @@
 from models_library.generics import Envelope
 from models_library.rest_error import EnvelopedError
 from servicelib.aiohttp.long_running_tasks._routes import _PathParam
-from servicelib.long_running_tasks._models import TaskGet, TaskStatus
+from servicelib.long_running_tasks.models import TaskGet, TaskStatus
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.tasks._exception_handlers import (
     _TO_HTTP_ERROR_MAP as export_data_http_error_map,

api/specs/web-server/_long_running_tasks_legacy.py

@@ -9,7 +9,7 @@
 from fastapi import APIRouter, Depends, status
 from models_library.generics import Envelope
 from servicelib.aiohttp.long_running_tasks._routes import _PathParam
-from servicelib.long_running_tasks._models import TaskGet, TaskStatus
+from servicelib.long_running_tasks.models import TaskGet, TaskStatus
 from simcore_service_webserver._meta import API_VTAG
 
 router = APIRouter(

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

@@ -2,7 +2,7 @@
 
 from aiohttp import web
 
-from ...long_running_tasks._task import TasksManager
+from ...long_running_tasks.task import TasksManager
 from ._constants import (
     APP_LONG_RUNNING_TASKS_MANAGER_KEY,
     RQT_LONG_RUNNING_TASKS_CONTEXT_KEY,

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

@@ -3,7 +3,7 @@
 from aiohttp import web
 from common_library.json_serialization import json_dumps
 
-from ...long_running_tasks._errors import (
+from ...long_running_tasks.errors import (
     TaskCancelledError,
     TaskNotCompletedError,
     TaskNotFoundError,

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

@@ -6,9 +6,9 @@
 from pydantic import BaseModel
 from servicelib.aiohttp import status
 
-from ...long_running_tasks._errors import TaskNotCompletedError, TaskNotFoundError
-from ...long_running_tasks._models import TaskGet, TaskId, TaskStatus
-from ...long_running_tasks._task import TrackedTask
+from ...long_running_tasks.errors import TaskNotCompletedError, TaskNotFoundError
+from ...long_running_tasks.models import TaskGet, TaskId, TaskStatus
+from ...long_running_tasks.task import TrackedTask
 from ..requests_validation import parse_request_path_parameters_as
 from ._dependencies import get_task_context, get_tasks_manager
 

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

@@ -9,8 +9,8 @@
 from pydantic import AnyHttpUrl, PositiveFloat, TypeAdapter
 
 from ...aiohttp import status
-from ...long_running_tasks._models import TaskGet
-from ...long_running_tasks._task import (
+from ...long_running_tasks.models import TaskGet
+from ...long_running_tasks.task import (
     TaskContext,
     TaskProtocol,
     TasksManager,
@@ -136,11 +136,11 @@ def setup(
 
     async def on_cleanup_ctx(app: web.Application) -> AsyncGenerator[None, None]:
         # add components to state
-        app[
-            APP_LONG_RUNNING_TASKS_MANAGER_KEY
-        ] = 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,
+        app[APP_LONG_RUNNING_TASKS_MANAGER_KEY] = 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,
+            )
         )
 
         # add error handlers

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

@@ -13,10 +13,16 @@
 from yarl import URL
 
 from ...long_running_tasks._constants import DEFAULT_POLL_INTERVAL_S, HOUR
-from ...long_running_tasks._models import LRTask, RequestBody
+from ...long_running_tasks.models import (
+    LRTask,
+    RequestBody,
+    TaskGet,
+    TaskId,
+    TaskProgress,
+    TaskStatus,
+)
 from ...rest_responses import unwrap_envelope_if_required
 from .. import status
-from .server import TaskGet, TaskId, TaskProgress, TaskStatus
 
 _logger = logging.getLogger(__name__)
 
@@ -123,6 +129,3 @@ async def long_running_task_request(
         if task:
             await _abort_task(session, URL(task.abort_href))
         raise
-
-
-__all__: tuple[str, ...] = ("LRTask",)

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

@@ -6,39 +6,19 @@
 running task.
 """
 
-from ...long_running_tasks._errors import TaskAlreadyRunningError, TaskCancelledError
-from ...long_running_tasks._models import ProgressMessage, ProgressPercent
-from ...long_running_tasks._task import (
-    TaskId,
-    TaskProgress,
-    TaskProtocol,
-    TasksManager,
-    TaskStatus,
-)
 from ._dependencies import (
     create_task_name_from_request,
     get_task_context,
     get_tasks_manager,
 )
-from ._routes import TaskGet
 from ._server import setup, start_long_running_task
 
 __all__: tuple[str, ...] = (
     "create_task_name_from_request",
     "get_task_context",
     "get_tasks_manager",
-    "ProgressMessage",
-    "ProgressPercent",
     "setup",
     "start_long_running_task",
-    "TaskAlreadyRunningError",
-    "TaskCancelledError",
-    "TaskId",
-    "TaskGet",
-    "TasksManager",
-    "TaskProgress",
-    "TaskProtocol",
-    "TaskStatus",
 )
 
 # nopycln: file

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

@@ -14,10 +14,10 @@
 from tenacity.stop import stop_after_attempt
 from tenacity.wait import wait_exponential
 
-from ...long_running_tasks._errors import GenericClientError
-from ...long_running_tasks._models import ClientConfiguration, TaskId, TaskStatus
+from ...long_running_tasks.errors import GenericClientError
+from ...long_running_tasks.models import ClientConfiguration, TaskId, TaskStatus
 
-DEFAULT_HTTP_REQUESTS_TIMEOUT: Final[PositiveFloat] = 15
+_DEFAULT_HTTP_REQUESTS_TIMEOUT: Final[PositiveFloat] = 15
 
 
 logger = logging.getLogger(__name__)
@@ -207,7 +207,7 @@ def setup(
     app: FastAPI,
     *,
     router_prefix: str = "",
-    http_requests_timeout: PositiveFloat = DEFAULT_HTTP_REQUESTS_TIMEOUT,
+    http_requests_timeout: PositiveFloat = _DEFAULT_HTTP_REQUESTS_TIMEOUT,
 ):
     """
     - `router_prefix` by default it is assumed the server mounts the APIs on

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

@@ -6,8 +6,8 @@
 
 from pydantic import PositiveFloat
 
-from ...long_running_tasks._errors import TaskClientTimeoutError
-from ...long_running_tasks._models import (
+from ...long_running_tasks.errors import TaskClientTimeoutError
+from ...long_running_tasks.models import (
     ProgressCallback,
     ProgressMessage,
     ProgressPercent,