Adds basic file watcher

.github/workflows/sanitizers.yaml

@@ -23,13 +23,14 @@ jobs:
       matrix:
         sanitizer: ['asan', 'msan']
     env:
-      CFLAGS: -g -O0 -fsanitize=${{ matrix.sanitizer == 'asan' && 'address' || 'memory' }}  -DZEND_TRACK_ARENA_ALLOC
+      CFLAGS: -g -O0 -fsanitize=${{ matrix.sanitizer == 'asan' && 'address' || 'memory' }} -DZEND_TRACK_ARENA_ALLOC
       LDFLAGS: -fsanitize=${{ matrix.sanitizer == 'asan' && 'address' || 'memory' }}
       CC: clang
       CXX: clang++
       USE_ZEND_ALLOC: 0
       LIBRARY_PATH: ${{ github.workspace }}/php/target/lib
       LD_LIBRARY_PATH: ${{ github.workspace }}/php/target/lib
+      EDANT_WATCHER_VERSION: next
     steps:
       -
         name: Remove local PHP
@@ -95,6 +96,20 @@ jobs:
       -
         name: Add PHP to the PATH
         run: echo "$(pwd)/php/target/bin" >> "$GITHUB_PATH"
+      -
+        uses: actions/checkout@v4
+        name: Checkout watcher
+        with:
+          repository: e-dant/watcher
+          ref: ${{ env.EDANT_WATCHER_VERSION }}
+          path: 'edant/watcher'
+      -
+        name: Compile edant/watcher
+        run: |
+          cd edant/watcher/watcher-c/
+          clang -o libwatcher.so ./src/watcher-c.cpp -I ./include -I ../include -std=c++17 -Wall -Wextra -fPIC -shared ${{ matrix.sanitizer == 'msan' && '-fsanitize=memory -fno-omit-frame-pointer -fno-optimize-sibling-calls' || '' }}
+          sudo cp libwatcher.so /usr/local/lib/libwatcher.so
+          sudo ldconfig
       -
         name: Set Set CGO flags
         run: |

.github/workflows/tests.yaml

@@ -23,6 +23,7 @@ jobs:
     env:
       GOEXPERIMENT: cgocheck2
       GOMAXPROCS: 10
+      EDANT_WATCHER_VERSION: next
     steps:
       -
         uses: actions/checkout@v4
@@ -43,6 +44,20 @@ jobs:
         env:
           phpts: ts
           debug: true
+      -
+        uses: actions/checkout@v4
+        name: Checkout watcher
+        with:
+          repository: e-dant/watcher
+          ref: ${{ env.EDANT_WATCHER_VERSION }}
+          path: 'edant/watcher'
+      -
+        name: Compile edant/watcher
+        run: |
+          cd edant/watcher/watcher-c/
+          gcc -o libwatcher.so ./src/watcher-c.cpp -I ./include -I ../include -std=c++17 -O3 -Wall -Wextra -fPIC -shared
+          sudo cp libwatcher.so /usr/local/lib/libwatcher.so
+          sudo ldconfig
       -
         name: Set CGO flags
         run: |

Dockerfile

@@ -24,7 +24,7 @@
 	echo '<?php phpinfo();' > /app/public/index.php
 
 COPY --link caddy/frankenphp/Caddyfile /etc/caddy/Caddyfile
 COPY --from=mlocati/php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/
 
 CMD ["--config", "/etc/caddy/Caddyfile", "--adapter", "caddyfile"]
 HEALTHCHECK CMD curl -f http://localhost:2019/metrics || exit 1
@@ -85,6 +85,16 @@
 COPY --link caddy caddy
 COPY --link internal internal
 COPY --link testdata testdata
+COPY --link watcher watcher
+
+# install edant/watcher (necessary for file watching)
+ARG EDANT_WATCHER_VERSION=next
+WORKDIR /usr/local/src/watcher
+RUN curl -L https://github.com/e-dant/watcher/archive/refs/heads/$EDANT_WATCHER_VERSION.tar.gz | tar xz
+WORKDIR /usr/local/src/watcher/watcher-$EDANT_WATCHER_VERSION/watcher-c
+RUN gcc -o libwatcher.so ./src/watcher-c.cpp -I ./include -I ../include -std=c++17 -O3 -Wall -Wextra -fPIC -shared && \
+	cp libwatcher.so /usr/local/lib/libwatcher.so && \
+	ldconfig /usr/local/lib
 
 # See https://github.com/docker-library/php/blob/master/8.3/bookworm/zts/Dockerfile#L57-L59 for PHP values
 ENV CGO_CFLAGS="-DFRANKENPHP_VERSION=$FRANKENPHP_VERSION $PHP_CFLAGS"
