Use configured deadlock timeout in error message#2419
Closed
kritibehl wants to merge 1 commit into
Closed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What was changed
This PR updates the workflow deadlock detection error message to report the configured deadlock detection timeout instead of always saying “a second”.
Specifically, the deadlock message now formats the timeout value passed into the coroutine execution path, so non-default
DeadlockDetectionTimeoutvalues are reflected in the emitted error.A regression test was added with a non-default timeout to verify that the error message includes the configured duration.
Why?
The deadlock detector already uses the configured timeout when deciding when to trigger. However, the error message was still hardcoded to say the workflow goroutine did not yield for over “a second”.
This could be misleading when users configure a different deadlock detection timeout.
Checklist
Closes Hardcoded deadlock timeout in error message can be misleading #2418
How was this tested:
go test ./internal -run 'TestDeadlockDetectorAndAwaitRace|TestDeadlockDetectorUsesConfiguredTimeoutInMessage|TestDeadlockDetectorStackTrace' -count=1go test ./internal -run 'TestDeadlockDetectorUsesConfiguredTimeoutInMessage' -count=5go test ./internal -run 'TestDeadlockDetector' -count=1go test ./internal -count=1No docs updates needed. This only updates the internal deadlock error message to reflect the configured timeout.