Fix horizon capturing jobs (#125)

Author: timacdonald

.github/workflows/pull_request.yml

@@ -9,7 +9,7 @@ concurrency:
 
 env:
   minimum_supported_php_version: "8.2"
-  package_extensions: none, mbstring, curl, ctype, tokenizer, mongodb, xml, pdo, fileinfo, dom, xmlwriter, simplexml, sqlite3, pdo_sqlite
+  package_extensions: none, mbstring, curl, ctype, tokenizer, mongodb, xml, pdo, fileinfo, dom, xmlwriter, simplexml, sqlite3, pdo_sqlite, posix, redis
   agent_extensions: none, mbstring, curl, ctype, dom, simplexml, tokenizer, xml, xmlwriter
   client_extensions: none, mbstring, curl, ctype, dom, simplexml, tokenizer, xml, xmlwriter
 
@@ -337,6 +337,13 @@ jobs:
       - build_client
     if: ${{ (needs.build_agent.outputs.agent-committed == 'false') && (needs.build_client.outputs.client-committed == 'false') }}
 
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+        options: --entrypoint redis-server
+
     strategy:
       matrix:
         php: [8.2, 8.3]

composer.json

@@ -30,6 +30,7 @@
         "guzzlehttp/guzzle": "^7.0",
         "guzzlehttp/promises": "^2.0",
         "guzzlehttp/psr7": "^2.0",
+        "laravel/horizon": "^5.4",
         "laravel/pint": "1.21.0",
         "mockery/mockery": "^1.0",
         "mongodb/laravel-mongodb": "^5.0",

src/Hooks/CommandStartingListener.php

@@ -49,7 +49,7 @@ public function __invoke(CommandStarting $event): void
 
         try {
             match ($event->command) {
-                'queue:work', 'queue:listen' => $this->registerJobHooks(),
+                'queue:work', 'queue:listen', 'horizon:work' => $this->registerJobHooks(),
                 'schedule:run', 'schedule:work' => $this->registerScheduledTaskHooks(),
                 default => $this->registerCommandHooks(),
             };

testbench.yaml

@@ -1,6 +1,5 @@
 providers:
   - Laravel\Nightwatch\NightwatchServiceProvider
-  - App\Providers\AppServiceProvider
 
 workbench:
   start: '/'

tests/Feature/Sensors/CommandSensorTest.php

@@ -75,6 +75,7 @@
 it('filters out the list command')->todo();
 it('filters out the queue:work command')->todo();
 it('filters out the queue:listen command')->todo();
+it('filters out the horizon:work command')->todo();
 
 it('modifies status code to value in range of 0-255', function () {
     $ingest = fakeIngest();

tests/Feature/Sensors/JobAttemptSensorTest.php

@@ -12,6 +12,7 @@
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Mail;
+use Illuminate\Support\Facades\Redis;
 use Illuminate\Support\Str;
 
 use function Pest\Laravel\travelTo;
@@ -30,17 +31,30 @@
 
     setTraceId('0d3ca349-e222-4982-ac23-2343692de258');
     Config::set('queue.default', 'database');
+    Redis::command('FLUSHALL');
 })->skip(version_compare(Application::VERSION, '11.0.0', '<'), 'Laravel 10 support is pending');
 
-it('ingests processed job attempts', function () {
+$workCommands = [
+    'queue:work',
+    'horizon:work',
+];
+
+$workOptions = [
+    '--max-jobs' => 1,
+    '--sleep' => 0,
+    '--stop-when-empty' => true,
+    '--tries' => 1,
+];
+
+it('ingests processed job attempts', function ($workCommand) use ($workOptions) {
     $ingest = fakeIngest();
     Str::createUuidsUsingSequence([
         $jobId = 'e2cb5fa7-6c2e-4bc5-82c9-45e79c3e8fdd',
         $attemptId = '02cb9091-8973-427f-8d3f-042f2ec4e862',
     ]);
     ProcessedJob::dispatch();
 
-    Artisan::call('queue:work', ['--max-jobs' => 1, '--stop-when-empty' => true, '--sleep' => 0]);
+    Artisan::call($workCommand, $workOptions);
 
     $ingest->assertWrittenTimes(1);
     $ingest->assertLatestWrite('job-attempt:*', [
@@ -76,17 +90,17 @@
             'peak_memory_usage' => 1234,
         ],
     ]);
-});
+})->with($workCommands);
 
-it('ingests job released job attempts', function () {
+it('ingests job released job attempts', function ($workCommand) use ($workOptions) {
     $ingest = fakeIngest();
     Str::createUuidsUsingSequence([
         $jobId = 'e2cb5fa7-6c2e-4bc5-82c9-45e79c3e8fdd',
         $attemptId = '02cb9091-8973-427f-8d3f-042f2ec4e862',
     ]);
     ReleasedJob::dispatch();
 
-    Artisan::call('queue:work', ['--max-jobs' => 1, '--stop-when-empty' => true, '--sleep' => 0]);
+    Artisan::call($workCommand, $workOptions);
 
     $ingest->assertWrittenTimes(1);
     $ingest->assertLatestWrite('job-attempt:*', [
@@ -122,17 +136,17 @@
             'peak_memory_usage' => 1234,
         ],
     ]);
-});
+})->with($workCommands);
 