@@ -104,6 +114,13 @@
 
 ENV GODEBUG=cgocheck=0
 
+# copy watcher shared library
+COPY --from=builder /usr/local/lib/libwatcher* /usr/local/lib/
+# fix for the file watcher on arm
+RUN apt-get install -y --no-install-recommends libstdc++6 && \
+	apt-get clean && \
+	ldconfig
+
 COPY --from=builder /usr/local/bin/frankenphp /usr/local/bin/frankenphp
 RUN setcap cap_net_bind_service=+ep /usr/local/bin/frankenphp && \
 	frankenphp version

alpine.Dockerfile

@@ -23,7 +23,7 @@
 	echo '<?php phpinfo();' > /app/public/index.php
 
 COPY --link caddy/frankenphp/Caddyfile /etc/caddy/Caddyfile
 COPY --from=mlocati/php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/
 
 CMD ["--config", "/etc/caddy/Caddyfile", "--adapter", "caddyfile"]
 HEALTHCHECK CMD curl -f http://localhost:2019/metrics || exit 1
@@ -58,21 +58,24 @@
 RUN apk add --no-cache --virtual .build-deps \
 	$PHPIZE_DEPS \
 	argon2-dev \
+	# Needed for the custom Go build
+	bash \
 	brotli-dev \
 	coreutils \
 	curl-dev \
+	# Needed for the custom Go build
+	git \
 	gnu-libiconv-dev \
 	libsodium-dev \
+	# Needed for the file watcher
+	libstdc++ \
 	libxml2-dev \
 	linux-headers \
 	oniguruma-dev \
 	openssl-dev \
 	readline-dev \
 	sqlite-dev \
-	upx \
-	# Needed for the custom Go build
-	git \
-	bash
+	upx
 
 # FIXME: temporary workaround for https://github.com/golang/go/issues/68285
 WORKDIR /
@@ -103,6 +106,16 @@
 COPY --link caddy caddy
 COPY --link internal internal
 COPY --link testdata testdata
+COPY --link watcher watcher
+
+# install edant/watcher (necessary for file watching)
+ARG EDANT_WATCHER_VERSION=next
+WORKDIR /usr/local/src/watcher
+RUN curl -L https://github.com/e-dant/watcher/archive/refs/heads/$EDANT_WATCHER_VERSION.tar.gz | tar xz
+WORKDIR /usr/local/src/watcher/watcher-$EDANT_WATCHER_VERSION/watcher-c
+RUN gcc -o libwatcher.so ./src/watcher-c.cpp -I ./include -I ../include -std=c++17 -O3 -Wall -Wextra -fPIC -shared && \
+	cp libwatcher.so /usr/local/lib/libwatcher.so && \
+	ldconfig /usr/local/lib
 
 # See https://github.com/docker-library/php/blob/master/8.3/alpine3.20/zts/Dockerfile#L53-L55
 ENV CGO_CFLAGS="-DFRANKENPHP_VERSION=$FRANKENPHP_VERSION $PHP_CFLAGS"
@@ -122,6 +135,11 @@
 
 ENV GODEBUG=cgocheck=0
 
+# copy watcher shared library (libgcc and libstdc++ are needed for the watcher)
+COPY --from=builder /usr/local/lib/libwatcher* /usr/local/lib/
+RUN apk add --no-cache libstdc++ && \
+	ldconfig /usr/local/lib
+
 COPY --from=builder /usr/local/bin/frankenphp /usr/local/bin/frankenphp
 RUN setcap cap_net_bind_service=+ep /usr/local/bin/frankenphp && \
 	frankenphp version

build-static.sh

@@ -142,6 +142,16 @@ if [ "${os}" = "linux" ]; then
 		CGO_LDFLAGS="${CGO_LDFLAGS} -lstdc++"
 	fi
 fi
