Add initial draft of job releasing

Author: marickvantuil

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 3.?.0 - ????-??-??
+
+**Added**
+
+- Jobs can now be released back onto the queue.
+
 ## 3.2.1 - 2022-09-02
 
 **Fixed**

README.md

@@ -79,13 +79,19 @@ Please check the table below on what the values mean and what their value should
 </details>
 <details>
 <summary>
-  How it works
+  How it works & Differences
 </summary>
   <br>
   Using Cloud Tasks as a Laravel queue driver is fundamentally different than other Laravel queue drivers, like Redis.
 
 Typically a Laravel queue has a worker that listens to incoming jobs using the `queue:work` / `queue:listen` command.
 With Cloud Tasks, this is not the case. Instead, Cloud Tasks will schedule the job for you and make an HTTP request to your application with the job payload. There is no need to run a `queue:work/listen` command.
+
+#### Good to know
+
+- The "Min backoff" and "Max backoff" options in Cloud Tasks are ignored. This is intentional: Laravel has its own backoff feature (which is more powerful than what Cloud Tasks offers) and therefore I have chosen that over the Cloud Tasks one.
+- Similarly to the backoff feature, I have also chosen to let the package do job retries the 'Laravel way'. In Cloud Tasks, when a task throws an exception, Cloud Tasks will decide for itself when to retry the task (based on the backoff values). It will also manage its own state and knows how many times a task has been retried. This is different from Laravel. In typical Laravel queues, when a job throws an exception, the job is deleted and released back onto the queue. In order to support Laravel's backoff feature, this package must behave the same way about job retries.
+
 </details>
 <details>
   <summary>Dashboard (beta)</summary>

src/CloudTasksApiFake.php

@@ -91,4 +91,9 @@ public function assertTaskCreated(Closure $closure): void
 
         Assert::assertTrue($count > 0, 'Task was not created.');
     }
+
+    public function assertCreatedTaskCount(int $count): void
+    {
+        Assert::assertCount($count, $this->createdTasks);
+    }
 }

src/CloudTasksJob.php

@@ -95,4 +95,11 @@ public function delete(): void
 
         $this->cloudTasksQueue->delete($this);
     }
+
+    public function release($delay = 0)
+    {
+        parent::release();
+
+        $this->cloudTasksQueue->release($this, $delay);
+    }
 }

src/CloudTasksQueue.php

@@ -93,7 +93,9 @@ function ($payload, $queue) {
      */
     public function pushRaw($payload, $queue = null, array $options = [])
     {
-        return $this->pushToCloudTasks($queue, $payload);
+        $delay = ! empty($options['delay']) ? $options['delay'] : 0;
+
+        $this->pushToCloudTasks($queue, $payload, $delay);
     }
 
     /**
@@ -217,6 +219,17 @@ public function delete(CloudTasksJob $job): void
         CloudTasksApi::deleteTask($taskName);
     }
 
+    public function release(CloudTasksJob $job, int $delay = 0): void
+    {
+        $job->delete();
+
+        $payload = $job->getRawBody();
+
+        $options = ['delay' => $delay];
+
+        $this->pushRaw($payload, $job->getQueue(), $options);
+    }
+
     private function createTask(): Task
     {
         return app(Task::class);

src/TaskHandler.php

@@ -7,6 +7,7 @@
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Encryption\Encrypter;
 use Illuminate\Queue\Jobs\Job;
+use Illuminate\Queue\QueueManager;
 use Illuminate\Queue\WorkerOptions;
 use Illuminate\Support\Str;
 use Illuminate\Validation\ValidationException;
@@ -102,11 +103,14 @@ private function loadQueueConnectionConfiguration(array $task): void
          * @var stdClass $command
          */
         $command = self::getCommandProperties($task['data']['command']);
-        $connection = $command['connection'] ?? config('queue.default');
-        $this->config = array_merge(
-            (array) config("queue.connections.{$connection}"),
-            ['connection' => $connection]
-        );
+        $connection = $command->connection ?? config('queue.default');
+        $baseConfig = config('queue.connections.' . $connection);
+        $config = (new CloudTasksConnector())->connect($baseConfig)->config;
+
+        // The connection name from the config may not be the actual connection name
+        $config['connection'] = $connection;
+
+        $this->config = $config;
     }
 
     private function setQueue(): void

