Merge remote-tracking branch '33090/32460_GraphQL_catalog_url_path' into comm_voted_v1

Author: engcom-Charlie

app/code/Magento/CatalogGraphQl/Model/Resolver/Products/Query/CategoryUrlPathArgsProcessor.php

@@ -0,0 +1,90 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogGraphQl\Model\Resolver\Products\Query;
+
+use Magento\Catalog\Model\ResourceModel\Category\Collection;
+use Magento\Catalog\Model\ResourceModel\Category\CollectionFactory;
+use Magento\Framework\GraphQl\Exception\GraphQlInputException;
+use Magento\Framework\GraphQl\Query\Resolver\ArgumentsProcessorInterface;
+
+/**
+ * Category Path processor class for category url path argument
+ */
+class CategoryUrlPathArgsProcessor implements ArgumentsProcessorInterface
+{
+    private const ID = 'category_id';
+
+    private const UID = 'category_uid';
+
+    private const URL_PATH = 'category_url_path';
+
+    /**
+     * @var CollectionFactory
+     */
+    private $collectionFactory;
+
+    /**
+     * @param CollectionFactory $collectionFactory
+     */
+    public function __construct(CollectionFactory $collectionFactory)
+    {
+        $this->collectionFactory = $collectionFactory;
+    }
+
+    /**
+     * Composite processor that loops through available processors for arguments that come from graphql input
+     *
+     * @param string $fieldName
+     * @param array $args
+     * @return array
+     * @throws GraphQlInputException
+     */
+    public function process(
+        string $fieldName,
+        array $args
+    ): array {
+        $idFilter = $args['filter'][self::ID] ?? [];
+        $uidFilter = $args['filter'][self::UID] ?? [];
+        $pathFilter = $args['filter'][self::URL_PATH] ?? [];
+
+        if (!empty($pathFilter) && $fieldName === 'products') {
+            if (!empty($idFilter)) {
+                throw new GraphQlInputException(
+                    __('`%1` and `%2` can\'t be used at the same time.', [self::ID, self::URL_PATH])
+                );
+            } elseif (!empty($uidFilter)) {
+                throw new GraphQlInputException(
+                    __('`%1` and `%2` can\'t be used at the same time.', [self::UID, self::URL_PATH])
+                );
+            }
+
+            /** @var Collection $collection */
+            $collection = $this->collectionFactory->create();
+            $collection->addAttributeToSelect('entity_id');
+            $collection->addAttributeToFilter('url_path', $pathFilter);
+
+            if ($collection->count() === 0) {
+                throw new GraphQlInputException(
+                    __('No category with the provided `%1` was found', [self::URL_PATH])
+                );
+            } elseif ($collection->count() === 1) {
+                $category = $collection->getFirstItem();
+                $args['filter'][self::ID]['eq'] = $category->getId();
+            } else {
+                $categoryIds = [];
+                foreach ($collection as $category) {
+                    $categoryIds[] = $category->getId();
+                }
+                $args['filter'][self::ID]['in'] = $categoryIds;
+            }
+
+            unset($args['filter'][self::URL_PATH]);
+        }
+        return $args;
+    }
+}

app/code/Magento/CatalogGraphQl/etc/di.xml

@@ -78,6 +78,7 @@
     <type name="Magento\Framework\GraphQl\Query\Resolver\ArgumentsCompositeProcessor">
         <arguments>
             <argument name="processors" xsi:type="array">
+                <item name="category_url_path" xsi:type="object">Magento\CatalogGraphQl\Model\Resolver\Products\Query\CategoryUrlPathArgsProcessor</item>
                 <item name="category_uid" xsi:type="object">Magento\CatalogGraphQl\Model\Resolver\Products\Query\CategoryUidArgsProcessor</item>
                 <item name="category_uids" xsi:type="object">Magento\CatalogGraphQl\Model\Category\CategoryUidsArgsProcessor</item>
                 <item name="parent_category_uids" xsi:type="object">Magento\CatalogGraphQl\Model\Category\ParentCategoryUidsArgsProcessor</item>

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

@@ -344,6 +344,7 @@ type CategoryProducts @doc(description: "Contains details about the products ass
 input ProductAttributeFilterInput @doc(description: "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.") {
     category_id: FilterEqualTypeInput @deprecated(reason: "Use `category_uid` instead.") @doc(description: "Deprecated: use `category_uid` to filter product by category ID.")
     category_uid: FilterEqualTypeInput @doc(description: "Filter product by the unique ID for a `CategoryInterface` object.")
+    category_url_path: FilterEqualTypeInput @doc(description: "Filter product by category URL path.")
 }
 
 input CategoryFilterInput  @doc(description: "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.")