Add fallback JobReleasedAfterException event

Author: marickvantuil

composer.json

@@ -36,5 +36,23 @@
                 "Stackkit\\LaravelGoogleCloudTasksQueue\\CloudTasksServiceProvider"
             ]
         }
+    },
+    "scripts": {
+        "l9": [
+            "composer require laravel/framework:9.* orchestra/testbench:7.* --no-interaction --no-update",
+            "composer update --prefer-stable --prefer-dist --no-interaction --no-suggest"
+        ],
+        "l8": [
+            "composer require laravel/framework:8.* orchestra/testbench:6.* --no-interaction --no-update",
+            "composer update --prefer-stable --prefer-dist --no-interaction --no-suggest"
+        ],
+        "l7": [
+            "composer require laravel/framework:7.* orchestra/testbench:5.* --no-interaction --no-update",
+            "composer update --prefer-stable --prefer-dist --no-interaction --no-suggest"
+        ],
+        "l6": [
+            "composer require laravel/framework:6.* orchestra/testbench:4.* --no-interaction --no-update",
+            "composer update --prefer-stable --prefer-dist --no-interaction --no-suggest"
+        ]
     }
 }

src/CloudTasksJob.php

@@ -111,5 +111,17 @@ public function release($delay = 0)
         parent::release();
 
         $this->cloudTasksQueue->release($this, $delay);
+
+        // The package uses the JobReleasedAfterException provided by Laravel to grab
+        // the payload of the released job in tests to easily run and test a released
+        // job. Because the event is only accessible in Laravel 9.x, we create an
+        // identical event to hook into for Laravel versions older than 9.x
+        if (version_compare(app()->version(), '9.0.0', '<')) {
+            $properties = TaskHandler::getCommandProperties($this->job['data']['command']);
+
+            $connection = $properties['connection'] ?? config('queue.default');
+
+            app('events')->dispatch(new JobReleasedAfterException($connection, $this));
+        }
     }
 }

src/JobReleasedAfterException.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stackkit\LaravelGoogleCloudTasksQueue;
+
+use Illuminate\Contracts\Queue\Job;
+
+class JobReleasedAfterException
+{
+    /**
+     * The connection name.
+     *
+     * @var string
+     */
+    public string $connectionName;
+
+    /**
+     * The job instance.
+     *
+     * @var Job
+     */
+    public Job $job;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param  string  $connectionName
+     * @param  Job  $job
+     * @return void
+     */
+    public function __construct(string $connectionName, Job $job)
+    {
+        $this->job = $job;
+        $this->connectionName = $connectionName;
+    }
+}

tests/QueueTest.php

@@ -176,7 +176,9 @@ public function it_can_dispatch_after_commit_inline()
         DB::beginTransaction();
         SimpleJob::dispatch()->afterCommit();
         Event::assertNotDispatched(JobQueued::class);
-        DB::commit();
+        while (DB::transactionLevel() !== 0) {
+            DB::commit();
+        }
         Event::assertDispatched(JobQueued::class, function (JobQueued $event) {
             return $event->job instanceof SimpleJob;
         });
@@ -201,7 +203,9 @@ public function it_can_dispatch_after_commit_through_config()
         DB::beginTransaction();
         SimpleJob::dispatch();
         Event::assertNotDispatched(JobQueued::class);
-        DB::commit();
+        while (DB::transactionLevel() !== 0) {
+            DB::commit();
+        }
         Event::assertDispatched(JobQueued::class, function (JobQueued $event) {
             return $event->job instanceof SimpleJob;
         });

tests/TaskHandlerTest.php

@@ -7,17 +7,14 @@
 use Google\Protobuf\Duration;
 use Illuminate\Queue\Events\JobProcessed;
 use Illuminate\Queue\Events\JobProcessing;
-use Illuminate\Queue\Events\JobReleasedAfterException;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Log;
-use Illuminate\Validation\ValidationException;
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksApi;
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksException;
 use Stackkit\LaravelGoogleCloudTasksQueue\LogFake;
 use Stackkit\LaravelGoogleCloudTasksQueue\OpenIdVerificator;
 use Stackkit\LaravelGoogleCloudTasksQueue\StackkitCloudTask;
 use Stackkit\LaravelGoogleCloudTasksQueue\TaskHandler;
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Tests\Support\EncryptedJob;
 use Tests\Support\FailingJob;
 use Tests\Support\SimpleJob;
