Merge pull request #12 from bwaidelich/master

TASK: Add helpful exception when using the `FakeQueue` with `async` with Flow < 3.3

Classes/Queue/FakeQueue.php

@@ -55,7 +55,7 @@ public function __construct($name, array $options = [])
      */
     public function setUp()
     {
-        // The SynchronousQueue does not require any setup but we use it to verify the options
+        // The FakeQueue does not require any setup but we use it to verify the options
         if ($this->async && !method_exists(Scripts::class, 'executeCommandAsync')) {
             throw new \RuntimeException('The "async" flag is set, but the currently used Flow version doesn\'t support this (Flow 3.3+ is required)', 1468940734);
         }
@@ -78,6 +78,9 @@ public function submit($payload, array $options = [])
         $message = new Message($messageId, $payload);
         $commandArguments = [$this->name, base64_encode(serialize($message))];
         if ($this->async) {
+            if (!method_exists(Scripts::class, 'executeCommandAsync')) {
+                throw new \RuntimeException('The "async" flag is set, but the currently used Flow version doesn\'t support this (Flow 3.3+ is required)', 1469116604);
+            }
             Scripts::executeCommandAsync('flowpack.jobqueue.common:job:execute', $this->flowSettings, $commandArguments);
         } else {
             Scripts::executeCommand('flowpack.jobqueue.common:job:execute', $this->flowSettings, true, $commandArguments);

README.md

@@ -65,9 +65,15 @@ Neos Flow package that allows for asynchronous and distributed execution of task
 
   *Note:* The method needs to be *public* and it must not return anything
 
-5. **Done.**
+5. **Start the worker (if required)**
 
-  Whenever the method `SomeClass::sendEmail()` is about to be called that method call is converted into a job that is executed asynchronously[1].
+  With the above code in place, whenever the method `SomeClass::sendEmail()` is about to be called that method call is converted into a job that is executed asynchronously[1].
+
+  Unless you use the `FakeQueue` like in the example, a so called `worker` has to be started, to listen for new jobs and execute them::
+
+  ```
+  ./flow flowpack.jobqueue.common:job:work some-queue --verbose
+  ```
 
 ## Introduction