Merge pull request #40 from ne-sachirou/default-timeout-is-infinity

[BREAKING]GracefulShutdownTimeoutを省略した場合にpanicしていたところ、正常終了を無期限に待つように変えた

Author: ne-sachirou

README.md

@@ -13,7 +13,7 @@ A library implemented in Go to gracefully shutdown the server.
   - Trap os.Signal and exit gracefully.
     - You can specify os.Signal to trap. By default, only os.Interrupt is trapped.
   - Exit processing can be specified.
-    - If the specified timeout period elapses, a forced termination will occur. By default, it terminates immediately.
+    - If the specified timeout period elapses, a forced termination will occur. By default, it waits indefinitely for a normal termination.
 - Multiple servers can be started gracefully.
   - If one of the servers fails to start, all started servers will be terminated gracefully.
 - The HTTP and gRPC servers implement a wrapper function for easy startup.
@@ -277,7 +277,7 @@ Go で実装した server を graceful に shutdown する library です。
   - os.Signal を trap し、graceful に終了します
     - trap する os.Signal を指定できます。標準では os.Interrupt のみを trap します
   - 終了処理を指定できます
-    - 指定した timeout 時間を過ぎると、強制終了します。標準では即座に強制終了します
+    - 指定した timeout 時間を過ぎると、強制終了します。標準では正常終了を永遠に待ちます
 - 複数の server を graceful に起動できます
   - その内の server の 1 つでも起動に失敗したら、起動済みの全ての server を graceful に終了します
 - HTTP と gRPC の server は、簡単に起動できる wrapper 函数を実装してあります

cmd/example-grpc/main.go

@@ -3,12 +3,10 @@ package main
 
 import (
 	"context"
-	"time"
 
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/reflection"
 
-	"github.com/ne-sachirou/go-graceful"
 	"github.com/ne-sachirou/go-graceful/gracefulgrpc"
 )
 
@@ -19,12 +17,7 @@ func main() {
 	srv := grpc.NewServer(opts...)
 	reflection.Register(srv)
 
-	if err := gracefulgrpc.ListenAndServe(
-		ctx,
-		":4317",
-		srv,
-		graceful.GracefulShutdownTimeout(time.Second),
-	); err != nil {
+	if err := gracefulgrpc.ListenAndServe(ctx, ":4317", srv); err != nil {
 		panic(err)
 	}
 }

cmd/example-http/main.go

@@ -5,9 +5,7 @@ import (
 	"context"
 	"fmt"
 	"net/http"
-	"time"
 
-	"github.com/ne-sachirou/go-graceful"
 	"github.com/ne-sachirou/go-graceful/gracefulhttp"
 )
 
@@ -21,12 +19,7 @@ func main() {
 		}
 	})
 
-	if err := gracefulhttp.ListenAndServe(
-		ctx,
-		":8000",
-		mux,
-		graceful.GracefulShutdownTimeout(time.Second),
-	); err != nil {
+	if err := gracefulhttp.ListenAndServe(ctx, ":8000", mux); err != nil {
 		panic(err)
 	}
 }

cmd/example/main.go

@@ -101,7 +101,7 @@ func main() {
 		},
 	}
 
-	if err := srv.Graceful(ctx, graceful.GracefulShutdownTimeout(time.Second)); err != nil {
+	if err := srv.Graceful(ctx); err != nil {
 		panic(err)
 	}
 }

go.sum

