Merge branch 'main' into workers

Author: henderkes

.github/workflows/tests.yaml

@@ -68,7 +68,7 @@ jobs:
       - name: Run integrations tests
         run: ./reload_test.sh
       - name: Lint Go code
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v7
         if: matrix.php-versions == '8.4'
         with:
           version: latest

build-static.sh

@@ -58,7 +58,20 @@ if [ -n "${DEBUG_SYMBOLS}" ]; then
 fi
 # php version to build
 if [ -z "${PHP_VERSION}" ]; then
-	export PHP_VERSION="8.4"
+	get_latest_php_version() {
+		input="$1"
+		json=$(curl -s "https://www.php.net/releases/index.php?json&version=$input")
+		latest=$(echo "$json" | jq -r '.version')
+
+		if [[ "$latest" == "$input"* ]]; then
+			echo "$latest"
+		else
+			echo "$input"
+		fi
+	}
+
+	PHP_VERSION="$(get_latest_php_version "8")"
+	export PHP_VERSION
 fi
 # default extension set
 defaultExtensions="apcu,bcmath,bz2,calendar,ctype,curl,dba,dom,exif,fileinfo,filter,ftp,gd,gmp,gettext,iconv,igbinary,imagick,intl,ldap,mbregex,mbstring,mysqli,mysqlnd,opcache,openssl,parallel,pcntl,pdo,pdo_mysql,pdo_pgsql,pdo_sqlite,pgsql,phar,posix,protobuf,readline,redis,session,shmop,simplexml,soap,sockets,sodium,sqlite3,ssh2,sysvmsg,sysvsem,sysvshm,tidy,tokenizer,xlswriter,xml,xmlreader,xmlwriter,zip,zlib,yaml,zstd"
@@ -138,9 +151,9 @@ if type "brew" >/dev/null 2>&1; then
 fi
 
 if [ "${SPC_REL_TYPE}" = "binary" ]; then
-	mkdir static-php-cli/
+	mkdir -p static-php-cli/
 	cd static-php-cli/
-	curl -o spc -fsSL "https://dl.static-php.dev/static-php-cli/spc-bin/nightly/spc-linux-$(uname -m)"
+	curl -o spc -fsSL "https://dl.static-php.dev/static-php-cli/spc-bin/nightly/spc-linux-${arch}"
 	chmod +x spc
 	spcCommand="./spc"
 elif [ -d "static-php-cli/src" ]; then

caddy/admin.go

@@ -44,7 +44,7 @@ func (admin *FrankenPHPAdmin) restartWorkers(w http.ResponseWriter, r *http.Requ
 	return nil
 }
 