tests/TaskHandlerTest.php

@@ -268,17 +268,17 @@ public function after_max_attempts_it_will_delete_the_task()
 
         // Act & Assert
         $job->run();
-        CloudTasksApi::assertDeletedTaskCount(0);
-        CloudTasksApi::assertTaskNotDeleted($job->task->getName());
+        CloudTasksApi::assertDeletedTaskCount(1);
+        CloudTasksApi::assertTaskDeleted($job->task->getName());
         $this->assertDatabaseCount('failed_jobs', 0);
 
         $job->run();
-        CloudTasksApi::assertDeletedTaskCount(0);
-        CloudTasksApi::assertTaskNotDeleted($job->task->getName());
+        CloudTasksApi::assertDeletedTaskCount(2);
+        CloudTasksApi::assertTaskDeleted($job->task->getName());
         $this->assertDatabaseCount('failed_jobs', 0);
 
         $job->run();
-        CloudTasksApi::assertDeletedTaskCount(1);
+        CloudTasksApi::assertDeletedTaskCount(3);
         CloudTasksApi::assertTaskDeleted($job->task->getName());
         $this->assertDatabaseCount('failed_jobs', 1);
     }
@@ -300,16 +300,16 @@ public function after_max_retry_until_it_will_log_to_failed_table_and_delete_the
         $job->run();
 
         // Assert
-        CloudTasksApi::assertDeletedTaskCount(0);
-        CloudTasksApi::assertTaskNotDeleted($job->task->getName());
+        CloudTasksApi::assertDeletedTaskCount(1);
+        CloudTasksApi::assertTaskDeleted($job->task->getName());
         $this->assertDatabaseCount('failed_jobs', 0);
 
         // Act
         CloudTasksApi::partialMock()->shouldReceive('getRetryUntilTimestamp')->andReturn(1);
         $job->run();
 
         // Assert
-        CloudTasksApi::assertDeletedTaskCount(1);
+        CloudTasksApi::assertDeletedTaskCount(2);
         CloudTasksApi::assertTaskDeleted($job->task->getName());
         $this->assertDatabaseCount('failed_jobs', 1);
     }
@@ -330,8 +330,8 @@ public function test_unlimited_max_attempts()
         $job = $this->dispatch(new FailingJob());
         foreach (range(1, 50) as $attempt) {
             $job->run();
-            CloudTasksApi::assertDeletedTaskCount(0);
-            CloudTasksApi::assertTaskNotDeleted($job->task->getName());
+            CloudTasksApi::assertDeletedTaskCount($attempt);
+            CloudTasksApi::assertTaskDeleted($job->task->getName());
             $this->assertDatabaseCount('failed_jobs', 0);
         }
     }
@@ -408,4 +408,26 @@ public function it_can_handle_encrypted_jobs()
 
         Log::assertLogged('EncryptedJob:success');
     }
+
+    public function failing_jobs_are_released()
+    {
+        // Arrange
+        OpenIdVerificator::fake();
+        CloudTasksApi::partialMock()->shouldReceive('getRetryConfig')->andReturn(
+            (new RetryConfig())->setMaxAttempts(3)
+        );
+
+        // Act
+        $job = $this->dispatch(new FailingJob());
+
+        CloudTasksApi::assertDeletedTaskCount(0);
+        CloudTasksApi::assertCreatedTaskCount(1);
+        CloudTasksApi::assertTaskNotDeleted($job->task->getName());
+
+        $job->run();
+
+        CloudTasksApi::assertDeletedTaskCount(1);
+        CloudTasksApi::assertCreatedTaskCount(2);
+        CloudTasksApi::assertTaskDeleted($job->task->getName());
+    }
 }