Merge pull request #68 from seregazhuk/use-fswatch

Use different fs watchers

Author: seregazhuk

.github/workflows/security.yml

@@ -36,7 +36,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: dom, sockets, grpc, curl
+          extensions: pcntl
 
       - name: Check Out Code
         uses: actions/checkout@v4

.github/workflows/tests-chokidar.yml

@@ -0,0 +1,70 @@
+name: 'Tests with Chokidar'
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '.gitignore'
+      - 'CHANGELOG.md'
+      - 'LICENSE'
+      - 'README.md'
+
+  pull_request:
+    paths-ignore:
+      - '.gitignore'
+      - 'CHANGELOG.md'
+      - 'LICENSE'
+      - 'README.md'
+
+jobs:
+  tests:
+    timeout-minutes: 5
+    name: Tests with Chokidar (PHP ${{ matrix.php }}, OS ${{ matrix.os }})
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        php: [8.1, 8.2, 8.3, 8.4]
+
+    env:
+      extensions: xdebug
+
+    steps:
+      - name: Check Out Code
+        uses: actions/checkout@v4
+
+      - name: Remove fswatch
+        run: sudo apt-get remove fswatch
+
+      - name: Setup node
+        uses: actions/setup-node@v6
+
+      - name: Install chokidar
+        run: npm install chokidar
+
+      - name: Setup PHP ${{ matrix.php }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: pcntl
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Install dependencies with composer
+        uses: ramsey/composer-install@v3
+        with:
+          dependency-versions: ${{ matrix.dependencies }}
+
+      - name: Validate lowest dependencies
+        if: matrix.dependencies == 'lowest' && matrix.php == '8.1'
+        env:
+          COMPOSER_POOL_OPTIMIZER: 0
+        run: vendor/bin/validate-prefer-lowest
+
+      - name: Run tests with Phpunit
+        run: |
+          XDEBUG_MODE=coverage php vendor/bin/phpunit 

.github/workflows/tests.yml .github/workflows/tests-fswatch.yml.github/workflows/tests.yml renamed to .github/workflows/tests-fswatch.yml

@@ -1,4 +1,4 @@
-name: 'Tests'
+name: 'Tests with FsWatch'
 
 on:
   push:
@@ -18,28 +18,31 @@ on:
       - 'README.md'
 
 jobs:
-  tests:
-    name: Tests (PHP ${{ matrix.php }}, OS ${{ matrix.os }})
+  tests-fswatch:
+    timeout-minutes: 5
+    name: Tests with FsWatch (PHP ${{ matrix.php }}, OS ${{ matrix.os }})
 
     runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
-        os: [ubuntu-latest]
+        os: [macos-latest ]
         php: [8.1, 8.2, 8.3, 8.4]
-
     env:
       extensions: xdebug
 
     steps:
       - name: Check Out Code
         uses: actions/checkout@v4
 
+      - name: Install fswatch
+        run: brew install fswatch
+
       - name: Setup PHP ${{ matrix.php }}
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: dom, sockets, grpc, curl ${{ matrix.extensions-suffix }}
+          extensions: pcntl
 
       - name: Validate composer.json and composer.lock
         run: composer validate --strict
@@ -57,4 +60,4 @@ jobs:
 
       - name: Run tests with Phpunit
         run: |
-          XDEBUG_MODE=coverage php vendor/bin/phpunit --testsuite unit
+          php vendor/bin/phpunit

README.md

@@ -35,6 +35,7 @@ PHP-watcher does not require any additional changes to your code or method of
 * [Default executable](#default-executable)
 * [Gracefully reloading down your script](#gracefully-reloading-down-your-script)
 * [Automatic restart](#automatic-restart)
+* [Performance](#performance)
 * [Spinner](#spinner)
 
 ## Installation
@@ -55,9 +56,6 @@ composer require seregazhuk/php-watcher --dev
 ```
 Locally installed you can run it with `vendor/bin/php-watcher`.
 
-Under the hood, to watch filesystem changes, PHP-watcher uses JavaScript package [chokidar](https://github.com/paulmillr/chokidar).
-At first run it will check and install it if required.
-
 ## Usage
 
 All the examples assume you've installed the package globally. If you opted for the local installation prepend `vendor/bin/` everywhere where `php-watcher` is mentioned.
@@ -236,9 +234,28 @@ script crashes PHP-watcher will notify you about that.
 
 ![app exit](images/exit.svg)
 
+## Performance
+
+The watcher can use different strategies to monitor your file system changes. Under the hood it 
+detects the environment and chooses the best suitable strategy.
+
+### Fswatch (OSX only)
+
+[FsWatch](https://github.com/emcrisostomo/fswatch) is a cross-platform (Linux,Mac,Windows) file change monitor that will automatically
+use the platforms native functionality when possible. Under the hood the filesystem notifies us
+when any changes occur. Currently, it [doesn't work correctly on Linux](https://github.com/emcrisostomo/fswatch/issues/247). 
+If your system is OSx and has fswatch installed, this strategy will be used.
+
+**Has not been extensively tested.**
+
+### Chokidar
+
+[Chokidar](https://github.com/paulmillr/chokidar) is a JavaScript package for watching file and directory changes.
+At first run the watcher will check if Node.js is available in the system. If it is, it will install chokidar into the project.
+
 ## Spinner
 
-By default the watcher outputs a nice spinner which indicates that the process is running
+By default, the watcher outputs a nice spinner which indicates that the process is running
 and watching your files. But if your system doesn't support ansi coded the watcher
 will try to detect it and disable the spinner. Or you can always disable the spinner
 manually with option '--no-spinner':

composer.json

@@ -31,9 +31,10 @@
         "react/child-process": "^0.6.1",
         "react/event-loop": "^1.1",
         "react/stream": "^1.0.0",
-        "spatie/file-system-watcher": "^1.2",
+        "seregazhuk/reactphp-fswatch": "^1.1.1",
         "symfony/console": "^6.0",
         "symfony/finder": "^6.0",
+        "symfony/process": "^6.0",
         "symfony/yaml": "^6.0"
     },
     "autoload": {

phpunit.xml.dist

@@ -6,19 +6,16 @@
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
-         stopOnFailure="true"
+         stopOnFailure="false"
          bootstrap="vendor/autoload.php">
     <testsuites>
         <testsuite name="Common">
-            <directory suffix="Test.php">tests</directory>
+            <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
     <filter>
         <whitelist processUncoveredFilesFromWhitelist="true">
             <directory suffix=".php">src</directory>
-            <exclude>
-                <file>src/Filesystem/watcher.php</file>
-            </exclude>
         </whitelist>
     </filter>
 </phpunit>

src/Filesystem/ChangesListener.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace seregazhuk\PhpWatcher\Filesystem\ChangesListener;
+
+use seregazhuk\PhpWatcher\Config\WatchList;
+
+interface ChangesListenerInterface
+{
+    public function start(WatchList $watchList): void;
+
+    public function onChange(callable $callback): void;
+
+    public function stop(): void;
+
+    public function getName(): string;
+}

src/Filesystem/ChangesListener/ChangesListenerInterface.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace seregazhuk\PhpWatcher\Filesystem\ChangesListener;
+
+use Evenement\EventEmitter;
+use React\EventLoop\LoopInterface;
+use React\EventLoop\TimerInterface;
+use seregazhuk\PhpWatcher\Config\WatchList;
+use Symfony\Component\Process\ExecutableFinder;
+use Symfony\Component\Process\Process;
+
+final class ChokidarChangesListener extends EventEmitter implements ChangesListenerInterface
+{
+    private const INTERVAL = 0.15;
+
+    private ?Process $process = null;
+
+    private ?TimerInterface $timer = null;
+
+    public function __construct(private readonly LoopInterface $loop) {}
+
+    public function start(WatchList $watchList): void
+    {
+        $command = [
+            (new ExecutableFinder)->find('node'),
+            realpath(__DIR__.'/../../../bin/file-watcher.js'),
+            json_encode($watchList->getPaths()),
+            json_encode($watchList->getIgnored()),
+            json_encode($watchList->getFileExtensions()),
+        ];
+
+        $this->process = new Process(command: $command);
+        $this->process->start();
+
+        $this->timer = $this->loop->addPeriodicTimer(
+            self::INTERVAL,
+            function (): void {
+                $output = $this->process->getIncrementalOutput();
+                if ($output !== '') {
+                    $this->emit('change');
+                }
+            }
+        );
+    }
+
+    public function onChange(callable $callback): void
+    {
+        $this->on('change', $callback);
+    }
+
+    public function stop(): void
+    {
+        if ($this->process instanceof Process && $this->process->isRunning()) {
+            $this->process->stop();
+        }
+
+        if ($this->timer instanceof TimerInterface) {
+            $this->loop->cancelTimer($this->timer);
+        }
+    }
+
+    public function getName(): string
+    {
+        return 'chokidar';
+    }
+}