use watcher-go

Author: dunglas

caddy/go.mod

@@ -1,6 +1,6 @@
 module github.com/dunglas/frankenphp/caddy
 
-go 1.25.0
+go 1.25.4
 
 replace github.com/dunglas/frankenphp => ../
 
@@ -63,6 +63,7 @@ require (
 	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
+	github.com/e-dant/watcher/watcher-go v0.0.0-20251208164151-f88ec3b7e146 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/fsnotify/fsnotify v1.9.0 // indirect
 	github.com/fxamacker/cbor/v2 v2.9.0 // indirect

caddy/go.sum

@@ -159,6 +159,8 @@ github.com/dunglas/vulcain/caddy v1.2.1/go.mod h1:8QrmLTfURmW2VgjTR6Gb9a53FrZjsp
 github.com/dustin/go-humanize v1.0.0/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk=
 github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
 github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
+github.com/e-dant/watcher/watcher-go v0.0.0-20251208164151-f88ec3b7e146 h1:h3vVM6X45PK0mAk8NqiYNQGXTyhvXy1HQ5GhuQN4eeA=
+github.com/e-dant/watcher/watcher-go v0.0.0-20251208164151-f88ec3b7e146/go.mod h1:sVUOkwtftoj71nnJRG2S0oWNfXFdKpz/M9vK0z06nmM=
 github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg=
 github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
 github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=

frankenphp.go

@@ -319,20 +319,15 @@ func Init(options ...Option) error {
 		convertToRegularThread(getInactivePHPThread())
 	}
 
-	watchPatterns, err := initWorkers(opt.workers)
-	if err != nil {
+	if err := initWorkers(opt.workers); err != nil {
 		Shutdown()
 
 		return err
 	}
 
-	watchPatterns = append(watchPatterns, opt.hotReload...)
-
-	if len(watchPatterns) > 0 {
-		if err := watcher.InitWatcher(globalCtx, globalLogger, watchPatterns); err != nil {
-			Shutdown()
-			return err
-		}
+	if err := initWatchers(opt); err != nil {
+		Shutdown()
+		return err
 	}
 
 	initAutoScaling(mainThread)

go.mod

@@ -1,6 +1,6 @@
 module github.com/dunglas/frankenphp
 
-go 1.25.0
+go 1.25.4
 
 retract v1.0.0-rc.1 // Human error
 
@@ -26,6 +26,7 @@ require (
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/dunglas/skipfilter v1.0.0 // indirect
+	github.com/e-dant/watcher/watcher-go v0.0.0-20251208164151-f88ec3b7e146 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/fsnotify/fsnotify v1.9.0 // indirect
 	github.com/go-viper/mapstructure/v2 v2.4.0 // indirect

go.sum

@@ -22,6 +22,8 @@ github.com/dunglas/mercure v0.21.2 h1:qaLTScSwsCHDps++4AeLWrRp3BysdR5EoHBqu7JNha
 github.com/dunglas/mercure v0.21.2/go.mod h1:3ElA7VwRI8BHUIAVU8oGlvPaqGwsKU5zZVWFNSFg/+U=
 github.com/dunglas/skipfilter v1.0.0 h1:JG9SgGg4n6BlFwuTYzb9RIqjH7PfwszvWehanrYWPF4=
 github.com/dunglas/skipfilter v1.0.0/go.mod h1:ryhr8j7CAHSjzeN7wI6YEuwoArQ3OQmRqWWVCEAfb9w=
+github.com/e-dant/watcher/watcher-go v0.0.0-20251208164151-f88ec3b7e146 h1:h3vVM6X45PK0mAk8NqiYNQGXTyhvXy1HQ5GhuQN4eeA=
+github.com/e-dant/watcher/watcher-go v0.0.0-20251208164151-f88ec3b7e146/go.mod h1:sVUOkwtftoj71nnJRG2S0oWNfXFdKpz/M9vK0z06nmM=
 github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg=
 github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
 github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=

hotreload.go

@@ -0,0 +1,44 @@
+//go:build !nomercure && !nowatcher
+
+package frankenphp
+
+import (
+	"encoding/json"
+	"log/slog"
+
+	"github.com/dunglas/frankenphp/internal/watcher"
+	"github.com/dunglas/mercure"
+	watcherGo "github.com/e-dant/watcher/watcher-go"
+)
+
+// WithHotReload sets files to watch for file changes to trigger a hot reload update.
+func WithHotReload(name string, hub *mercure.Hub, patterns []string) Option {
+	return func(o *opt) error {
+		o.hotReload = append(o.hotReload, &watcher.PatternGroup{
+			Patterns: patterns,
+			Callback: func(events []*watcherGo.Event) {
+				// Wait for workers to restart before sending the update
+				go func() {
+					data, err := json.Marshal(events)
+					if err != nil {
+						if globalLogger.Enabled(globalCtx, slog.LevelError) {
+							globalLogger.LogAttrs(globalCtx, slog.LevelError, "error marshaling watcher events", slog.Any("error", err))
+						}
+
+						return
+					}
+
+					if err := hub.Publish(globalCtx, &mercure.Update{
+						Topics: []string{"https://frankenphp.dev/hot-reload/" + name},
+						Event:  mercure.Event{Data: string(data)},
+						Debug:  globalLogger.Enabled(globalCtx, slog.LevelDebug),
+					}); err != nil && globalLogger.Enabled(globalCtx, slog.LevelError) {
+						globalLogger.LogAttrs(globalCtx, slog.LevelError, "error publishing hot reloading Mercure update", slog.Any("error", err))
+					}
+				}()
+			},
+		})
+
+		return nil
+	}
+}

internal/watcher/pattern.go

@@ -2,20 +2,13 @@
 
 package watcher
 
-// #cgo LDFLAGS: -lwatcher-c -lstdc++
-// #include <stdint.h>
-// #include <stdlib.h>
-// #include "watcher.h"
-import "C"
 import (
 	"log/slog"
 	"path/filepath"
-	"runtime/cgo"
 	"strings"
-	"time"
-	"unsafe"
 
 	"github.com/dunglas/frankenphp/internal/fastabs"
+	"github.com/e-dant/watcher/watcher-go"
 )
 
 type pattern struct {
@@ -24,31 +17,16 @@ type pattern struct {
 	parsedValues []string
 	events       chan eventHolder
 	failureCount int
-	watcher      C.uintptr_t
-	h            cgo.Handle
-}
 
-func (p *pattern) startSession() error {
-	p.h = cgo.NewHandle(p)
-	cDir := C.CString(p.value)
-	defer C.free(unsafe.Pointer(cDir))
+	watcher *watcher.Watcher
+}
 
-	p.watcher = C.start_new_watcher(cDir, C.uintptr_t(p.h))
-	if p.watcher != 0 {
-		if globalLogger.Enabled(globalCtx, slog.LevelDebug) {
-			globalLogger.LogAttrs(globalCtx, slog.LevelDebug, "watching", slog.String("pattern", p.value))
-		}
+func (p *pattern) startSession() {
+	p.watcher = watcher.NewWatcher(p.value, p.handle)
 
-		return nil
+	if globalLogger.Enabled(globalCtx, slog.LevelDebug) {
+		globalLogger.LogAttrs(globalCtx, slog.LevelDebug, "watching", slog.String("pattern", p.value))
 	}
-
-	if globalLogger.Enabled(globalCtx, slog.LevelError) {
-		globalLogger.LogAttrs(globalCtx, slog.LevelError, "couldn't start watching", slog.String("pattern", p.value))
-	}
-
-	p.h.Delete()
-
-	return ErrUnableToStartWatching
 }
 
 // this method prepares the pattern struct (aka /path/*pattern)
@@ -94,7 +72,7 @@ func (p *pattern) parse() (err error) {
 	return nil
 }
 
-func (p *pattern) allowReload(event *Event) bool {
+func (p *pattern) allowReload(event *watcher.Event) bool {
 	if !isValidEventType(event.EffectType) || !isValidPathType(event) {
 		return false
 	}
@@ -105,9 +83,9 @@ func (p *pattern) allowReload(event *Event) bool {
 	return p.isValidPattern(event.PathName) || p.isValidPattern(event.AssociatedPathName)
 }
 
-func (p *pattern) handle(event *Event) {
+func (p *pattern) handle(event *watcher.Event) {
 	// If the watcher prematurely sends the die@ event, retry watching
-	if event.PathType == PathTypeWatcher && strings.HasPrefix(event.PathName, "e/self/die@") && watcherIsActive.Load() {
+	if event.PathType == watcher.PathTypeWatcher && strings.HasPrefix(event.PathName, "e/self/die@") && watcherIsActive.Load() {
 		p.retryWatching()
 
 		return
@@ -119,23 +97,19 @@ func (p *pattern) handle(event *Event) {
 }
 
 func (p *pattern) stop() {
-	if C.stop_watcher(p.watcher) == 0 && globalLogger.Enabled(globalCtx, slog.LevelWarn) {
-		globalLogger.LogAttrs(globalCtx, slog.LevelWarn, "couldn't close the watcher")
-	}
-
-	p.h.Delete()
+	p.watcher.Close()
 }
 
-func isValidEventType(effectType EffectType) bool {
-	return effectType <= EffectTypeDestroy
+func isValidEventType(effectType watcher.EffectType) bool {
+	return effectType <= watcher.EffectTypeDestroy
 }
 
-func isValidPathType(event *Event) bool {
-	if event.PathType == PathTypeWatcher && globalLogger.Enabled(globalCtx, slog.LevelDebug) {
+func isValidPathType(event *watcher.Event) bool {
+	if event.PathType == watcher.PathTypeWatcher && globalLogger.Enabled(globalCtx, slog.LevelDebug) {
 		globalLogger.LogAttrs(globalCtx, slog.LevelDebug, "special e-dant/watcher event", slog.Any("event", event))
 	}
 
-	return event.PathType <= PathTypeHardLink
+	return event.PathType <= watcher.PathTypeHardLink
 }
 
 func (p *pattern) isValidPattern(fileName string) bool {
@@ -234,18 +208,3 @@ func matchPattern(pattern string, fileName string) bool {
 
 	return patternMatches
 }
-
-//export go_handle_file_watcher_event
-func go_handle_file_watcher_event(event C.struct_wtr_watcher_event, handle C.uintptr_t) {
-	p := cgo.Handle(handle).Value().(*pattern)
-
-	e := &Event{
-		EffectTime:         time.Unix(int64(event.effect_time)/1000000000, int64(event.effect_time)%1000000000),
-		PathName:           C.GoString(event.path_name),
-		AssociatedPathName: C.GoString(event.associated_path_name),
-		EffectType:         EffectType(event.effect_type),
-		PathType:           PathType(event.path_type),
-	}
-
-	p.handle(e)
-}

internal/watcher/pattern_test.go

@@ -6,6 +6,7 @@ import (
 	"path/filepath"
 	"testing"
 
+	"github.com/e-dant/watcher/watcher-go"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -14,14 +15,14 @@ func TestDisallowOnEventTypeBiggerThan3(t *testing.T) {
 	w := pattern{value: "/some/path"}
 	require.NoError(t, w.parse())
 
-	assert.False(t, w.allowReload(&Event{PathName: "/some/path/watch-me.php", EffectType: EffectTypeOwner}))
+	assert.False(t, w.allowReload(&watcher.Event{PathName: "/some/path/watch-me.php", EffectType: watcher.EffectTypeOwner}))
 }
 
 func TestDisallowOnPathTypeBiggerThan2(t *testing.T) {
 	w := pattern{value: "/some/path"}
 	require.NoError(t, w.parse())
 
-	assert.False(t, w.allowReload(&Event{PathName: "/some/path/watch-me.php", PathType: PathTypeSymLink}))
+	assert.False(t, w.allowReload(&watcher.Event{PathName: "/some/path/watch-me.php", PathType: watcher.PathTypeSymLink}))
 }
 
 func TestWatchesCorrectDir(t *testing.T) {
@@ -306,7 +307,7 @@ func TestAnAssociatedEventTriggersTheWatcher(t *testing.T) {
 	require.NoError(t, w.parse())
 	w.events = make(chan eventHolder)
 
-	e := &Event{PathName: "/path/temporary_file", AssociatedPathName: "/path/file.php"}
+	e := &watcher.Event{PathName: "/path/temporary_file", AssociatedPathName: "/path/file.php"}
 	go w.handle(e)
 
 	assert.Equal(t, e, (<-w.events).event)
@@ -333,7 +334,7 @@ func shouldMatch(t *testing.T, p string, fileName string) {
 	w := pattern{value: p}
 	require.NoError(t, w.parse())
 
-	assert.True(t, w.allowReload(&Event{PathName: fileName}))
+	assert.True(t, w.allowReload(&watcher.Event{PathName: fileName}))
 }
 
 func shouldNotMatch(t *testing.T, p string, fileName string) {
@@ -342,5 +343,5 @@ func shouldNotMatch(t *testing.T, p string, fileName string) {
 	w := pattern{value: p}
 	require.NoError(t, w.parse())
 
-	assert.False(t, w.allowReload(&Event{PathName: fileName}))
+	assert.False(t, w.allowReload(&watcher.Event{PathName: fileName}))
 }