added notes

Author: Andrei Neagu

services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/services/generic_scheduler/_deferred_runner.py

@@ -29,7 +29,7 @@
 )
 
 
-def _get_step_store_proxy(context: DeferredContext) -> StepStoreProxy:
+def get_step_store_proxy(context: DeferredContext) -> StepStoreProxy:
     app: FastAPI = context["app"]
     schedule_id: ScheduleId = context["schedule_id"]
     operation_name: OperationName = context["operation_name"]
@@ -48,7 +48,7 @@ def _get_step_store_proxy(context: DeferredContext) -> StepStoreProxy:
     )
 
 
-def _get_step_group_proxy(context: DeferredContext) -> StepGroupProxy:
+def get_step_group_proxy(context: DeferredContext) -> StepGroupProxy:
     app: FastAPI = context["app"]
     schedule_id: ScheduleId = context["schedule_id"]
     operation_name: OperationName = context["operation_name"]
@@ -90,7 +90,7 @@ async def _send_group_done_check_event(context: DeferredContext) -> None:
     expected_steps_count: NonNegativeInt = context["expected_steps_count"]
 
     if (
-        await _get_step_group_proxy(context).increment_and_get_done_steps_count()
+        await get_step_group_proxy(context).increment_and_get_done_steps_count()
         == expected_steps_count
     ):
         await enqueue_schedule_event(app, schedule_id)
@@ -161,7 +161,7 @@ async def get_timeout(cls, context: DeferredContext) -> timedelta:
 
     @classmethod
     async def on_created(cls, task_uid: TaskUID, context: DeferredContext) -> None:
-        await _get_step_store_proxy(context).set_multiple(
+        await get_step_store_proxy(context).set_multiple(
             {"deferred_task_uid": task_uid, "status": StepStatus.CREATED}
         )
 
@@ -170,7 +170,7 @@ async def run(cls, context: DeferredContext) -> None:
         app = context["app"]
         is_creating = context["is_creating"]
 
-        await _get_step_store_proxy(context).set("status", StepStatus.RUNNING)
+        await get_step_store_proxy(context).set("status", StepStatus.RUNNING)
 
         step = _get_step(context)
 
@@ -208,22 +208,22 @@ async def run(cls, context: DeferredContext) -> None:
     @classmethod
     async def on_result(cls, result: None, context: DeferredContext) -> None:
         _ = result
-        await _get_step_store_proxy(context).set("status", StepStatus.SUCCESS)
+        await get_step_store_proxy(context).set("status", StepStatus.SUCCESS)
 
         await _send_group_done_check_event(context)
 
     @classmethod
     async def on_finished_with_error(
         cls, error: TaskResultError, context: DeferredContext
     ) -> None:
-        await _get_step_store_proxy(context).set_multiple(
+        await get_step_store_proxy(context).set_multiple(
             {"status": StepStatus.FAILED, "error_traceback": error.format_error()}
         )
 
         await _send_group_done_check_event(context)
 
     @classmethod
     async def on_cancelled(cls, context: DeferredContext) -> None:
-        await _get_step_store_proxy(context).set("status", StepStatus.CANCELLED)
+        await get_step_store_proxy(context).set("status", StepStatus.CANCELLED)
 
         await _send_group_done_check_event(context)

services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/services/generic_scheduler/_operation.py

@@ -58,15 +58,23 @@ def get_create_provides_context_keys(cls) -> set[str]:
 
     @classmethod
     async def get_create_retries(cls, context: DeferredContext) -> int:
-        """[optional] amount of retires in case of creation"""
+        """
+        [optional] amount of retires in case of creation
+        HINT: you can use `get_step_group_proxy(context)` and `get_step_store_proxy(context)`
+        to implement custom retry strategy
+        """
         assert context  # nosec
         return _DEFAULT_STEP_RETRIES
 
     @classmethod
     async def get_create_wait_between_attempts(
         cls, context: DeferredContext
     ) -> timedelta:
-        """[optional] wait time between retires case of creation"""
+        """
+        [optional] wait time between retires case of creation
+        HINT: you can use `get_step_group_proxy(context)` and `get_step_store_proxy(context)`
+        to implement custom retry strategy
+        """
         assert context  # nosec
         return _DEFAULT_STEP_TIMEOUT
 
@@ -110,15 +118,23 @@ def get_revert_provides_context_keys(cls) -> set[str]:
 
     @classmethod
     async def get_revert_retries(cls, context: DeferredContext) -> int:
-        """[optional] amount of retires in case of failure"""
+        """
+        [optional] amount of retires in case of failure
+        HINT: you can use `get_step_group_proxy(context)` and `get_step_store_proxy(context)`
+        to implement custom retry strategy
+        """
         assert context  # nosec
         return _DEFAULT_STEP_RETRIES
 
     @classmethod
     async def get_revert_wait_between_attempts(
         cls, context: DeferredContext
     ) -> timedelta:
-        """[optional] timeout between retires in case of failure"""
+        """
+        [optional] timeout between retires in case of failure
+        HINT: you can use `get_step_group_proxy(context)` and `get_step_store_proxy(context)`
+        to implement custom retry strategy
+        """
         assert context  # nosec
         return _DEFAULT_STEP_TIMEOUT