-func (admin *FrankenPHPAdmin) threads(w http.ResponseWriter, r *http.Request) error {
+func (admin *FrankenPHPAdmin) threads(w http.ResponseWriter, _ *http.Request) error {
 	debugState := frankenphp.DebugState()
 	prettyJson, err := json.MarshalIndent(debugState, "", "    ")
 	if err != nil {

cgi.go

@@ -168,7 +168,7 @@ func packCgiVariable(key *C.zend_string, value string) C.ht_key_value_pair {
 	return C.ht_key_value_pair{key, toUnsafeChar(value), C.size_t(len(value))}
 }
 
-func addHeadersToServer(thread *phpThread, fc *frankenPHPContext, trackVarsArray *C.zval) {
+func addHeadersToServer(fc *frankenPHPContext, trackVarsArray *C.zval) {
 	for field, val := range fc.request.Header {
 		if k := mainThread.commonHeaders[field]; k != nil {
 			v := strings.Join(val, ", ")
@@ -197,7 +197,7 @@ func go_register_variables(threadIndex C.uintptr_t, trackVarsArray *C.zval) {
 	fc := thread.getRequestContext()
 
 	addKnownVariablesToServer(thread, fc, trackVarsArray)
-	addHeadersToServer(thread, fc, trackVarsArray)
+	addHeadersToServer(fc, trackVarsArray)
 
 	// The Prepared Environment is registered last and can overwrite any previous values
 	addPreparedEnvToServer(fc, trackVarsArray)

docs/config.md

@@ -2,8 +2,7 @@
 
 FrankenPHP, Caddy as well as the Mercure and Vulcain modules can be configured using [the formats supported by Caddy](https://caddyserver.com/docs/getting-started#your-first-config).
 
-In [the Docker images](docker.md), the `Caddyfile` is located at `/etc/caddy/Caddyfile`.
-The static binary will look for the `Caddyfile` in the directory in which it is started.
+In [the Docker images](docker.md), the `Caddyfile` is located at `/etc/caddy/Caddyfile`. The static binary will look for the `Caddyfile` in the directory where the `frankenphp run` command is executed. You can specify a custom path with the `-c` or `--config` option.
 
 PHP itself can be configured [using a `php.ini` file](https://www.php.net/manual/en/configuration.file.php).
 
@@ -103,7 +102,9 @@ other.example.com {
 ```
 
 Using the `php_server` directive is generally what you need,
-but if you need full control, you can use the lower level `php` directive:
+but if you need full control, you can use the lower-level `php` directive.
+The `php` directive passes all input to PHP, instead of first checking whether
+it's a PHP file or not. Read more about it in the [performance page](performance.md).
 
 Using the `php_server` directive is equivalent to this configuration:
 

docs/fr/config.md

@@ -104,6 +104,8 @@ other.example.com {
 
 L'utilisation de la directive `php_server` est généralement suffisante,
 mais si vous avez besoin d'un contrôle total, vous pouvez utiliser la directive `php`, qui permet un plus grand niveau de finesse dans la configuration.
+La directive `php` transmet toutes les entrées à PHP, au lieu de vérifier d'abord si
+c'est un fichier PHP ou pas. En savoir plus à ce sujet dans la [page performances](performance.md).
 
 Utiliser la directive `php_server` est équivalent à cette configuration :
 

frankenphp.go

@@ -55,13 +55,13 @@ type contextKeyStruct struct{}
 var contextKey = contextKeyStruct{}
 
 var (
-	InvalidRequestError         = errors.New("not a FrankenPHP request")
-	AlreadyStartedError         = errors.New("FrankenPHP is already started")
-	InvalidPHPVersionError      = errors.New("FrankenPHP is only compatible with PHP 8.2+")
-	MainThreadCreationError     = errors.New("error creating the main thread")
-	RequestContextCreationError = errors.New("error during request context creation")
-	ScriptExecutionError        = errors.New("error during PHP script execution")
-	NotRunningError             = errors.New("FrankenPHP is not running. For proper configuration visit: https://frankenphp.dev/docs/config/#caddyfile-config")
+	ErrInvalidRequest         = errors.New("not a FrankenPHP request")
+	ErrAlreadyStarted         = errors.New("FrankenPHP is already started")
+	ErrInvalidPHPVersion      = errors.New("FrankenPHP is only compatible with PHP 8.2+")
+	ErrMainThreadCreation     = errors.New("error creating the main thread")
+	ErrRequestContextCreation = errors.New("error during request context creation")
+	ErrScriptExecution        = errors.New("error during PHP script execution")
+	ErrNotRunning             = errors.New("FrankenPHP is not running. For proper configuration visit: https://frankenphp.dev/docs/config/#caddyfile-config")
 
 	isRunning bool
 
@@ -189,7 +189,7 @@ func calculateMaxThreads(opt *opt) (int, int, int, error) {
 		return opt.numThreads, numWorkers, opt.maxThreads, nil
 	}
 
-	if !numThreadsIsSet && !maxThreadsIsSet {
+	if !numThreadsIsSet {
 		if numWorkers >= maxProcs {
 			// Start at least as many threads as workers, and keep a free thread to handle requests in non-worker mode
 			opt.numThreads = numWorkers + 1
@@ -218,7 +218,7 @@ func calculateMaxThreads(opt *opt) (int, int, int, error) {
 // Init starts the PHP runtime and the configured workers.
 func Init(options ...Option) error {
 	if isRunning {
-		return AlreadyStartedError
+		return ErrAlreadyStarted
 	}
 	isRunning = true
 
@@ -265,7 +265,7 @@ func Init(options ...Option) error {
 	config := Config()
 
 	if config.Version.MajorVersion < 8 || (config.Version.MajorVersion == 8 && config.Version.MinorVersion < 2) {
-		return InvalidPHPVersionError
+		return ErrInvalidPHPVersion
 	}
 
 	if config.ZTS {
@@ -381,7 +381,7 @@ func updateServerContext(thread *phpThread, fc *frankenPHPContext, isWorkerReque
 	)
 
 	if ret > 0 {
-		return RequestContextCreationError
+		return ErrRequestContextCreation
 	}
 
 	return nil
@@ -390,12 +390,12 @@ func updateServerContext(thread *phpThread, fc *frankenPHPContext, isWorkerReque
 // ServeHTTP executes a PHP script according to the given context.
 func ServeHTTP(responseWriter http.ResponseWriter, request *http.Request) error {
 	if !isRunning {
-		return NotRunningError
+		return ErrNotRunning
 	}
 
 	fc, ok := fromContext(request.Context())
 	if !ok {
-		return InvalidRequestError
+		return ErrInvalidRequest
 	}
 
 	fc.responseWriter = responseWriter

frankenphp_test.go

@@ -754,7 +754,7 @@ func testFileUpload(t *testing.T, opts *testOptions) {
 		_, err := part.Write([]byte("bar"))
 		require.NoError(t, err)
 
-		writer.Close()
+		require.NoError(t, writer.Close())
 
 		req := httptest.NewRequest("POST", "http://example.com/file-upload.php", requestBody)
 		req.Header.Add("Content-Type", writer.FormDataContentType())

internal/watcher/watcher.go

@@ -37,22 +37,23 @@ var failureMu = sync.Mutex{}
 var watcherIsActive = atomic.Bool{}
 
 var (
+	ErrAlreadyStarted        = errors.New("the watcher is already running")
+	ErrUnableToStartWatching = errors.New("unable to start the watcher")
+
 	// the currently active file watcher
 	activeWatcher *watcher
 	// after stopping the watcher we will wait for eventual reloads to finish
 	reloadWaitGroup sync.WaitGroup
 	// we are passing the logger from the main package to the watcher
-	logger                *zap.Logger
-	AlreadyStartedError   = errors.New("the watcher is already running")
-	UnableToStartWatching = errors.New("unable to start the watcher")
+	logger *zap.Logger
 )
 
 func InitWatcher(filePatterns []string, callback func(), zapLogger *zap.Logger) error {
 	if len(filePatterns) == 0 {
 		return nil
 	}
 	if watcherIsActive.Load() {
-		return AlreadyStartedError
+		return ErrAlreadyStarted
 	}
 	watcherIsActive.Store(true)
 	logger = zapLogger
@@ -142,7 +143,7 @@ func startSession(w *watchPattern) (C.uintptr_t, error) {
 	}
 	logger.Error("couldn't start watching", zap.String("dir", w.dir))
 
-	return watchSession, UnableToStartWatching
+	return watchSession, ErrUnableToStartWatching
 }
 
 func stopSession(session C.uintptr_t) {
@@ -186,7 +187,6 @@ func listenForFileEvents(triggerWatcher chan string, stopWatcher chan struct{})
 	for {
 		select {
 		case <-stopWatcher:
-			break
 		case lastChangedFile = <-triggerWatcher:
 			timer.Reset(debounceDuration)
 		case <-timer.C:

metrics.go

@@ -11,7 +11,7 @@ import (
 const (
 	StopReasonCrash = iota
 	StopReasonRestart
-	StopReasonShutdown
+	//StopReasonShutdown
 )
 
 type StopReason int
@@ -74,9 +74,9 @@ func (n nullMetrics) StartWorkerRequest(string) {
 func (n nullMetrics) Shutdown() {
 }
 
-func (n nullMetrics) QueuedWorkerRequest(name string) {}
+func (n nullMetrics) QueuedWorkerRequest(string) {}
 
-func (n nullMetrics) DequeuedWorkerRequest(name string) {}
+func (n nullMetrics) DequeuedWorkerRequest(string) {}
 
 func (n nullMetrics) QueuedRequest()   {}
 func (n nullMetrics) DequeuedRequest() {}
@@ -127,9 +127,10 @@ func (m *PrometheusMetrics) StopWorker(name string, reason StopReason) {
 	m.totalWorkers.WithLabelValues(name).Dec()
 	m.readyWorkers.WithLabelValues(name).Dec()
 
-	if reason == StopReasonCrash {
+	switch reason {
+	case StopReasonCrash:
 		m.workerCrashes.WithLabelValues(name).Inc()
-	} else if reason == StopReasonRestart {
+	case StopReasonRestart:
 		m.workerRestarts.WithLabelValues(name).Inc()
 	}
 }