Require laravel horizon and add failed jobs command

Author: codebarista

.gitignore

@@ -1,4 +1,4 @@
+/composer.lock
 /vendor
-composer.lock
+.vscode
 .idea
-

composer.json

@@ -16,11 +16,14 @@
     ],
     "require": {
         "php": "^8.3",
+        "ext-redis": "*",
         "laravel/framework": "^10.0",
-        "spatie/laravel-health": "^1.20"
+        "laravel/horizon": "^5.0",
+        "spatie/laravel-health": "^1.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^v8.21",
+        "laravel/pint": "^1.0",
+        "orchestra/testbench": "^8.0",
         "pestphp/pest-plugin-laravel": "^2.0"
     },
     "suggest": {

phpunit.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          stopOnFailure="true"
          cacheResult="false"
@@ -16,4 +15,7 @@
             <directory suffix=".php">./src</directory>
         </include>
     </source>
+    <php>
+        <server name="REDIS_CLIENT" value="phpredis"/>
+    </php>
 </phpunit>

src/Console/Commands/FailedJobs.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace Codebarista\LaravelEssentials\Console\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Contracts\Console\Isolatable;
+use Illuminate\Contracts\Console\PromptsForMissingInput;
+use Illuminate\Support\Str;
+use Laravel\Horizon\Jobs\RetryFailedJob;
+use Laravel\Horizon\Repositories\RedisJobRepository;
+
+use function dispatch;
+
+class FailedJobs extends Command implements Isolatable, PromptsForMissingInput
+{
+    /**
+     * @var string
+     */
+    protected $signature = 'codebarista:failed-jobs {action : The action: retry or delete}';
+
+    /**
+     * @var string
+     */
+    protected $description = 'Retry or delete all failed jobs.';
+
+    public function handle(RedisJobRepository $repository): int
+    {
+        return match ($this->argument('action')) {
+            'delete' => $this->deleteFailedJobs($repository),
+            'retry' => $this->retryFailedJobs($repository),
+            default => self::INVALID,
+        };
+    }
+
+    private function deleteFailedJobs(RedisJobRepository $repository): int
+    {
+        if (! $this->confirm('Really delete all failed jobs?')) {
+            $this->components->info('Process terminated by user');
+
+            return self::SUCCESS;
+        }
+
+        $i = $repository->getFailed()->count();
+
+        // What a hack...but it works
+        $repository->recentFailedJobExpires = 0;
+        $repository->trimRecentJobs();
+
+        $repository->failedJobExpires = 0;
+        $repository->trimFailedJobs();
+
+        $this->components->info(
+            sprintf('%d %s deleted.', $i, Str::plural(' job', $i))
+        );
+
+        return self::SUCCESS;
+    }
+
+    private function retryFailedJobs(RedisJobRepository $repository): int
+    {
+        if (! $this->confirm('Really retry all failed jobs?')) {
+            $this->components->info('Process terminated by user');
+
+            return self::SUCCESS;
+        }
+
+        $i = $repository->getFailed()->each(function ($job) {
+            dispatch(new RetryFailedJob($job->id));
+        })->count();
+
+        $this->components->info(
+            sprintf('%d %s retried.', $i, Str::plural(' job', $i))
+        );
+
+        return self::SUCCESS;
+    }
+}

src/EssentialsServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace Codebarista\LaravelEssentials;
 
+use Codebarista\LaravelEssentials\Console\Commands\FailedJobs;
 use Illuminate\Support\Arr;
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Support\Str;
@@ -12,6 +13,9 @@ public function register(): void
     {
         $this->registerStringMacros();
         $this->registerArrayMacros();
+        $this->commands([
+            FailedJobs::class,
+        ]);
     }
 
     public function boot(): void

tests/Feature/FailedJobsTest.php

@@ -0,0 +1,39 @@
+<?php
+
+it('returns invalid', function () {
+    $this->artisan('codebarista:failed-jobs')
+        ->expectsQuestion('What is the action: retry or delete?', 'invalid')
+        ->assertExitCode(2);
+});
+
+it('aborts retry failed jobs', function () {
+    $this->artisan('codebarista:failed-jobs')
+        ->expectsQuestion('What is the action: retry or delete?', 'retry')
+        ->expectsConfirmation('Really retry all failed jobs?')
+        ->expectsOutputToContain('Process terminated by user')
+        ->assertExitCode(0);
+});
+
+it('aborts delete failed jobs', function () {
+    $this->artisan('codebarista:failed-jobs')
+        ->expectsQuestion('What is the action: retry or delete?', 'delete')
+        ->expectsConfirmation('Really delete all failed jobs?')
+        ->expectsOutputToContain('Process terminated by user')
+        ->assertExitCode(0);
+});
+
+it('retries failed jobs', function () {
+    $this->artisan('codebarista:failed-jobs')
+        ->expectsQuestion('What is the action: retry or delete?', 'retry')
+        ->expectsConfirmation('Really retry all failed jobs?', 'yes')
+        ->expectsOutputToContain('jobs retried')
+        ->assertExitCode(0);
+});
+
+it('deletes failed jobs', function () {
+    $this->artisan('codebarista:failed-jobs')
+        ->expectsQuestion('What is the action: retry or delete?', 'delete')
+        ->expectsConfirmation('Really delete all failed jobs?', 'yes')
+        ->expectsOutputToContain('jobs deleted')
+        ->assertExitCode(0);
+});

tests/PackageTestCase.php

@@ -5,6 +5,7 @@
 namespace Codebarista\LaravelEssentials\Tests;
 
 use Codebarista\LaravelEssentials\EssentialsServiceProvider;
+use Laravel\Horizon\HorizonServiceProvider;
 use Orchestra\Testbench\TestCase;
 
 abstract class PackageTestCase extends TestCase
@@ -13,6 +14,12 @@ protected function getPackageProviders($app): array
     {
         return [
             EssentialsServiceProvider::class,
+            HorizonServiceProvider::class,
         ];
     }
+
+    protected function getEnvironmentSetUp($app): void
+    {
+        $app['config']->set('queue.default', 'redis');
+    }
 }