+
+# install edant/watcher for file watching (static version)
+git clone --branch="${EDANT_WATCHER_VERSION:-next}" https://github.com/e-dant/watcher watcher
+cd watcher/watcher-c
+gcc -c -o libwatcher.o ./src/watcher-c.cpp -I ./include -I ../include -std=c++17 -Wall -Wextra -fPIC
+ar rcs libwatcher.a libwatcher.o
+cp libwatcher.a "../../buildroot/lib/libwatcher.a"
+cd ../../
+CGO_LDFLAGS="${CGO_LDFLAGS} -lstdc++ ${PWD}/buildroot/lib/libwatcher.a"
+
 export CGO_LDFLAGS
 
 LIBPHP_VERSION="$(./buildroot/bin/php-config --version)"

caddy/caddy.go

@@ -66,6 +66,8 @@ type FrankenPHPApp struct {
 	NumThreads int `json:"num_threads,omitempty"`
 	// Workers configures the worker scripts to start.
 	Workers []workerConfig `json:"workers,omitempty"`
+	// Directories to watch for changes
+	Watch []watchConfig `json:"watch,omitempty"`
 }
 
 // CaddyModule returns the Caddy module information.
@@ -84,6 +86,9 @@ func (f *FrankenPHPApp) Start() error {
 	for _, w := range f.Workers {
 		opts = append(opts, frankenphp.WithWorkers(repl.ReplaceKnown(w.FileName, ""), w.Num, w.Env))
 	}
+	for _, watchConfig := range f.Watch {
+		opts = applyWatchConfig(opts, watchConfig)
+	}
 
 	_, loaded, err := phpInterpreter.LoadOrNew(mainPHPInterpreterKey, func() (caddy.Destructor, error) {
 		if err := frankenphp.Init(opts...); err != nil {
@@ -128,7 +133,11 @@ func (f *FrankenPHPApp) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
 				}
 
 				f.NumThreads = v
-
+			case "watch":
+				if !d.NextArg() {
+					return d.Err(`The "watch" directive must be followed by a path`)
+				}
+				f.Watch = append(f.Watch, parseWatchConfig(d.Val()))
 			case "worker":
 				wc := workerConfig{}
 				if d.NextArg() {

caddy/caddy_test.go

@@ -305,3 +305,29 @@ func TestPHPServerDirectiveDisableFileServer(t *testing.T) {
 	tester.AssertGetResponse("http://localhost:9080", http.StatusOK, "I am by birth a Genevese (i not set)")
 	tester.AssertGetResponse("http://localhost:9080/hello.txt", http.StatusNotFound, "Not found")
 }
+
+func TestWorkerWithSleepingWatcher(t *testing.T) {
+	tester := caddytest.NewTester(t)
+	tester.InitServer(`
+		{
+			skip_install_trust
+			admin localhost:2999
+			http_port 9080
+			https_port 9443
+
+			frankenphp {
+				worker ../testdata/worker-with-watcher.php 1
+				watch ./**/*.php
+			}
+		}
+
+		localhost:9080 {
+			root * ../testdata
+			rewrite * worker-with-watcher.php
+			php
+		}
+		`, "caddyfile")
+
+	tester.AssertGetResponse("http://localhost:9080", http.StatusOK, "requests:1")
+	tester.AssertGetResponse("http://localhost:9080", http.StatusOK, "requests:2")
+}

caddy/go.mod

@@ -14,6 +14,7 @@ require (
 	github.com/dunglas/mercure/caddy v0.16.3
 	github.com/dunglas/vulcain/caddy v1.0.5
 	github.com/spf13/cobra v1.8.1
+	github.com/stretchr/testify v1.9.0
 	go.uber.org/zap v1.27.0
 )
 
@@ -42,6 +43,7 @@ require (
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/chzyer/readline v1.5.1 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.4 // indirect
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/dgraph-io/badger v1.6.2 // indirect
 	github.com/dgraph-io/badger/v2 v2.2007.4 // indirect
 	github.com/dgraph-io/ristretto v0.1.1 // indirect
@@ -119,6 +121,7 @@ require (
 	github.com/perimeterx/marshmallow v1.1.5 // indirect
 	github.com/pires/go-proxyproto v0.7.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/prometheus/client_golang v1.20.2 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
 	github.com/prometheus/common v0.55.0 // indirect

caddy/php-server.go

@@ -29,7 +29,7 @@ import (
 func init() {
 	caddycmd.RegisterCommand(caddycmd.Command{
 		Name:  "php-server",
-		Usage: "[--domain <example.com>] [--root <path>] [--listen <addr>] [--worker /path/to/worker.php<,nb-workers>] [--access-log] [--debug] [--no-compress] [--mercure]",
+		Usage: "[--domain <example.com>] [--root <path>] [--listen <addr>] [--worker /path/to/worker.php<,nb-workers>] [--watch /path/to/watch] [--access-log] [--debug] [--no-compress] [--mercure]",
 		Short: "Spins up a production-ready PHP server",
 		Long: `
 A simple but production-ready PHP server. Useful for quick deployments,
@@ -48,6 +48,7 @@ For more advanced use cases, see https://github.com/dunglas/frankenphp/blob/main
 			cmd.Flags().StringP("root", "r", "", "The path to the root of the site")
 			cmd.Flags().StringP("listen", "l", "", "The address to which to bind the listener")
 			cmd.Flags().StringArrayP("worker", "w", []string{}, "Worker script")
+			cmd.Flags().StringArrayP("watch", "", []string{}, "Directory to watch for file changes")
 			cmd.Flags().BoolP("access-log", "a", false, "Enable the access log")
 			cmd.Flags().BoolP("debug", "v", false, "Enable verbose debug logs")
 			cmd.Flags().BoolP("mercure", "m", false, "Enable the built-in Mercure.rocks hub")
@@ -73,6 +74,10 @@ func cmdPHPServer(fs caddycmd.Flags) (int, error) {
 	if err != nil {
 		panic(err)
 	}
+	watch, err := fs.GetStringArray("watch")
+	if err != nil {
+		panic(err)
+	}
 
 	var workersOption []workerConfig
 	if len(workers) != 0 {
@@ -305,7 +310,7 @@ func cmdPHPServer(fs caddycmd.Flags) (int, error) {
 		},
 		AppsRaw: caddy.ModuleMap{
 			"http":       caddyconfig.JSON(httpApp, nil),
-			"frankenphp": caddyconfig.JSON(FrankenPHPApp{Workers: workersOption}, nil),
+			"frankenphp": caddyconfig.JSON(FrankenPHPApp{Workers: workersOption, Watch: parseWatchConfigs(watch)}, nil),
 		},
 	}
 

caddy/watch.go

@@ -0,0 +1,57 @@
+package caddy
+
+import (
+	"github.com/dunglas/frankenphp"
+	"github.com/dunglas/frankenphp/watcher"
+	"path/filepath"
+	"strings"
+)
+
+type watchConfig struct {
+	// Directory that should be watched for changes
+	Dir string `json:"dir,omitempty"`
+	// Whether to watch the directory recursively
+	IsRecursive bool `json:"recursive,omitempty"`
+	// The shell filename pattern to match against
+	Pattern string `json:"pattern,omitempty"`
+}
+
+func applyWatchConfig(opts []frankenphp.Option, watchConfig watchConfig) []frankenphp.Option {
+	return append(opts, frankenphp.WithFileWatcher(
+		watcher.WithWatcherDir(watchConfig.Dir),
+		watcher.WithWatcherRecursion(watchConfig.IsRecursive),
+		watcher.WithWatcherPattern(watchConfig.Pattern),
+	))
+}
+
+func parseWatchConfigs(filePatterns []string) []watchConfig {
+	watchConfigs := []watchConfig{}
+	for _, filePattern := range filePatterns {
+		watchConfigs = append(watchConfigs, parseWatchConfig(filePattern))
+	}
+	return watchConfigs
+}
+
+// TODO: better path validation?
+// for the one line short-form in the caddy config, aka: 'watch /path/*pattern'
+func parseWatchConfig(filePattern string) watchConfig {
+	watchConfig := watchConfig{IsRecursive: true}
+	dirName := filePattern
+	splitDirName, baseName := filepath.Split(filePattern)
+	if filePattern != "." && filePattern != ".." && strings.ContainsAny(baseName, "*.[?\\") {
+		dirName = splitDirName
+		watchConfig.Pattern = baseName
+		watchConfig.IsRecursive = false
+	}
+	if strings.Contains(filePattern, "**/") {
+		dirName = strings.Split(filePattern, "**/")[0]
+		watchConfig.Pattern = strings.Split(filePattern, "**/")[1]
+		watchConfig.IsRecursive = true
+	}
+	watchConfig.Dir = dirName
+	if dirName != "/" {
+		watchConfig.Dir = strings.TrimRight(dirName, "/")
+	}
+
+	return watchConfig
+}