refactor naming

Author: Andrei Neagu

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

@@ -55,7 +55,7 @@ def _get_redis_key_task_data_match(self) -> str:
     def _get_redis_key_task_data_hash(self, task_id: TaskId) -> str:
         return f"{self.namespace}:{_STORE_TYPE_TASK_DATA}:{task_id}"
 
-    def _get_key_cancelled_tasks(self) -> str:
+    def _get_key_to_remove(self) -> str:
         return f"{self.namespace}:{_STORE_TYPE_CANCELLED_TASKS}"
 
     # TaskData
@@ -120,25 +120,25 @@ async def delete_task_data(self, task_id: TaskId) -> None:
 
     # to cancel
 
-    async def set_to_cancel(
+    async def set_to_remove(
         self, task_id: TaskId, with_task_context: TaskContext
     ) -> None:
-        """marks a task_id to be cancelled"""
+        """marks a task_id to be removed"""
         await handle_redis_returns_union_types(
             self._redis.hset(
-                self._get_key_cancelled_tasks(), task_id, json_dumps(with_task_context)
+                self._get_key_to_remove(), task_id, json_dumps(with_task_context)
             )
         )
 
-    async def remove_to_cancel(self, task_id: TaskId) -> None:
-        """removes a task_id from the ones to be cancelled"""
+    async def delete_to_remove(self, task_id: TaskId) -> None:
+        """deletes a task_id from the ones to be removed"""
         await handle_redis_returns_union_types(
-            self._redis.hdel(self._get_key_cancelled_tasks(), task_id)
+            self._redis.hdel(self._get_key_to_remove(), task_id)
         )
 
-    async def get_all_to_cancel(self) -> dict[TaskId, TaskContext]:
-        """returns all task_ids that are to be cancelled"""
+    async def get_all_to_remove(self) -> dict[TaskId, TaskContext]:
+        """returns all task_ids that are to be removed"""
         result: dict[str, str | None] = await handle_redis_returns_union_types(
-            self._redis.hgetall(self._get_key_cancelled_tasks())
+            self._redis.hgetall(self._get_key_to_remove())
         )
         return {task_id: json_loads(context) for task_id, context in result.items()}

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

@@ -267,14 +267,12 @@ async def _stale_tasks_monitor(self) -> None:
 
     async def _cancelled_tasks_removal(self) -> None:
         """
-        A task can be cancelled by the client, which implies it does not for sure
-        run in the same process as the one processing the request.
-
-        This is a periodic task that ensures the cancellation occurred.
+        Periodicallu checks which tasks are maked for removal and attempts to remove the
+        task if it's handled by this process.
         """
         self._started_event_task_cancelled_tasks_removal.set()
 
-        cancelled_tasks = await self._tasks_data.get_all_to_cancel()
+        cancelled_tasks = await self._tasks_data.get_all_to_remove()
         for task_id in cancelled_tasks:
             await self._attempt_cancel_and_remove_local_task(task_id)
 
@@ -396,7 +394,7 @@ async def _attempt_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.remove_to_cancel(task_id)
+            await self._tasks_data.delete_to_remove(task_id)
             await self._tasks_data.delete_task_data(task_id)
 
     async def remove_task(
@@ -414,7 +412,7 @@ async def remove_task(
                 raise
             return
 
-        await self._tasks_data.set_to_cancel(
+        await self._tasks_data.set_to_remove(
             tracked_task.task_id, tracked_task.task_context
         )
 

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

@@ -50,11 +50,11 @@ async def test_workflow(store: RedisStore, task_data: TaskData) -> None:
     assert await store.list_tasks_data() == []
 
     # cancelled tasks
-    assert await store.get_all_to_cancel() == {}
+    assert await store.get_all_to_remove() == {}
 
-    await store.set_to_cancel(task_data.task_id, task_data.task_context)
+    await store.set_to_remove(task_data.task_id, task_data.task_context)
 
-    assert await store.get_all_to_cancel() == {
+    assert await store.get_all_to_remove() == {
         task_data.task_id: task_data.task_context
     }
 
@@ -89,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_all_to_cancel() == {}
+        assert await store.get_all_to_remove() == {}
 
     for store in redis_stores:
         await store.add_task_data(task_data.task_id, task_data)
-        await store.set_to_cancel(task_data.task_id, {})
+        await store.set_to_remove(task_data.task_id, {})
 
     for store in redis_stores:
         assert await store.list_tasks_data() == [task_data]
-        assert await store.get_all_to_cancel() == {task_data.task_id: {}}
+        assert await store.get_all_to_remove() == {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_to_cancel(  # noqa: SLF001
+    await long_running_manager.tasks_manager._tasks_data.set_to_remove(  # noqa: SLF001
         task_id, with_task_context=empty_context
     )