MAGETWO-92260: GraphQL - Fix urlResolver query to support relative path #13

Author: Alex Paliarush

app/code/Magento/CmsUrlRewriteGraphQl/Model/Resolver/UrlRewrite/HomePageUrlResolver.php renamed to app/code/Magento/CmsUrlRewriteGraphQl/Model/Resolver/UrlRewrite/HomePageUrlLocator.php

@@ -7,14 +7,14 @@
 
 namespace Magento\CmsUrlRewriteGraphQl\Model\Resolver\UrlRewrite;
 
-use Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite\CustomUrlResolverInterface;
+use Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite\CustomUrlLocatorInterface;
 use Magento\Store\Model\ScopeInterface;
 use Magento\Cms\Helper\Page;
 
 /**
- * Home page URL resolver.
+ * Home page URL locator.
  */
-class HomePageUrlResolver implements CustomUrlResolverInterface
+class HomePageUrlLocator implements CustomUrlLocatorInterface
 {
     /**
      * @var \Magento\Framework\App\Config\ScopeConfigInterface
@@ -33,7 +33,7 @@ public function __construct(
     /**
      * @inheritdoc
      */
-    public function resolveUrl($urlKey): ?string
+    public function locateUrl($urlKey): ?string
     {
         if ($urlKey === '/') {
             $homePageUrl = $this->scopeConfig->getValue(

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

@@ -6,10 +6,10 @@
  */
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
-    <type name="Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite\CustomUrlResolver">
+    <type name="Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite\CustomUrlLocator">
         <arguments>
-            <argument name="urlResolvers" xsi:type="array">
-                <item name="homePageResolver" xsi:type="object">Magento\CmsUrlRewriteGraphQl\Model\Resolver\UrlRewrite\HomePageUrlResolver</item>
+            <argument name="urlLocators" xsi:type="array">
+                <item name="homePageUrlLocator" xsi:type="object">Magento\CmsUrlRewriteGraphQl\Model\Resolver\UrlRewrite\HomePageUrlLocator</item>
             </argument>
         </arguments>
     </type>

app/code/Magento/UrlRewriteGraphQl/Model/Resolver/UrlRewrite.php

@@ -14,7 +14,7 @@
 use Magento\Framework\GraphQl\Query\ResolverInterface;
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\UrlRewrite\Model\UrlFinderInterface;
-use Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite\CustomUrlResolverInterface;
+use Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite\CustomUrlLocatorInterface;
 
 /**
  * UrlRewrite field resolver, used for GraphQL request processing.
@@ -37,26 +37,26 @@ class UrlRewrite implements ResolverInterface
     private $valueFactory;
 
     /**
-     * @var UrlRewrite\CustomUrlResolverInterface
+     * @var CustomUrlLocatorInterface
      */
-    private $customUrlResolver;
+    private $customUrlLocator;
 
     /**
      * @param UrlFinderInterface $urlFinder
      * @param StoreManagerInterface $storeManager
      * @param ValueFactory $valueFactory
-     * @param CustomUrlResolverInterface $customUrlResolver
+     * @param CustomUrlLocatorInterface $customUrlLocator
      */
     public function __construct(
         UrlFinderInterface $urlFinder,
         StoreManagerInterface $storeManager,
         ValueFactory $valueFactory,
-        CustomUrlResolverInterface $customUrlResolver
+        CustomUrlLocatorInterface $customUrlLocator
     ) {
         $this->urlFinder = $urlFinder;
         $this->storeManager = $storeManager;
         $this->valueFactory = $valueFactory;
-        $this->customUrlResolver = $customUrlResolver;
+        $this->customUrlLocator = $customUrlLocator;
     }
 
     /**
@@ -78,7 +78,7 @@ public function resolve(
             if (substr($url, 0, 1) === '/' && $url !== '/') {
                 $url = ltrim($url, '/');
             }
-            $customUrl = $this->customUrlResolver->resolveUrl($url);
+            $customUrl = $this->customUrlLocator->locateUrl($url);
             $url = $customUrl ?: $url;
             $urlRewrite = $this->findCanonicalUrl($url);
             if ($urlRewrite) {

app/code/Magento/UrlRewriteGraphQl/Model/Resolver/UrlRewrite/CustomUrlLocator.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite;
+
+/**
+ * Pool of custom URL locators.
+ */
+class CustomUrlLocator implements CustomUrlLocatorInterface
+{
+    /**
+     * @var CustomUrlLocatorInterface[]
+     */
+    private $urlLocators;
+
+    /**
+     * @param CustomUrlLocatorInterface[] $urlLocators
+     */
+    public function __construct(array $urlLocators = [])
+    {
+        $this->urlLocators = $urlLocators;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function locateUrl($urlKey): ?string
+    {
+        foreach ($this->urlLocators as $urlLocator) {
+            $url = $urlLocator->locateUrl($urlKey);
+            if ($url !== null) {
+                return $url;
+            }
+        }
+        return null;
+    }
+}

app/code/Magento/UrlRewriteGraphQl/Model/Resolver/UrlRewrite/CustomUrlResolverInterface.php renamed to app/code/Magento/UrlRewriteGraphQl/Model/Resolver/UrlRewrite/CustomUrlLocatorInterface.php

@@ -12,13 +12,13 @@
  *
  * It can be used, for example, to resolve '\' URL path to a 'Home' page.
  */
-interface CustomUrlResolverInterface
+interface CustomUrlLocatorInterface
 {
     /**
      * Resolve URL based on custom rules.
      *
      * @param string $urlKey
      * @return string|null Return null if URL cannot be resolved
      */
-    public function resolveUrl($urlKey): ?string;
+    public function locateUrl($urlKey): ?string;
 }

app/code/Magento/UrlRewriteGraphQl/Model/Resolver/UrlRewrite/CustomUrlResolver.php

@@ -6,5 +6,5 @@
  */
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
-    <preference for="Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite\CustomUrlResolverInterface" type="Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite\CustomUrlResolver"/>
+    <preference for="Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite\CustomUrlLocatorInterface" type="Magento\UrlRewriteGraphQl\Model\Resolver\UrlRewrite\CustomUrlLocator"/>
 </config>