new config

Author: dunglas

caddy/app.go

@@ -279,7 +279,7 @@ func (f *FrankenPHPApp) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
 				}
 
 			case "worker":
-				wc, err := parseWorkerConfig(d)
+				wc, err := unmarshalWorker(d)
 				if err != nil {
 					return err
 				}

caddy/caddy.go

@@ -13,7 +13,6 @@ import (
 const (
 	defaultDocumentRoot = "public"
 	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/hotreload-skip.go

@@ -1,6 +1,14 @@
 //go:build nowatcher || nomercure
+
 package caddy
 
+type hotReloadContext struct {
+}
+
 func (_ *FrankenPHPModule) configureHotReload(_ *FrankenPHPApp) error {
 	return nil
 }
+
+func (_ *FrankenPHPModule) unmarshalHotReload(d *caddyfile.Dispenser) error {
+	return errors.New("Hot reload support disabled")
+}

caddy/hotreload.go

@@ -1,24 +1,111 @@
 //go:build !nowatcher && !nomercure
+
 package caddy
 
 import (
+	"bytes"
+	"encoding/gob"
 	"errors"
+	"fmt"
+	"hash/fnv"
 	"net/url"
 
+	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
 	"github.com/dunglas/frankenphp"
 )
 
+const defaultHotReloadPattern = "./**/*.{css,env,gif,htm,html,jpg,jpeg,js,mjs,php,png,svg,twig,webp,xml,yaml,yml}"
+
+type hotReloadContext struct {
+	// HotReload specifies files to watch for file changes to trigger hot reloads updates. Supports the glob syntax.
+	HotReload *hotReloadConfig `json:"hot_reload,omitempty"`
+}
+
+type hotReloadConfig struct {
+	Topic string   `json:"topic"`
+	Watch []string `json:"watch"`
+}
+
 func (f *FrankenPHPModule) configureHotReload(app *FrankenPHPApp) error {
-	if len(f.HotReload) == 0 {
+	if f.HotReload == nil {
 		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)
+	if len(f.HotReload.Watch) == 0 {
+		f.HotReload.Watch = []string{defaultHotReloadPattern}
+	}
+
+	if f.HotReload.Topic == "" {
+		uid, err := uniqueID(f)
+		if err != nil {
+			return err
+		}
+
+		f.HotReload.Topic = "https://frankenphp.dev/hot-reload/" + uid
+	}
+
+	app.opts = append(app.opts, frankenphp.WithHotReload(f.HotReload.Topic, f.mercureHub, f.HotReload.Watch))
+	f.preparedEnv["FRANKENPHP_HOT_RELOAD\x00"] = "/.well-known/mercure?topic=" + url.QueryEscape(f.HotReload.Topic)
 
 	return nil
 }
+
+func (f *FrankenPHPModule) unmarshalHotReload(d *caddyfile.Dispenser) error {
+	patterns := d.RemainingArgs()
+	if len(patterns) > 0 {
+		f.HotReload = &hotReloadConfig{
+			Watch: patterns,
+		}
+	}
+
+	for d.NextBlock(1) {
+		switch v := d.Val(); v {
+		case "topic":
+			if !d.NextArg() {
+				return d.ArgErr()
+			}
+
+			if f.HotReload == nil {
+				f.HotReload = &hotReloadConfig{}
+			}
+
+			f.HotReload.Topic = d.Val()
+
+		case "watch":
+			patterns := d.RemainingArgs()
+			if len(patterns) == 0 {
+				return d.ArgErr()
+			}
+
+			if f.HotReload == nil {
+				f.HotReload = &hotReloadConfig{}
+			}
+
+			f.HotReload.Watch = append(f.HotReload.Watch, patterns...)
+
+		default:
+			return wrongSubDirectiveError("hot_reload", "topic, watch", v)
+		}
+	}
+
+	return nil
+}
+
+func uniqueID(s any) (string, error) {
+	var b bytes.Buffer
+
+	if err := gob.NewEncoder(&b).Encode(s); err != nil {
+		return "", fmt.Errorf("unable to generate unique name: %w", err)
+	}
+
+	h := fnv.New64a()
+	if _, err := h.Write(b.Bytes()); err != nil {
+		return "", fmt.Errorf("unable to generate unique name: %w", err)
+	}
+
+	return fmt.Sprintf("%016x", h.Sum64()), nil
+}

caddy/hotreload_test.go

@@ -0,0 +1,88 @@
+//go:build !nowatcher && !nomercure
+
+package caddy_test
+
+import (
+	"context"
+	"net/http"
+	"net/url"
+	"os"
+	"path/filepath"
+	"strings"
+	"sync"
+	"testing"
+
+	"github.com/caddyserver/caddy/v2/caddytest"
+	"github.com/stretchr/testify/require"
+)
+
+func TestHotReload(t *testing.T) {
+	const topic = "https://frankenphp.dev/hot-reload/test"
+
+	u := "/.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 {
+				root `+tmpDir+`
+				hot_reload {
+					topic `+topic+`
+					watch `+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+u, 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
+			}
+		}
+
+		require.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, u)
+}

caddy/module.go

@@ -1,12 +1,9 @@
 package caddy
 
 import (
-	"bytes"
-	"encoding/gob"
 	"encoding/json"
 	"errors"
 	"fmt"
-	"hash/fnv"
 	"log/slog"
 	"net/http"
 	"path/filepath"
@@ -37,9 +34,8 @@ var serverHeader = []string{"FrankenPHP Caddy"}
 //	}
 type FrankenPHPModule struct {
 	mercureContext
+	hotReloadContext
 
-	// Name for the server. Default: to the worker filename if any, a unique ID otherwise.
-	Name string `json:"name,omitempty"`
 	// Root sets the root folder to the site. Default: `root` directive, or the path of the public directory of the embed app it exists.
 	Root string `json:"root,omitempty"`
 	// SplitPath sets the substrings for splitting the URI into two parts. The first matching substring will be used to split the "path info" from the path. The first piece is suffixed with the matching substring and will be assumed as the actual resource (CGI script) name. The second piece will be set to PATH_INFO for the CGI script to use. Default: `.php`.
@@ -50,8 +46,6 @@ type FrankenPHPModule struct {
 	Env map[string]string `json:"env,omitempty"`
 	// Workers configures the worker scripts to start.
 	Workers []workerConfig `json:"workers,omitempty"`
-	// HotReload specifies files to watch for file changes to trigger hot reloads updates. Supports the glob syntax.
-	HotReload []string `json:"hot_reload,omitempty"`
 
 	resolvedDocumentRoot        string
 	preparedEnv                 frankenphp.PreparedEnv
@@ -85,12 +79,6 @@ func (f *FrankenPHPModule) Provision(ctx caddy.Context) error {
 
 	f.assignMercureHub(ctx)
 
-	// If there is only one worker, and a name is set for the server,
-	// use the server name for the worker if none is set.
-	if len(f.Workers) == 1 && f.Name != "" && f.Workers[0].Name == "" {
-		f.Workers[0].Name = f.Name
-	}
-
 	loggerOpt := frankenphp.WithRequestLogger(f.logger)
 	for i, wc := range f.Workers {
 		// make the file path absolute from the public directory
@@ -114,12 +102,6 @@ func (f *FrankenPHPModule) Provision(ctx caddy.Context) error {
 	}
 	f.Workers = workers
 
-	// If there is only one worker, and no name is set for the server,
-	// use the worker name without the "m#" prefix
-	if len(f.Workers) == 1 && f.Name == "" && f.Workers[0].Name != "" {
-		f.Name = strings.TrimPrefix(f.Workers[0].Name, "m#")
-	}
-
 	if f.Root == "" {
 		if frankenphp.EmbeddedAppPath == "" {
 			f.Root = "{http.vars.root}"
@@ -171,13 +153,6 @@ func (f *FrankenPHPModule) Provision(ctx caddy.Context) error {
 		}
 	}
 
-	if f.Name == "" {
-		// Generate a unique name if none is provided
-		if f.Name, err = uniqueID(f); err != nil {
-			return err
-		}
-	}
-
 	if err := f.configureHotReload(fapp); err != nil {
 		return err
 	}
@@ -272,12 +247,6 @@ func (f *FrankenPHPModule) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
 	for d.Next() {
 		for d.NextBlock(0) {
 			switch d.Val() {
-			case "name":
-				if !d.NextArg() {
-					return d.ArgErr()
-				}
-
-				f.Name = d.Val()
 			case "root":
 				if !d.NextArg() {
 					return d.ArgErr()
@@ -316,23 +285,18 @@ func (f *FrankenPHPModule) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
 				f.ResolveRootSymlink = &v
 
 			case "worker":
-				wc, err := parseWorkerConfig(d)
+				wc, err := unmarshalWorker(d)
 				if err != nil {
 					return err
 				}
 
 				f.Workers = append(f.Workers, wc)
 
 			case "hot_reload":
-				patterns := d.RemainingArgs()
-				if len(patterns) == 0 {
-					f.HotReload = append(f.HotReload, defaultHotReloadPattern)
-
-					continue
+				if err := f.unmarshalHotReload(d); err != nil {
+					return err
 				}
 
-				f.HotReload = append(f.HotReload, patterns...)
-
 			default:
 				return wrongSubDirectiveError("php or php_server", "hot_reload, name, root, split, env, resolve_root_symlink, worker", d.Val())
 			}
@@ -693,21 +657,6 @@ func prependWorkerRoutes(routes caddyhttp.RouteList, h httpcaddyfile.Helper, f F
 	return routes
 }
 
-func uniqueID(s any) (string, error) {
-	var b bytes.Buffer
-
-	if err := gob.NewEncoder(&b).Encode(s); err != nil {
-		return "", fmt.Errorf("unable to generate unique name: %w", err)
-	}
-
-	h := fnv.New64a()
-	if _, err := h.Write(b.Bytes()); err != nil {
-		return "", fmt.Errorf("unable to generate unique name: %w", err)
-	}
-
-	return fmt.Sprintf("%016x", h.Sum64()), nil
-}
-
 // Interface guards
 var (
 	_ caddy.Provisioner           = (*FrankenPHPModule)(nil)