Dispatch invalid item exception inside item step

gquemener · gquemener · commit 1ce9e3cd71ec · 2013-10-14T11:56:33.000+02:00
diff --git a/Event/InvalidItemEvent.php b/Event/InvalidItemEvent.php
@@ -2,7 +2,7 @@
 
 namespace Oro\Bundle\BatchBundle\Event;
 
-use Oro\Bundle\NotificationBundle\Entity\Event;
+use Symfony\Component\EventDispatcher\Event;
 
 /**
  * Invalid Item Event
diff --git a/Item/InvalidItemException.php b/Item/InvalidItemException.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace Oro\Bundle\BatchBundle\Item;
+
+/**
+ * Exception throw during step execution when an item is invalid
+ *
+ * @author    Gildas Quemener <gildas@akeneo.com>
+ * @copyright 2013 Akeneo SAS (http://www.akeneo.com)
+ * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ */
+class InvalidItemException extends \Exception
+{
+    /** @var array */
+    protected $item;
+
+    /**
+     * Constructor
+     *
+     * @param string $message
+     * @param array  $item
+     */
+    public function __construct($message, array $item)
+    {
+        parent::__construct($message);
+
+        $this->item = $item;
+    }
+
+    /**
+     * Get the invalid item
+     */
+    public function getItem()
+    {
+        return $this->item;
+    }
+}
diff --git a/Item/InvalidItemExceptionTest.php b/Item/InvalidItemExceptionTest.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Oro\Bundle\BatchBundle\Item;
+
+/**
+ * Test related class
+ *
+ * @author    Gildas Quemener <gildas@akeneo.com>
+ * @copyright 2013 Akeneo SAS (http://www.akeneo.com)
+ * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ */
+class InvalidItemExceptionTest extends \PHPUnit_Framework_TestCase
+{
+    protected function setUp()
+    {
+        $this->exception = new InvalidItemException(
+            'Tango is down, I repeat...',
+            array('foo' => 'fighter')
+        );
+    }
+
+    public function testIsAnException()
+    {
+        $this->assertInstanceOf('\Exception', $this->exception);
+    }
+
+    public function testAccessors()
+    {
+        $this->assertEquals('Tango is down, I repeat...', $this->exception->getMessage());
+        $this->assertEquals(array('foo' => 'fighter'), $this->exception->getItem());
+    }
+}
diff --git a/Step/AbstractStep.php b/Step/AbstractStep.php
@@ -10,6 +10,7 @@
 use Oro\Bundle\BatchBundle\Job\JobInterruptedException;
 use Oro\Bundle\BatchBundle\Entity\StepExecution;
 use Oro\Bundle\BatchBundle\Event\StepExecutionEvent;
+use Oro\Bundle\BatchBundle\Event\InvalidItemEvent;
 use Oro\Bundle\BatchBundle\Event\EventInterface;
 
 /**
@@ -47,7 +48,7 @@ public function __construct($name)
     /**
      * Set the event dispatcher
      *
-     * @param EventDispatcherInterface $eventDispatcher
+     * @param  EventDispatcherInterface $eventDispatcher
      * @return AbstractStep
      */
     public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
@@ -60,7 +61,7 @@ public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
     /**
      * Public setter for {@link JobRepositoryInterface}.
      *
-     * @param JobRepositoryInterface $jobRepository jobRepository is a mandatory dependence (no default).
+     * @param  JobRepositoryInterface $jobRepository jobRepository is a mandatory dependence (no default).
      * @return AbstractStep
      */
     public function setJobRepository(JobRepositoryInterface $jobRepository)
@@ -89,7 +90,7 @@ public function getName()
     /**
      * Set the name property
      *
-     * @param string $name
+     * @param  string       $name
      * @return AbstractStep
      */
     public function setName($name)
@@ -103,7 +104,7 @@ public function setName($name)
      * Extension point for subclasses to execute business logic. Subclasses should set the {@link ExitStatus} on the
      * {@link StepExecution} before returning.
      *
-     * @param StepExecution $stepExecution the current step context
+     * @param  StepExecution $stepExecution the current step context
      * @throws \Exception
      */
     abstract protected function doExecute(StepExecution $stepExecution);
@@ -174,7 +175,7 @@ final public function execute(StepExecution $stepExecution)
 
     /**
      * Determine the step status based on the exception.
-     * @param \Exception $e
+     * @param  \Exception $e
      * @return int
      */
     private static function determineBatchStatus(\Exception $e)
