ACP2E-894: add new argument to filter customer orders based on scope level

Author: alzota

app/code/Magento/SalesGraphQl/Model/Resolver/CustomerOrders.php

@@ -8,16 +8,19 @@
 namespace Magento\SalesGraphQl\Model\Resolver;
 
 use Magento\Framework\Api\SearchCriteriaBuilder;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\InputException;
 use Magento\Framework\GraphQl\Config\Element\Field;
 use Magento\Framework\GraphQl\Exception\GraphQlAuthorizationException;
 use Magento\Framework\GraphQl\Exception\GraphQlInputException;
 use Magento\Framework\GraphQl\Query\ResolverInterface;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
+use Magento\Sales\Api\Data\OrderSearchResultInterface;
 use Magento\Sales\Api\OrderRepositoryInterface;
 use Magento\SalesGraphQl\Model\Formatter\Order as OrderFormatter;
 use Magento\SalesGraphQl\Model\Resolver\CustomerOrders\Query\OrderFilter;
 use Magento\Store\Api\Data\StoreInterface;
+use Magento\Store\Model\StoreManagerInterface;
 
 /**
  * Orders data resolver
@@ -44,22 +47,30 @@ class CustomerOrders implements ResolverInterface
      */
     private $orderFormatter;
 
+    /**
+     * @var StoreManagerInterface|mixed|null
+     */
+    private $storeManager;
+
     /**
      * @param OrderRepositoryInterface $orderRepository
      * @param SearchCriteriaBuilder $searchCriteriaBuilder
      * @param OrderFilter $orderFilter
      * @param OrderFormatter $orderFormatter
+     * @param StoreManagerInterface|null $storeManager
      */
     public function __construct(
         OrderRepositoryInterface $orderRepository,
         SearchCriteriaBuilder $searchCriteriaBuilder,
         OrderFilter $orderFilter,
-        OrderFormatter $orderFormatter
+        OrderFormatter $orderFormatter,
+        StoreManagerInterface $storeManager = null
     ) {
         $this->orderRepository = $orderRepository;
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
         $this->orderFilter = $orderFilter;
         $this->orderFormatter = $orderFormatter;
+        $this->storeManager = ObjectManager::getInstance()->get(StoreManagerInterface::class) ?? null;
     }
 
     /**
@@ -81,11 +92,15 @@ public function resolve(
         if ($args['pageSize'] < 1) {
             throw new GraphQlInputException(__('pageSize value must be greater than 0.'));
         }
+        $storeIds = [];
         $userId = $context->getUserId();
         /** @var StoreInterface $store */
         $store = $context->getExtensionAttributes()->getStore();
