-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
feat: Improve and Optimize ShutdownWithContext Func #3162
base: main
Are you sure you want to change the base?
Changes from 7 commits
137da86
b41d084
e1ad8e9
a683166
a4a5831
424ecbb
98fbdff
796922f
e465b5b
ee866ec
e0a56be
d01a09e
750a7fa
2ea0bb3
b9509fe
c2792e7
18111e5
83ea43d
66dcb42
f3902c5
da193ac
0a92125
b0bc70c
44cbc62
0e99032
a32bddd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -860,45 +860,61 @@ | |||||||||||||||||
t.Parallel() | ||||||||||||||||||
|
||||||||||||||||||
app := New() | ||||||||||||||||||
shutdownHookCalled := false | ||||||||||||||||||
app.Hooks().OnShutdown(func() error { | ||||||||||||||||||
shutdownHookCalled = true | ||||||||||||||||||
return nil | ||||||||||||||||||
}) | ||||||||||||||||||
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. Possible Data Race on The Suggested Fix: Use an Atomic Variable Replace +import "sync/atomic"
- shutdownHookCalled := false
+ var shutdownHookCalled int32
app.Hooks().OnShutdown(func() error {
- shutdownHookCalled = true
+ atomic.StoreInt32(&shutdownHookCalled, 1)
return nil
})
// ...
- assert.True(t, shutdownHookCalled, "Shutdown hook was not called")
+ assert.Equal(t, int32(1), atomic.LoadInt32(&shutdownHookCalled), "Shutdown hook was not called")
|
||||||||||||||||||
|
||||||||||||||||||
app.Get("/", func(ctx Ctx) error { | ||||||||||||||||||
time.Sleep(5 * time.Second) | ||||||||||||||||||
return ctx.SendString("body") | ||||||||||||||||||
}) | ||||||||||||||||||
|
||||||||||||||||||
ln := fasthttputil.NewInmemoryListener() | ||||||||||||||||||
|
||||||||||||||||||
go func() { | ||||||||||||||||||
err := app.Listener(ln) | ||||||||||||||||||
assert.NoError(t, err) | ||||||||||||||||||
}() | ||||||||||||||||||
|
||||||||||||||||||
time.Sleep(1 * time.Second) | ||||||||||||||||||
|
||||||||||||||||||
go func() { | ||||||||||||||||||
conn, err := ln.Dial() | ||||||||||||||||||
assert.NoError(t, err) | ||||||||||||||||||
|
||||||||||||||||||
_, err = conn.Write([]byte("GET / HTTP/1.1\r\nHost: google.com\r\n\r\n")) | ||||||||||||||||||
assert.NoError(t, err) | ||||||||||||||||||
}() | ||||||||||||||||||
serverErr := make(chan error, 1) | ||||||||||||||||||
go func() { | ||||||||||||||||||
serverErr <- app.Listener(ln) | ||||||||||||||||||
}() | ||||||||||||||||||
|
||||||||||||||||||
time.Sleep(100 * time.Millisecond) | ||||||||||||||||||
|
||||||||||||||||||
clientDone := make(chan struct{}) | ||||||||||||||||||
go func() { | ||||||||||||||||||
conn, err := ln.Dial() | ||||||||||||||||||
assert.NoError(t, err) | ||||||||||||||||||
_, err = conn.Write([]byte("GET / HTTP/1.1\r\nHost: example.com\r\n\r\n")) | ||||||||||||||||||
assert.NoError(t, err) | ||||||||||||||||||
close(clientDone) | ||||||||||||||||||
}() | ||||||||||||||||||
|
||||||||||||||||||
<-clientDone | ||||||||||||||||||
time.Sleep(100 * time.Millisecond) | ||||||||||||||||||
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. why do we need a sleep here? i think it's arbitrary since we already wait for clientDone channel 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.
This sleep is to ensure that our server has started processing the request. Although we have confirmed that the client has sent the request through <-clientDone, this means that the request has been sent to the server's listening port, and there is no guarantee that the server's processing coroutine has been sent. Start processing the request, so I think sleep 100 * Millisecond is required here as well. |
||||||||||||||||||
|
||||||||||||||||||
shutdownErr := make(chan error, 1) | ||||||||||||||||||
go func() { | ||||||||||||||||||
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second) | ||||||||||||||||||
defer cancel() | ||||||||||||||||||
shutdownErr <- app.ShutdownWithContext(ctx) | ||||||||||||||||||
}() | ||||||||||||||||||
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. Ensure Proper Context Cancellation The context created with Suggested Improvement Move the ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
+ defer cancel()
shutdownErr <- app.ShutdownWithContext(ctx)
- defer cancel() 📝 Committable suggestion
Suggested change
|
||||||||||||||||||
|
||||||||||||||||||
time.Sleep(1 * time.Second) | ||||||||||||||||||
select { | ||||||||||||||||||
case <-time.After(2 * time.Second): | ||||||||||||||||||
t.Fatal("shutdown did not complete in time") | ||||||||||||||||||
case err := <-shutdownErr: | ||||||||||||||||||
assert.Error(t, err, "Expected shutdown to return an error due to timeout") | ||||||||||||||||||
assert.True(t, errors.Is(err, context.DeadlineExceeded), "Expected DeadlineExceeded error") | ||||||||||||||||||
} | ||||||||||||||||||
|
||||||||||||||||||
shutdownErr := make(chan error) | ||||||||||||||||||
go func() { | ||||||||||||||||||
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second) | ||||||||||||||||||
defer cancel() | ||||||||||||||||||
shutdownErr <- app.ShutdownWithContext(ctx) | ||||||||||||||||||
}() | ||||||||||||||||||
assert.True(t, shutdownHookCalled, "Shutdown hook was not called") | ||||||||||||||||||
|
||||||||||||||||||
select { | ||||||||||||||||||
case <-time.After(5 * time.Second): | ||||||||||||||||||
t.Fatal("idle connections not closed on shutdown") | ||||||||||||||||||
case err := <-shutdownErr: | ||||||||||||||||||
if err == nil || !errors.Is(err, context.DeadlineExceeded) { | ||||||||||||||||||
t.Fatalf("unexpected err %v. Expecting %v", err, context.DeadlineExceeded) | ||||||||||||||||||
} | ||||||||||||||||||
} | ||||||||||||||||||
case err := <-serverErr: | ||||||||||||||||||
assert.NoError(t, err, "Server should have shut down without error") | ||||||||||||||||||
default: | ||||||||||||||||||
// Server is still running, which is expected as the long-running request prevented full shutdown | ||||||||||||||||||
} | ||||||||||||||||||
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. 🛠️ Refactor suggestion Avoid Skipping Server Error Handling Using a Suggested Fix: Remove the This ensures the test waits for select {
case err := <-serverErr:
assert.NoError(t, err, "Server should have shut down without error")
- default:
- // Server is still running, which is expected as the long-running request prevented full shutdown
} 📝 Committable suggestion
Suggested change
|
||||||||||||||||||
} | ||||||||||||||||||
|
||||||||||||||||||
// go test -run Test_App_Mixed_Routes_WithSameLen | ||||||||||||||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -205,7 +205,7 @@ Shutdown gracefully shuts down the server without interrupting any active connec | |
|
||
ShutdownWithTimeout will forcefully close any active connections after the timeout expires. | ||
|
||
ShutdownWithContext shuts down the server including by force if the context's deadline is exceeded. | ||
ShutdownWithContext shuts down the server including by force if the context's deadline is exceeded.Shutdown hooks will still be executed, even if an error occurs during the shutdown process, as they are deferred to ensure cleanup happens regardless of errors. | ||
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. Missing space before "Shutdown 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. Thank you, I have solved this problem |
||
|
||
```go | ||
func (app *App) Shutdown() error | ||
|
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.
It would be nice to update the docs to explain shutdown & hook execution order
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.
done