update comments

Author: Andrei Neagu

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

@@ -287,7 +287,7 @@ async def _on_schedule_event(self, schedule_id: ScheduleId) -> None:
             is_creating=is_creating,
         )
 
-        # 1. ensure all steps in the group are started
+        # 1) ensure all steps in the group are started
         started_steps_couunt = await start_steps_and_get_count(
             group_step_proxies,
             is_creating=is_creating,
@@ -300,7 +300,7 @@ async def _on_schedule_event(self, schedule_id: ScheduleId) -> None:
         steps_statuses = await get_steps_statuses(group_step_proxies.values())
         _logger.debug("DETECTED: steps_statuses=%s", steps_statuses)
 
-        # 2. wait for all steps to finish before continuing
+        # 2) wait for all steps to finish before continuing
         if is_operation_in_progress_status(steps_statuses):
             _logger.debug(
                 "Operation '%s' has not finished: steps_statuses='%s'",
@@ -309,13 +309,12 @@ async def _on_schedule_event(self, schedule_id: ScheduleId) -> None:
             )
             return
 
-        # 3. all steps are in a final state, process them
+        # 3) all steps are in a final state, process them
         _logger.debug("steps_statuses=%s in final state in operation", steps_statuses)
 
         if step_group.repeat_steps is True and is_creating:
-            # Meaning check:
-            # 3A1. if any of the repeating steps was cancelled -> move to revert
-            # 3A2. otherwise restart all steps in the group
+            # 3A1) if any of the repeating steps was cancelled -> move to revert
+            # 3A2) otherwise restart all steps in the group
             await self._continue_as_repeating_group(
                 schedule_data_proxy,
                 schedule_id,
@@ -325,10 +324,11 @@ async def _on_schedule_event(self, schedule_id: ScheduleId) -> None:
                 group_step_proxies,
             )
         elif is_creating:
-            # Meaning check:
-            # 3B1. if all steps in group in SUUCESS -> move to next group
-            # 3B2. if manual intervention is required -> do nothing else
-            # 3B3. if any step in CANCELLED or FAILED(and not in manual intervention) -> move to revert
+            # 3B1) if all steps in group in SUUCESS
+            # - 3B1a) move to next group
+            # - 3B1b) reached the end of the CREATE operation, remove all created data
+            # 3B2) if manual intervention is required -> do nothing else
+            # 3B3) if any step in CANCELLED or FAILED(and not in manual intervention) -> move to revert
             await self._continue_as_creation(
                 steps_statuses,
                 schedule_data_proxy,
@@ -339,10 +339,11 @@ async def _on_schedule_event(self, schedule_id: ScheduleId) -> None:
                 operation,
             )
         else:
-            # Meaning check:
-            # 3C1. if all steps in gorup in SUUCESS -> go back to previous group untill done
-            # 3C2. it is unexpected to have a FAILED step -> do nothing else
-            # 3C3. it is unexpected to have a CANCELLED step -> do nothing else
+            # 3C1) if all steps in gorup in SUUCESS
+            # - 3C1a) reached the end of the REVERT operation, remove all created data
+            # - 3C1b) go back to previous group untill done
+            # 3C2) it is unexpected to have a FAILED step -> do nothing else
+            # 3C3) it is unexpected to have a CANCELLED step -> do nothing else
             await self._continue_as_reverting(
                 steps_statuses,
                 schedule_data_proxy,
@@ -375,14 +376,14 @@ async def _continue_as_repeating_group(
         # since a cancellation request might have been requested
         steps_stauses = await get_steps_statuses(step_proxies)
 
-        # 3A1. if any of the repeating steps was cancelled -> move to revert
+        # 3A1) if any of the repeating steps was cancelled -> move to revert
         if any(status == StepStatus.CANCELLED for status in steps_stauses.values()):
             # NOTE:
             await schedule_data_proxy.set("is_creating", value=False)
             await enqueue_schedule_event(self.app, schedule_id)
             return
 
-        # 3A2. otherwise restart all steps in the group
+        # 3A2) otherwise restart all steps in the group
         await limited_gather(
             *(x.remove() for x in step_proxies), limit=PARALLEL_STATUS_REQUESTS
         )
@@ -406,23 +407,24 @@ async def _continue_as_creation(
         current_step_group: BaseStepGroup,
         operation: Operation,
     ) -> None:
-        # 3B1. if all steps in group in SUUCESS -> move to next group
+        # 3B1) if all steps in group in SUUCESS
         if all(status == StepStatus.SUCCESS for status in steps_statuses.values()):
+            # 3B1a) move to next group
             try:
                 next_group_index = group_index + 1
                 # does a next group exist?
                 _ = operation[next_group_index]
                 await schedule_data_proxy.set("group_index", value=next_group_index)
                 await enqueue_schedule_event(self.app, schedule_id)
             except IndexError:
-                # reached the end of the CREATE operation, remove all created data
+                # 3B1b) reached the end of the CREATE operation, remove all created data
                 await cleanup_after_finishing(
                     self._store, schedule_id=schedule_id, is_creating=True
                 )
 
             return
 
-        # 3B2. if manual intervention is required -> do nothing else
+        # 3B2) if manual intervention is required -> do nothing else
         manual_intervention_step_names: set[StepName] = set()
         current_step_group.get_step_subgroup_to_run()
         for step in current_step_group.get_step_subgroup_to_run():
@@ -452,7 +454,7 @@ async def _continue_as_creation(
             )
             return
 
-        # 3B3. if any step in CANCELLED or FAILED(and not in manual intervention) -> move to revert
+        # 3B3) if any step in CANCELLED or FAILED(and not in manual intervention) -> move to revert
         if any(
             s in {StepStatus.FAILED, StepStatus.CANCELLED}
             for s in steps_statuses.values()
@@ -479,21 +481,22 @@ async def _continue_as_reverting(
         group_index: NonNegativeInt,
         current_step_group: BaseStepGroup,
     ) -> None:
-        # 3C1. if all steps in gorup in SUUCESS -> go back to previous group untill done
+        # 3C1) if all steps in gorup in SUUCESS
         if all(s == StepStatus.SUCCESS for s in steps_statuses.values()):
             previous_group_index = group_index - 1
             if previous_group_index < 0:
-                # reached the end of the REVERT operation, remove all created data
+                # 3C1a) reached the end of the REVERT operation, remove all created data
                 await cleanup_after_finishing(
                     self._store, schedule_id=schedule_id, is_creating=False
                 )
                 return
 
+            # 3C1b) go back to previous group untill done
             await schedule_data_proxy.set("group_index", value=previous_group_index)
             await enqueue_schedule_event(self.app, schedule_id)
             return
 
-        # 3C2. it is unexpected to have a FAILED step -> do nothing else
+        # 3C2) it is unexpected to have a FAILED step -> do nothing else
         if failed_step_names := [
             n for n, s in steps_statuses.items() if s == StepStatus.FAILED
         ]:
@@ -527,7 +530,7 @@ async def _continue_as_reverting(
             )
             return
 
-        # 3C3. it is unexpected to have a CANCELLED step -> do nothing else
+        # 3C3) it is unexpected to have a CANCELLED step -> do nothing else
         if cancelled_step_names := [
             n for n, s in steps_statuses.items() if s == StepStatus.CANCELLED
         ]: