Merge pull request #237 from roelvanduijnhoven/feature/loosen-typehint

Prepare for a release that does not allow return status codes of jobs

src/Job/JobInterface.php

@@ -27,7 +27,13 @@ public function setId($id): JobInterface;
     public function getId();
 
     /**
-     * Execute the job
+     * Execute the job.
+     *
+     * TODO Deprecate the usage of int as return value, and introduce exceptions as part of the API to signal a
+     *   non-success result.
+     *
+     * @return void|?int Omitting return value, or returning `null` means the job was successful. Otherwise the int
+     *   returned will represent.
      */
-    public function execute(): ?int;
+    public function execute();
 }

tests/Asset/JobWithNoReturnType.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace SlmQueueTest\Asset;
+
+use SlmQueue\Job\AbstractJob;
+
+class JobWithNoReturnType extends AbstractJob
+{
+    public function execute()
+    {
+        // Just set some stupid metadata
+        $this->setMetadata('foo', 'bar');
+
+        return 999;
+    }
+}

tests/Asset/JobWithVoidReturnType.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace SlmQueueTest\Asset;
+
+use SlmQueue\Job\AbstractJob;
+
+class JobWithVoidReturnType extends AbstractJob
+{
+    public function execute()
+    {
+        // Just set some stupid metadata
+        $this->setMetadata('foo', 'bar');
+
+        return 999;
+    }
+}

tests/Strategy/ProcessQueueStrategyTest.php

@@ -4,13 +4,16 @@
 
 use Laminas\EventManager\EventManagerInterface;
 use PHPUnit\Framework\TestCase;
+use SlmQueue\Job\JobInterface;
 use SlmQueue\Queue\QueueInterface;
 use SlmQueue\Strategy\AbstractStrategy;
 use SlmQueue\Strategy\ProcessQueueStrategy;
 use SlmQueue\Worker\Event\ProcessJobEvent;
 use SlmQueue\Worker\Event\ProcessQueueEvent;
 use SlmQueue\Worker\Event\WorkerEventInterface;
 use SlmQueue\Worker\Result\ExitWorkerLoopResult;
+use SlmQueueTest\Asset\JobWithNoReturnType;
+use SlmQueueTest\Asset\JobWithVoidReturnType;
 use SlmQueueTest\Asset\SimpleJob;
 use SlmQueueTest\Asset\SimpleWorker;
 
@@ -101,9 +104,11 @@ function ($e) use (&$triggeredIdle) {
         static::assertTrue($event->propagationIsStopped(), "EventPropagation should be stopped");
     }
 
-    public function testJobPopWithJobTriggersProcessJobEvent(): void
+    /**
+     * @dataProvider jobsProvider
+     */
+    public function testJobPopWithJobTriggersProcessJobEvent(JobInterface $job): void
     {
-        $job = new SimpleJob();
         $popOptions = [];
         $this->queue->expects($this->at(0))
             ->method('pop')
@@ -127,9 +132,11 @@ function ($e) use (&$triggeredProcessJobEvent) {
         static::assertFalse($event->propagationIsStopped(), "EventPropagation should not be stopped");
     }
 
-    public function testOnJobProcess(): void
+    /**
+     * @dataProvider jobsProvider
+     */
+    public function testOnJobProcess(JobInterface $job): void
     {
-        $job = new SimpleJob();
         $event = new ProcessJobEvent($job, $this->worker, $this->queue);
 
         $this->listener->onJobProcess($event);
@@ -138,4 +145,13 @@ public function testOnJobProcess(): void
         static::assertEquals($job, $event->getJob());
         static::assertSame('bar', $event->getJob()->getMetadata('foo'));
     }
+
+    public function jobsProvider(): array
+    {
+        return [
+            [new SimpleJob()],
+            [new JobWithNoReturnType()],
+            [new JobWithVoidReturnType()],
+        ];
+    }
 }