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/DependencyInjection/Configuration.php

@@ -29,6 +29,17 @@ public function getConfigTreeBuilder()
         $treeBuilder->root('task')
             ->children()
                 ->enumNode('storage')->values(['array', 'doctrine'])->defaultValue('doctrine')->end()
+                ->arrayNode('adapters')
+                    ->addDefaultsIfNotSet()
+                    ->children()
+                        ->arrayNode('doctrine')
+                            ->addDefaultsIfNotSet()
+                            ->children()
+                                ->booleanNode('clear')->defaultTrue()->end()
+                            ->end()
+                        ->end()
+                    ->end()
+                ->end()
                 ->arrayNode('run')
                     ->addDefaultsIfNotSet()
                     ->children()

src/DependencyInjection/TaskExtension.php

@@ -13,9 +13,12 @@
 
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Loader;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Task\Event\Events;
+use Task\TaskBundle\EventListener\TaskExecutionListener;
 
 /**
  * Container extension for php-task library.
@@ -40,12 +43,24 @@ public function load(array $configs, ContainerBuilder $container)
             $loader->load('listener.xml');
         }
 
-        if ('doctrine' === $config['storage']) {
-            // FIXME move to compiler pass
-            $container->getDefinition('task.command.schedule_task')
-                ->addArgument(new Reference('doctrine.orm.entity_manager'));
-            $container->getDefinition('task.command.run')
-                ->addArgument(new Reference('doctrine.orm.entity_manager'));
+        $this->loadDoctrineAdapter($config['adapters']['doctrine'], $container);
+    }
+
+    /**
+     * Load doctrine adapter.
+     *
+     * @param array $config
+     * @param ContainerBuilder $container
+     */
+    private function loadDoctrineAdapter(array $config, ContainerBuilder $container)
+    {
+        if ($config['clear']) {
+            $definition = new Definition(TaskExecutionListener::class, [new Reference('doctrine.orm.entity_manager')]);
+            $definition->addTag(
+                'kernel.event_dispatcher',
+                ['event' => Events::TASK_AFTER, 'method' => 'clearEntityManagerAfterTask']
+            );
+            $container->setDefinition('task.adapter.doctrine.execution_listener', $definition);
         }
     }
 }

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/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 Task\TaskBundle\Tests\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();
+    }
+}