Skip to content

feat: unify php_server logic#2499

Open
AlliBalliBaba wants to merge 53 commits into
mainfrom
refactor/phpserver
Open

feat: unify php_server logic#2499
AlliBalliBaba wants to merge 53 commits into
mainfrom
refactor/phpserver

Conversation

@AlliBalliBaba

Copy link
Copy Markdown
Contributor

Currently the concept of a php_server only exists on the caddy side and not the FrankenPHP side.
Lately we have been moving more and more in a direction of scoping requests or workers to specific php_server blocks.

This PR is an attempt at refactoring the current php_server logic so it is properly mirrored on the FrankenPHP side without BC breaks for library users (and to prevent future bugs like mentioned in #2487)

Comment thread options.go Outdated
Comment thread options.go Outdated
Comment thread options.go Outdated
Comment thread phpserver.go Outdated
@dunglas

dunglas commented Jul 5, 2026

Copy link
Copy Markdown
Member

Why do we need the index to be explicitly passed? Couldn't we generate it and return it if needed?

@AlliBalliBaba

Copy link
Copy Markdown
Contributor Author

Same reason as in #2487. The caddy modules might be converted to and from JSON multiple times between parsing, provisioning and the actual server start. So the index must already be present when parsing the Caddyfile.

Not sure how to make it more elegant, maybe somehow like this?

type ServerIdx int

@dunglas

dunglas commented Jul 5, 2026

Copy link
Copy Markdown
Member

Hum ok got it. I indeed prefer having a custom opaque type (could be an unit under the hood btw)

@AlliBalliBaba

Copy link
Copy Markdown
Contributor Author

Alright I changed it so WithServer additionally returns a Server instance.

type Server struct { idx }
func WithServer(idx int, resolvedDocumentRoot string,splitPath []string,env map[string]string) (Server, Option)
func WithWorkerServerScope(Server) WorkerOption
func Server.ServeHTTP(responseWriter http.ResponseWriter, request *http.Request, opts ...RequestOption) error

I also noticed that currently configuration would bleed across tests, which probably caused some flakiness. I fixed it by purging configuration right after Init().

Also noticed that watcher.Close() will still sometimes hang up in TestHotReload, not sure why (also on main).

When refactoring the context I also fixed some inconsistencies with which logger was being used and which original request method was passed in the debug state.

@AlliBalliBaba AlliBalliBaba marked this pull request as ready for review July 5, 2026 16:12
Comment thread scaling.go
@AlliBalliBaba

Copy link
Copy Markdown
Contributor Author

I changed the api again a bit, this feels like it makes the most sense (no idx passing required):

server := frankenphp.NewServer(root, env, splitPath)

frankenphp.Init(frankenphp.WithServer(server))

server.ServeHTTP(request, responseWriter)

Comment thread context.go
Comment thread caddy/module.go Outdated
Comment thread caddy/module.go Outdated
Comment thread caddy/app.go Outdated
Comment thread server.go Outdated
Comment thread caddy/app.go Outdated
@AlliBalliBaba

Copy link
Copy Markdown
Contributor Author

Another subtlety I fixed: the "external workers" from RegisterWorkers should probably persist across reloads.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants