magento-engcom/bulk-api#4 Support for Async operations in WebAPI

- Fixed static tests

Author: vrann

app/code/Magento/AsynchronousOperations/Model/BulkOperationsStatus.php

@@ -6,51 +6,20 @@
 
 namespace Magento\AsynchronousOperations\Model;
 
-use Magento\AsynchronousOperations\Model\ResourceModel\Bulk\CollectionFactory as BulkCollectionFactory;
-use Magento\AsynchronousOperations\Model\ResourceModel\Operation\CollectionFactory as OperationCollectionFactory;
-use Magento\AsynchronousOperations\Api\Data\OperationInterface;
-use Magento\AsynchronousOperations\Api\Data\BulkSummaryInterface;
-use Magento\Framework\App\ResourceConnection;
-use Magento\AsynchronousOperations\Model\BulkStatus\CalculatedStatusSql;
-use Magento\Framework\EntityManager\MetadataPool;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\EntityManager\EntityManager;
 use Magento\AsynchronousOperations\Api\Data\BulkStatusInterfaceFactory as BulkStatusShortFactory;
 use Magento\AsynchronousOperations\Api\Data\DetailedBulkStatusInterfaceFactory as BulkStatusDetailedFactory;
 use Magento\AsynchronousOperations\Api\Data\OperationDetailsInterfaceFactory;
 use Magento\AsynchronousOperations\Api\BulkStatusInterface;
+use Magento\AsynchronousOperations\Model\ResourceModel\Operation\CollectionFactory;
 
 /**
  * Class BulkStatus
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class BulkOperationsStatus implements BulkStatusInterface
 {
-    /**
-     * @var \Magento\AsynchronousOperations\Api\Data\BulkSummaryInterfaceFactory
-     */
-    private $bulkCollectionFactory;
-
-    /**
-     * @var \Magento\AsynchronousOperations\Api\Data\OperationInterfaceFactory
-     */
-    private $operationCollectionFactory;
-
-    /**
-     * @var ResourceConnection
-     */
-    private $resourceConnection;
-
-    /**
-     * @var CalculatedStatusSql
-     */
-    private $calculatedStatusSql;
-
-    /**
-     * @var MetadataPool
-     */
-    private $metadataPool;
-
     /**
      * @var EntityManager
      */
@@ -66,33 +35,34 @@ class BulkOperationsStatus implements BulkStatusInterface
      */
     private $bulkShortFactory;
 
