fix: use build flags for startup log version (#2551)

Author: ousamabenyounes

Dockerfile

@@ -121,7 +121,7 @@ ENV CGO_LDFLAGS="-L/usr/local/lib -lssl -lcrypto -lreadline -largon2 -lcurl -lon
 
 WORKDIR /go/src/app/caddy/frankenphp
 RUN GOBIN=/usr/local/bin \
-	../../go.sh install -ldflags "-w -s -X 'github.com/caddyserver/caddy/v2.CustomVersion=FrankenPHP $FRANKENPHP_VERSION PHP $PHP_VERSION Caddy' -X 'github.com/caddyserver/caddy/v2.CustomBinaryName=frankenphp' -X 'github.com/caddyserver/caddy/v2/modules/caddyhttp.ServerHeader=FrankenPHP Caddy'" -buildvcs=true && \
+	../../go.sh install -ldflags "-w -s -X 'github.com/dunglas/frankenphp.frankenPHPVersion=$FRANKENPHP_VERSION' -X 'github.com/caddyserver/caddy/v2.CustomVersion=FrankenPHP $FRANKENPHP_VERSION PHP $PHP_VERSION Caddy' -X 'github.com/caddyserver/caddy/v2.CustomBinaryName=frankenphp' -X 'github.com/caddyserver/caddy/v2/modules/caddyhttp.ServerHeader=FrankenPHP Caddy'" -buildvcs=true && \
 	setcap cap_net_bind_service=+ep /usr/local/bin/frankenphp && \
 	cp Caddyfile /etc/frankenphp/Caddyfile && \
 	frankenphp version && \

alpine.Dockerfile

@@ -126,7 +126,7 @@ ENV CGO_LDFLAGS="-lssl -lcrypto -lreadline -largon2 -lcurl -lonig -lz $PHP_LDFLA
 
 WORKDIR /go/src/app/caddy/frankenphp
 RUN GOBIN=/usr/local/bin \
-		../../go.sh install -ldflags "-w -s -extldflags '-Wl,-z,stack-size=0x80000' -X 'github.com/caddyserver/caddy/v2.CustomVersion=FrankenPHP $FRANKENPHP_VERSION PHP $PHP_VERSION Caddy' -X 'github.com/caddyserver/caddy/v2.CustomBinaryName=frankenphp' -X 'github.com/caddyserver/caddy/v2/modules/caddyhttp.ServerHeader=FrankenPHP Caddy'" -buildvcs=true && \
+		../../go.sh install -ldflags "-w -s -extldflags '-Wl,-z,stack-size=0x80000' -X 'github.com/dunglas/frankenphp.frankenPHPVersion=$FRANKENPHP_VERSION' -X 'github.com/caddyserver/caddy/v2.CustomVersion=FrankenPHP $FRANKENPHP_VERSION PHP $PHP_VERSION Caddy' -X 'github.com/caddyserver/caddy/v2.CustomBinaryName=frankenphp' -X 'github.com/caddyserver/caddy/v2/modules/caddyhttp.ServerHeader=FrankenPHP Caddy'" -buildvcs=true && \
 	setcap cap_net_bind_service=+ep /usr/local/bin/frankenphp && \
 	([ -n "${COMPRESS}" ] && upx --best /usr/local/bin/frankenphp || true) && \
 	frankenphp version && \

caddy/app.go

@@ -25,7 +25,7 @@ var (
 	optionsMU sync.RWMutex
 )
 
-const appBaseOptionCapacity = 8
+const appBaseOptionCapacity = 7
 
 // EXPERIMENTAL: RegisterWorkers provides a way for extensions to register frankenphp.Workers
 func RegisterWorkers(name, fileName string, num int, wo ...frankenphp.WorkerOption) frankenphp.Workers {
@@ -180,7 +180,6 @@ func (f *FrankenPHPApp) Start() error {
 	f.opts = append(f.opts,
 		frankenphp.WithContext(f.ctx),
 		frankenphp.WithLogger(f.logger),
-		frankenphp.WithFrankenPHPVersion(frankenPHPVersionFromCaddyCustomVersion(caddy.CustomVersion)),
 		frankenphp.WithNumThreads(f.NumThreads),
 		frankenphp.WithMaxThreads(f.MaxThreads),
 		frankenphp.WithMetrics(f.metrics),

caddy/version.go

@@ -342,7 +342,7 @@ func Init(options ...Option) error {
 	initAutoScaling(mainThread)
 
 	if globalLogger.Enabled(globalCtx, slog.LevelInfo) {
-		globalLogger.LogAttrs(globalCtx, slog.LevelInfo, startupLogMessage, startupLogAttrs(opt.frankenPHPVersion, Version().Version, mainThread.numThreads, mainThread.maxThreads, maxRequestsPerThread)...)
+		globalLogger.LogAttrs(globalCtx, slog.LevelInfo, startupLogMessage, startupLogAttrs(Version().Version, mainThread.numThreads, mainThread.maxThreads, maxRequestsPerThread)...)
 
 		if EmbeddedAppPath != "" {
 			globalLogger.LogAttrs(globalCtx, slog.LevelInfo, "embedded PHP app 📦", slog.String("path", EmbeddedAppPath))

caddy/version_test.go

@@ -22,17 +22,16 @@ type WorkerOption func(*workerOpt) error
 type opt struct {
 	hotReloadOpt
 
-	ctx               context.Context
-	numThreads        int
-	maxThreads        int
-	workers           []workerOpt
-	logger            *slog.Logger
-	frankenPHPVersion string
-	metrics           Metrics
-	phpIni            map[string]string
-	maxWaitTime       time.Duration
-	maxIdleTime       time.Duration
-	maxRequests       int
+	ctx         context.Context
+	numThreads  int
+	maxThreads  int
+	workers     []workerOpt
+	logger      *slog.Logger
+	metrics     Metrics
+	phpIni      map[string]string
+	maxWaitTime time.Duration
+	maxIdleTime time.Duration
+	maxRequests int
 }
 
 type workerOpt struct {
@@ -142,15 +141,6 @@ func WithLogger(l *slog.Logger) Option {
 	}
 }
 
-// WithFrankenPHPVersion configures the FrankenPHP version exposed in startup logs.
-func WithFrankenPHPVersion(version string) Option {
-	return func(o *opt) error {
-		o.frankenPHPVersion = version
-
-		return nil
-	}
-}
-
 // WithPhpIni configures user defined PHP ini settings.
 func WithPhpIni(overrides map[string]string) Option {
 	return func(o *opt) error {

frankenphp.go

@@ -12,7 +12,9 @@ const (
 	startupLogAttrCapacity    = 5
 )
 
-func startupLogAttrs(frankenPHPVersion string, phpVersion string, numThreads int, maxThreads int, maxRequests int) []slog.Attr {
+var frankenPHPVersion string
+
+func startupLogAttrs(phpVersion string, numThreads int, maxThreads int, maxRequests int) []slog.Attr {
 	attrs := make([]slog.Attr, 0, startupLogAttrCapacity)
 	if frankenPHPVersion != "" {
 		attrs = append(attrs, slog.String(startupLogAttrVersion, frankenPHPVersion))

options.go

@@ -1,8 +1,13 @@
 package frankenphp
 
-import "testing"
+import (
+	"os"
+	"testing"
+)
 
-func TestStartupLogAttrsIncludeConfiguredFrankenPHPVersion(t *testing.T) {
+const startupLogTestExpectedBuildFlagVersionEnv = "FRANKENPHP_EXPECT_LDFLAG_VERSION"
+
+func TestStartupLogAttrsIncludeBuildFlagFrankenPHPVersion(t *testing.T) {
 	const (
 		expectedFrankenPHPVersion = "1.12.4-test"
 		testPHPVersion            = "8.2.31"
@@ -11,7 +16,19 @@ func TestStartupLogAttrsIncludeConfiguredFrankenPHPVersion(t *testing.T) {
 		testMaxRequests           = 0
 	)
 
-	attrs := startupLogAttrs(expectedFrankenPHPVersion, testPHPVersion, testNumThreads, testMaxThreads, testMaxRequests)
+	if expectedBuildFlagVersion := os.Getenv(startupLogTestExpectedBuildFlagVersionEnv); expectedBuildFlagVersion != "" {
+		if frankenPHPVersion != expectedBuildFlagVersion {
+			t.Fatalf("expected FrankenPHP version %q from build flags, got %q", expectedBuildFlagVersion, frankenPHPVersion)
+		}
+	} else {
+		previousFrankenPHPVersion := frankenPHPVersion
+		frankenPHPVersion = expectedFrankenPHPVersion
+		defer func() {
+			frankenPHPVersion = previousFrankenPHPVersion
+		}()
+	}
+
+	attrs := startupLogAttrs(testPHPVersion, testNumThreads, testMaxThreads, testMaxRequests)
 	if len(attrs) == 0 {
 		t.Fatal("expected startup log attrs")
 	}