MAGETWO-63945: Add extension point to sales grid indexer

- Refactoring according CR

Author: viktym

app/code/Magento/Sales/Model/ResourceModel/AbstractGrid.php

@@ -90,7 +90,8 @@ public function purge($value, $field = null)
      *
      * @param string $default
      * @return string
-     * @deprecated unused
+     * @deprecated this method is not used in abstract model but only in single child so
+     * this deprecation is a part of cleaning abstract classes.
      * @see \Magento\Sales\Model\ResourceModel\Provider\UpdatedIdListProvider
      */
     protected function getLastUpdatedAtValue($default = '0000-00-00 00:00:00')

app/code/Magento/Sales/Model/ResourceModel/Grid.php

@@ -8,7 +8,7 @@
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\DB\Adapter\AdapterInterface;
 use Magento\Framework\Model\ResourceModel\Db\Context;
-use Magento\Sales\Model\ResourceModel\Provider\IdListProviderInterface;
+use Magento\Sales\Model\ResourceModel\Provider\NotSyncedDataProviderInterface;
 
 /**
  * Class Grid
@@ -41,7 +41,7 @@ class Grid extends AbstractGrid
     protected $columns;
 
     /**
-     * @var IdListProviderInterface
+     * @var NotSyncedDataProviderInterface
      */
     private $idListProvider;
 
@@ -53,7 +53,7 @@ class Grid extends AbstractGrid
      * @param array $joins
      * @param array $columns
      * @param string $connectionName