+    /**
+     * @var BulkStatus
+     */
+    private $bulkStatus;
+
+    /**
+     * @var \Magento\AsynchronousOperations\Api\Data\OperationInterfaceFactory
+     */
+    private $operationCollectionFactory;
+
     /**
      * Init dependencies.
      *
-     * @param \Magento\AsynchronousOperations\Model\ResourceModel\Bulk\CollectionFactory $bulkCollection
-     * @param \Magento\AsynchronousOperations\Model\ResourceModel\Operation\CollectionFactory $operationCollection
-     * @param \Magento\Framework\App\ResourceConnection $resourceConnection
-     * @param \Magento\AsynchronousOperations\Model\BulkStatus\CalculatedStatusSql $calculatedStatusSql
-     * @param \Magento\Framework\EntityManager\MetadataPool $metadataPool
+     * @param BulkStatus $bulkStatus
+     * @param CollectionFactory $operationCollection
      * @param BulkStatusDetailedFactory $bulkDetailedFactory
      * @param BulkStatusShortFactory $bulkShortFactory
      * @param \Magento\Framework\EntityManager\EntityManager $entityManager
      */
     public function __construct(
-        BulkCollectionFactory $bulkCollection,
-        OperationCollectionFactory $operationCollection,
-        ResourceConnection $resourceConnection,
-        CalculatedStatusSql $calculatedStatusSql,
-        MetadataPool $metadataPool,
+        BulkStatus $bulkStatus,
+        CollectionFactory $operationCollection,
         BulkStatusDetailedFactory $bulkDetailedFactory,
         BulkStatusShortFactory $bulkShortFactory,
         EntityManager $entityManager
     ) {
         $this->operationCollectionFactory = $operationCollection;
-        $this->bulkCollectionFactory = $bulkCollection;
-        $this->resourceConnection = $resourceConnection;
-        $this->calculatedStatusSql = $calculatedStatusSql;
-        $this->metadataPool = $metadataPool;
+        $this->bulkStatus = $bulkStatus;
         $this->bulkDetailedFactory = $bulkDetailedFactory;
         $this->bulkShortFactory = $bulkShortFactory;
         $this->entityManager = $entityManager;
@@ -103,127 +73,31 @@ public function __construct(
      */
     public function getFailedOperationsByBulkId($bulkUuid, $failureType = null)
     {
-        $failureCodes = $failureType
-            ? [$failureType]
-            : [
-                OperationInterface::STATUS_TYPE_RETRIABLY_FAILED,
-                OperationInterface::STATUS_TYPE_NOT_RETRIABLY_FAILED,
-            ];
-        $operations = $this->operationCollectionFactory->create()
-            ->addFieldToFilter('bulk_uuid', $bulkUuid)
-            ->addFieldToFilter('status', $failureCodes)
-            ->getItems();
-
-        return $operations;
+        return $this->bulkStatus->getFailedOperationsByBulkId($bulkUuid, $failureType);
     }
 
     /**
      * @inheritDoc
      */
     public function getOperationsCountByBulkIdAndStatus($bulkUuid, $status)
     {
-
-        /** @var \Magento\AsynchronousOperations\Model\ResourceModel\Operation\Collection $collection */
-        $collection = $this->operationCollectionFactory->create();
-
-        return $collection->addFieldToFilter('bulk_uuid', $bulkUuid)
-            ->addFieldToFilter('status', $status)
-            ->getSize();
+        return $this->bulkStatus->getOperationsCountByBulkIdAndStatus($bulkUuid, $status);
     }
 
     /**
      * @inheritDoc
      */
     public function getBulksByUser($userId)
     {
-        /** @var ResourceModel\Bulk\Collection $collection */
-        $collection = $this->bulkCollectionFactory->create();
-        $operationTableName = $this->resourceConnection->getTableName('magento_operation');
-        $statusesArray = [
-            OperationInterface::STATUS_TYPE_RETRIABLY_FAILED,
-            OperationInterface::STATUS_TYPE_NOT_RETRIABLY_FAILED,
-            BulkSummaryInterface::NOT_STARTED,
-            OperationInterface::STATUS_TYPE_OPEN,
-            OperationInterface::STATUS_TYPE_COMPLETE,
-        ];
-        $select = $collection->getSelect();
-        $select->columns(['status' => $this->calculatedStatusSql->get($operationTableName)])
-            ->order(
-                new \Zend_Db_Expr(
-                    'FIELD(status, ' . implode(',', $statusesArray) . ')'
-                )
-            );
-        $collection->addFieldToFilter('user_id', $userId)
-            ->addOrder('start_time');
-
-        return $collection->getItems();
+        return $this->bulkStatus->getBulksByUser($userId);
     }
 
     /**
      * @inheritDoc
      */
     public function getBulkStatus($bulkUuid)
     {
-        /**
-         * Number of operations that has been processed (i.e. operations with any status but 'open')
-         */
-        $allProcessedOperationsQty = (int)$this->operationCollectionFactory->create()
-            ->addFieldToFilter('bulk_uuid', $bulkUuid)
-            ->getSize();
-
-        if ($allProcessedOperationsQty == 0) {
-            return BulkSummaryInterface::NOT_STARTED;
-        }
-
-        /**
-         * Total number of operations that has been scheduled within the given bulk
-         */
-        $allOperationsQty = $this->getOperationCount($bulkUuid);
-
-        /**
-         * Number of operations that has not been started yet (i.e. operations with status 'open')
-         */
-        $allOpenOperationsQty = $allOperationsQty - $allProcessedOperationsQty;
-
-        /**
-         * Number of operations that has been completed successfully
-         */
-        $allCompleteOperationsQty = $this->operationCollectionFactory
-            ->create()
-            ->addFieldToFilter('bulk_uuid', $bulkUuid)
-            ->addFieldToFilter(
-                'status',
-                OperationInterface::STATUS_TYPE_COMPLETE
-            )
-            ->getSize();
-
-        if ($allCompleteOperationsQty == $allOperationsQty) {
-            return BulkSummaryInterface::FINISHED_SUCCESSFULLY;
-        }
-
-        if ($allOpenOperationsQty > 0 && $allOpenOperationsQty !== $allOperationsQty) {
-            return BulkSummaryInterface::IN_PROGRESS;
-        }
-
-        return BulkSummaryInterface::FINISHED_WITH_FAILURE;
-    }
-
-    /**
-     * Get total number of operations that has been scheduled within the given bulk.
-     *
-     * @param string $bulkUuid
-     * @return int
-     */
-    private function getOperationCount($bulkUuid)
-    {
-        $metadata = $this->metadataPool->getMetadata(BulkSummaryInterface::class);
-        $connection = $this->resourceConnection->getConnectionByName($metadata->getEntityConnectionName());
-
-        return (int)$connection->fetchOne(
-            $connection->select()
-                ->from($metadata->getEntityTable(), 'operation_count')
-                ->where('uuid = ?', $bulkUuid)
-        );
+        return $this->bulkStatus->getBulkStatus($bulkUuid);
     }
 
     /**

dev/tests/integration/testsuite/Magento/Webapi/Controller/Rest/SchemaRequestProcessorTest.php

@@ -25,6 +25,19 @@ public function testSchemaRequest($path)
         $this->assertRegExp('/200 Success/', $schema);
     }
 
+    /**
+     * Response getter
+     *
+     * @return \Magento\Framework\App\ResponseInterface
+     */
+    public function getResponse()
+    {
+        if (!$this->_response) {
+            $this->_response = $this->_objectManager->get(\Magento\Framework\Webapi\Rest\Response::class);
+        }
+        return $this->_response;
+    }
+
     /**
      * @return array
      */