(BC) closer.New with options that allow implicit CloseAll call +

golangci-lint v2

Author: a-menshchikov

.github/workflows/actions.yml

@@ -11,7 +11,7 @@ permissions:
 
 env:
   GO_VERSION: stable
-  GOLANGCI_LINT_VERSION: v1.64.8
+  GOLANGCI_LINT_VERSION: v2.1.6
 
 jobs:
   detect-modules:
@@ -40,7 +40,7 @@ jobs:
         with:
           go-version: ${{ env.GO_VERSION }}
       - name: golangci-lint ${{ matrix.module }}
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v8
         with:
           version: ${{ env.GOLANGCI_LINT_VERSION }}
           working-directory: ${{ matrix.module }}

closer/.golangci.yml

@@ -5,7 +5,6 @@ package closer
 import (
 	"context"
 	"errors"
-	"os"
 	"os/signal"
 	"sync"
 	"sync/atomic"
@@ -62,29 +61,34 @@ func CloseAll() {
 	global.CloseAll()
 }
 
-// New returns signal notifiable Context and base Closer implementation.
-//
-// If signals specified, then close functions will trigger when any arrives.
-func New(ctx context.Context, signals ...os.Signal) (context.Context, *closer) {
+// New returns Closer implementation.
+func New(ctx context.Context, opts ...Option) (context.Context, *closer) {
+	o := options{}
+	for _, opt := range opts {
+		opt(&o)
+	}
+
+	var cancel context.CancelFunc
+	if len(o.signals) > 0 {
+		ctx, cancel = signal.NotifyContext(ctx, o.signals...)
+	}
+
 	c := &closer{done: make(chan struct{})}
 	if ctx == nil {
 		panic("cannot create closer with nil context")
 	}
 	c.ctx.Store(&ctx)
 
-	var cancel context.CancelFunc
-	if len(signals) > 0 {
-		ctx, cancel = signal.NotifyContext(ctx, signals...)
-	}
-
-	go func() {
-		if cancel != nil {
-			defer cancel()
-		}
+	if o.ctxCancel {
+		go func() {
+			if cancel != nil {
+				defer cancel()
+			}
 
-		<-ctx.Done()
-		c.CloseAll() //nolint:contextcheck
-	}()
+			<-ctx.Done()
+			c.CloseAll() //nolint:contextcheck
+		}()
+	}
 
 	return ctx, c
 }

closer/closer.go

@@ -5,8 +5,10 @@ package closer_test
 import (
 	"context"
 	"errors"
+	"os"
 	"sync"
 	"sync/atomic"
+	"syscall"
 	"testing"
 
 	. "github.com/nbgrp/pkg/closer"
@@ -39,11 +41,11 @@ func TestCloser(t *testing.T) {
 		wg.Wait()
 	})
 
-	t.Run("with cancel", func(t *testing.T) {
+	t.Run("with context cancel", func(t *testing.T) {
 		goleak.VerifyNone(t, goleak.IgnoreCurrent())
 
 		ctx, cancel := context.WithCancel(context.Background())
-		_, c := New(ctx)
+		_, c := New(ctx, WithContextCancel())
 
 		var cnt atomic.Uint32
 		c.Add(func(context.Context) error {
@@ -74,7 +76,36 @@ func TestCloser(t *testing.T) {
 		cancel()
 		wg.Wait()
 
-		c.CloseAll()
+		assert.Equal(t, uint32(2), cnt.Load())
+	})
+
+	t.Run("with signals", func(t *testing.T) {
+		goleak.VerifyNone(t, goleak.IgnoreCurrent())
+
+		ctx := context.Background()
+		_, c := New(ctx, WithSignals(syscall.SIGINT, syscall.SIGTERM))
+
+		var cnt atomic.Uint32
+		c.Add(func(context.Context) error {
+			cnt.Add(1)
+			return nil
+		})
+		c.Add(func(context.Context) error {
+			cnt.Add(1)
+			return nil
+		})
+
+		wg := sync.WaitGroup{}
+		wg.Add(1)
+		go func() {
+			<-c.Done()
+			wg.Done()
+		}()
+
+		err := syscall.Kill(os.Getpid(), syscall.SIGTERM)
+		assert.NoError(t, err)
+
+		wg.Wait()
 
 		assert.Equal(t, uint32(2), cnt.Load())
 	})

closer/closer_test.go

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
+package closer
+
+import (
+	"os"
+)
+
+type options struct {
+	signals   []os.Signal
+	ctxCancel bool
+}
+
+type Option func(*options)
+
+// WithContextCancel allows to call closer CloseAll on context cancel implicitly.
+func WithContextCancel() Option {
+	return func(o *options) {
+		o.ctxCancel = true
+	}
+}
+
+// WithSignals will trigger creation of signal notifiable context.
+// The closer CloseAll will be called implicitly when any of the specified signals arrives.
+func WithSignals(signals ...os.Signal) Option {
+	return func(o *options) {
+		o.ctxCancel = true
+		if o.signals == nil {
+			o.signals = signals
+			return
+		}
+		o.signals = append(o.signals, signals...)
+	}
+}