added cancellation tests

Author: Andrei Neagu

packages/service-library/src/servicelib/long_running_interfaces/_client.py

@@ -11,8 +11,8 @@
 from ._errors import (
     AlreadyStartedError,
     FinishedWithError,
+    NoMoreRetryAttemptsError,
     TimedOutError,
-    UnexpectedNoMoreRetryAttemptsError,
     UnexpectedResultTypeError,
     UnexpectedStatusError,
 )
@@ -145,8 +145,7 @@ async def _decrease_remaining_attempts_or_raise(
                     traceback=last_result.error.traceback,
                 )
 
-            # NOTE: this edge case should not happen
-            raise UnexpectedNoMoreRetryAttemptsError(
+            raise NoMoreRetryAttemptsError(
                 unique_id=unique_id,
                 retry_count=retry_count,
                 remaining_attempts=remaining_attempts,

packages/service-library/src/servicelib/long_running_interfaces/_errors.py

@@ -15,7 +15,7 @@ class FinishedWithError(BaseLongRunningError):
     msg_template = "unique_id='{unique_id}' finished with error='{error}' message='{message}'\n{traceback}"
 
 
-class UnexpectedNoMoreRetryAttemptsError(FinishedWithError):
+class NoMoreRetryAttemptsError(FinishedWithError):
     msg_template = "attempt {remaining_attempts} of {retry_count} for unique_id='{unique_id}' with last_result='{last_result}'"
 
 

packages/service-library/src/servicelib/long_running_interfaces/_rpc/server.py

@@ -104,3 +104,5 @@ async def result(self, unique_id: JobUniqueId) -> ResultModel:
                     traceback=formatted_traceback,
                 )
             )
+        finally:
+            await self.remove(unique_id)

packages/service-library/tests/long_running_interfaces/test_workflow.py

@@ -2,7 +2,6 @@
 # pylint:disable=unused-argument
 
 import asyncio
-from asyncio import CancelledError
 from collections.abc import AsyncIterable
 from dataclasses import dataclass
 from datetime import timedelta
@@ -212,7 +211,9 @@ async def _cancel_task_in_server(server: Server) -> None:
         task.cancel()
 
 
-async def test_cancellation_from_server(server: Server, client: Client):
+async def test_cancellation_from_server_retires_and_finishes(
+    server: Server, client: Client
+):
     async def _to_run() -> None:
         result = await client.ensure_result(
             "sleep_for_f",
@@ -229,7 +230,29 @@ async def _to_run() -> None:
 
     await _cancel_task_in_server(server)
 
+    await task
+
+
+async def test_cancellation_from_server_fails_if_no_more_retries_available(
+    server: Server, client: Client
+):
+    async def _to_run() -> None:
+        result = await client.ensure_result(
+            "sleep_for_f",
+            expected_type=type(None),
+            timeout=timedelta(seconds=10),
+            duration=2,
+            retry_count=1,
+        )
+        assert result is None
+
+    await _assert_tasks_count(server, count=0)
+
+    task = asyncio.create_task(_to_run())
+    await _assert_tasks_count(server, count=1)
+
+    await _cancel_task_in_server(server)
+
     with pytest.raises(FinishedWithError) as exec_info:
         await task
-
-    assert exec_info.value.error == CancelledError
+    assert exec_info.value.error == asyncio.CancelledError