New rule: validate async intervals #139
Merged
Conversation
This file contains 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
The linter now supports new optional rul (turned off by default). This rule validates the async functions' timeout and polling arguments. The linter checks for three things: 1. best effort: if the time interval is known (when using integr literals or `time.Duration` values), the linter validates that the timeout is not shorter than the polling interval. 2. Forces the timeout and the polling arguments of the `Eventually` and `Consistently` functions, to be of type `time.Duration`. Best effort auto-fix: in cases that the linter can do that, e.g. for an integer value, it suggests replacing this value with a multiply with time.Second. 3. Forces up to one timeout and up to one polling arguments.
Pull Request Test Coverage Report for Build 8317036138Details
💛 - Coveralls |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
The linter now supports new optional rul (turned off by default). This rule validates the async functions' timeout and polling arguments.
The linter checks for three things:
best effort: if the time interval is known (when using integr literals or
time.Durationvalues), the linter validates that the timeout is not shorter than the polling interval.Forces the timeout and the polling arguments of the
EventuallyandConsistentlyfunctions, to be of typetime.Duration.Best effort auto-fix: in cases that the linter can do that, e.g. for an integer value, it suggests replacing this value with a multiply with time.Second.
Forces up to one timeout and up to one polling arguments.
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes #129
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist: