make AllLocations accept a context #2518
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 previous implementation would leak a goroutine if the caller of AllLocations stopped iterating early. Now, accept a context so that the caller can cancel the AllLocations iterator rather than leak the goroutine. Signed-off-by: Will Murphy <will.murphy@anchore.com>
willmurphyscode
commented
Jan 19, 2024
Signed-off-by: Will Murphy <will.murphy@anchore.com>
willmurphyscode
commented
Jan 19, 2024
spiffcs
reviewed
Jan 19, 2024
| @@ -1398,11 +1400,14 @@ func TestDirectoryResolver_DoNotAddVirtualPathsToTree(t *testing.T) { | |||
| } | |||
|
|
|||
| func TestDirectoryResolver_FilesContents_errorOnDirRequest(t *testing.T) { | |||
| defer goleak.VerifyNone(t) | |||
spiffcs
reviewed
Jan 19, 2024
Select will block until one or other channel action happens on its own; the loop would only ever have run once anyway. Signed-off-by: Will Murphy <will.murphy@anchore.com>
wagoodman
approved these changes
Jan 19, 2024
willmurphyscode
deleted the
fix/prevent-location-resolver-goroutine-leak
branch
GijsCalis
pushed a commit
to GijsCalis/syft
that referenced
this pull request
Feb 19, 2024
The previous implementation would leak a goroutine if the caller of AllLocations stopped iterating early. Now, accept a context so that the caller can cancel the AllLocations iterator rather than leak the goroutine. Signed-off-by: Will Murphy <will.murphy@anchore.com>
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.
The previous implementation would leak a goroutine if the caller of AllLocations stopped iterating early. Now, accept a context so that the caller can cancel the AllLocations iterator rather than leak the goroutine.
Fixes #2487 .