-     * @param IdListProviderInterface $idListProvider
+     * @param NotSyncedDataProviderInterface $idListProvider
      */
     public function __construct(
         Context $context,
@@ -63,14 +63,14 @@ public function __construct(
         array $joins = [],
         array $columns = [],
         $connectionName = null,
-        IdListProviderInterface $idListProvider = null
+        NotSyncedDataProviderInterface $idListProvider = null
     ) {
         $this->mainTableName = $mainTableName;
         $this->gridTableName = $gridTableName;
         $this->orderIdField = $orderIdField;
         $this->joins = $joins;
         $this->columns = $columns;
-        $this->idListProvider = $idListProvider ?: ObjectManager::getInstance()->get(IdListProviderInterface::class);
+        $this->idListProvider = $idListProvider ?: ObjectManager::getInstance()->get(NotSyncedDataProviderInterface::class);
         parent::__construct($context, $connectionName);
     }
 

app/code/Magento/Sales/Model/ResourceModel/Provider/IdListProvider.php renamed to app/code/Magento/Sales/Model/ResourceModel/Provider/NotSyncedDataProvider.php

@@ -8,12 +8,12 @@
 use Magento\Framework\ObjectManager\TMapFactory;
 
 /**
- * Implements IdListProviderInterface as composite
+ * Implements NotSyncedDataProviderInterface as composite
  */
-class IdListProvider implements IdListProviderInterface
+class NotSyncedDataProvider implements NotSyncedDataProviderInterface
 {
     /**
-     * @var IdListProviderInterface[]
+     * @var NotSyncedDataProviderInterface[]
      */
     private $providers;
 
@@ -28,21 +28,21 @@ public function __construct(
         $this->providers = $tmapFactory->create(
             [
                 'array' => $providers,
-                'type' => IdListProviderInterface::class
+                'type' => NotSyncedDataProviderInterface::class
             ]
         );
     }
 
     /**
      * @inheritDoc
      */
-    public function get($mainTableName, $gridTableName)
+    public function getIds($mainTableName, $gridTableName)
     {
         $result = [];
         foreach ($this->providers as $provider) {
             $result = array_merge($result, $provider->get($mainTableName, $gridTableName));
         }
 
-        return $result;
+        return array_unique($result);
     }
 }

app/code/Magento/Sales/Model/ResourceModel/Provider/IdListProviderInterface.php renamed to app/code/Magento/Sales/Model/ResourceModel/Provider/NotSyncedDataProviderInterface.php

@@ -8,7 +8,7 @@
 /**
  * Interface provides entities id list that should be updated in grid
  */
-interface IdListProviderInterface
+interface NotSyncedDataProviderInterface
 {
     /**
      * Returns id list of entities for adding or updating in grid.
@@ -17,5 +17,5 @@ interface IdListProviderInterface
      * @param string $gridTableName grid table name
      * @return array
      */
-    public function get($mainTableName, $gridTableName);
+    public function getIds($mainTableName, $gridTableName);
 }

app/code/Magento/Sales/Model/ResourceModel/Provider/UpdatedIdListProvider.php

@@ -11,7 +11,7 @@
 /**
  * Provides latest updated entities ids list
  */
-class UpdatedIdListProvider implements IdListProviderInterface
+class UpdatedIdListProvider implements NotSyncedDataProviderInterface
 {
     /**
      * @var ResourceConnection
@@ -24,7 +24,7 @@ class UpdatedIdListProvider implements IdListProviderInterface
     private $connection;
 
     /**
-     * IdListProvider constructor.
+     * NotSyncedDataProvider constructor.
      * @param ResourceConnection $resourceConnection
      */
     public function __construct(
@@ -36,7 +36,7 @@ public function __construct(
     /**
      * @inheritdoc
      */
-    public function get($mainTableName, $gridTableName)
+    public function getIds($mainTableName, $gridTableName)
     {
         $lastUpdatedAt = $this->getLastUpdatedAtValue($gridTableName);
         $select = $this->getConnection()->select()

app/code/Magento/Sales/Test/Unit/Model/ResourceModel/Provider/IdListProviderTest.php renamed to app/code/Magento/Sales/Test/Unit/Model/ResourceModel/Provider/NotSyncedDataProviderTest.php

@@ -7,14 +7,14 @@
 
 use Magento\Framework\ObjectManager\TMap;
 use Magento\Framework\ObjectManager\TMapFactory;
-use Magento\Sales\Model\ResourceModel\Provider\IdListProvider;
-use Magento\Sales\Model\ResourceModel\Provider\IdListProviderInterface;
+use Magento\Sales\Model\ResourceModel\Provider\NotSyncedDataProvider;
+use Magento\Sales\Model\ResourceModel\Provider\NotSyncedDataProviderInterface;
 use PHPUnit_Framework_MockObject_MockObject as MockObject;
 
 /**
- * Class IdListProviderTest
+ * Class NotSyncedDataProviderTest
  */
-class IdListProviderTest extends \PHPUnit_Framework_TestCase
+class NotSyncedDataProviderTest extends \PHPUnit_Framework_TestCase
 {
     public function testGetEmpty()
     {
@@ -32,20 +32,20 @@ public function testGetEmpty()
             ->with(
                 [
                     'array' => [],
-                    'type' => IdListProviderInterface::class
+                    'type' => NotSyncedDataProviderInterface::class
                 ]
             )
             ->willReturn($tMap);
         $tMap->expects(static::once())
             ->method('getIterator')
             ->willReturn(new \ArrayIterator([]));
 
-        $provider = new IdListProvider($tMapFactory, []);
-        static::assertEquals([], $provider->get('main_table', 'grid_table'));
+        $provider = new NotSyncedDataProvider($tMapFactory, []);
+        static::assertEquals([], $provider->getIds('main_table', 'grid_table'));
     }
 
     /**
-     * @covers \Magento\Sales\Model\ResourceModel\Provider\IdListProvider::get
+     * @covers \Magento\Sales\Model\ResourceModel\Provider\NotSyncedDataProvider::get
      */
     public function testGet()
     {
@@ -58,42 +58,42 @@ public function testGet()
             ->disableOriginalConstructor()
             ->getMock();
 
-        $provider1 = $this->getMockBuilder(IdListProviderInterface::class)
+        $provider1 = $this->getMockBuilder(NotSyncedDataProviderInterface::class)
             ->getMockForAbstractClass();
         $provider1->expects(static::once())
             ->method('get')
             ->willReturn([1, 2]);
 
-        $provider2 = $this->getMockBuilder(IdListProviderInterface::class)
+        $provider2 = $this->getMockBuilder(NotSyncedDataProviderInterface::class)
             ->getMockForAbstractClass();
         $provider2->expects(static::once())
             ->method('get')
-            ->willReturn([3, 4]);
+            ->willReturn([2, 3, 4]);
 
         $tMapFactory->expects(static::once())
             ->method('create')
             ->with(
                 [
                     'array' => [
-                        'provider1' => IdListProviderInterface::class,
-                        'provider2' => IdListProviderInterface::class
+                        'provider1' => NotSyncedDataProviderInterface::class,
+                        'provider2' => NotSyncedDataProviderInterface::class
                     ],
-                    'type' => IdListProviderInterface::class
+                    'type' => NotSyncedDataProviderInterface::class
                 ]
             )
             ->willReturn($tMap);
         $tMap->expects(static::once())
             ->method('getIterator')
             ->willReturn(new \ArrayIterator([$provider1, $provider2]));
 
-        $provider = new IdListProvider(
+        $provider = new NotSyncedDataProvider(
             $tMapFactory,
             [
-                'provider1' => IdListProviderInterface::class,
-                'provider2' => IdListProviderInterface::class,
+                'provider1' => NotSyncedDataProviderInterface::class,
+                'provider2' => NotSyncedDataProviderInterface::class,
             ]
         );
 
-        static::assertEquals([1, 2, 3, 4], $provider->get('main_table', 'grid_table'));
+        static::assertEquals([1, 2, 3, 4], array_values($provider->getIds('main_table', 'grid_table')));
     }
 }