@@ -190,7 +191,7 @@ private static function determineBatchStatus(\Exception $e)
      * Default mapping from throwable to {@link ExitStatus}. Clients can modify the exit code using a
      * {@link StepExecutionListener}.
      *
-     * @param \Exception $e the cause of the failure
+     * @param  \Exception $e the cause of the failure
      * @return ExitStatus {@link ExitStatus}
      */
     private function getDefaultExitStatusForFailure(\Exception $e)
@@ -218,6 +219,12 @@ protected function dispatchStepExecutionEvent($eventName, StepExecution $stepExe
         $this->dispatch($eventName, $event);
     }
 
+    protected function dispatchInvalidItemEvent($class, $reason, array $item)
+    {
+        $event = new InvalidItemEvent($class, $reason, $item);
+        $this->dispatch(EventInterface::INVALID_ITEM, $event);
+    }
+
     /**
      * Generic batch event dispatcher
      *
diff --git a/Step/ItemStep.php b/Step/ItemStep.php
@@ -3,13 +3,13 @@
 namespace Oro\Bundle\BatchBundle\Step;
 
 use Symfony\Component\Validator\Constraints as Assert;
+use Oro\Bundle\BatchBundle\Step\StepExecutionAwareInterface;
 use Oro\Bundle\BatchBundle\Entity\StepExecution;
+use Oro\Bundle\BatchBundle\Item\AbstractConfigurableStepElement;
 use Oro\Bundle\BatchBundle\Item\ItemReaderInterface;
 use Oro\Bundle\BatchBundle\Item\ItemProcessorInterface;
 use Oro\Bundle\BatchBundle\Item\ItemWriterInterface;
-use Oro\Bundle\BatchBundle\Event\EventInterface;
-use Oro\Bundle\BatchBundle\Item\AbstractConfigurableStepElement;
-use Oro\Bundle\BatchBundle\Step\StepExecutionAwareInterface;
+use Oro\Bundle\BatchBundle\Item\InvalidItemException;
 
 /**
  * Basic step implementation that read items, process them and write them
@@ -161,33 +161,74 @@ public function setConfiguration(array $config)
      */
     public function doExecute(StepExecution $stepExecution)
     {
-        $itemsToWrite = array();
-        $writeCount = 0;
+        $itemsToWrite  = array();
+        $writeCount    = 0;
+        $stopExecution = false;
 
         $this->initializeStepComponents($stepExecution);
 
-        while (($item = $this->reader->read()) !== null) {
-            if (false === $item) {
-                $this->dispatchStepExecutionEvent(EventInterface::INVALID_READER_EXECUTION, $stepExecution);
+        while (!$stopExecution) {
+            // Reading
+            try {
+                if (null === $item = $this->reader->read()) {
+                    $stopExecution = true;
+
+                    continue;
+                }
+            } catch (InvalidItemException $e) {
+                $this->dispatchInvalidItemEvent(
+                    get_class($this->reader),
+                    $e->getMessage(),
+                    $e->getItem()
+                );
+
                 continue;
             }
 
-            if (null !== $processedItem = $this->processor->process($item)) {
-                if (false === $processedItem) {
+            // Processing
+            try {
+                if (null === $processedItem = $this->processor->process($item)) {
                     continue;
                 }
-                $itemsToWrite[] = $processedItem;
-                $writeCount++;
-                if (0 === $writeCount % $this->batchSize) {
+            } catch (InvalidItemException $e) {
+                $this->dispatchInvalidItemEvent(
+                    get_class($this->processor),
+                    $e->getMessage(),
+                    $e->getItem()
+                );
+
+                continue;
+            }
+
+            // Writing
+            $itemsToWrite[] = $processedItem;
+            if (0 === ++$writeCount % $this->batchSize) {
+                try {
                     $this->writer->write($itemsToWrite);
                     $itemsToWrite = array();
+                } catch (InvalidItemException $e) {
+                    $this->dispatchInvalidItemEvent(
+                        get_class($this->processor),
+                        $e->getMessage(),
+                        $e->getItem()
+                    );
+
+                    continue;
                 }
             }
         }
 
         if (count($itemsToWrite) > 0) {
-            $this->writer->write($itemsToWrite);
-            $itemsToWrite = array();
+            try {
+                $this->writer->write($itemsToWrite);
+                $itemsToWrite = array();
+            } catch (InvalidItemException $e) {
+                $this->dispatchInvalidItemEvent(
+                    get_class($this->processor),
+                    $e->getMessage(),
+                    $e->getItem()
+                );
+            }
         }
     }
 
diff --git a/Tests/Unit/Step/ItemStepTest.php b/Tests/Unit/Step/ItemStepTest.php
