Add comments

Author: Sushisource

tests/worker/test_replayer.py

@@ -398,7 +398,7 @@ async def test_replayer_command_reordering_backward_compatibility() -> None:
     )
 
 
-workflow_res = None
+test_replayer_workflow_res = None
 
 
 class WorkerWorkflowResultInterceptor(Interceptor):
@@ -410,9 +410,9 @@ def workflow_interceptor_class(
 
 class WorkflowResultInterceptor(WorkflowInboundInterceptor):
     async def execute_workflow(self, input: ExecuteWorkflowInput) -> Any:
-        global workflow_res
+        global test_replayer_workflow_res
         res = await super().execute_workflow(input)
-        workflow_res = res
+        test_replayer_workflow_res = res
         return res
 
 
@@ -471,7 +471,7 @@ async def test_replayer_async_ordering() -> None:
             workflows=[SignalsActivitiesTimersUpdatesTracingWorkflow],
             interceptors=[WorkerWorkflowResultInterceptor()],
         ).replay_workflow(WorkflowHistory.from_json("fake", history))
-        assert workflow_res == expected
+        assert test_replayer_workflow_res == expected
 
 
 async def test_replayer_alternate_async_ordering() -> None:
@@ -483,4 +483,10 @@ async def test_replayer_alternate_async_ordering() -> None:
         workflows=[ActivityAndSignalsWhileWorkflowDown],
         interceptors=[WorkerWorkflowResultInterceptor()],
     ).replay_workflow(WorkflowHistory.from_json("fake", history))
-    assert workflow_res == ["act-start", "sig-1", "sig-2", "counter-2", "act-done"]
+    assert test_replayer_workflow_res == [
+        "act-start",
+        "sig-1",
+        "sig-2",
+        "counter-2",
+        "act-done",
+    ]

tests/worker/test_workflow.py

@@ -6452,6 +6452,12 @@ async def test_concurrent_sleeps_use_proper_options(
 
 @workflow.defn
 class SignalsActivitiesTimersUpdatesTracingWorkflow:
+    """
+    These handlers all do different things that will cause the event loop to yield, sometimes
+    until the next workflow task (ex: timer) sometimes within the workflow task (ex: future resolve
+    or wait condition).
+    """
+
     def __init__(self) -> None:
         self.events: List[str] = []
 
@@ -6542,7 +6548,6 @@ async def run(self, activity_tq: str) -> List[str]:
         await workflow.wait_condition(lambda: self.counter >= 2)
         self.events.append(f"counter-{self.counter}")
         await act_task
-        workflow.logger.warning(f"run done: {self.events}")
         return self.events
 
     @workflow.signal
@@ -6580,13 +6585,15 @@ async def test_alternate_async_loop_ordering(client: Client):
         activities=[say_hello],
         task_queue=task_queue,
     ):
+        # This sleep exists to make sure the first WFT is processed
         await asyncio.sleep(0.2)
 
     async with new_worker(
         client,
         activities=[say_hello],
         task_queue=activity_tq,
     ):
+        # Make sure the activity starts being processed before sending signals
         await asyncio.sleep(1)
         await handle.signal(ActivityAndSignalsWhileWorkflowDown.dosig, "1")
         await handle.signal(ActivityAndSignalsWhileWorkflowDown.dosig, "2")