Added support for the exception in the error callback

Changelog.md

@@ -0,0 +1,23 @@
+# Change log
+
+## 0.2.0
+
+Added support for receiving the exception in the `error` callback:
+
+```php
+$error = function (Exception $e) {
+    echo "There was an error while completing the operation: " . $e->getMessage();
+}
+
+$workDispatcher->runBackground($task, 5, null, null, $error);
+```
+
+However the exception will not be the original exception that made the worker error. The reason for that
+is that it is complex to serialize an exception and transmit it between the worker and the web request.
+
+It becomes really useful though when using the `SimpleWorkDispatcher`, as you will get the original exception here.
+It can help debugging a lot in a development environment.
+
+## 0.1.0
+
+First release.

README.md

@@ -70,6 +70,10 @@ class BigComputationExecutor implements MyCLabs\Work\TaskExecutor\TaskExecutor
 }
 ```
 
+## Read more
+
+Read more in [the docs](doc/).
+
 ## Contributing
 
 You can run the tests with PHPUnit:

doc/RabbitMQ.md

@@ -53,14 +53,14 @@ This can be achieve using this library. Here is a schema of how it works interna
 On you client side, you can use `runBackground` like so:
 
 ```php
-$completed = function() {
+$completed = function () {
     echo "The operation has completed.";
 }
-$timeout = function() {
+$timeout = function () {
     echo "The operation is being applied. You will be notified when it has completed.";
     // to notify the user, see below
 }
-$error = function() {
+$error = function (Exception $e) {
     echo "There was an error while completing the operation!";
 }
 

src/MyCLabs/Work/Dispatcher/RabbitMQWorkDispatcher.php

@@ -116,7 +116,8 @@ private function waitForTask(
         // If the first message of the queue is a "errored" message from the worker
         if ($message->body == 'errored') {
             if ($errored !== null) {
-                call_user_func($errored);
+                $e = new \RuntimeException("An error occured in the background task");
+                call_user_func($errored, $e);
             }
             // Delete the temporary exchange
             $this->channel->exchange_delete($exchange);

src/MyCLabs/Work/Dispatcher/SimpleWorkDispatcher.php

@@ -47,7 +47,7 @@ public function runBackground(
             $this->worker->executeTask($task);
         } catch (\Exception $e) {
             if ($errored) {
-                call_user_func($errored);
+                call_user_func($errored, $e);
             }
             return;
         }

src/MyCLabs/Work/Dispatcher/WorkDispatcher.php

@@ -38,7 +38,7 @@ abstract class WorkDispatcher
      * @param int      $wait      Number of seconds to wait for the task to complete. If 0, doesn't wait.
      * @param callable $completed Called (if $wait > 0) when the task has completed.
      * @param callable $timedout  Called (if $wait > 0) if we hit the timeout while waiting.
-     * @param callable $errored   Called (if $wait > 0) if the task errors.
+     * @param callable $errored   Called (if $wait > 0) if the task errors. Takes 1 parameter which is the exception.
      *
      * @return void No results
      */

tests/FunctionalTest/MyCLabs/Work/RabbitMQ/RabbitMQTest.php

@@ -192,7 +192,8 @@ public function testRunBackgroundWaitError()
         $mock->expects($this->never())
             ->method('timeout');
         $mock->expects($this->once())
-            ->method('errored');
+            ->method('errored')
+            ->with($this->isInstanceOf('Exception'));
 
         $workDispatcher->runBackground(new FakeTask(), 1, [$mock, 'completed'], [$mock, 'timeout'], [$mock, 'errored']);
 

tests/UnitTest/MyCLabs/Work/Dispatcher/SimpleWorkDispatcherTest.php

@@ -64,7 +64,8 @@ public function testCallbackError()
         $mock->expects($this->never())
             ->method('timeout');
         $mock->expects($this->once())
-            ->method('errored');
+            ->method('errored')
+            ->with($this->isInstanceOf('Exception'));
 
         $dispatcher->runBackground($task, 1, [$mock, 'completed'], [$mock, 'timeout'], [$mock, 'errored']);
     }