@@ -417,7 +414,7 @@ public function failing_jobs_are_released()
         CloudTasksApi::partialMock()->shouldReceive('getRetryConfig')->andReturn(
             (new RetryConfig())->setMaxAttempts(3)
         );
-        Event::fake([JobReleasedAfterException::class]);
+        Event::fake($this->getJobReleasedAfterExceptionEvent());
 
         // Act
         $job = $this->dispatch(new FailingJob());
@@ -431,7 +428,7 @@ public function failing_jobs_are_released()
         CloudTasksApi::assertDeletedTaskCount(1);
         CloudTasksApi::assertCreatedTaskCount(2);
         CloudTasksApi::assertTaskDeleted($job->task->getName());
-        Event::assertDispatched(JobReleasedAfterException::class, function ($event) {
+        Event::assertDispatched($this->getJobReleasedAfterExceptionEvent(), function ($event) {
             return $event->job->attempts() === 1;
         });
     }
@@ -444,21 +441,21 @@ public function attempts_are_tracked_internally()
         // Arrange
         CloudTasksApi::fake();
         OpenIdVerificator::fake();
-        Event::fake([JobReleasedAfterException::class]);
+        Event::fake($this->getJobReleasedAfterExceptionEvent());
 
         // Act & Assert
         $job = $this->dispatch(new FailingJob());
         $job->run();
         $releasedJob = null;
 
-        Event::assertDispatched(JobReleasedAfterException::class, function ($event) use (&$releasedJob) {
+        Event::assertDispatched($this->getJobReleasedAfterExceptionEvent(), function ($event) use (&$releasedJob) {
             $releasedJob = $event->job->getRawBody();
             return $event->job->attempts() === 1;
         });
 
         $this->runFromPayload($releasedJob);
 
-        Event::assertDispatched(JobReleasedAfterException::class, function ($event) {
+        Event::assertDispatched($this->getJobReleasedAfterExceptionEvent(), function ($event) {
             return $event->job->attempts() === 2;
         });
     }

tests/TestCase.php

@@ -5,16 +5,13 @@
 use Closure;
 use Firebase\JWT\JWT;
 use Google\ApiCore\ApiException;
-use Google\Cloud\Tasks\V2\Queue;
-use Google\Cloud\Tasks\V2\RetryConfig;
 use Google\Cloud\Tasks\V2\Task;
 use Illuminate\Foundation\Testing\DatabaseTransactions;
 use Illuminate\Queue\Events\JobReleasedAfterException;
 use Illuminate\Support\Facades\DB;
 use Google\Cloud\Tasks\V2\CloudTasksClient;
 use Illuminate\Support\Facades\Event;
-use Mockery;
-use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksJob;
+use Stackkit\LaravelGoogleCloudTasksQueue\JobReleasedAfterException as PackageJobReleasedAfterException;
 use Stackkit\LaravelGoogleCloudTasksQueue\TaskCreated;
 use Stackkit\LaravelGoogleCloudTasksQueue\TaskHandler;
 
@@ -38,8 +35,8 @@ protected function setUp(): void
         $this->defaultHeaders['Authorization'] = 'Bearer ' . encrypt(time() + 10);
 
         Event::listen(
-            JobReleasedAfterException::class,
-            function (JobReleasedAfterException $event) {
+            $this->getJobReleasedAfterExceptionEvent(),
+            function ($event) {
                 $this->releasedJobPayload = $event->job->getRawBody();
             }
         );
@@ -238,4 +235,14 @@ protected function assertDatabaseCount($table, int $count, $connection = null)
     {
         $this->assertEquals($count, DB::connection($connection)->table($table)->count());
     }
+
+    public function getJobReleasedAfterExceptionEvent(): string
+    {
+        // The JobReleasedAfterException event is not available in Laravel versions
+        // below 9.x so instead for those versions we throw our own event which
+        // is identical to the Laravel one.
+        return version_compare(app()->version(), '9.0.0', '<')
+            ? PackageJobReleasedAfterException::class
+            : JobReleasedAfterException::class;
+    }
 }