Merge pull request #47 from seregazhuk/detecting-script-exit

Support for watching script exit

Author: seregazhuk

README.md

@@ -209,6 +209,15 @@ function terminationHandler()
 
 By default PHP-watcher sends `SIGINT` signal.
 
+## Automatic restart
+
+PHP-watcher was originally written to restart long-running processes such as web servers, but 
+it also supports apps that cleanly exit. If your script exits cleanly, the watcher will continue 
+to monitor the directory (or directories) and restart the script if there are any changes. If the
+script crashes PHP-watcher will notify you about that.
+
+![app exit](images/exit.svg)
+
 # License
 
 MIT [http://rem.mit-license.org](http://rem.mit-license.org)

images/exit.svg

@@ -53,6 +53,12 @@ private function info(string $text): void
         $this->output->writeln($text);
     }
 
+    private function warning(string $text): void
+    {
+        $text = sprintf('<fg=red>%s</>', $this->message($text));
+        $this->output->writeln($text);
+    }
+
     public function start(string $command): void
     {
         $command = str_replace('exec', '', $command);
@@ -78,6 +84,14 @@ public function subscribeToProcessOutput(Process $process): void
         $process->stderr->on('data', static function ($data) {
             echo $data;
         });
+
+        $process->on('exit', function($exitCode) {
+            if ($exitCode === 0) {
+                $this->info('clean exit - waiting for changes before restart');
+            } else {
+                $this->warning('app crashed - waiting for file changes before starting...');
+            }
+        });
     }
 
     public function showSpinner(LoopInterface $loop): void

src/Screen.php

@@ -45,6 +45,7 @@ private function startProcess(Process $process): void
     private function restartProcess(Process $process, int $signal, float $delayToRestart): void
     {
         $process->terminate($signal);
+        $process->removeAllListeners();
         $this->screen->restarting($process->getCommand());
 
         $this->loop->addTimer($delayToRestart, function () use ($process) {

src/Watcher/Watcher.php

@@ -24,6 +24,14 @@ public static function createHelloWorldPHPFile(): string
         return $name;
     }
 
+    public static function createPHPFileThatCrashes(): string
+    {
+        $name = self::FIXTURES_DIR . 'test.php';
+        self::createFile($name, '<?php exit(1);');
+
+        return $name;
+    }
+
     public static function createStdErrorPHPFile(): string
     {
         $name = self::FIXTURES_DIR . 'test.php';

tests/Helper/Filesystem.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types=1);
+
+namespace tests;
+
+use tests\Helper\Filesystem;
+use tests\Helper\WatcherRunner;
+use tests\Helper\WatcherTestCase;
+
+final class ScriptExitTest extends WatcherTestCase
+{
+    /** @test */
+    public function it_detects_when_script_exits(): void
+    {
+        $fileToWatch = Filesystem::createHelloWorldPHPFile();
+        $watcher = (new WatcherRunner)->run($fileToWatch, ['--watch', $fileToWatch]);
+        $this->wait();
+
+        $this->assertStringContainsString('clean exit - waiting for changes before restart', $watcher->getOutput());
+    }
+
+    /** @test */
+    public function it_detects_when_script_crashes(): void
+    {
+        $fileToWatch = Filesystem::createPHPFileThatCrashes();
+        $watcher = (new WatcherRunner)->run($fileToWatch, ['--watch', $fileToWatch]);
+        $this->wait();
+
+        $this->assertStringContainsString('app crashed - waiting for file changes before starting', $watcher->getOutput());
+    }
+}