rename interface

Author: Andrei Neagu

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

@@ -118,23 +118,26 @@ async def delete_task_data(self, task_id: TaskId) -> None:
             self._redis.delete(self._get_redis_key_task_data_hash(task_id))
         )
 
-    # cancelled
+    # to cancel
 
-    async def set_as_cancelled(
+    async def set_to_cancel(
         self, task_id: TaskId, with_task_context: TaskContext
     ) -> None:
+        """marks a task_id to be cancelled"""
         await handle_redis_returns_union_types(
             self._redis.hset(
                 self._get_key_cancelled_tasks(), task_id, json_dumps(with_task_context)
             )
         )
 
-    async def delete_set_as_cancelled(self, task_id: TaskId) -> None:
+    async def remove_to_cancel(self, task_id: TaskId) -> None:
+        """removes a task_id from the ones to be cancelled"""
         await handle_redis_returns_union_types(
             self._redis.hdel(self._get_key_cancelled_tasks(), task_id)
         )
 
-    async def get_cancelled(self) -> dict[TaskId, TaskContext]:
+    async def get_all_to_cancel(self) -> dict[TaskId, TaskContext]:
+        """returns all task_ids that are to be cancelled"""
         result: dict[str, str | None] = await handle_redis_returns_union_types(
             self._redis.hgetall(self._get_key_cancelled_tasks())
         )

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

@@ -275,7 +275,7 @@ async def _cancelled_tasks_removal(self) -> None:
         """
         self._started_event_task_cancelled_tasks_removal.set()
 
-        cancelled_tasks = await self._tasks_data.get_cancelled()
+        cancelled_tasks = await self._tasks_data.get_all_to_cancel()
         for task_id in cancelled_tasks:
             await self._cancel_and_remove_local_task(task_id)
 
@@ -397,7 +397,7 @@ async def _cancel_and_remove_local_task(self, task_id: TaskId) -> None:
         task_to_cancel = self._created_tasks.pop(task_id, None)
         if task_to_cancel is not None:
             await cancel_wait_task(task_to_cancel)
-            await self._tasks_data.delete_set_as_cancelled(task_id)
+            await self._tasks_data.remove_to_cancel(task_id)
             await self._tasks_data.delete_task_data(task_id)
 
     async def remove_task(
@@ -415,7 +415,7 @@ async def remove_task(
                 raise
             return
 
-        await self._tasks_data.set_as_cancelled(
+        await self._tasks_data.set_to_cancel(
             tracked_task.task_id, tracked_task.task_context
         )
 

packages/service-library/tests/long_running_tasks/test_long_running_tasks__store.py

@@ -50,11 +50,13 @@ async def test_workflow(store: RedisStore, task_data: TaskData) -> None:
     assert await store.list_tasks_data() == []
 
     # cancelled tasks
-    assert await store.get_cancelled() == {}
+    assert await store.get_all_to_cancel() == {}
 
-    await store.set_as_cancelled(task_data.task_id, task_data.task_context)
+    await store.set_to_cancel(task_data.task_id, task_data.task_context)
 
-    assert await store.get_cancelled() == {task_data.task_id: task_data.task_context}
+    assert await store.get_all_to_cancel() == {
+        task_data.task_id: task_data.task_context
+    }
 
 
 @pytest.fixture
@@ -87,15 +89,15 @@ async def test_workflow_multiple_redis_stores_with_different_namespaces(
 
     for store in redis_stores:
         assert await store.list_tasks_data() == []
-        assert await store.get_cancelled() == {}
+        assert await store.get_all_to_cancel() == {}
 
     for store in redis_stores:
         await store.add_task_data(task_data.task_id, task_data)
-        await store.set_as_cancelled(task_data.task_id, None)
+        await store.set_to_cancel(task_data.task_id, {})
 
     for store in redis_stores:
         assert await store.list_tasks_data() == [task_data]
-        assert await store.get_cancelled() == {task_data.task_id: None}
+        assert await store.get_all_to_cancel() == {task_data.task_id: {}}
 
     for store in redis_stores:
         await store.delete_task_data(task_data.task_id)

packages/service-library/tests/long_running_tasks/test_long_running_tasks_task.py

@@ -480,7 +480,7 @@ async def test__cancelled_tasks_worker_equivalent_of_cancellation_from_a_differe
         total_sleep=10,
         task_context=empty_context,
     )
-    await long_running_manager.tasks_manager._tasks_data.set_as_cancelled(  # noqa: SLF001
+    await long_running_manager.tasks_manager._tasks_data.set_to_cancel(  # noqa: SLF001
         task_id, with_task_context=empty_context
     )