fix: race condition

Author: pilinux

.github/workflows/go.yml

@@ -93,7 +93,7 @@ jobs:
           TEST_INDEX_HTML_URL: ${{ secrets.TEST_INDEX_HTML_URL }}
           TEST_SENTRY_DSN: ${{ secrets.TEST_SENTRY_DSN }}
           TEST_KEY_FILE_LOCATION: ${{ secrets.TEST_KEY_FILE_LOCATION }}
-        run: go test -v -cover -coverprofile=coverage.txt -covermode=atomic ./...
+        run: go test -race -v -cover -coverprofile=coverage.txt -covermode=atomic ./...
 
       - name: Upload coverage reports to Codecov
         if: github.event_name == 'push' && github.ref == 'refs/heads/main'

database/dbConnect.go

@@ -6,6 +6,7 @@ import (
 	"context"
 	"database/sql"
 	"fmt"
+	"sync"
 	"time"
 
 	"github.com/pilinux/gorest/config"
@@ -50,6 +51,9 @@ var RedisConnTTL int
 // mongoClient holds the MongoDB client connection instance.
 var mongoClient *mongo.Client
 
+// protect CloseAllDB from concurrent calls
+var closeAllOnce sync.Once
+
 // InitDB initializes the database connection.
 func InitDB() *gorm.DB {
 	var db = dbClient
@@ -309,22 +313,24 @@ func GetMongo() *mongo.Client {
 
 // CloseAllDB closes all database connections.
 func CloseAllDB() error {
-	err := CloseSQL()
-	if err != nil {
-		return err
-	}
-
-	err = CloseRedis()
-	if err != nil {
-		return err
-	}
+	var err error
+	closeAllOnce.Do(func() {
+		err = CloseSQL()
+		if err != nil {
+			return
+		}
 
-	err = CloseMongo()
-	if err != nil {
-		return err
-	}
+		err = CloseRedis()
+		if err != nil {
+			return
+		}
 
-	return nil
+		err = CloseMongo()
+		if err != nil {
+			return
+		}
+	})
+	return err
 }
 
 // CloseSQL closes the SQL database connection.

lib/server/shutdown.go

@@ -18,6 +18,7 @@ func GracefulShutdown(srv *http.Server, timeout time.Duration, done chan struct{
 	// create context that listens for the interrupt signal from the OS
 	sigCh := make(chan os.Signal, 1)
 	signal.Notify(sigCh, syscall.SIGINT, syscall.SIGTERM)
+	defer signal.Stop(sigCh)
 
 	sig := <-sigCh
 	log.Printf("signal %v received: starting graceful shutdown with timeout %v\n", sig, timeout)

lib/server/shutdown_test.go

@@ -159,13 +159,13 @@ func TestGracefulShutdown_SuccessWithDBFail(t *testing.T) {
 		return expectedErr
 	}
 
-	// channel to signal shutdown completion
+	// channel to signal shutdown completion and to receive shutdown error
 	done := make(chan struct{})
-	var shutdownErr error
+	errCh := make(chan error, 1)
 
-	// run GracefulShutdown with the failing closeDB function
+	// run GracefulShutdown with the failing closeDB function and send error on channel
 	go func() {
-		shutdownErr = server.GracefulShutdown(srv, 5*time.Second, done, closeDB)
+		errCh <- server.GracefulShutdown(srv, 5*time.Second, done, closeDB)
 	}()
 
 	// send SIGINT after 1 second
@@ -179,7 +179,8 @@ func TestGracefulShutdown_SuccessWithDBFail(t *testing.T) {
 		t.Fatal("shutdown did not complete within 10 seconds")
 	}
 
-	// verify that the closeDB error is returned
+	// receive and verify that the closeDB error is returned
+	shutdownErr := <-errCh
 	if shutdownErr == nil {
 		t.Error("expected an error, got nil")
 	} else if !errors.Is(shutdownErr, expectedErr) {
@@ -225,13 +226,13 @@ func TestGracefulShutdown_TimeoutForceCloseSuccess(t *testing.T) {
 	// wait briefly to ensure the request starts
 	time.Sleep(500 * time.Millisecond)
 
-	// channel to signal shutdown completion
+	// channel to signal shutdown completion and to receive shutdown error
 	done := make(chan struct{})
-	var shutdownErr error
+	errCh := make(chan error, 1)
 
-	// run GracefulShutdown with a 2-second timeout
+	// run GracefulShutdown with a 2-second timeout and send error on channel
 	go func() {
-		shutdownErr = server.GracefulShutdown(srv, 2*time.Second, done)
+		errCh <- server.GracefulShutdown(srv, 2*time.Second, done)
 	}()
 
 	// send SIGINT after 1 second, while the handler is still sleeping
@@ -245,7 +246,8 @@ func TestGracefulShutdown_TimeoutForceCloseSuccess(t *testing.T) {
 		t.Fatal("shutdown did not complete within 10 seconds")
 	}
 
-	// verify that the error is context.DeadlineExceeded
+	// receive and verify that the error is context.DeadlineExceeded
+	shutdownErr := <-errCh
 	if !errors.Is(shutdownErr, context.DeadlineExceeded) {
 		t.Errorf("expected context.DeadlineExceeded, got %v", shutdownErr)
 	}