fix: simplify startup log version lookup

Use Go build info instead of the FRANKENPHP_VERSION cgo macro for startup log version detection, and fold the log helper back into frankenphp.go.

RED->GREEN: build-info tests failed before the helper existed, then passed after the review cleanup. Local run-ci baseline/final tests pass before diff-coverage on committed HEAD.

Author: ousamabenyounes

frankenphp.go

@@ -18,13 +18,11 @@ package frankenphp
 // #include <php_variables.h>
 // #include <zend_llist.h>
 // #include <SAPI.h>
-// static inline const char *frankenphp_get_build_version() {
-//   return TOSTRING(FRANKENPHP_VERSION);
-// }
 import "C"
 import (
 	"bytes"
 	"context"
+	"debug/buildinfo"
 	"errors"
 	"fmt"
 	"io"
@@ -33,6 +31,7 @@ import (
 	"os"
 	"os/signal"
 	"runtime"
+	runtimeDebug "runtime/debug"
 	"strings"
 	"sync"
 	"sync/atomic"
@@ -73,6 +72,10 @@ var (
 	// atomic: read by in-flight requests while a reload may rewrite it
 	maxWaitTime          atomic.Int64
 	maxRequestsPerThread int
+
+	frankenPHPVersion = sync.OnceValues(func() (string, error) {
+		return frankenPHPVersionFromExecutable(os.Executable, buildinfo.ReadFile)
+	})
 )
 
 type ErrRejected struct {
@@ -97,6 +100,24 @@ const (
 	syslogLevelDebug                     // debug-level messages
 )
 
+const (
+	frankenPHPModulePath = "github.com/dunglas/frankenphp"
+	unknownModuleVersion = "(devel)"
+
+	startupLogMessage                   = "FrankenPHP started 🐘"
+	startupLogVersionUnavailableMessage = "FrankenPHP version unavailable"
+	startupLogAttrVersion               = "version"
+	startupLogAttrPHPVersion            = "php_version"
+	startupLogAttrNumThreads            = "num_threads"
+	startupLogAttrMaxThreads            = "max_threads"
+	startupLogAttrMaxRequests           = "max_requests"
+	startupLogAttrError                 = "error"
+	startupLogAttrCapacity              = 5
+
+	executablePathErrorMessage = "getting executable path: %w"
+	buildInfoReadErrorMessage  = "reading build info: %w"
+)
+
 func (l syslogLevel) String() string {
 	switch l {
 	case syslogLevelEmerg:
@@ -148,8 +169,46 @@ func Version() PHPVersion {
 	}
 }
 
-func frankenPHPVersion() string {
-	return C.GoString(C.frankenphp_get_build_version())
+func frankenPHPVersionFromExecutable(executablePathFunc func() (string, error), readBuildInfoFunc func(string) (*runtimeDebug.BuildInfo, error)) (string, error) {
+	executablePath, err := executablePathFunc()
+	if err != nil {
+		return "", fmt.Errorf(executablePathErrorMessage, err)
+	}
+
+	info, err := readBuildInfoFunc(executablePath)
+	if err != nil {
+		return "", fmt.Errorf(buildInfoReadErrorMessage, err)
+	}
+
+	return frankenPHPVersionFromBuildInfo(info), nil
+}
+
+func frankenPHPVersionFromBuildInfo(info *runtimeDebug.BuildInfo) string {
+	if info == nil {
+		return ""
+	}
+	if info.Main.Path == frankenPHPModulePath && moduleVersionIsKnown(info.Main.Version) {
+		return info.Main.Version
+	}
+	for _, dep := range info.Deps {
+		if dep.Path == frankenPHPModulePath && moduleVersionIsKnown(dep.Version) {
+			return dep.Version
+		}
+	}
+	return ""
+}
+
+func moduleVersionIsKnown(version string) bool {
+	return version != "" && version != unknownModuleVersion
+}
+
+func startupLogAttrs(frankenPHPVersion string, 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))
+	}
+
+	return append(attrs, slog.String(startupLogAttrPHPVersion, phpVersion), slog.Int(startupLogAttrNumThreads, numThreads), slog.Int(startupLogAttrMaxThreads, maxThreads), slog.Int(startupLogAttrMaxRequests, maxRequests))
 }
 
 func Config() PHPConfig {
@@ -349,7 +408,13 @@ func Init(options ...Option) error {
 	initAutoScaling(mainThread)
 
 	if globalLogger.Enabled(globalCtx, slog.LevelInfo) {
-		globalLogger.LogAttrs(globalCtx, slog.LevelInfo, startupLogMessage, startupLogAttrs(Version().Version, mainThread.numThreads, mainThread.maxThreads, maxRequestsPerThread)...)
+		frankenPHPBuildVersion := ""
+		if version, err := frankenPHPVersion(); err != nil {
+			globalLogger.LogAttrs(globalCtx, slog.LevelDebug, startupLogVersionUnavailableMessage, slog.Any(startupLogAttrError, err))
+		} else {
+			frankenPHPBuildVersion = version
+		}
+		globalLogger.LogAttrs(globalCtx, slog.LevelInfo, startupLogMessage, startupLogAttrs(frankenPHPBuildVersion, Version().Version, mainThread.numThreads, mainThread.maxThreads, maxRequestsPerThread)...)
 
 		if EmbeddedAppPath != "" {
 			globalLogger.LogAttrs(globalCtx, slog.LevelInfo, "embedded PHP app 📦", slog.String("path", EmbeddedAppPath))

startup_log.go

@@ -1,33 +1,114 @@
 package frankenphp
 
 import (
-	"os"
+	"errors"
+	"runtime/debug"
 	"testing"
 )
 
-const startupLogTestExpectedVersionEnv = "FRANKENPHP_EXPECT_VERSION"
+const (
+	startupLogTestDependencyVersion = "v1.12.6"
+	startupLogTestMainVersion       = "v1.12.7"
+	startupLogTestExecutablePath    = "/tmp/frankenphp-test"
+	startupLogTestPHPVersion        = "8.2.31"
+	startupLogTestNumThreads        = 4
+	startupLogTestMaxThreads        = 8
+	startupLogTestMaxRequests       = 0
+	startupLogTestExecutableError   = "executable error"
+	startupLogTestBuildInfoError    = "build info error"
+)
 
-func TestStartupLogAttrsIncludeFrankenPHPVersion(t *testing.T) {
-	const (
-		testPHPVersion  = "8.2.31"
-		testNumThreads  = 4
-		testMaxThreads  = 8
-		testMaxRequests = 0
+func TestFrankenPHPVersionFromBuildInfoDependency(t *testing.T) {
+	info := &debug.BuildInfo{
+		Deps: []*debug.Module{
+			{
+				Path:    frankenPHPModulePath,
+				Version: startupLogTestDependencyVersion,
+			},
+		},
+	}
+
+	if got := frankenPHPVersionFromBuildInfo(info); got != startupLogTestDependencyVersion {
+		t.Fatalf("expected FrankenPHP dependency version %q, got %q", startupLogTestDependencyVersion, got)
+	}
+}
+
+func TestFrankenPHPVersionFromBuildInfoMainModule(t *testing.T) {
+	info := &debug.BuildInfo{
+		Main: debug.Module{
+			Path:    frankenPHPModulePath,
+			Version: startupLogTestMainVersion,
+		},
+	}
+
+	if got := frankenPHPVersionFromBuildInfo(info); got != startupLogTestMainVersion {
+		t.Fatalf("expected FrankenPHP main module version %q, got %q", startupLogTestMainVersion, got)
+	}
+}
+
+func TestFrankenPHPVersionFromExecutable(t *testing.T) {
+	version, err := frankenPHPVersionFromExecutable(
+		func() (string, error) {
+			return startupLogTestExecutablePath, nil
+		},
+		func(path string) (*debug.BuildInfo, error) {
+			if path != startupLogTestExecutablePath {
+				t.Fatalf("expected executable path %q, got %q", startupLogTestExecutablePath, path)
+			}
+			return &debug.BuildInfo{
+				Deps: []*debug.Module{
+					{
+						Path:    frankenPHPModulePath,
+						Version: startupLogTestDependencyVersion,
+					},
+				},
+			}, nil
+		},
+	)
+	if err != nil {
+		t.Fatalf("expected no error, got %v", err)
+	}
+	if version != startupLogTestDependencyVersion {
+		t.Fatalf("expected FrankenPHP version %q, got %q", startupLogTestDependencyVersion, version)
+	}
+}
+
+func TestFrankenPHPVersionFromExecutableErrors(t *testing.T) {
+	_, err := frankenPHPVersionFromExecutable(
+		func() (string, error) {
+			return "", errors.New(startupLogTestExecutableError)
+		},
+		func(string) (*debug.BuildInfo, error) {
+			t.Fatal("expected build info reader not to be called")
+			return nil, nil
+		},
 	)
+	if err == nil {
+		t.Fatal("expected executable path error")
+	}
 
-	expectedFrankenPHPVersion := os.Getenv(startupLogTestExpectedVersionEnv)
-	if expectedFrankenPHPVersion == "" {
-		expectedFrankenPHPVersion = frankenPHPVersion()
+	_, err = frankenPHPVersionFromExecutable(
+		func() (string, error) {
+			return startupLogTestExecutablePath, nil
+		},
+		func(string) (*debug.BuildInfo, error) {
+			return nil, errors.New(startupLogTestBuildInfoError)
+		},
+	)
+	if err == nil {
+		t.Fatal("expected build info read error")
 	}
+}
 
-	attrs := startupLogAttrs(testPHPVersion, testNumThreads, testMaxThreads, testMaxRequests)
+func TestStartupLogAttrsIncludeFrankenPHPVersion(t *testing.T) {
+	attrs := startupLogAttrs(startupLogTestDependencyVersion, startupLogTestPHPVersion, startupLogTestNumThreads, startupLogTestMaxThreads, startupLogTestMaxRequests)
 	if len(attrs) == 0 {
 		t.Fatal("expected startup log attrs")
 	}
 	if attrs[0].Key != startupLogAttrVersion {
 		t.Fatalf("expected first startup log attr key %q, got %q", startupLogAttrVersion, attrs[0].Key)
 	}
-	if got := attrs[0].Value.String(); got != expectedFrankenPHPVersion {
-		t.Fatalf("expected startup log version %q, got %q", expectedFrankenPHPVersion, got)
+	if got := attrs[0].Value.String(); got != startupLogTestDependencyVersion {
+		t.Fatalf("expected startup log version %q, got %q", startupLogTestDependencyVersion, got)
 	}
 }