Add timeout parameter to file watch method

pierredup · pierredup · commit 418d1d6ffbbe · 2019-10-01T11:18:34.000+02:00
diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -732,18 +732,19 @@ public function appendToFile($filename, $content)
      *
      * @param mixed    $path     The path to watch for changes. Can be a path to a file or directory, iterator or array with paths
      * @param callable $callback The callback to execute when a change is detected
+     * @param float    $timeout  The time in milliseconds to wait between checking for changes (defaults to 1000 when inotify is not available)
      *
-     * @throws \InvalidArgumentException
+     * @throws \InvalidArgumentException|IOException
      */
-    public function watch($path, callable $callback)
+    public function watch($path, callable $callback, float $timeout = null)
     {
         if (\extension_loaded('inotify')) {
             $watcher = new INotifyWatcher();
         } else {
             $watcher = new FileChangeWatcher();
         }
 
-        $watcher->watch($path, $callback);
+        $watcher->watch($path, $callback, $timeout);
     }
 
     private function toIterable($files): iterable
diff --git a/src/Symfony/Component/Filesystem/Watcher/FileChangeWatcher.php b/src/Symfony/Component/Filesystem/Watcher/FileChangeWatcher.php
@@ -25,8 +25,12 @@ public function __construct()
         $this->locator = new FileResourceLocator();
     }
 
-    public function watch($path, callable $callback)
+    public function watch($path, callable $callback, float $timeout = null)
     {
+        if (null === $timeout) {
+            $timeout = 1000;
+        }
+
         $resource = $this->locator->locate($path);
 
         if (!$resource) {
@@ -42,7 +46,7 @@ public function watch($path, callable $callback)
                 }
             }
 
-            sleep(1);
+            usleep($timeout * 1000);
         }
     }
 }
diff --git a/src/Symfony/Component/Filesystem/Watcher/INotifyWatcher.php b/src/Symfony/Component/Filesystem/Watcher/INotifyWatcher.php
@@ -11,28 +11,50 @@
 
 namespace Symfony\Component\Filesystem\Watcher;
 
+use Symfony\Component\Filesystem\Exception\IOException;
+
 /**
  * @internal
  */
 class INotifyWatcher implements WatcherInterface
 {
-    public function watch($path, callable $callback)
+    public function watch($path, callable $callback, float $timeout = null)
     {
         $inotifyInit = inotify_init();
-        $dir = false;
 
-        if (is_dir($path)) {
+        if (false === $inotifyInit) {
+            throw new IOException('Unable initialize inotify', 0, null, $path);
+        }
+
+        stream_set_blocking($inotifyInit, false);
+
+        $isDir = is_dir($path);
+
+        if ($isDir) {
             $watchId = inotify_add_watch($inotifyInit, $path, IN_CREATE | IN_DELETE | IN_MODIFY);
-            $dir = true;
         } else {
             $watchId = inotify_add_watch($inotifyInit, $path, IN_MODIFY);
         }
 
         try {
-            $run = true;
-            while ($run) {
+            $read = [$inotifyInit];
+            $write = null;
+            $except = null;
+            $tvSec = $timeout === null ? null : 0;
+            $tvUsec = $timeout === null ? null : $timeout * 1000;
+
+            while (true) {
+                if (0 === stream_select($read, $write, $except, $tvSec, $tvUsec)) {
+                    $read = [$inotifyInit];
+                    continue;
+                }
+
                 $events = inotify_read($inotifyInit);
 
+                if (false === $events) {
+                    continue;
+                }
+
                 foreach ($events as $event) {
                     $code = null;
                     switch ($event['mask']) {
@@ -47,7 +69,9 @@ public function watch($path, callable $callback)
                             break;
                     }
 
-                    $run = false !== $callback(($dir ? $path : '').$event['name'], $code);
+                    if (false === $callback(($isDir ? $path : '').$event['name'], $code)) {
+                        break;
+                    }
                 }
             }
         } finally {
diff --git a/src/Symfony/Component/Filesystem/Watcher/WatcherInterface.php b/src/Symfony/Component/Filesystem/Watcher/WatcherInterface.php
@@ -13,5 +13,5 @@
 
 interface WatcherInterface
 {
-    public function watch($path, callable $callback);
+    public function watch($path, callable $callback, float $timeout = null);
 }

Original file line number	Diff line number	Diff line change
`@@ -732,18 +732,19 @@ public function appendToFile($filename, $content)`
`732`	`732`	`*`
`733`	`733`	`* @param mixed $path The path to watch for changes. Can be a path to a file or directory, iterator or array with paths`
`734`	`734`	`* @param callable $callback The callback to execute when a change is detected`
	`735`	`+ * @param float $timeout The time in milliseconds to wait between checking for changes (defaults to 1000 when inotify is not available)`
`735`	`736`	`*`
`736`		`- * @throws \InvalidArgumentException`
	`737`	`+ * @throws \InvalidArgumentException\|IOException`
`737`	`738`	`*/`
`738`		`- public function watch($path, callable $callback)`
	`739`	`+ public function watch($path, callable $callback, float $timeout = null)`
`739`	`740`	`{`
`740`	`741`	`if (\extension_loaded('inotify')) {`
`741`	`742`	`$watcher = new INotifyWatcher();`
`742`	`743`	`} else {`
`743`	`744`	`$watcher = new FileChangeWatcher();`
`744`	`745`	`}`
`745`	`746`
`746`		`- $watcher->watch($path, $callback);`
	`747`	`+ $watcher->watch($path, $callback, $timeout);`
`747`	`748`	`}`
`748`	`749`
`749`	`750`	`private function toIterable($files): iterable`
Original file line number	Diff line number	Diff line change
`@@ -25,8 +25,12 @@ public function __construct()`
`25`	`25`	`$this->locator = new FileResourceLocator();`
`26`	`26`	`}`
`27`	`27`
`28`		`- public function watch($path, callable $callback)`
	`28`	`+ public function watch($path, callable $callback, float $timeout = null)`
`29`	`29`	`{`
	`30`	`+ if (null === $timeout) {`
	`31`	`+ $timeout = 1000;`
	`32`	`+ }`
	`33`	`+`
`30`	`34`	`$resource = $this->locator->locate($path);`
`31`	`35`
`32`	`36`	`if (!$resource) {`
`@@ -42,7 +46,7 @@ public function watch($path, callable $callback)`
`42`	`46`	`}`
`43`	`47`	`}`
`44`	`48`
`45`		`- sleep(1);`
	`49`	`+ usleep($timeout * 1000);`
`46`	`50`	`}`
`47`	`51`	`}`
`48`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,5 @@`
`13`	`13`
`14`	`14`	`interface WatcherInterface`
`15`	`15`	`{`
`16`		`- public function watch($path, callable $callback);`
	`16`	`+ public function watch($path, callable $callback, float $timeout = null);`
`17`	`17`	`}`