refactor moduleID to uint64 for faster comparisons

Author: henderkes

caddy/caddy.go

@@ -5,7 +5,7 @@ package caddy
 
 import (
 	"crypto/sha256"
-	"encoding/hex"
+	"encoding/binary"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -32,8 +32,11 @@ const defaultDocumentRoot = "public"
 
 var iniError = errors.New("'php_ini' must be in the format: php_ini \"<key>\" \"<value>\"")
 
-// moduleWorkers is a package-level variable to store workers that can be accessed by both FrankenPHPModule and FrankenPHPApp
-var moduleWorkers []workerConfig
+// sharedState is a package-level variable to store information that can be accessed by both FrankenPHPModule and FrankenPHPApp
+var sharedState struct {
+	ModuleIDs []uint64
+	Workers   []workerConfig
+}
 
 func init() {
 	caddy.RegisterModule(FrankenPHPApp{})
@@ -61,7 +64,7 @@ type workerConfig struct {
 	// Directories to watch for file changes
 	Watch []string `json:"watch,omitempty"`
 	// ModuleID identifies which module created this worker
-	ModuleID string `json:"module_id,omitempty"`
+	ModuleID uint64 `json:"module_id,omitempty"`
 }
 
 type FrankenPHPApp struct {
@@ -121,7 +124,7 @@ func (f *FrankenPHPApp) Start() error {
 	}
 
 	// Add workers from FrankenPHPModule configurations
-	for _, w := range moduleWorkers {
+	for _, w := range sharedState.Workers {
 		opts = append(opts, frankenphp.WithWorkers(w.Name, repl.ReplaceKnown(w.FileName, ""), w.Num, w.Env, w.Watch, w.ModuleID))
 	}
 
@@ -143,13 +146,13 @@ func (f *FrankenPHPApp) Stop() error {
 		frankenphp.DrainWorkers()
 	}
 
-	// reset configuration so it doesn't bleed into later tests
+	// reset the configuration so it doesn't bleed into later tests
 	f.Workers = nil
 	f.NumThreads = 0
 	f.MaxWaitTime = 0
 
 	// reset moduleWorkers
-	moduleWorkers = nil
+	sharedState.Workers = nil
 
 	return nil
 }
@@ -358,7 +361,7 @@ type FrankenPHPModule struct {
 	// 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:"-"`
+	ModuleID uint64 `json:"-"`
 	// Workers configures the worker scripts to start.
 	Workers []workerConfig `json:"workers,omitempty"`
 
@@ -432,15 +435,20 @@ 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 {
+		envString := ""
+		for k, v := range f.Env {
+			envString += k + "=" + v + ","
+		}
+		data := []byte(f.Root + envString)
+		hash := sha256.Sum256(data)
+		f.ModuleID = binary.LittleEndian.Uint64(hash[:8])
+
 		for _, w := range f.Workers {
 			w.ModuleID = f.ModuleID
 		}
-		moduleWorkers = append(moduleWorkers, f.Workers...)
+		sharedState.Workers = append(sharedState.Workers, f.Workers...)
+		f.logger.Warn(fmt.Sprintf("Initialized FrankenPHP module %d with %d workers", f.ModuleID, len(f.Workers)))
 	}
 
 	return nil

context.go

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

frankenphp.go

@@ -407,13 +407,13 @@ 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 == "" || worker.moduleID == fc.moduleID {
+		if worker.moduleID == 0 || worker.moduleID == fc.moduleID {
 			worker.handleRequest(fc)
 			return nil
 		}
 	}
 
-	// If no worker was available send the request to non-worker threads
+	// If no worker was available, send the request to non-worker threads
 	handleRequestWithRegularPHPThreads(fc)
 
 	return nil

frankenphp_test.go

@@ -65,7 +65,7 @@ func runTest(t *testing.T, test func(func(http.ResponseWriter, *http.Request), *
 
 	initOpts := []frankenphp.Option{frankenphp.WithLogger(opts.logger)}
 	if opts.workerScript != "" {
-		initOpts = append(initOpts, frankenphp.WithWorkers("workerName", testDataDir+opts.workerScript, opts.nbWorkers, opts.env, opts.watch, ""))
+		initOpts = append(initOpts, frankenphp.WithWorkers("workerName", testDataDir+opts.workerScript, opts.nbWorkers, opts.env, opts.watch, 0))
 	}
 	initOpts = append(initOpts, opts.initOpts...)
 	if opts.phpIni != nil {

options.go

@@ -28,7 +28,7 @@ type workerOpt struct {
 	num      int
 	env      PreparedEnv
 	watch    []string
-	moduleID string
+	moduleID uint64
 }
 
 // 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 string) Option {
+func WithWorkers(name string, fileName string, num int, env map[string]string, watch []string, moduleID uint64) Option {
 	return func(o *opt) error {
 		o.workers = append(o.workers, workerOpt{name, fileName, num, PrepareEnv(env), watch, moduleID})
 

phpmainthread_test.go

@@ -94,8 +94,8 @@ func TestTransitionThreadsWhileDoingRequests(t *testing.T) {
 
 	assert.NoError(t, Init(
 		WithNumThreads(numThreads),
-		WithWorkers(worker1Name, worker1Path, 1, map[string]string{"ENV1": "foo"}, []string{}, ""),
-		WithWorkers(worker2Name, worker2Path, 1, map[string]string{"ENV1": "foo"}, []string{}, ""),
+		WithWorkers(worker1Name, worker1Path, 1, map[string]string{"ENV1": "foo"}, []string{}, 0),
+		WithWorkers(worker2Name, worker2Path, 1, map[string]string{"ENV1": "foo"}, []string{}, 0),
 		WithLogger(zap.NewNop()),
 	))
 

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 string) RequestOption {
+func WithModuleID(moduleID uint64) 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    string
+	moduleID    uint64
 }
 
 var (

worker_test.go

@@ -119,8 +119,8 @@ func TestWorkerGetOpt(t *testing.T) {
 
 func ExampleServeHTTP_workers() {
 	if err := frankenphp.Init(
-		frankenphp.WithWorkers("worker1", "worker1.php", 4, map[string]string{"ENV1": "foo"}, []string{}, ""),
-		frankenphp.WithWorkers("worker1", "worker2.php", 2, map[string]string{"ENV2": "bar"}, []string{}, ""),
+		frankenphp.WithWorkers("worker1", "worker1.php", 4, map[string]string{"ENV1": "foo"}, []string{}, 0),
+		frankenphp.WithWorkers("worker1", "worker2.php", 2, map[string]string{"ENV2": "bar"}, []string{}, 0),
 	); err != nil {
 		panic(err)
 	}