-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Fix race condition in timeout handler causing activator crashes #16222
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Fedosin
wants to merge
1
commit into
knative:main
Choose a base branch
from
Fedosin:timeout-headers
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,6 +22,7 @@ import ( | |
| "net/http" | ||
| "net/http/httptest" | ||
| "sync" | ||
| "sync/atomic" | ||
| "testing" | ||
| "time" | ||
|
|
||
|
|
@@ -626,6 +627,99 @@ func BenchmarkTimeoutHandler(b *testing.B) { | |
| }) | ||
| } | ||
|
|
||
| func TestTimeoutHandlerConcurrentHeaderAccess(t *testing.T) { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we sure that this test would actually catch verify the problem? |
||
| // This test verifies the fix for the race condition when requests time out. | ||
| // It simulates the scenario where the timeout handler completes while the | ||
| // inner handler is still trying to modify headers. The key is that this | ||
| // should not panic with a concurrent map access error. | ||
|
|
||
| var completedCount atomic.Int32 | ||
| var panicCount int32 | ||
| innerHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| // Simulate work that takes around the same time as timeout | ||
| time.Sleep(55 * time.Millisecond) | ||
|
|
||
| // After potential context cancellation, try to access headers | ||
| // This simulates what the error handler does | ||
| if r.Context().Err() != nil { | ||
| // Try to modify headers - this should not cause a panic | ||
| // even if timeout has occurred | ||
| w.Header().Set("X-Test-Header", "value") | ||
| http.Error(w, "context canceled", http.StatusBadGateway) | ||
| } else { | ||
| // If no timeout, write normally | ||
| w.WriteHeader(http.StatusOK) | ||
| } | ||
| completedCount.Add(1) | ||
| }) | ||
|
|
||
| timeoutHandler := NewTimeoutHandler( | ||
| innerHandler, | ||
| "timeout", | ||
| func(r *http.Request) (time.Duration, time.Duration, time.Duration) { | ||
| return 50 * time.Millisecond, 0, 0 | ||
| }, | ||
| zaptest.NewLogger(t).Sugar(), | ||
| ) | ||
|
|
||
| // Run multiple concurrent requests to increase chances of hitting the race | ||
| var wg sync.WaitGroup | ||
| var timeoutResponses atomic.Int32 | ||
| var normalResponses atomic.Int32 | ||
| for range 10 { | ||
| wg.Add(1) | ||
| go func() { | ||
| defer wg.Done() | ||
| defer func() { | ||
| if r := recover(); r != nil { | ||
| // Should not panic with concurrent map access | ||
| atomic.AddInt32(&panicCount, 1) | ||
| t.Errorf("Unexpected panic: %v", r) | ||
| } | ||
| }() | ||
|
|
||
| req, err := http.NewRequest(http.MethodGet, "/", nil) | ||
| if err != nil { | ||
| t.Error(err) | ||
| return | ||
| } | ||
|
|
||
| rec := httptest.NewRecorder() | ||
|
|
||
| // This should not panic with concurrent map access | ||
| timeoutHandler.ServeHTTP(rec, req) | ||
|
|
||
| // We may get either a timeout or a normal response depending on timing | ||
| // The key is that we don't panic | ||
| switch rec.Code { | ||
| case http.StatusGatewayTimeout: | ||
| timeoutResponses.Add(1) | ||
| case http.StatusOK: | ||
| normalResponses.Add(1) | ||
| default: | ||
| t.Errorf("Unexpected status code: %d", rec.Code) | ||
| } | ||
| }() | ||
| } | ||
|
|
||
| wg.Wait() | ||
|
|
||
| // Give a bit more time for any lingering goroutines to complete | ||
| time.Sleep(100 * time.Millisecond) | ||
|
|
||
| // Check that no panics occurred | ||
| if panicCount > 0 { | ||
| t.Errorf("Got %d panics, expected 0", panicCount) | ||
| } | ||
|
|
||
| // At least some requests should have timed out | ||
| if timeoutResponses.Load() == 0 { | ||
| t.Error("Expected at least some timeout responses") | ||
| } | ||
|
|
||
| t.Logf("Got %d timeout responses and %d normal responses", timeoutResponses.Load(), normalResponses.Load()) | ||
| } | ||
|
|
||
| func StaticTimeoutFunc(timeout time.Duration, requestStart time.Duration, idle time.Duration) TimeoutFunc { | ||
| return func(req *http.Request) (time.Duration, time.Duration, time.Duration) { | ||
| return timeout, requestStart, idle | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not 100% sure if I understood the timeoutHandler/Writer stuff correctly but wouldn't we still see a concurrent access to the map here?