feat: Add AssertReceiveTimeout check#16
Merged
Merged
Conversation
Adds a new check which flags `assert_receive` calls that specify explicit timeouts. These timeouts can seem like a fine idea in dev, but when your test later runs on a dog-slow CI machine, the tight timeouts can cause flakiness. (In CI, you might run with an absurdly long timeout to avoid flakiness.) Supports an optional `min_assert_receive_timeout` parameter that allows literal `assert_receive` timeouts greater than or equal to the configured minimum. Also supports an optional `max_refute_receive_timeout` parameter that flags `refute_receive` calls whose timeout exceeds the configured maximum (because `refute_receive` always blocks for its full timeout, setting a lower bound on the test's runtime).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new check which flags
assert_receivecalls that specify explicit timeouts. These timeouts can seem like a fine idea in dev, but when your test later runs on a dog-slow CI machine, the tight timeouts can cause flakiness. (In CI, you might run with an absurdly long timeout to avoid flakiness.)Supports an optional
min_assert_receive_timeoutparameter that allows literalassert_receivetimeouts greater than or equal to the configured minimum. Also supports an optionalmax_refute_receive_timeoutparameter that flagsrefute_receivecalls whose timeout exceeds the configured maximum (becauserefute_receivealways blocks for its full timeout, setting a lower bound on the test's runtime).