feat: hot reloading

caddy/admin_test.go

@@ -4,12 +4,13 @@ import (
 	"bytes"
 	"encoding/json"
 	"fmt"
-	"github.com/dunglas/frankenphp/internal/fastabs"
 	"io"
 	"net/http"
 	"sync"
 	"testing"
 
+	"github.com/dunglas/frankenphp/internal/fastabs"
+
 	"github.com/caddyserver/caddy/v2/caddytest"
 	"github.com/dunglas/frankenphp"
 	"github.com/stretchr/testify/assert"

caddy/app.go

@@ -49,13 +49,14 @@ type FrankenPHPApp struct {
 	NumThreads int `json:"num_threads,omitempty"`
 	// MaxThreads limits how many threads can be started at runtime. Default 2x NumThreads
 	MaxThreads int `json:"max_threads,omitempty"`
-	// Workers configures the worker scripts to start.
+	// Workers configures the worker scripts to start
 	Workers []workerConfig `json:"workers,omitempty"`
 	// Overwrites the default php ini configuration
 	PhpIni map[string]string `json:"php_ini,omitempty"`
 	// The maximum amount of time a request may be stalled waiting for a thread
 	MaxWaitTime time.Duration `json:"max_wait_time,omitempty"`
 
+	opts    []frankenphp.Option
 	metrics frankenphp.Metrics
 	ctx     context.Context
 	logger  *slog.Logger
@@ -76,6 +77,9 @@ func (f *FrankenPHPApp) Provision(ctx caddy.Context) error {
 	f.ctx = ctx
 	f.logger = ctx.Slogger()
 
+	// We have at least 7 hardcoded options
+	f.opts = make([]frankenphp.Option, 0, 7+len(options))
+
 	if httpApp, err := ctx.AppIfConfigured("http"); err == nil {
 		if httpApp.(*caddyhttp.App).Metrics != nil {
 			f.metrics = frankenphp.NewPrometheusMetrics(ctx.GetMetricsRegistry())
@@ -135,11 +139,10 @@ func (f *FrankenPHPApp) Start() error {
 	repl := caddy.NewReplacer()
 
 	optionsMU.RLock()
-	opts := make([]frankenphp.Option, 0, len(options)+len(f.Workers)+7)
-	opts = append(opts, options...)
+	f.opts = append(f.opts, options...)
 	optionsMU.RUnlock()
 
-	opts = append(opts,
+	f.opts = append(f.opts,
 		frankenphp.WithContext(f.ctx),
 		frankenphp.WithLogger(f.logger),
 		frankenphp.WithNumThreads(f.NumThreads),
@@ -150,31 +153,19 @@ func (f *FrankenPHPApp) Start() error {
 	)
 
 	for _, w := range f.Workers {
-		workerOpts := make([]frankenphp.WorkerOption, 0, len(w.requestOptions)+4)
-
-		if w.requestOptions == nil {
-			workerOpts = append(workerOpts,
-				frankenphp.WithWorkerEnv(w.Env),
-				frankenphp.WithWorkerWatchMode(w.Watch),
-				frankenphp.WithWorkerMaxFailures(w.MaxConsecutiveFailures),
-				frankenphp.WithWorkerMaxThreads(w.MaxThreads),
-			)
-		} else {
-			workerOpts = append(
-				workerOpts,
-				frankenphp.WithWorkerEnv(w.Env),
-				frankenphp.WithWorkerWatchMode(w.Watch),
-				frankenphp.WithWorkerMaxFailures(w.MaxConsecutiveFailures),
-				frankenphp.WithWorkerMaxThreads(w.MaxThreads),
-				frankenphp.WithWorkerRequestOptions(w.requestOptions...),
-			)
-		}
-
-		opts = append(opts, frankenphp.WithWorkers(w.Name, repl.ReplaceKnown(w.FileName, ""), w.Num, workerOpts...))
+		w.options = append(w.options,
+			frankenphp.WithWorkerEnv(w.Env),
+			frankenphp.WithWorkerWatchMode(w.Watch),
+			frankenphp.WithWorkerMaxFailures(w.MaxConsecutiveFailures),
+			frankenphp.WithWorkerMaxThreads(w.MaxThreads),
+			frankenphp.WithWorkerRequestOptions(w.requestOptions...),
+		)
+
+		f.opts = append(f.opts, frankenphp.WithWorkers(w.Name, repl.ReplaceKnown(w.FileName, ""), w.Num, w.options...))
 	}
 
 	frankenphp.Shutdown()
-	if err := frankenphp.Init(opts...); err != nil {
+	if err := frankenphp.Init(f.opts...); err != nil {
 		return err
 	}
 

caddy/caddy.go

@@ -12,7 +12,8 @@ import (
 
 const (
 	defaultDocumentRoot = "public"
-	defaultWatchPattern = "./**/*.{php,yaml,yml,twig,env}"
+	defaultWatchPattern = "./**/*.{env,php,twig,yaml,yml}"
+	defaultHotReloadPattern = "./**/*.{css,env,gif,htm,html,jpg,jpeg,js,mjs,php,png,svg,twig,webp,xml,yaml,yml}"
 )
 
 func init() {

caddy/caddy_test.go

@@ -2,8 +2,10 @@ package caddy_test
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"net/http"
+	"net/url"
 	"os"
 	"path/filepath"
 	"strconv"
@@ -16,6 +18,7 @@ import (
 	"github.com/caddyserver/caddy/v2/caddytest"
 	"github.com/dunglas/frankenphp/internal/fastabs"
 	"github.com/prometheus/client_golang/prometheus/testutil"
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
@@ -1362,7 +1365,7 @@ func TestWorkerMatchDirective(t *testing.T) {
 		}
 		`, "caddyfile")
 
-	// worker is outside of public directory, match anyways
+	// worker is outside public directory, match anyway
 	tester.AssertGetResponse("http://localhost:"+testPort+"/matched-path", http.StatusOK, "requests:1")
 	tester.AssertGetResponse("http://localhost:"+testPort+"/matched-path/anywhere", http.StatusOK, "requests:2")
 
@@ -1472,3 +1475,72 @@ func TestDd(t *testing.T) {
 		"dump123",
 	)
 }
+
+func TestHotReload(t *testing.T) {
+	const topic = "https://frankenphp.dev/hot-reload/test"
+
+	url := "/.well-known/mercure?topic=" + url.QueryEscape(topic)
+
+	tmpDir := t.TempDir()
+	indexFile := filepath.Join(tmpDir, "index.php")
+
+	tester := caddytest.NewTester(t)
+	tester.InitServer(`
+		{
+			debug
+			skip_install_trust
+			admin localhost:2999
+		}
+
+		http://localhost:`+testPort+` {
+			mercure {
+				transport local
+				subscriber_jwt TestKey 
+				anonymous
+			}
+
+			php_server {
+				name test
+				root `+tmpDir+`
+				hot_reload `+tmpDir+`/*.php
+			}
+		`, "caddyfile")
+
+	var connected, received sync.WaitGroup
+
+	connected.Add(1)
+	received.Go(func() {
+		cx, cancel := context.WithCancel(t.Context())
+		req, _ := http.NewRequest(http.MethodGet, "http://localhost:"+testPort+url, nil)
+		req = req.WithContext(cx)
+		resp := tester.AssertResponseCode(req, http.StatusOK)
+
+		connected.Done()
+
+		var receivedBody strings.Builder
+
+		buf := make([]byte, 1024)
+		for {
+			_, err := resp.Body.Read(buf)
+			require.NoError(t, err)
+
+			receivedBody.Write(buf)
+
+			if strings.Contains(receivedBody.String(), "index.php") {
+				cancel()
+
+				break
+			}
+		}
+
+		assert.NoError(t, resp.Body.Close())
+	})
+
+	connected.Wait()
+
+	require.NoError(t, os.WriteFile(indexFile, []byte(`<?=$_SERVER['FRANKENPHP_HOT_RELOAD'];?>`), 0644))
+
+	received.Wait()
+
+	tester.AssertGetResponse("http://localhost:"+testPort+"/index.php", http.StatusOK, url)
+}

caddy/config_test.go

@@ -181,7 +181,7 @@ func TestModuleWorkerWithWatchConfiguration(t *testing.T) {
 
 	// Verify that the watch directories were set correctly
 	require.Len(t, module.Workers[0].Watch, 3, "Expected three watch patterns")
-	require.Equal(t, "./**/*.{php,yaml,yml,twig,env}", module.Workers[0].Watch[0], "First watch pattern should be the default")
+	require.Equal(t, defaultWatchPattern, module.Workers[0].Watch[0], "First watch pattern should be the default")
 	require.Equal(t, "./src/**/*.php", module.Workers[0].Watch[1], "Second watch pattern should match the configuration")
 	require.Equal(t, "./config/**/*.yaml", module.Workers[0].Watch[2], "Third watch pattern should match the configuration")
 }

caddy/go.mod

@@ -11,6 +11,7 @@ require (
 	github.com/caddyserver/certmagic v0.25.0
 	github.com/dunglas/caddy-cbrotli v1.0.1
 	github.com/dunglas/frankenphp v1.10.1
+	github.com/dunglas/mercure v0.21.2
 	github.com/dunglas/mercure/caddy v0.21.2
 	github.com/dunglas/vulcain/caddy v1.2.1
 	github.com/prometheus/client_golang v1.23.2
@@ -59,7 +60,6 @@ require (
 	github.com/dgryski/go-farm v0.0.0-20240924180020-3414d57e47da // indirect
 	github.com/dlclark/regexp2 v1.11.5 // indirect
 	github.com/dunglas/httpsfv v1.1.0 // indirect
-	github.com/dunglas/mercure v0.21.2 // indirect
 	github.com/dunglas/skipfilter v1.0.0 // indirect
 	github.com/dunglas/vulcain v1.2.1 // indirect
 	github.com/dustin/go-humanize v1.0.1 // indirect

caddy/mercure-skip.go

@@ -2,9 +2,12 @@
 
 package caddy
 
-import (
-	"github.com/caddyserver/caddy/v2"
-)
+type mercureContext struct {
+}
+
+func (f *FrankenPHPModule) configureHotReload(_ *FrankenPHPApp) error {
+	return nil
+}
 
-func (f *FrankenPHPModule) assignMercureHubRequestOption(_ caddy.Context) {
+func (f *FrankenPHPModule) assignMercureHub(_ caddy.Context) {
 }

caddy/mercure.go

@@ -3,18 +3,50 @@
 package caddy
 
 import (
+	"errors"
+	"net/url"
+
 	"github.com/caddyserver/caddy/v2"
 	"github.com/dunglas/frankenphp"
+	"github.com/dunglas/mercure"
 	mercureCaddy "github.com/dunglas/mercure/caddy"
 )
 
 func init() {
 	mercureCaddy.AllowNoPublish = true
 }
 
-func (f *FrankenPHPModule) assignMercureHubRequestOption(ctx caddy.Context) {
-	if hub := mercureCaddy.FindHub(ctx.Modules()); hub != nil {
-		opt := frankenphp.WithMercureHub(hub)
-		f.mercureHubRequestOption = &opt
+type mercureContext struct {
+	mercureHub *mercure.Hub
+}
+
+func (f *FrankenPHPModule) configureHotReload(app *FrankenPHPApp) error {
+	if len(f.HotReload) == 0 {
+		return nil
+	}
+
+	if f.mercureHub == nil {
+		return errors.New("unable to enable hot reloading: no Mercure hub configured")
+	}
+
+	app.opts = append(app.opts, frankenphp.WithHotReload(f.Name, f.mercureHub, f.HotReload))
+	f.preparedEnv["FRANKENPHP_HOT_RELOAD\x00"] = "/.well-known/mercure?topic=https%3A%2F%2Ffrankenphp.dev%2Fhot-reload%2F" + url.QueryEscape(f.Name)
+
+	return nil
+}
+
+func (f *FrankenPHPModule) assignMercureHub(ctx caddy.Context) {
+	if f.mercureHub = mercureCaddy.FindHub(ctx.Modules()); f.mercureHub == nil {
+		return
+	}
+
+	opt := frankenphp.WithMercureHub(f.mercureHub)
+	f.mercureHubRequestOption = &opt
+
+	for i, wc := range f.Workers {
+		wc.mercureHub = f.mercureHub
+		wc.options = append(wc.options, frankenphp.WithWorkerMercureHub(wc.mercureHub))
+
+		f.Workers[i] = wc
 	}
 }