This repository has been archived by the owner on Sep 14, 2020. It is now read-only.
Rename "cooldown" to "backoff" for handler retrying #266
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.
Fix a terminology issue, but keep it backward compatible.
Description
Due to my not so good English vocabulary, a slightly inappropriate word was used for the delay between retries of the handlers in #222: "cooldown".
"Cooldowns" are used in the RPG games for the spells. In Computer Science, the proper word would be "backoff":
retry
library'sbackoff=
kwarg,CrashLoopBackOff
,spec.backoffLimit
,It is better to fix this terminology issue before it spreads all over the codebase. (It is also possible that this kwarg will be extended to "exponential backoff" in the future.)
The handlers'/decorators'
cooldown=
kwarg and.cooldown
read-only property are kept there for backward compatibility as aliases forbackoff=
/.backoff
— since there was at least one public release with this naming (we do not know if it is already used somewhere or not).The aliases are tested only to minimally guarantee that they work as expected until they are removed in the next major release (1.0). The rest of the tests are switched to the proper name.
Types of Changes
Review
List of tasks the reviewer must do to review the PR