feat: Queue::push() to return job ID instead of boolean

src/Handlers/BaseHandler.php

@@ -39,7 +39,7 @@ abstract class BaseHandler
 
     abstract public function name(): string;
 
-    abstract public function push(string $queue, string $job, array $data, ?PayloadMetadata $metadata = null): bool;
+    abstract public function push(string $queue, string $job, array $data, ?PayloadMetadata $metadata = null): ?string;
 
     abstract public function pop(string $queue, array $priorities): ?QueueJob;
 
@@ -153,7 +153,7 @@ public function setPriority(string $priority): static
      *
      * @param Closure $callback Chain definition callback
      */
-    public function chain(Closure $callback): bool
+    public function chain(Closure $callback): ?string
     {
         $chainBuilder = new ChainBuilder($this);
         $callback($chainBuilder);

src/Handlers/DatabaseHandler.php

@@ -47,7 +47,7 @@ public function name(): string
      *
      * @throws ReflectionException
      */
-    public function push(string $queue, string $job, array $data, ?PayloadMetadata $metadata = null): bool
+    public function push(string $queue, string $job, array $data, ?PayloadMetadata $metadata = null): ?string
     {
         $this->validateJobAndPriority($queue, $job);
 
@@ -62,7 +62,9 @@ public function push(string $queue, string $job, array $data, ?PayloadMetadata $
 
         $this->priority = $this->delay = null;
 
-        return $this->jobModel->insert($queueJob, false);
+        $jobId = $this->jobModel->insert($queueJob);
+
+        return $jobId !== 0 ? (string) $jobId : null;
     }
 
     /**

src/Handlers/PredisHandler.php

@@ -59,16 +59,17 @@ public function name(): string
     /**
      * Add job to the queue.
      */
-    public function push(string $queue, string $job, array $data, ?PayloadMetadata $metadata = null): bool
+    public function push(string $queue, string $job, array $data, ?PayloadMetadata $metadata = null): ?string
     {
         $this->validateJobAndPriority($queue, $job);
 
         helper('text');
 
+        $jobId       = random_string('numeric', 16);
         $availableAt = Time::now()->addSeconds($this->delay ?? 0);
 
         $queueJob = new QueueJob([
-            'id'           => random_string('numeric', 16),
+            'id'           => $jobId,
             'queue'        => $queue,
             'payload'      => new Payload($job, $data, $metadata),
             'priority'     => $this->priority,
@@ -81,7 +82,7 @@ public function push(string $queue, string $job, array $data, ?PayloadMetadata $
 
         $this->priority = $this->delay = null;
 
-        return $result > 0;
+        return $result > 0 ? $jobId : null;
     }
 
     /**

src/Handlers/RedisHandler.php

@@ -76,16 +76,17 @@ public function name(): string
      *
      * @throws RedisException
      */
-    public function push(string $queue, string $job, array $data, ?PayloadMetadata $metadata = null): bool
+    public function push(string $queue, string $job, array $data, ?PayloadMetadata $metadata = null): ?string
     {
         $this->validateJobAndPriority($queue, $job);
 
         helper('text');
 
         $availableAt = Time::now()->addSeconds($this->delay ?? 0);
+        $jobId       = random_string('numeric', 16);
 
         $queueJob = new QueueJob([
-            'id'           => random_string('numeric', 16),
+            'id'           => $jobId,
             'queue'        => $queue,
             'payload'      => new Payload($job, $data, $metadata),
             'priority'     => $this->priority,
@@ -98,7 +99,7 @@ public function push(string $queue, string $job, array $data, ?PayloadMetadata $
 
         $this->priority = $this->delay = null;
 
-        return $result > 0;
+        return $result > 0 ? $jobId : null;
     }
 
     /**

src/Payloads/ChainBuilder.php

@@ -44,10 +44,10 @@ public function push(string $queue, string $jobName, array $data = []): ChainEle
     /**
      * Dispatch the chain of jobs
      */
-    public function dispatch(): bool
+    public function dispatch(): ?string
     {
         if ($this->payloads->count() === 0) {
-            return true;
+            return null;
         }
 
         $current  = $this->payloads->shift();

tests/DatabaseHandlerTest.php

@@ -85,7 +85,7 @@ public function testPush(): void
         $handler = new DatabaseHandler($this->config);
         $result  = $handler->push('queue', 'success', ['key' => 'value']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
         $this->seeInDatabase('queue_jobs', [
             'queue'        => 'queue',
             'payload'      => json_encode(['job' => 'success', 'data' => ['key' => 'value'], 'metadata' => []]),
@@ -103,7 +103,7 @@ public function testPushWithPriority(): void
         $handler = new DatabaseHandler($this->config);
         $result  = $handler->setPriority('high')->push('queue', 'success', ['key' => 'value']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
         $this->seeInDatabase('queue_jobs', [
             'queue'        => 'queue',
             'payload'      => json_encode(['job' => 'success', 'data' => ['key' => 'value'], 'metadata' => []]),
@@ -122,7 +122,7 @@ public function testPushAndPopWithPriority(): void
         $handler = new DatabaseHandler($this->config);
         $result  = $handler->push('queue', 'success', ['key1' => 'value1']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
         $this->seeInDatabase('queue_jobs', [
             'queue'        => 'queue',
             'payload'      => json_encode(['job' => 'success', 'data' => ['key1' => 'value1'], 'metadata' => []]),
@@ -132,7 +132,7 @@ public function testPushAndPopWithPriority(): void
 
         $result = $handler->setPriority('high')->push('queue', 'success', ['key2' => 'value2']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
         $this->seeInDatabase('queue_jobs', [
             'queue'        => 'queue',
             'payload'      => json_encode(['job' => 'success', 'data' => ['key2' => 'value2'], 'metadata' => []]),
@@ -161,7 +161,7 @@ public function testPushWithDelay(): void
         $handler = new DatabaseHandler($this->config);
         $result  = $handler->setDelay(MINUTE)->push('queue-delay', 'success', ['key' => 'value']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $availableAt = 1703859376;
 
@@ -188,7 +188,7 @@ public function testChain(): void
                 ->push('queue', 'success', ['key2' => 'value2']);
         });
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
         $this->seeInDatabase('queue_jobs', [
             'queue'   => 'queue',
             'payload' => json_encode([
@@ -221,7 +221,7 @@ public function testChainWithPriorityAndDelay(): void
                 ->setDelay(120);
         });
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
         $this->seeInDatabase('queue_jobs', [
             'queue'   => 'queue',
             'payload' => json_encode([

tests/Payloads/ChainBuilderTest.php

@@ -63,7 +63,7 @@ public function testChainWithSingleJob(): void
             $chain->push('queue', 'success', ['key' => 'value']);
         });
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
         $this->seeInDatabase('queue_jobs', [
             'queue'   => 'queue',
             'payload' => json_encode([
@@ -84,7 +84,7 @@ public function testEmptyChain(): void
             // No jobs added
         });
 
-        $this->assertTrue($result);
+        $this->assertNull($result);
         $this->seeInDatabase('queue_jobs', []);
     }
 
@@ -99,7 +99,7 @@ public function testMultipleDifferentQueues(): void
                 ->push('queue2', 'success', ['key2' => 'value2']);
         });
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
         $this->seeInDatabase('queue_jobs', [
             'queue'   => 'queue1',
             'payload' => json_encode([
@@ -132,7 +132,7 @@ public function testChainWithManyJobs(): void
                 ->push('queue', 'success', ['key3' => 'value3']);
         });
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
         $this->seeInDatabase('queue_jobs', [
             'queue'   => 'queue',
             'payload' => json_encode([

tests/PredisHandlerTest.php

@@ -72,7 +72,7 @@ public function testPush(): void
         $handler = new PredisHandler($this->config);
         $result  = $handler->push('queue', 'success', ['key' => 'value']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $predis = self::getPrivateProperty($handler, 'predis');
         $this->assertSame(1, $predis->zcard('queues:queue:low'));
@@ -92,7 +92,7 @@ public function testPushWithPriority(): void
         $handler = new PredisHandler($this->config);
         $result  = $handler->setPriority('high')->push('queue', 'success', ['key' => 'value']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $predis = self::getPrivateProperty($handler, 'predis');
         $this->assertSame(1, $predis->zcard('queues:queue:high'));
@@ -114,7 +114,7 @@ public function testPushWithDelay(): void
         $handler = new PredisHandler($this->config);
         $result  = $handler->setDelay(MINUTE)->push('queue-delay', 'success', ['key' => 'value']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $predis = self::getPrivateProperty($handler, 'predis');
         $this->assertSame(1, $predis->zcard('queues:queue-delay:default'));
@@ -140,7 +140,7 @@ public function testChain(): void
                 ->push('queue', 'success', ['key2' => 'value2']);
         });
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $predis = self::getPrivateProperty($handler, 'predis');
         $this->assertSame(1, $predis->zcard('queues:queue:low'));
@@ -180,7 +180,7 @@ public function testChainWithPriorityAndDelay(): void
                 ->setDelay(120);
         });
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $predis = self::getPrivateProperty($handler, 'predis');
         // Should be in high priority queue

tests/PushAndPopWithDelayTest.php

@@ -64,11 +64,11 @@ public function testPushAndPopWithDelay(string $name, string $class): void
         $handler = new $class($this->config);
         $result  = $handler->setDelay(MINUTE)->push('queue-delay', 'success', ['key1' => 'value1']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $result = $handler->push('queue-delay', 'success', ['key2' => 'value2']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         if ($name === 'database') {
             $this->seeInDatabase('queue_jobs', [

tests/RedisHandlerTest.php

@@ -69,7 +69,7 @@ public function testPush(): void
         $handler = new RedisHandler($this->config);
         $result  = $handler->push('queue', 'success', ['key' => 'value']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $redis = self::getPrivateProperty($handler, 'redis');
         $this->assertSame(1, $redis->zCard('queues:queue:low'));
@@ -86,7 +86,7 @@ public function testPushWithPriority(): void
         $handler = new RedisHandler($this->config);
         $result  = $handler->setPriority('high')->push('queue', 'success', ['key' => 'value']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $redis = self::getPrivateProperty($handler, 'redis');
         $this->assertSame(1, $redis->zCard('queues:queue:high'));
@@ -108,7 +108,7 @@ public function testPushWithDelay(): void
         $handler = new RedisHandler($this->config);
         $result  = $handler->setDelay(MINUTE)->push('queue-delay', 'success', ['key' => 'value']);
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $redis = self::getPrivateProperty($handler, 'redis');
         $this->assertSame(1, $redis->zCard('queues:queue-delay:default'));
@@ -134,7 +134,7 @@ public function testChain(): void
                 ->push('queue', 'success', ['key2' => 'value2']);
         });
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $redis = self::getPrivateProperty($handler, 'redis');
         $this->assertSame(1, $redis->zCard('queues:queue:low'));
@@ -174,7 +174,7 @@ public function testChainWithPriorityAndDelay(): void
                 ->setDelay(120);
         });
 
-        $this->assertTrue($result);
+        $this->assertNotNull($result);
 
         $redis = self::getPrivateProperty($handler, 'redis');
         // Should be in high priority queue