feat(watcher): log last changed file (#1447)

* logs last changed file.

* Fixes race condition.

---------

Co-authored-by: Alliballibaba <[email protected]>

Author: AlliBalliBaba

debugstate.go

@@ -37,7 +37,7 @@ func DebugState() FrankenPHPDebugState {
 func threadDebugState(thread *phpThread) ThreadDebugState {
 	return ThreadDebugState{
 		Index:                    thread.threadIndex,
-		Name:                     thread.handler.name(),
+		Name:                     thread.name(),
 		State:                    thread.state.name(),
 		IsWaiting:                thread.state.isInWaitingState(),
 		IsBusy:                   !thread.state.isInWaitingState(),

frankenphp_test.go

@@ -672,11 +672,12 @@ func TestFailingWorker(t *testing.T) {
 }
 
 func TestEnv(t *testing.T) {
-	testEnv(t, &testOptions{nbParallelRequests:1})
+	testEnv(t, &testOptions{nbParallelRequests: 1})
 }
 func TestEnvWorker(t *testing.T) {
-	testEnv(t, &testOptions{nbParallelRequests:1, workerScript: "env/test-env.php"})
+	testEnv(t, &testOptions{nbParallelRequests: 1, workerScript: "env/test-env.php"})
 }
+
 // testEnv cannot be run in parallel due to https://github.com/golang/go/issues/63567
 func testEnv(t *testing.T, opts *testOptions) {
 	assert.NoError(t, os.Setenv("EMPTY", ""))

internal/watcher/watch_pattern.go

@@ -13,7 +13,7 @@ import (
 type watchPattern struct {
 	dir          string
 	patterns     []string
-	trigger      chan struct{}
+	trigger      chan string
 	failureCount int
 }
 

internal/watcher/watch_pattern_test.go

@@ -149,12 +149,14 @@ func TestInValidExtendedPatterns(t *testing.T) {
 func TestAnAssociatedEventTriggersTheWatcher(t *testing.T) {
 	watchPattern, err := parseFilePattern("/**/*.php")
 	assert.NoError(t, err)
-	watchPattern.trigger = make(chan struct{})
+	watchPattern.trigger = make(chan string)
 
 	go handleWatcherEvent(watchPattern, "/path/temorary_file", "/path/file.php", 0, 0)
 
+	var path string
 	select {
-	case <-watchPattern.trigger:
+	case path = <-watchPattern.trigger:
+		assert.Equal(t, "/path/file.php", path, "should be associated file path")
 	case <-time.After(2 * time.Second):
 		assert.Fail(t, "associated watchPattern did not trigger after 2s")
 	}

internal/watcher/watcher.go

@@ -22,7 +22,7 @@ import (
 type watcher struct {
 	sessions []C.uintptr_t
 	callback func()
-	trigger  chan struct{}
+	trigger  chan string
 	stop     chan struct{}
 }
 
@@ -105,7 +105,7 @@ func retryWatching(watchPattern *watchPattern) {
 }
 
 func (w *watcher) startWatching(filePatterns []string) error {
-	w.trigger = make(chan struct{})
+	w.trigger = make(chan string)
 	w.stop = make(chan struct{})
 	w.sessions = make([]C.uintptr_t, len(filePatterns))
 	watchPatterns, err := parseFilePatterns(filePatterns)
@@ -166,37 +166,38 @@ func handleWatcherEvent(watchPattern *watchPattern, path string, associatedPath
 	}
 
 	if watchPattern.allowReload(path, eventType, pathType) {
-		watchPattern.trigger <- struct{}{}
+		watchPattern.trigger <- path
 		return
 	}
 
 	// 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{}{}
+		watchPattern.trigger <- associatedPath
 	}
 }
 
-func listenForFileEvents(triggerWatcher chan struct{}, stopWatcher chan struct{}) {
+func listenForFileEvents(triggerWatcher chan string, stopWatcher chan struct{}) {
 	timer := time.NewTimer(debounceDuration)
 	timer.Stop()
+	lastChangedFile := ""
 	defer timer.Stop()
 	for {
 		select {
 		case <-stopWatcher:
 			break
-		case <-triggerWatcher:
+		case lastChangedFile = <-triggerWatcher:
 			timer.Reset(debounceDuration)
 		case <-timer.C:
 			timer.Stop()
+			logger.Info("filesystem change detected", zap.String("file", lastChangedFile))
 			scheduleReload()
 		}
 	}
 }
 
 func scheduleReload() {
-	logger.Info("filesystem change detected")
 	reloadWaitGroup.Add(1)
 	activeWatcher.callback()
 	reloadWaitGroup.Done()