[Resolves #1] Forbid improper conversions using time.Duration()
#2
+344
−28
Conversation
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
navijation
commented
Mar 19, 2023
| // `var Name = 123`, and `a := 123` declarations are already type-checked | ||
| // by the compiler | ||
| func hasUntypedConstDeclaration(ti *types.Info, identifier *ast.Ident) bool { | ||
| func hasIntOrUntypedConstDeclaration(ti *types.Info, identifier *ast.Ident) bool { |
Author
There was a problem hiding this comment.
This is necessary to handle Sleep(time.Duration(someExistingIntegerInSecondsConstant)) correctly, but it needs to be rethought to handle a greater variety of cases.
navijation
commented
Mar 19, 2023
|
|
||
| func (s *improperDurationContextStack) Finish() { | ||
| for _, diagnostic := range s.sentinel.deferredImproperDurationDiagnostics { | ||
| s.ReportImproperDurationNode(diagnostic) |
Author
There was a problem hiding this comment.
This should be s.pass.Report(diagnostic). Although sentinel in practice will never have diagnostics.
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.
This PR introduces a new
forbid-improper-conversionsflag which, when enabled, will cause the analyzer to raiseerrors on invocations of
time.Duration()on non-duration integer types unless these invocations are multipliedby "proper" durations like
time.Millisecondsubsequently.This helps capture a class of bugs caused by a lack of awareness that
time.Duration()converts its integer argumentsto nanoseconds. It would be nice to forbid conversions via
time.Duration()entirely, but it is necessarybecause existing integer variables such as "timeout in milliseconds" cannot be multiplied by the time units due to
having a defined and mismatching type compared to
time.Duration.Resolves #1