fix: add timeouts to test telemetry snapshot #17879
Merged
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
coderd/telemetry/telemetry_test.go
Outdated
Comment on lines
453
to
457
| select { | ||
| case <-ctx.Done(): | ||
| t.Fatal("timed out sending deployment") | ||
| case deployment <- dd: | ||
| } |
There was a problem hiding this comment.
Have a look at testutil.RequireReceive; that provides a nice abstraction over this pattern.
There was a problem hiding this comment.
The testutil.Require* functions were not safe to use from helper goroutines, so I ended up creating 3 new helper functions.
39cbc5b to
cc56091
Compare
dannykopping
approved these changes
May 22, 2025
| // The second return value indicates whether the receive was successful. | ||
| // | ||
| // Safety: can be called from any goroutine. | ||
| func AssertReceive[A any](ctx context.Context, t testing.TB, c <-chan A) (A, bool) { |
There was a problem hiding this comment.
Nit: could we abstract the logic and either use t.Fatal or t.Error in either case? That seems to be the only delta between the implementations.
There was a problem hiding this comment.
There's also the extra return value. I suppose we could create internal helper functions which would be called with a bool param by the Require/Assert variants. Not sure if it's worth it here - what do you think?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 ensures that waits on channels will time out according to the test context, rather than waiting indefinitely. This should alleviate the panic seen in coder/internal#645 and, if the deadlock recurs, allow the test to be retried automatically in CI.