better globals handling

Author: dunglas

caddy/app.go

@@ -1,6 +1,7 @@
 package caddy
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"log/slog"
@@ -56,6 +57,7 @@ type FrankenPHPApp struct {
 	MaxWaitTime time.Duration `json:"max_wait_time,omitempty"`
 
 	metrics frankenphp.Metrics
+	ctx     context.Context
 	logger  *slog.Logger
 }
 
@@ -71,6 +73,7 @@ func (f FrankenPHPApp) CaddyModule() caddy.ModuleInfo {
 
 // Provision sets up the module.
 func (f *FrankenPHPApp) Provision(ctx caddy.Context) error {
+	f.ctx = ctx
 	f.logger = ctx.Slogger()
 
 	if httpApp, err := ctx.AppIfConfigured("http"); err == nil {
@@ -128,9 +131,10 @@ func (f *FrankenPHPApp) Start() error {
 	repl := caddy.NewReplacer()
 
 	opts := []frankenphp.Option{
+		frankenphp.WithContext(f.ctx),
+		frankenphp.WithLogger(f.logger),
 		frankenphp.WithNumThreads(f.NumThreads),
 		frankenphp.WithMaxThreads(f.MaxThreads),
-		frankenphp.WithLogger(f.logger),
 		frankenphp.WithMetrics(f.metrics),
 		frankenphp.WithPhpIni(f.PhpIni),
 		frankenphp.WithMaxWaitTime(f.MaxWaitTime),

frankenphp.go

@@ -60,9 +60,9 @@ var (
 	isRunning        bool
 	onServerShutdown []func()
 
-	globalMu sync.RWMutex
-	// Set default values because to make Shutdown() idempotent
-	globalCtx    = context.TODO()
+	// Set default values to make Shutdown() idempotent
+	globalMu     sync.Mutex
+	globalCtx    = context.Background()
 	globalLogger = slog.Default()
 
 	metrics Metrics = nullMetrics{}
@@ -235,18 +235,12 @@ func Init(options ...Option) error {
 
 	globalMu.Lock()
 
-	if opt.ctx == nil {
-		globalCtx = context.Background()
-	} else {
+	if opt.ctx != nil {
 		globalCtx = opt.ctx
 		opt.ctx = nil
 	}
 
-	if opt.logger == nil {
-		// set a default globalLogger
-		// to disable logging, set the globalLogger to slog.New(slog.DiscardHandler)
-		opt.logger = slog.Default()
-	} else {
+	if opt.logger != nil {
 		globalLogger = opt.logger
 		opt.logger = nil
 	}
@@ -352,11 +346,7 @@ func Shutdown() {
 		globalLogger.LogAttrs(globalCtx, slog.LevelDebug, "FrankenPHP shut down")
 	}
 
-	globalMu.Lock()
-	globalCtx = context.TODO()
-	globalLogger = slog.Default()
-	workers = nil
-	globalMu.Unlock()
+	resetGlobals()
 }
 
 // ServeHTTP executes a PHP script according to the given context.
@@ -722,3 +712,11 @@ func timeoutChan(timeout time.Duration) <-chan time.Time {
 
 	return time.After(timeout)
 }
+
+func resetGlobals() {
+	globalMu.Lock()
+	globalCtx = context.Background()
+	globalLogger = slog.Default()
+	workers = nil
+	globalMu.Unlock()
+}

phpmainthread_test.go

@@ -21,18 +21,9 @@ var testDataPath, _ = filepath.Abs("./testdata")
 func setupGlobals(t *testing.T) {
 	t.Helper()
 
-	t.Cleanup(func() {
-		globalMu.Lock()
-		globalCtx = nil
-		globalLogger = nil
-		workers = nil
-		globalMu.Unlock()
-	})
+	t.Cleanup(Shutdown)
 
-	globalMu.Lock()
-	globalCtx = t.Context()
-	globalLogger = slog.Default()
-	globalMu.Unlock()
+	resetGlobals()
 }
 
 func TestStartAndStopTheMainThreadWithOneInactiveThread(t *testing.T) {