added task-execution listener to clear entity-manager

Author: wachterjohannes

composer.json

@@ -11,7 +11,7 @@
     ],
     "require": {
         "php": "~5.5 || ~7.0",
-        "php-task/php-task": "dev-master",
+        "php-task/php-task": "dev-bugfix/event-after",
         "symfony/http-kernel": "^2.6 || ^3.0",
         "symfony/dependency-injection": "^2.6 || ^3.0",
         "symfony/config": "^2.6 || ^3.0",

src/EventListener/TaskExecutionListener.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of php-task library.
+ *
+ * (c) php-task
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Task\TaskBundle\EventListener;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Task\Event\TaskExecutionEvent;
+
+/**
+ * Listens on task-execution events.
+ */
+class TaskExecutionListener
+{
+    /**
+     * @var EntityManagerInterface
+     */
+    private $entityManager;
+
+    /**
+     * @param EntityManagerInterface $entityManager
+     */
+    public function __construct(EntityManagerInterface $entityManager)
+    {
+        $this->entityManager = $entityManager;
+    }
+
+    /**
+     * This method clears the entity-manager after each task to ensure clean state before next task.
+     *
+     * @param TaskExecutionEvent $event
+     */
+    public function clearEntityManagerAfterTask(TaskExecutionEvent $event)
+    {
+        $this->entityManager->clear();
+    }
+}

src/Resources/config/storage/doctrine.xml

@@ -16,5 +16,11 @@
             <argument type="string">TaskBundle:TaskExecution</argument>
         </service>
         <service id="task.storage.task_execution" alias="task.repository.task_execution"/>
+
+        <service id="task.event_listener.execution" class="Task\TaskBundle\EventListener\TaskExecutionListener">
+            <argument type="service" id="doctrine.orm.entity_manager"/>
+
+            <tag name="%task.events.after%" method="clearEntityManagerAfterTask"/>
+        </service>
     </services>
 </container>

src/Resources/config/task_event_listener.xml

@@ -7,6 +7,7 @@
         <parameter key="task.events.create" type="constant">Task\Event\Events::TASK_CREATE</parameter>
         <parameter key="task.events.create_execution" type="constant">Task\Event\Events::TASK_EXECUTION_CREATE</parameter>
         <parameter key="task.events.before" type="constant">Task\Event\Events::TASK_BEFORE</parameter>
+        <parameter key="task.events.after" type="constant">Task\Event\Events::TASK_AFTER</parameter>
         <parameter key="task.events.finished" type="constant">Task\Event\Events::TASK_FINISHED</parameter>
         <parameter key="task.events.passed" type="constant">Task\Event\Events::TASK_PASSED</parameter>
         <parameter key="task.events.failed" type="constant">Task\Event\Events::TASK_FAILED</parameter>

tests/Unit/EventListener/TaskExecutionListenerTest.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of php-task library.
+ *
+ * (c) php-task
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Unit\EventListener;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Task\Event\TaskExecutionEvent;
+use Task\TaskBundle\EventListener\TaskExecutionListener;
+
+/**
+ * Tests for class TaskExecutionListener.
+ */
+class TaskExecutionListenerTest extends \PHPUnit_Framework_TestCase
+{
+    public function testClearEntityManagerAfterTask()
+    {
+        $entityManager = $this->prophesize(EntityManagerInterface::class);
+
+        $listener = new TaskExecutionListener($entityManager->reveal());
+        $listener->clearEntityManagerAfterTask($this->prophesize(TaskExecutionEvent::class)->reveal());
+
+        $entityManager->clear()->shouldBeCalled();
+    }
+}