File watching in development environments

config/nativephp.php

@@ -126,6 +126,10 @@
         ],
     ],
 
+    'on_php_file_change' => [
+        \Native\Laravel\Pipelines\ProjectFileChanged\RestartQueueWorkers::class,
+    ],
+
     /**
      * Define your own scripts to run before and after the build process.
      */

src/Events/App/ProjectFileChanged.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Native\Laravel\Events\App;
+
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcastNow;
+use Illuminate\Foundation\Events\Dispatchable;
+
+class ProjectFileChanged implements ShouldBroadcastNow
+{
+    use Dispatchable, InteractsWithSockets;
+
+    public function __construct(public readonly string $relativePath) {}
+
+    public function broadcastOn()
+    {
+        return [
+            new Channel('nativephp'),
+        ];
+    }
+}

src/Listeners/ProjectFileChangedListener.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Native\Laravel\Listeners;
+
+use Illuminate\Support\Facades\Pipeline;
+use Native\Laravel\Events\App\ProjectFileChanged;
+use Webmozart\Assert\Assert;
+
+class ProjectFileChangedListener
+{
+    public function handle(ProjectFileChanged $event): void
+    {
+        foreach ($pipelines = config('nativephp.on_php_file_change') as $class) {
+            Assert::classExists($class, "Class {$class} does not exist");
+        }
+
+        Pipeline::send($event)->through($pipelines)->thenReturn();
+    }
+}

src/NativeServiceProvider.php

@@ -3,6 +3,7 @@
 namespace Native\Laravel;
 
 use Illuminate\Console\Application;
+use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Foundation\Application as Foundation;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Artisan;
@@ -19,9 +20,11 @@
 use Native\Laravel\Contracts\QueueWorker as QueueWorkerContract;
 use Native\Laravel\Contracts\WindowManager as WindowManagerContract;
 use Native\Laravel\DTOs\QueueConfig;
+use Native\Laravel\Events\App\ProjectFileChanged;
 use Native\Laravel\Events\EventWatcher;
 use Native\Laravel\Exceptions\Handler;
 use Native\Laravel\GlobalShortcut as GlobalShortcutImplementation;
+use Native\Laravel\Listeners\ProjectFileChangedListener;
 use Native\Laravel\Logging\LogWatcher;
 use Native\Laravel\PowerMonitor as PowerMonitorImplementation;
 use Native\Laravel\Windows\WindowManager as WindowManagerImplementation;
@@ -97,6 +100,8 @@ public function packageRegistered()
 
     public function bootingPackage()
     {
+        $this->app->make(Dispatcher::class)->listen(ProjectFileChanged::class, ProjectFileChangedListener::class);
+
         if (config('nativephp-internal.running')) {
             $this->rewriteDatabase();
         }

src/Pipelines/ProjectFileChanged/RestartQueueWorkers.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Native\Laravel\Pipelines\ProjectFileChanged;
+
+use Closure;
+use Native\Laravel\Contracts\QueueWorker;
+use Native\Laravel\DTOs\QueueConfig;
+use Native\Laravel\Events\App\ProjectFileChanged;
+
+class RestartQueueWorkers
+{
+    public function __construct(
+        private readonly QueueWorker $queueWorker,
+    ) {}
+
+    public function __invoke(ProjectFileChanged $event, Closure $next): ProjectFileChanged
+    {
+        $queueConfigs = QueueConfig::fromConfigArray(config('nativephp.queue_workers'));
+
+        foreach ($queueConfigs as $queueConfig) {
+            $this->queueWorker->down($queueConfig->alias);
+        }
+
+        return $next($event);
+    }
+}

tests/Fixtures/Fakes/FakePipeline.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Native\Laravel\Tests\Fixtures\Fakes;
+
+use Closure;
+
+class FakePipeline
+{
+    public bool $handled = false;
+
+    public mixed $carry;
+
+    public function handle(mixed $carry, Closure $next)
+    {
+        $this->handled = true;
+        $this->carry = $carry;
+
+        return $next($carry);
+    }
+}

tests/Listeners/ProjectFileChangedListenerTest.php

@@ -0,0 +1,35 @@
+<?php
+
+use Illuminate\Contracts\Events\Dispatcher;
+use Native\Laravel\Events\App\ProjectFileChanged;
+use Native\Laravel\Tests\Fixtures\Fakes\FakePipeline;
+use Webmozart\Assert\InvalidArgumentException as WebmozartInvalidArgumentException;
+
+it('listens for the project file changed event and runs configured pipelines', function () {
+    app()->singleton(FakePipeline::class, fn () => $fake = new FakePipeline);
+
+    config(['nativephp.on_php_file_change' => [
+        FakePipeline::class,
+    ]]);
+
+    app(Dispatcher::class)->dispatch(new ProjectFileChanged('some/file.php'));
+
+    expect(app(FakePipeline::class)->handled)->toBeTrue();
+    expect(app(FakePipeline::class)->carry)->toBeInstanceOf(ProjectFileChanged::class);
+});
+
+it('rejects nonexistent classes', function () {
+    config(['nativephp.on_php_file_change' => [
+        'definitely-not-a-class-fqcn',
+    ]]);
+
+    try {
+        app(Dispatcher::class)->dispatch(new ProjectFileChanged('some/file.php'));
+    } catch (WebmozartInvalidArgumentException $e) {
+        expect($e->getMessage())->toBe('Class definitely-not-a-class-fqcn does not exist');
+
+        return;
+    }
+
+    $this->fail('Expected an exception to be thrown');
+});

tests/Pipelines/ProjectFileChanged/RestartQueueWorkersTest.php

@@ -0,0 +1,22 @@
+<?php
+
+use Illuminate\Support\Facades\Pipeline;
+use Native\Laravel\Events\App\ProjectFileChanged;
+use Native\Laravel\Facades\QueueWorker;
+use Native\Laravel\Pipelines\ProjectFileChanged\RestartQueueWorkers;
+
+it('restarts configured queue workers', function () {
+    QueueWorker::fake();
+
+    config(['nativephp.queue_workers' => [
+        'something' => [],
+        'another' => [],
+    ]]);
+
+    Pipeline::send(new ProjectFileChanged('some/file.php'))
+        ->through([RestartQueueWorkers::class])
+        ->thenReturn();
+
+    QueueWorker::assertDown('something');
+    QueueWorker::assertDown('another');
+});