Skip to content

Fix flaky test: test_workflow_return_is_honored_when_it_precedes_signal_completion_command #1115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 24, 2025
Merged

Fix flaky test: test_workflow_return_is_honored_when_it_precedes_signal_completion_command #1115

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
17d74cf
Run the test a lot
tconley1428 Sep 23, 2025
7b5c792
Run the test a bunch
tconley1428 Sep 23, 2025
7ffac2c
More logs
tconley1428 Sep 23, 2025
96d39c3
Format
tconley1428 Sep 23, 2025
e94d16c
Try a simpler method of signals waiting for run completion
tconley1428 Sep 23, 2025
526e916
Remove ci changes and logging
tconley1428 Sep 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 7 additions & 14 deletions tests/worker/test_workflow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6091,22 +6091,21 @@ def __init__(
self.main_workflow_returns_before_signal_completions = (
main_workflow_returns_before_signal_completions
)
self.ping_pong_val = 1
self.ping_pong_counter = 0
self.ping_pong_max_count = 4
self.run_finished = False

@workflow.run
async def run(self) -> str:
await workflow.wait_condition(
lambda: self.seen_first_signal and self.seen_second_signal
)
self.run_finished = True
return "workflow-result"

@workflow.signal
async def this_signal_executes_first(self):
self.seen_first_signal = True
if self.main_workflow_returns_before_signal_completions:
await self.ping_pong(lambda: self.ping_pong_val > 0)
await workflow.wait_condition(lambda: self.run_finished)
raise ApplicationError(
"Client should see this error unless doing ping-pong "
"(in which case main coroutine returns first)"
Expand All @@ -6117,18 +6116,12 @@ async def this_signal_executes_second(self):
await workflow.wait_condition(lambda: self.seen_first_signal)
self.seen_second_signal = True
if self.main_workflow_returns_before_signal_completions:
await self.ping_pong(lambda: self.ping_pong_val < 0)
await workflow.wait_condition(lambda: self.run_finished)
raise ApplicationError("Client should never see this error!")

async def ping_pong(self, cond: Callable[[], bool]):
while self.ping_pong_counter < self.ping_pong_max_count:
await workflow.wait_condition(cond)
self.ping_pong_val = -self.ping_pong_val
self.ping_pong_counter += 1


@workflow.defn
class FirstCompletionCommandIsHonoredPingPongWorkflow(
class FirstCompletionCommandIsHonoredSignalWaitWorkflow(
FirstCompletionCommandIsHonoredWorkflow
):
def __init__(self) -> None:
Expand Down Expand Up @@ -6157,10 +6150,10 @@ async def _do_first_completion_command_is_honored_test(
client: Client, main_workflow_returns_before_signal_completions: bool
):
workflow_cls: Union[
Type[FirstCompletionCommandIsHonoredPingPongWorkflow],
Type[FirstCompletionCommandIsHonoredSignalWaitWorkflow],
Type[FirstCompletionCommandIsHonoredWorkflow],
] = (
FirstCompletionCommandIsHonoredPingPongWorkflow
FirstCompletionCommandIsHonoredSignalWaitWorkflow
if main_workflow_returns_before_signal_completions
else FirstCompletionCommandIsHonoredWorkflow
)
Expand Down
Loading