+        if (isset($args['scope'])) {
+            $storeIds = $this->getStoresByScope($args['scope'], $store);
+        }
         try {
-            $searchResult = $this->getSearchResult($args, (int)$userId, (int)$store->getId());
+            $searchResult = $this->getSearchResult($args, (int)$userId, (int)$store->getId(), $storeIds);
             $maxPages = (int)ceil($searchResult->getTotalCount() / $searchResult->getPageSize());
         } catch (InputException $e) {
             throw new GraphQlInputException(__($e->getMessage()));
@@ -113,12 +128,13 @@ public function resolve(
      * @param array $args
      * @param int $userId
      * @param int $storeId
-     * @return \Magento\Sales\Api\Data\OrderSearchResultInterface
+     * @param array $scope
+     * @return OrderSearchResultInterface
      * @throws InputException
      */
-    private function getSearchResult(array $args, int $userId, int $storeId)
+    private function getSearchResult(array $args, int $userId, int $storeId, array $storeIds)
     {
-        $filterGroups = $this->orderFilter->createFilterGroups($args, $userId, (int)$storeId);
+        $filterGroups = $this->orderFilter->createFilterGroups($args, $userId, (int)$storeId, $storeIds);
         $this->searchCriteriaBuilder->setFilterGroups($filterGroups);
         if (isset($args['currentPage'])) {
             $this->searchCriteriaBuilder->setCurrentPage($args['currentPage']);
@@ -128,4 +144,52 @@ private function getSearchResult(array $args, int $userId, int $storeId)
         }
         return $this->orderRepository->getList($this->searchCriteriaBuilder->create());
     }
+
+    /**
+     * @param string $scope
+     * @param StoreInterface $store
+     * @return void
+     */
+    private function getStoresByScope(string $scope, StoreInterface $store)
+    {
+        $storeIds = [];
+        switch ($scope) {
+            case 'global':
+                $storeIds = $this->getStoresByFilter(null, null);
+                break;
+            case 'website':
+                    $websiteId = $store->getWebsiteId();
+                    $storeIds = $this->getStoresByFilter((int)$websiteId, null);
+                break;
+            case 'store':
+                    $storeGroupId = $store->getStoreGroupId();
+                    $storeIds = $this->getStoresByFilter(null, (int)$storeGroupId);
+                break;
+            default:
+                break;
+        }
+        return $storeIds;
+    }
+
+    /**
+     * @param int|null $websiteId
+     * @param int|null $storeGroupId
+     * @return array
+     */
+    private function getStoresByFilter(?int $websiteId, ?int $storeGroupId)
+    {
+        $stores = $this->storeManager->getStores(true, true);
+        $storeIds = [];
+        foreach ($stores as $store) {
+            if (isset($websiteId) && $websiteId === (int)$store->getWebsiteId()
+                ||
+                isset($storeGroupId) && $storeGroupId === (int)$store->getStoreGroupId()
+            ) {
+                $storeIds[] = $store->getId();
+            } elseif (!isset($websiteId) && !isset($storeGroupId)) {
+                $storeIds[] = $store->getId();
+            }
+        }
+        return $storeIds;
+    }
 }

app/code/Magento/SalesGraphQl/Model/Resolver/CustomerOrders/Query/OrderFilter.php

@@ -8,10 +8,10 @@
 namespace Magento\SalesGraphQl\Model\Resolver\CustomerOrders\Query;
 
 use Magento\Framework\Api\FilterBuilder;
+use Magento\Framework\Api\Search\FilterGroup;
 use Magento\Framework\Api\Search\FilterGroupBuilder;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Exception\InputException;
-use Magento\Framework\Api\Search\FilterGroup;
 
 /**
  * Order filter allows to filter collection using 'increment_id' as order number, from the search criteria.
@@ -63,20 +63,23 @@ public function __construct(
      * @param int $userId
      * @param int $storeId
      * @return FilterGroup[]
+     * @throws InputException
      */
     public function createFilterGroups(
         array $args,
         int $userId,
-        int $storeId
+        int $storeId,
+        array $storeIds
     ): array {
         $filterGroups = [];
         $this->filterGroupBuilder->setFilters(
             [$this->filterBuilder->setField('customer_id')->setValue($userId)->setConditionType('eq')->create()]
         );
         $filterGroups[] = $this->filterGroupBuilder->create();
 
+        $storeIds[] = $storeId;
         $this->filterGroupBuilder->setFilters(
-            [$this->filterBuilder->setField('store_id')->setValue($storeId)->setConditionType('eq')->create()]
+            [$this->filterBuilder->setField('store_id')->setValue($storeIds)->setConditionType('in')->create()]
         );
         $filterGroups[] = $this->filterGroupBuilder->create();
 

app/code/Magento/SalesGraphQl/etc/schema.graphqls

@@ -25,6 +25,7 @@ type Customer {
         filter: CustomerOrdersFilterInput @doc(description: "Defines the filter to use for searching customer orders."),
         currentPage: Int = 1 @doc(description: "Specifies which page of results to return. The default value is 1."),
         pageSize: Int = 20 @doc(description: "Specifies the maximum number of results to return at once. The default value is 20."),
+        scope: String @doc(description: "Specifies the scope of the orders (global, website, store)"),
     ): CustomerOrders @resolver(class: "Magento\\SalesGraphQl\\Model\\Resolver\\CustomerOrders") @cache(cacheable: false)
 }