Require every job to extend the base Job class

Author: pprkut

README.md

@@ -110,7 +110,7 @@ Resque\Resque::enqueue('default', 'My_Job', $args);
 Each job should be in its own class, and include a `perform` method.
 
 ```php
-class My_Job
+class My_Job extends \Resque\Job\Job
 {
     public function perform()
     {
@@ -132,9 +132,9 @@ defined, it will be called before the `perform` method is run. The `tearDown`
 method, if defined, will be called after the job finishes.
 
 ```php
-class My_Job
+class My_Job extends \Resque\Job\Job
 {
-    public function setUp()
+    public function setUp(): void
     {
         // ... Set up environment for this job
     }
@@ -144,7 +144,7 @@ class My_Job
         // .. Run job
     }
 
-    public function tearDown()
+    public function tearDown(): void
     {
         // ... Remove environment for this job
     }

lib/Job/Factory.php

@@ -10,23 +10,17 @@ class Factory implements FactoryInterface
 	 * @param $className
 	 * @param array $args
 	 * @param $queue
-	 * @return \Resque\Job\JobInterface
+	 * @return \Resque\Job\Job
 	 * @throws \Resque\Exceptions\ResqueException
 	 */
-	public function create($className, $args, $queue)
+	public function create($className, $args, $queue): Job
 	{
 		if (!class_exists($className)) {
 			throw new ResqueException(
 				'Could not find job class ' . $className . '.'
 			);
 		}
 
-		if (!method_exists($className, 'perform')) {
-			throw new ResqueException(
-				'Job class ' . $className . ' does not contain a perform method.'
-			);
-		}
-
 		$instance = new $className();
 		$instance->args = $args;
 		$instance->queue = $queue;

lib/Job/FactoryInterface.php

@@ -8,7 +8,7 @@ interface FactoryInterface
 	 * @param $className
 	 * @param array $args
 	 * @param $queue
-	 * @return \Resque\Job\JobInterface
+	 * @return \Resque\Job\Job
 	 */
-	public function create($className, $args, $queue);
+	public function create($className, $args, $queue): Job;
 }

lib/Job/JobInterface.php

@@ -8,6 +8,7 @@
 use Resque\Exceptions\DoNotPerformException;
 use Resque\Job\FactoryInterface;
 use Resque\Job\Factory;
+use Resque\Job\Job;
 use Error;
 
 /**
@@ -50,7 +51,7 @@ class JobHandler
 	public $endTime;
 
 	/**
-	 * @var object|\Resque\Job\JobInterface Instance of the class performing work for this job.
+	 * @var Job Instance of the class performing work for this job.
 	 */
 	private $instance;
 
@@ -194,10 +195,10 @@ public function getArguments()
 
 	/**
 	 * Get the instantiated object for this job that will be performing work.
-	 * @return \Resque\Job\JobInterface Instance of the object that this job belongs to.
+	 * @return \Resque\Job\Job Instance of the object that this job belongs to.
 	 * @throws \Resque\Exceptions\ResqueException
 	 */
