Skip to content

Change fail_fast default to True for the StubBroker join() method #739

New issue
New issue
Open
#758
Open
Change fail_fast default to True for the StubBroker join() method#739
#758
Assignees
LincolnPuzey
Labels
enhancement
Milestone
v2.0.0
@LincolnPuzey

Description

@LincolnPuzey
LincolnPuzey
opened on Jul 21, 2025

As indicated in the docstring here

dramatiq/dramatiq/brokers/stub.py

Lines 132 to 150 in 1b23e03

# TODO: Make fail_fast default to True.
def join(self, queue_name: str, *, timeout: Optional[int] = None, fail_fast: bool = False) -> None:
"""Wait for all the messages on the given queue to be
processed. This method is only meant to be used in tests
to wait for all the messages in a queue to be processed.
Raises:
QueueJoinTimeout: When the timeout elapses.
QueueNotFound: If the given queue was never declared.
Parameters:
queue_name(str): The queue to wait on.
fail_fast(bool): When this is True and any message gets
dead-lettered during the join, then an exception will be
raised. This will be True by default starting with
version 2.0.
timeout(Optional[int]): The max amount of time, in
milliseconds, to wait on this queue.
"""

the fail_fast argument should be changed to default to True

Metadata

Metadata

Assignees

Labels

enhancement

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions