Skip to content

Commit 8a72e73

Browse files
committed
Add changelog entry for fail_fast default change
1 parent 5243577 commit 8a72e73

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

docs/source/changelog.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,21 @@ Major Breaking Changes
1616

1717
These are breaking changes we believe are most likely to effect your project.
1818

19+
* The ``fail_fast`` argument to |StubBroker_join| now defaults to True.
20+
This means that calling |StubBroker_join|, will by default,
21+
re-raise any Exceptions that caused messages to get dead-lettered
22+
(i.e. any uncaught Exceptions in your actor functions).
23+
You may need to explicitly catch these exception in your tests
24+
(e.g. with :meth:`unittest.TestCase.assertRaises` or :func:`pytest.raises`).
25+
26+
Alternatively, you can revert to the old behavior
27+
by passing ``fail_fast_default=False`` to |StubBroker|.
28+
29+
However, we think the new default behavior is best, because it makes
30+
exceptions happening in your actor functions obvious in your tests.
31+
Previsouly, exceptions in your actor functions could pass silently,
32+
and potentially unnoticed unless you checked the side-effects of the actor.
33+
(`#739`_, `#758`_, `@LincolnPuzey`_)
1934
* The |Prometheus| middleware is no longer in the default middleware list.
2035
To keep exporting the Prometheus statistics, you must now install the ``prometheus`` extra
2136
(e.g. ``pip install 'dramatiq[prometheus]'``)
@@ -31,6 +46,8 @@ These are breaking changes we believe are most likely to effect your project.
3146
.. _#688: https://github.com/Bogdanp/dramatiq/pull/688
3247
.. _@azmeuk: https://github.com/azmeuk
3348
.. _#728: https://github.com/Bogdanp/dramatiq/pull/728
49+
.. _#758: https://github.com/Bogdanp/dramatiq/pull/758
50+
.. _#739: https://github.com/Bogdanp/dramatiq/issues/739
3451

3552
Minor Breaking Changes
3653
~~~~~~~~~~~~~~~~~~~~~~

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,4 +195,5 @@
195195
"python": ("https://docs.python.org/3", None),
196196
"pika": ("https://pika.readthedocs.io/en/stable/", None),
197197
"redis": ("https://redis.readthedocs.io/en/latest/", None),
198+
"pytest": ("https://docs.pytest.org/en/stable", None),
198199
}

0 commit comments

Comments
 (0)