Docker scan errors should be surfaced to the user beyond just logs #2827
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
ahrav
reviewed
May 12, 2024
| @@ -132,6 +132,7 @@ func (s *Source) Chunks(ctx context.Context, chunksChan chan *sources.Chunk, _ . | |||
| _ = workers.Wait() | |||
| if scanErrs.Count() > 0 { | |||
| ctx.Logger().V(2).Info("scan errors", "errors", scanErrs.String()) | |||
| return errors.New(scanErrs.String()) | |||
There was a problem hiding this comment.
Question: Are we certain this approach is what we want? Adopting this logic means any single error during the scan will lead to its failure. We've encountered this issue with other sources and found it detrimental to the user experience. However, the situation with the Docker source might be different, and perhaps we are willing to accept that trade-off
There was a problem hiding this comment.
As an alternative, implementing SourceUnitEnumChunker would provide a way to differentiate between fatal and non-fatal errors. It would be a little more work than adding this single line, but it doesn't look like it would be too much more, and it's work we want to do anyway.
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:
Currently if a Docker image scan fails due to invalid auth in TruffleHog Enterprise, the source integration is still showing as healthy because the error is not surfaced. This PR returns the errors.
Checklist:
make test-community)?make lintthis requires golangci-lint)?