-it('ingests job failed job attempts', function () {
+it('ingests job failed job attempts', function ($workCommand) use ($workOptions) {
     $ingest = fakeIngest();
     Str::createUuidsUsingSequence([
         $jobId = 'e2cb5fa7-6c2e-4bc5-82c9-45e79c3e8fdd',
         $attemptId = '02cb9091-8973-427f-8d3f-042f2ec4e862',
     ]);
     FailedJob::dispatch();
 
-    Artisan::call('queue:work', ['--max-jobs' => 1, '--stop-when-empty' => true, '--sleep' => 0]);
+    Artisan::call($workCommand, $workOptions);
 
     $ingest->assertWrittenTimes(1);
     $ingest->assertLatestWrite('job-attempt:*', [
@@ -170,7 +184,7 @@
     ]);
     $ingest->assertLatestWrite('exception:0.execution_source', 'job');
     $ingest->assertLatestWrite('exception:0.execution_id', $attemptId);
-});
+})->with($workCommands);
 
 it('does not ingest jobs dispatched on the sync queue', function () {
     $ingest = fakeIngest();
@@ -179,7 +193,7 @@
     $ingest->assertWrittenTimes(0);
 });
 
-it('captures closure job', function () {
+it('captures closure job', function ($workCommand) use ($workOptions) {
     $ingest = fakeIngest();
     Str::createUuidsUsingSequence([
         $jobId = 'e2cb5fa7-6c2e-4bc5-82c9-45e79c3e8fdd',
@@ -190,7 +204,7 @@
         travelTo(now()->addMicroseconds(2500));
     });
 
-    Artisan::call('queue:work', ['--max-jobs' => 1, '--stop-when-empty' => true, '--sleep' => 0]);
+    Artisan::call($workCommand, $workOptions);
 
     $ingest->assertWrittenTimes(1);
     $ingest->assertLatestWrite('job-attempt:*', [
@@ -226,9 +240,9 @@
             'peak_memory_usage' => 1234,
         ],
     ]);
-});
+})->with($workCommands);
 
-it('captures queued event listener', function () {
+it('captures queued event listener', function ($workCommand) use ($workOptions) {
     $ingest = fakeIngest();
     Str::createUuidsUsingSequence([
         $jobId = 'e2cb5fa7-6c2e-4bc5-82c9-45e79c3e8fdd',
@@ -237,7 +251,7 @@
     Event::listen(MyEvent::class, MyEventListener::class);
     Event::dispatch(new MyEvent);
 
-    Artisan::call('queue:work', ['--max-jobs' => 1, '--stop-when-empty' => true, '--sleep' => 0]);
+    Artisan::call($workCommand, $workOptions);
 
     $ingest->assertWrittenTimes(1);
     $ingest->assertLatestWrite('job-attempt:*', [
@@ -273,9 +287,9 @@
             'peak_memory_usage' => 1234,
         ],
     ]);
-});
+})->with($workCommands);
 
-it('captures queued mail', function () {
+it('captures queued mail', function ($workCommand) use ($workOptions) {
     $ingest = fakeIngest();
     Str::createUuidsUsingSequence([
         $jobId = 'e2cb5fa7-6c2e-4bc5-82c9-45e79c3e8fdd',
@@ -285,7 +299,7 @@
 
     Mail::to('[email protected]')->queue(new MyQueuedMail);
 
-    Artisan::call('queue:work', ['--max-jobs' => 1, '--stop-when-empty' => true, '--sleep' => 0]);
+    Artisan::call($workCommand, $workOptions);
 
     $ingest->assertWrittenTimes(1);
     $ingest->assertLatestWrite('job-attempt:*', [
@@ -345,17 +359,17 @@
             'failed' => false,
         ],
     ]);
-});
+})->with($workCommands);
 
-it('captures multiple job attempts', function () {
+it('captures multiple job attempts', function ($workCommand) use ($workOptions) {
     $ingest = fakeIngest();
     FailedJob::dispatch();
 
-    Artisan::call('queue:work', ['--max-jobs' => 2, '--tries' => 2, '--stop-when-empty' => true, '--sleep' => 0]);
+    Artisan::call($workCommand, [...$workOptions, '--max-jobs' => 2, '--tries' => 2]);
 
     $ingest->assertWrittenTimes(2);
     $ingest->assertLatestWrite('job-attempt:0.attempt', 2);
-});
+})->with($workCommands);
 
 final class ProcessedJob implements ShouldQueue
 {

workbench/bootstrap/providers.php

@@ -0,0 +1,6 @@
+<?php
+
+return [
+    \App\Providers\AppServiceProvider::class,
+    \Laravel\Horizon\HorizonServiceProvider::class,
+];