@@ -8,16 +8,16 @@ github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-go.opentelemetry.io/otel v1.31.0 h1:NsJcKPIW0D0H3NgzPDHmo0WW6SptzPdqg/L1zsIm2hY=
-go.opentelemetry.io/otel v1.31.0/go.mod h1:O0C14Yl9FgkjqcCZAsE053C13OaddMYr/hz6clDkEJE=
-go.opentelemetry.io/otel/metric v1.31.0 h1:FSErL0ATQAmYHUIzSezZibnyVlft1ybhy4ozRPcF2fE=
-go.opentelemetry.io/otel/metric v1.31.0/go.mod h1:C3dEloVbLuYoX41KpmAhOqNriGbA+qqH6PQ5E5mUfnY=
-go.opentelemetry.io/otel/sdk v1.31.0 h1:xLY3abVHYZ5HSfOg3l2E5LUj2Cwva5Y7yGxnSW9H5Gk=
-go.opentelemetry.io/otel/sdk v1.31.0/go.mod h1:TfRbMdhvxIIr/B2N2LQW2S5v9m3gOQ/08KsbbO5BPT0=
-go.opentelemetry.io/otel/sdk/metric v1.31.0 h1:i9hxxLJF/9kkvfHppyLL55aW7iIJz4JjxTeYusH7zMc=
-go.opentelemetry.io/otel/sdk/metric v1.31.0/go.mod h1:CRInTMVvNhUKgSAMbKyTMxqOBC0zgyxzW55lZzX43Y8=
-go.opentelemetry.io/otel/trace v1.31.0 h1:ffjsj1aRouKewfr85U2aGagJ46+MvodynlQ1HYdmJys=
-go.opentelemetry.io/otel/trace v1.31.0/go.mod h1:TXZkRk7SM2ZQLtR6eoAWQFIHPvzQ06FJAsO1tJg480A=
+go.opentelemetry.io/otel v1.32.0 h1:WnBN+Xjcteh0zdk01SVqV55d/m62NJLJdIyb4y/WO5U=
+go.opentelemetry.io/otel v1.32.0/go.mod h1:00DCVSB0RQcnzlwyTfqtxSm+DRr9hpYrHjNGiBHVQIg=
+go.opentelemetry.io/otel/metric v1.32.0 h1:xV2umtmNcThh2/a/aCP+h64Xx5wsj8qqnkYZktzNa0M=
+go.opentelemetry.io/otel/metric v1.32.0/go.mod h1:jH7CIbbK6SH2V2wE16W05BHCtIDzauciCRLoc/SyMv8=
+go.opentelemetry.io/otel/sdk v1.32.0 h1:RNxepc9vK59A8XsgZQouW8ue8Gkb4jpWtJm9ge5lEG4=
+go.opentelemetry.io/otel/sdk v1.32.0/go.mod h1:LqgegDBjKMmb2GC6/PrTnteJG39I8/vJCAP9LlJXEjU=
+go.opentelemetry.io/otel/sdk/metric v1.32.0 h1:rZvFnvmvawYb0alrYkjraqJq0Z4ZUJAiyYCU9snn1CU=
+go.opentelemetry.io/otel/sdk/metric v1.32.0/go.mod h1:PWeZlq0zt9YkYAp3gjKZ0eicRYvOh1Gd+X99x6GHpCQ=
+go.opentelemetry.io/otel/trace v1.32.0 h1:WIC9mYrXf8TmY/EXuULKc8hR17vE+Hjv2cssQDe03fM=
+go.opentelemetry.io/otel/trace v1.32.0/go.mod h1:+i4rkvCraA+tG6AzwloGaCtkx53Fa+L+V8e9a7YvhT8=
 golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I=
 golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
 golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
@@ -26,10 +26,6 @@ golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
 golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20241223144023-3abc09e42ca8 h1:TqExAhdPaB60Ux47Cn0oLV07rGnxZzIsaRhQaqS666A=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20241223144023-3abc09e42ca8/go.mod h1:lcTa1sDdWEIHMWlITnIczmw5w60CF9ffkb8Z+DVmmjA=
-google.golang.org/grpc v1.69.2 h1:U3S9QEtbXC0bYNvRtcoklF3xGtLViumSYxWykJS+7AU=
-google.golang.org/grpc v1.69.2/go.mod h1:vyjdE6jLBI76dgpDojsFGNaHlxdjXN9ghpnd2o7JGZ4=
-google.golang.org/grpc v1.69.4 h1:MF5TftSMkd8GLw/m0KM6V8CMOCY6NZ1NQDPGFgbTt4A=
-google.golang.org/grpc v1.69.4/go.mod h1:vyjdE6jLBI76dgpDojsFGNaHlxdjXN9ghpnd2o7JGZ4=
 google.golang.org/grpc v1.70.0 h1:pWFv03aZoHzlRKHWicjsZytKAiYCtNS0dHbXnIdq7jQ=
 google.golang.org/grpc v1.70.0/go.mod h1:ofIJqVKDXx/JiXrwr2IG4/zwdH9txy3IlF40RmcJSQw=
 google.golang.org/protobuf v1.36.1 h1:yBPeRvTftaleIgM3PZ/WBIZ7XM/eEYAaEyCwvyjq/gk=

graceful.go

@@ -77,7 +77,14 @@ func (s Servers) Graceful(ctx context.Context, options ...Option) error {
 		return errors.Join(errors.New("failed to start servers"), err) // nolint:govet
 	}
 
-	ctx, cancelT := context.WithTimeout(context.Background(), opts.ShutdownTimeout)
+	var shutdownCtx context.Context
+	var cancelT context.CancelFunc
+	if opts.ShutdownTimeout > 0 {
+		shutdownCtx, cancelT = context.WithTimeout(context.Background(), opts.ShutdownTimeout)
+	} else {
+		shutdownCtx, cancelT = context.WithCancel(context.Background())
+	}
+	ctx = shutdownCtx
 	defer cancelT()
 
 	var wg sync.WaitGroup