fix(watcher): handles associated events (#1379)

* Handles associated events.

* triggers pipeline

* Adjusts comment.

* Uses fixed version.

* Update watch_pattern_test.go

---------

Co-authored-by: Alliballibaba <alliballibaba@gmail.com>
Co-authored-by: Kévin Dunglas <kevin@dunglas.fr>

Author: AlliBalliBaba

.github/actions/watcher/action.yaml

@@ -19,7 +19,7 @@ runs:
       name: Compile e-dant/watcher
       run: |
         mkdir watcher
-        gh release download --repo e-dant/watcher -A tar.gz -O - | tar -xz -C watcher --strip-components 1
+        gh release download 0.13.2 --repo e-dant/watcher -A tar.gz -O - | tar -xz -C watcher --strip-components 1
         cd watcher
         cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
         cmake --build build

internal/watcher/watch_pattern_test.go

@@ -5,6 +5,7 @@ package watcher
 import (
 	"path/filepath"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 )
@@ -145,6 +146,20 @@ func TestInValidExtendedPatterns(t *testing.T) {
 	shouldNotMatch(t, "/path/{dir1,dir2}/**/*.php", "/path/dir1/subpath/file.txt")
 }
 
+func TestAnAssociatedEventTriggersTheWatcher(t *testing.T) {
+	watchPattern, err := parseFilePattern("/**/*.php")
+	assert.NoError(t, err)
+	watchPattern.trigger = make(chan struct{})
+
+	go handleWatcherEvent(watchPattern, "/path/temorary_file", "/path/file.php", 0, 0)
+
+	select {
+	case <-watchPattern.trigger:
+	case <-time.After(2 * time.Second):
+		assert.Fail(t, "associated watchPattern did not trigger after 2s")
+	}
+}
+
 func relativeDir(t *testing.T, relativePath string) string {
 	dir, err := filepath.Abs("./" + relativePath)
 	assert.NoError(t, err)

internal/watcher/watcher.c

@@ -5,8 +5,9 @@
 #include "wtr/watcher-c.h"
 
 void handle_event(struct wtr_watcher_event event, void *data) {
-  go_handle_file_watcher_event((char *)event.path_name, event.effect_type,
-                               event.path_type, (uintptr_t)data);
+  go_handle_file_watcher_event(
+      (char *)event.path_name, (char *)event.associated_path_name,
+      event.effect_type, event.path_type, (uintptr_t)data);
 }
 
 uintptr_t start_new_watcher(char const *const path, uintptr_t data) {

internal/watcher/watcher.go

@@ -82,6 +82,7 @@ func retryWatching(watchPattern *watchPattern) {
 	failureMu.Lock()
 	defer failureMu.Unlock()
 	if watchPattern.failureCount >= maxFailureCount {
+		logger.Warn("gave up watching", zap.String("dir", watchPattern.dir))
 		return
 	}
 	logger.Info("watcher was closed prematurely, retrying...", zap.String("dir", watchPattern.dir))
@@ -152,17 +153,28 @@ func stopSession(session C.uintptr_t) {
 }
 
 //export go_handle_file_watcher_event
-func go_handle_file_watcher_event(path *C.char, eventType C.int, pathType C.int, handle C.uintptr_t) {
+func go_handle_file_watcher_event(path *C.char, associatedPath *C.char, eventType C.int, pathType C.int, handle C.uintptr_t) {
 	watchPattern := cgo.Handle(handle).Value().(*watchPattern)
-	goPath := C.GoString(path)
+	handleWatcherEvent(watchPattern, C.GoString(path), C.GoString(associatedPath), int(eventType), int(pathType))
+}
+
+func handleWatcherEvent(watchPattern *watchPattern, path string, associatedPath string, eventType int, pathType int) {
+	// If the watcher prematurely sends the die@ event, retry watching
+	if pathType == 4 && strings.HasPrefix(path, "e/self/die@") && watcherIsActive.Load() {
+		retryWatching(watchPattern)
+		return
+	}
 
-	if watchPattern.allowReload(goPath, int(eventType), int(pathType)) {
+	if watchPattern.allowReload(path, eventType, pathType) {
 		watchPattern.trigger <- struct{}{}
+		return
 	}
 
-	// If the watcher prematurely sends the die@ event, retry watching
-	if pathType == 4 && strings.HasPrefix(goPath, "e/self/die@") && watcherIsActive.Load() {
-		retryWatching(watchPattern)
+	// some editors create temporary files and never actually modify the original file
+	// so we need to also check the associated path of an event
+	// see https://github.com/dunglas/frankenphp/issues/1375
+	if associatedPath != "" && watchPattern.allowReload(associatedPath, eventType, pathType) {
+		watchPattern.trigger <- struct{}{}
 	}
 }