-	public function getInstance()
+	public function getInstance(): Job
 	{
 		if (!is_null($this->instance)) {
 			return $this->instance;
@@ -212,9 +213,8 @@ public function getInstance()
 	 * Actually execute a job by calling the perform method on the class
 	 * associated with the job with the supplied arguments.
 	 *
-	 * @return bool
-	 * @throws Resque\Exceptions\ResqueException When the job's class could not be found
-	 * 											 or it does not contain a perform method.
+	 * @return mixed
+	 * @throws Resque\Exceptions\ResqueException When the job's class could not be found.
 	 */
 	public function perform()
 	{
@@ -225,15 +225,12 @@ public function perform()
 			$this->startTime = microtime(true);
 
 			$instance = $this->getInstance();
-			if (is_callable([$instance, 'setUp'])) {
-				$instance->setUp();
-			}
+
+			$instance->setUp();
 
 			$result = $instance->perform();
 
-			if (is_callable([$instance, 'tearDown'])) {
-				$instance->tearDown();
-			}
+			$instance->tearDown();
 
 			$this->endTime = microtime(true);
 
@@ -343,7 +340,7 @@ public function setJobFactory(FactoryInterface $jobFactory)
 	/**
 	 * @return Resque\Job\FactoryInterface
 	 */
-	public function getJobFactory()
+	public function getJobFactory(): FactoryInterface
 	{
 		if ($this->jobFactory === null) {
 			$this->jobFactory = new Factory();

lib/JobHandler.php

@@ -7,7 +7,7 @@
 use \Resque\Redis;
 use \Resque\JobHandler;
 use \Resque\Stat;
-use \Resque\Job\JobInterface;
+use \Resque\Job\Job;
 use \Resque\Job\FactoryInterface;
 use \Test_Job_With_SetUp;
 use \Test_Job_With_TearDown;
@@ -410,7 +410,7 @@ public function testUseFactoryToGetJobInstance()
 		$factory = new Some_Stub_Factory();
 		$job->setJobFactory($factory);
 		$instance = $job->getInstance();
-		$this->assertInstanceOf('Resque\Job\JobInterface', $instance);
+		$this->assertInstanceOf('Resque\Job\Job', $instance);
 	}
 
 	public function testDoNotUseFactoryToGetInstance()
@@ -422,11 +422,11 @@ public function testDoNotUseFactoryToGetInstance()
 		$job = new JobHandler('jobs', $payload);
 		$factory = $this->getMockBuilder('Resque\Job\FactoryInterface')
 			->getMock();
-		$testJob = $this->getMockBuilder('Resque\Job\JobInterface')
+		$testJob = $this->getMockBuilder('Resque\Job\Job')
 			->getMock();
 		$factory->expects(self::never())->method('create')->will(self::returnValue($testJob));
 		$instance = $job->getInstance();
-		$this->assertInstanceOf('Resque\Job\JobInterface', $instance);
+		$this->assertInstanceOf('Resque\Job\Job', $instance);
 	}
 
 	public function testJobStatusIsNullIfIdMissingFromPayload()
@@ -505,7 +505,7 @@ public function testJobHandlerSetsStartAndEndTimeForFailedJob()
 	}
 }
 
-class Some_Job_Class implements JobInterface
+class Some_Job_Class extends Job
 {
 
 	/**
@@ -524,9 +524,9 @@ class Some_Stub_Factory implements FactoryInterface
 	 * @param $className
 	 * @param array $args
 	 * @param $queue
-	 * @return Resque\Job\JobInterface
+	 * @return Resque\Job\Job
 	 */
-	public function create($className, $args, $queue)
+	public function create($className, $args, $queue): Job
 	{
 		return new Some_Job_Class();
 	}

test/Resque/Tests/JobHandlerTest.php

@@ -6,6 +6,7 @@
 use \Resque\Job\Status;
 use \Resque\JobHandler;
 use \Resque\Resque;
+use \stdClass;
 
 /**
  * Status tests.
@@ -30,6 +31,25 @@ public function setUp(): void
 		$this->worker->setLogger($this->logger);
 	}
 
+	/**
+	 * Unit test data provider for potential return values from perform().
+	 *
+	 * @return array
+	 */
+	public static function performResultProvider(): array
+	{
+		$data = [];
+
+		$data['boolean'] = [ true ];
+		$data['float']   = [ 1.0 ];
+		$data['integer'] = [ 100 ];
+		$data['string']  = [ 'string' ];
+		$data['null']    = [ null ];
+		$data['array']   = [[ 'key' => 'value' ]];
+
+		return $data;
+	}
+
 	public function testJobStatusCanBeTracked()
 	{
 		$token = Resque::enqueue('jobs', 'Test_Job', null, true);
@@ -76,6 +96,28 @@ public function testCompletedJobReturnsCompletedStatus()
 		$this->assertEquals(Status::STATUS_COMPLETE, $status->get());
 	}
 
+	/**
+	 * @param mixed $value Potential return value from perform()
+	 *
+	 * @dataProvider performResultProvider
+	 */
+	public function testCompletedJobReturnsResult($value)
+	{
+		$token = Resque::enqueue('jobs', 'Returning_Job', [ 'return' => $value ], true);
+		$this->worker->work(0);
+		$status = new Status($token);
+		$this->assertEquals($value, $status->result());
+	}
+
+	public function testCompletedJobReturnsObjectResultAsArray()
+	{
+		$value = new stdClass();
+		$token = Resque::enqueue('jobs', 'Returning_Job', [ 'return' => $value ], true);
+		$this->worker->work(0);
+		$status = new Status($token);
+		$this->assertEquals([], $status->result());
+	}
+
 	public function testStatusIsNotTrackedWhenToldNotTo()
 	{
 		$token = Resque::enqueue('jobs', 'Test_Job', null, false);

test/Resque/Tests/JobStatusTest.php

@@ -85,7 +85,7 @@ function sigint()
 	pcntl_signal(SIGTERM, 'sigint');
 }
 
-class Test_Job
+class Test_Job extends \Resque\Job\Job
 {
 	public static $called = false;
 
@@ -95,12 +95,20 @@ public function perform()
 	}
 }
 
+class Returning_Job extends \Resque\Job\Job
+{
+	public function perform()
+	{
+		return $this->args['return'] ?? NULL;
+	}
+}
+
 class Failing_Job_Exception extends \Exception
 {
 
 }
 
-class Failing_Job
+class Failing_Job extends \Resque\Job\Job
 {
 	public function perform()
 	{
@@ -114,7 +122,7 @@ public function perform()
  *
  * CAUTION Use this test job only with Worker::work, i.e. only when you actually trigger the fork in tests.
  */
-class InProgress_Job
+class InProgress_Job extends \Resque\Job\Job
 {
 	public function perform()
 	{
@@ -126,17 +134,12 @@ public function perform()
 	}
 }
 
-class Test_Job_Without_Perform_Method
-{
-
-}
-
-class Test_Job_With_SetUp
+class Test_Job_With_SetUp extends \Resque\Job\Job
 {
 	public static $called = false;
 	public $args = false;
 
-	public function setUp()
+	public function setUp(): void
 	{
 		self::$called = true;
 	}
@@ -148,7 +151,7 @@ public function perform()
 }
 
 
-class Test_Job_With_TearDown
+class Test_Job_With_TearDown extends \Resque\Job\Job
 {
 	public static $called = false;
 	public $args = false;
@@ -158,13 +161,13 @@ public function perform()
 
 	}
 
-	public function tearDown()
+	public function tearDown(): void
 	{
 		self::$called = true;
 	}
 }
 
-class Test_Infinite_Recursion_Job
+class Test_Infinite_Recursion_Job extends \Resque\Job\Job
 {
     public function perform()
     {