chore: import upstream snapshot with attribution
govulncheck / govulncheck (push) Has been cancelled
Lint / golangci-lint (push) Has been cancelled
Run Tests / Unit Tests (push) Has been cancelled
Run Tests / Etcd Integration Tests (push) Has been cancelled
Harness (E2E) / Harnesses (mock LLM) (push) Has been cancelled
Harness (E2E) / Provider harnesses (live LLM conformance) (push) Has been cancelled
govulncheck / govulncheck (push) Has been cancelled
Lint / golangci-lint (push) Has been cancelled
Run Tests / Unit Tests (push) Has been cancelled
Run Tests / Etcd Integration Tests (push) Has been cancelled
Harness (E2E) / Harnesses (mock LLM) (push) Has been cancelled
Harness (E2E) / Provider harnesses (live LLM conformance) (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,38 @@
|
||||
# Graceful Stop Demo
|
||||
|
||||
This example demonstrates the intended shutdown behavior after the gRPC graceful-stop patch.
|
||||
|
||||
## Run
|
||||
|
||||
```bash
|
||||
go run ./examples/graceful-stop
|
||||
```
|
||||
|
||||
## Expected behavior
|
||||
|
||||
- one long-running RPC starts
|
||||
- shutdown begins while that RPC is still running
|
||||
- new RPCs stop being accepted shortly after shutdown starts
|
||||
- the in-flight RPC is allowed to finish
|
||||
|
||||
Typical output:
|
||||
|
||||
```text
|
||||
long RPC is running; starting shutdown
|
||||
new RPC rejected after shutdown began: ...
|
||||
long RPC completed: slept for 1500ms
|
||||
done
|
||||
```
|
||||
|
||||
There may be a small race window where the first post-stop RPC is still accepted once before subsequent new RPCs are rejected. The important part is that in-flight RPCs are drained while new RPCs are cut off.
|
||||
|
||||
## Automated check
|
||||
|
||||
```bash
|
||||
go test ./server/grpc -run TestGracefulStopRejectsNewRPCsButAllowsInFlightRPCs -v
|
||||
```
|
||||
|
||||
## Environment
|
||||
|
||||
- no special environment variables are required
|
||||
- the demo may print a TLS warning from `go-micro`; it is unrelated to this change
|
||||
@@ -0,0 +1,129 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
"net"
|
||||
"time"
|
||||
|
||||
micro "go-micro.dev/v6"
|
||||
"go-micro.dev/v6/client"
|
||||
grpcclient "go-micro.dev/v6/client/grpc"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/server"
|
||||
grpcserver "go-micro.dev/v6/server/grpc"
|
||||
)
|
||||
|
||||
type SleepRequest struct {
|
||||
DelayMS int `json:"delay_ms"`
|
||||
}
|
||||
|
||||
type SleepResponse struct {
|
||||
Message string `json:"message"`
|
||||
}
|
||||
|
||||
type Sleeper struct {
|
||||
started chan struct{}
|
||||
}
|
||||
|
||||
func (s *Sleeper) Sleep(ctx context.Context, req *SleepRequest, rsp *SleepResponse) error {
|
||||
select {
|
||||
case s.started <- struct{}{}:
|
||||
default:
|
||||
}
|
||||
|
||||
timer := time.NewTimer(time.Duration(req.DelayMS) * time.Millisecond)
|
||||
defer timer.Stop()
|
||||
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return ctx.Err()
|
||||
case <-timer.C:
|
||||
}
|
||||
|
||||
rsp.Message = fmt.Sprintf("slept for %dms", req.DelayMS)
|
||||
return nil
|
||||
}
|
||||
|
||||
func main() {
|
||||
listener, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
defer listener.Close()
|
||||
|
||||
addr := listener.Addr().String()
|
||||
reg := registry.NewMemoryRegistry()
|
||||
handler := &Sleeper{started: make(chan struct{}, 1)}
|
||||
|
||||
service := micro.NewService("grace-demo",
|
||||
micro.HandleSignal(false),
|
||||
micro.Registry(reg),
|
||||
micro.Server(grpcserver.NewServer(
|
||||
server.Registry(reg),
|
||||
server.Name("grace-demo"),
|
||||
server.Address(addr),
|
||||
grpcserver.Listener(listener),
|
||||
grpcserver.GracefulStopTimeout(3*time.Second),
|
||||
)),
|
||||
micro.Client(grpcclient.NewClient(
|
||||
client.Registry(reg),
|
||||
client.ContentType("application/grpc+json"),
|
||||
client.DialTimeout(200*time.Millisecond),
|
||||
client.RequestTimeout(5*time.Second),
|
||||
)),
|
||||
)
|
||||
|
||||
if err := service.Handle(handler); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if err := service.Start(); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
log.Printf("service started on %s", addr)
|
||||
|
||||
longDone := make(chan error, 1)
|
||||
go func() {
|
||||
req := service.Client().NewRequest("grace-demo", "Sleeper.Sleep", &SleepRequest{DelayMS: 1500})
|
||||
rsp := &SleepResponse{}
|
||||
longDone <- service.Client().Call(context.Background(), req, rsp, client.WithAddress(addr))
|
||||
if rsp.Message != "" {
|
||||
log.Printf("long RPC completed: %s", rsp.Message)
|
||||
}
|
||||
}()
|
||||
|
||||
<-handler.started
|
||||
log.Printf("long RPC is running; starting shutdown")
|
||||
|
||||
stopDone := make(chan error, 1)
|
||||
go func() {
|
||||
stopDone <- service.Stop()
|
||||
}()
|
||||
|
||||
deadline := time.Now().Add(500 * time.Millisecond)
|
||||
for time.Now().Before(deadline) {
|
||||
callCtx, cancel := context.WithTimeout(context.Background(), 150*time.Millisecond)
|
||||
req := service.Client().NewRequest("grace-demo", "Sleeper.Sleep", &SleepRequest{DelayMS: 50})
|
||||
rsp := &SleepResponse{}
|
||||
err = service.Client().Call(callCtx, req, rsp, client.WithAddress(addr))
|
||||
cancel()
|
||||
if err != nil {
|
||||
log.Printf("new RPC rejected after shutdown began: %v", err)
|
||||
break
|
||||
}
|
||||
|
||||
log.Printf("new RPC still accepted during shutdown: %s", rsp.Message)
|
||||
time.Sleep(10 * time.Millisecond)
|
||||
}
|
||||
|
||||
if err := <-longDone; err != nil {
|
||||
log.Fatalf("long RPC failed: %v", err)
|
||||
}
|
||||
if err := <-stopDone; err != nil {
|
||||
log.Fatalf("service stop failed: %v", err)
|
||||
}
|
||||
|
||||
log.Printf("done")
|
||||
}
|
||||
Reference in New Issue
Block a user