caddy can shift FrankenPHPModules in memory for some godforsaken reason, can't rely on them staying the same

Author: henderkes

caddy/caddy.go

@@ -4,6 +4,8 @@
 package caddy
 
 import (
+	"crypto/sha256"
+	"encoding/hex"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -12,7 +14,6 @@ import (
 	"strconv"
 	"strings"
 	"time"
-	"unsafe"
 
 	"github.com/dunglas/frankenphp/internal/fastabs"
 
@@ -60,7 +61,7 @@ type workerConfig struct {
 	// Directories to watch for file changes
 	Watch []string `json:"watch,omitempty"`
 	// ModuleID identifies which module created this worker
-	ModuleID uintptr `json:"module_id,omitempty"`
+	ModuleID string `json:"module_id,omitempty"`
 }
 
 type FrankenPHPApp struct {
@@ -356,6 +357,8 @@ type FrankenPHPModule struct {
 	ResolveRootSymlink *bool `json:"resolve_root_symlink,omitempty"`
 	// Env sets an extra environment variable to the given value. Can be specified more than once for multiple environment variables.
 	Env map[string]string `json:"env,omitempty"`
+	// ModuleID is the module ID that created this request.
+	ModuleID string `json:"-"`
 	// Workers configures the worker scripts to start.
 	Workers []workerConfig `json:"workers,omitempty"`
 
@@ -429,9 +432,13 @@ func (f *FrankenPHPModule) Provision(ctx caddy.Context) error {
 		}
 	}
 
+	data := []byte(f.Root + strings.Join(f.SplitPath, ",") + time.Now().String())
+	hash := sha256.Sum256(data)
+	f.ModuleID = hex.EncodeToString(hash[:8])
+
 	if len(f.Workers) > 0 {
-		for i := range f.Workers {
-			f.Workers[i].ModuleID = uintptr(unsafe.Pointer(f))
+		for _, w := range f.Workers {
+			w.ModuleID = f.ModuleID
 		}
 		moduleWorkers = append(moduleWorkers, f.Workers...)
 	}
@@ -471,7 +478,7 @@ func (f *FrankenPHPModule) ServeHTTP(w http.ResponseWriter, r *http.Request, _ c
 		frankenphp.WithRequestSplitPath(f.SplitPath),
 		frankenphp.WithRequestPreparedEnv(env),
 		frankenphp.WithOriginalRequest(&origReq),
-		frankenphp.WithModuleID(uintptr(unsafe.Pointer(f))),
+		frankenphp.WithModuleID(f.ModuleID),
 	)
 
 	if err != nil {

context.go

@@ -33,7 +33,7 @@ type frankenPHPContext struct {
 	startedAt time.Time
 
 	// The module ID that created this request
-	moduleID uintptr
+	moduleID string
 }
 
 // fromContext extracts the frankenPHPContext from a context.

frankenphp.go

@@ -407,10 +407,11 @@ func ServeHTTP(responseWriter http.ResponseWriter, request *http.Request) error
 	// Detect if a worker is available to handle this request
 	if worker, ok := workers[fc.scriptFilename]; ok {
 		// can handle with a global worker, or a module worker from the matching module
-		if worker.moduleID == 0 || worker.moduleID == fc.moduleID {
+		if worker.moduleID == "" || worker.moduleID == fc.moduleID {
 			worker.handleRequest(fc)
 			return nil
 		}
+		fc.logger.Warn(fmt.Sprintf("Module ID mismatch: %s != %s", worker.moduleID, fc.moduleID))
 	}
 
 	// If no worker was available send the request to non-worker threads

options.go

@@ -28,7 +28,7 @@ type workerOpt struct {
 	num      int
 	env      PreparedEnv
 	watch    []string
-	moduleID uintptr
+	moduleID string
 }
 
 // WithNumThreads configures the number of PHP threads to start.
@@ -57,7 +57,7 @@ func WithMetrics(m Metrics) Option {
 }
 
 // WithWorkers configures the PHP workers to start, moduleID is used to identify the worker for a specific domain
-func WithWorkers(name string, fileName string, num int, env map[string]string, watch []string, moduleID uintptr) Option {
+func WithWorkers(name string, fileName string, num int, env map[string]string, watch []string, moduleID string) Option {
 	return func(o *opt) error {
 		o.workers = append(o.workers, workerOpt{name, fileName, num, PrepareEnv(env), watch, moduleID})
 

request_options.go

@@ -125,7 +125,7 @@ func WithRequestLogger(logger *zap.Logger) RequestOption {
 }
 
 // WithModuleID sets the module ID associated with the current request
-func WithModuleID(moduleID uintptr) RequestOption {
+func WithModuleID(moduleID string) RequestOption {
 	return func(o *frankenPHPContext) error {
 		o.moduleID = moduleID
 

worker.go

@@ -20,7 +20,7 @@ type worker struct {
 	requestChan chan *frankenPHPContext
 	threads     []*phpThread
 	threadMutex sync.RWMutex
-	moduleID    uintptr
+	moduleID    string
 }
 
 var (