Merge pull request #8 from mageworx/update_support_of_route_query_bug…

…fixes WIP: Bugfix for Custom Redirects in GraphQL
mageworx · Sep 23, 2024 · 0e9ec5f · 0e9ec5f
2 parents 21c228c + 8a2f159
commit 0e9ec5f
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 30 deletions.
diff --git a/Model/CustomRedirectDataProvider.php b/Model/CustomRedirectDataProvider.php
@@ -8,10 +8,11 @@
 
 namespace MageWorx\SeoRedirectsGraphQl\Model;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\GraphQl\Query\Uid;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\UrlRewrite\Model\UrlFinderInterface;
-use Magento\UrlRewrite\Model\UrlRewriteFactory;
+use Magento\UrlRewrite\Service\V1\Data\UrlRewriteFactory;
 use Magento\UrlRewrite\Service\V1\Data\UrlRewrite;
 use Magento\UrlRewriteGraphQl\Model\DataProvider\EntityDataProviderComposite;
 use MageWorx\SeoRedirects\Api\Data\CustomRedirectInterface;
@@ -98,28 +99,7 @@ public function getEntityUrlDataByCustomRedirectEntity(CustomRedirectInterface $
      */
     public function getUrlRewriteDataByCustomRedirectEntity(CustomRedirectInterface $customRedirect): ?array
     {
-        $urlRewrite = $this->getUrlRewrite($customRedirect);
-
-        if (!$urlRewrite) {
-            // Trying to get rewrite to custom url by target path
-            $urlRewrite = $this->getRewriteByTargetPath($customRedirect->getTargetEntityIdentifier(), (int)$customRedirect->getStoreId());
-            if (!$urlRewrite) {
-                // Trying to get rewrite to custom url by request path
-                $urlRewrite = $this->getRewriteByRequestPath($customRedirect->getTargetEntityIdentifier(), (int)$customRedirect->getStoreId());
-                if (!$urlRewrite) {
-                    // Create new URL rewrite dummy entity to return the data about our custom redirect
-                    /** @var \Magento\UrlRewrite\Model\UrlRewrite $urlRewrite */
-                    $urlRewrite = $this->urlRewriteFactory->create();
-                    $urlRewrite->setEntityId(0);
-                    $urlRewrite->setRequestPath($customRedirect->getTargetEntityIdentifier());
-                    $urlRewrite->setEntityType('CUSTOM');
-                    $urlRewrite->setStoreId((int)$customRedirect->getStoreId());
-                    $urlRewrite->setMetadata(['redirect_code' => $customRedirect->getRedirectCode()]);
-                    $urlRewrite->setRedirectType($customRedirect->getRedirectCode());
-                    $urlRewrite->setTargetPath($customRedirect->getTargetEntityIdentifier());
-                }
-            }
-        }
+        $urlRewrite = $this->searchUrlRewriteByCustomRedirect($customRedirect);
 
         return [
             'id'            => $urlRewrite->getEntityId(),
@@ -152,11 +132,7 @@ public function getRouteData(int $storeId, int $objectId, string $objectType, Re
             return null;
         }
 
-        $urlRewrite = $this->getUrlRewrite($customRedirect);
-
-        if (!$urlRewrite) {
-            return null;
-        }
+        $urlRewrite = $this->searchUrlRewriteByCustomRedirect($customRedirect);
 
         $type   = $this->sanitizeType($urlRewrite->getEntityType());
         $result = $this->entityDataProviderComposite->getData($type, (int)$urlRewrite->getEntityId(), $info, $storeId);
@@ -195,9 +171,43 @@ protected function getCustomRedirect(int $storeId, int $objectId, string $object
         return $customRedirectCollection->getFirstItem();
     }
 
+    /**
+     * @param CustomRedirect $customRedirect
+     * @return UrlRewrite
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    protected function searchUrlRewriteByCustomRedirect(CustomRedirect $customRedirect): UrlRewrite
+    {
+        $urlRewrite = $this->getUrlRewrite($customRedirect);
+
+        if (!$urlRewrite) {
+            // Trying to get rewrite to custom url by target path
+            $urlRewrite = $this->getRewriteByTargetPath($customRedirect->getTargetEntityIdentifier(), (int)$customRedirect->getStoreId());
+            if (!$urlRewrite) {
+                // Trying to get rewrite to custom url by request path
+                $urlRewrite = $this->getRewriteByRequestPath($customRedirect->getTargetEntityIdentifier(), (int)$customRedirect->getStoreId());
+                if (!$urlRewrite) {
+                    // Create new URL rewrite dummy entity to return the data about our custom redirect
+                    /** @var \Magento\UrlRewrite\Model\UrlRewrite $urlRewrite */
+                    $urlRewrite = $this->urlRewriteFactory->create();
+                    $urlRewrite->setEntityId(0);
+                    $urlRewrite->setRequestPath($customRedirect->getTargetEntityIdentifier());
+                    $urlRewrite->setEntityType(CustomRedirectTypeOptions::TYPE_CUSTOM);
+                    $urlRewrite->setStoreId((int)$customRedirect->getStoreId());
+                    $urlRewrite->setMetadata(['redirect_code' => $customRedirect->getRedirectCode()]);
+                    $urlRewrite->setRedirectType($customRedirect->getRedirectCode());
+                    $urlRewrite->setTargetPath($customRedirect->getTargetEntityIdentifier());
+                }
+            }
+        }
+
+        return $urlRewrite;
+    }
+
     /**
      * @param CustomRedirect $customRedirect
      * @return UrlRewrite|null
+     * @throws LocalizedException
      */
     protected function getUrlRewrite(CustomRedirect $customRedirect): ?UrlRewrite
     {

diff --git a/Model/CustomUrlTypeResolver.php b/Model/CustomUrlTypeResolver.php
@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © MageWorx. All rights reserved.
+ * See LICENSE.txt for license details.
+ */
+declare(strict_types = 1);
+
+namespace MageWorx\SeoRedirectsGraphQl\Model;
+
+use Magento\Framework\GraphQl\Query\Resolver\TypeResolverInterface;
+use MageWorx\SeoRedirectsGraphQl\Model\Source\CustomRedirectType;
+
+class CustomUrlTypeResolver implements TypeResolverInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function resolveType(array $data) : string
+    {
+        if (isset($data['type_id']) && $data['type_id'] === CustomRedirectType::TYPE_CUSTOM) {
+            return 'CustomUrlRedirect';
+        }
+        return '';
+    }
+}
diff --git a/Model/Source/CustomRedirectType.php b/Model/Source/CustomRedirectType.php
@@ -4,7 +4,7 @@
  * See LICENSE.txt for license details.
  */
 
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace MageWorx\SeoRedirectsGraphQl\Model\Source;
 
@@ -15,6 +15,7 @@ class CustomRedirectType
     const TYPE_PRODUCT  = 'PRODUCT';
     const TYPE_CATEGORY = 'CATEGORY';
     const TYPE_CMS_PAGE = 'CMS_PAGE';
+    const TYPE_CUSTOM   = 'CUSTOM';
 
     /**
      * @return array
@@ -24,7 +25,8 @@ public function getTypes(): array
         return [
             self::TYPE_PRODUCT  => CustomRedirect::REDIRECT_TYPE_PRODUCT,
             self::TYPE_CATEGORY => CustomRedirect::REDIRECT_TYPE_CATEGORY,
-            self::TYPE_CMS_PAGE => CustomRedirect::REDIRECT_TYPE_PAGE
+            self::TYPE_CMS_PAGE => CustomRedirect::REDIRECT_TYPE_PAGE,
+            self::TYPE_CUSTOM   => CustomRedirect::REDIRECT_TYPE_CUSTOM
         ];
     }
 }
diff --git a/etc/graphql/di.xml b/etc/graphql/di.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © MageWorx. All rights reserved.
+ * See LICENSE.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <type name="Magento\UrlRewriteGraphQl\Model\RoutableInterfaceTypeResolver">
+        <arguments>
+            <argument name="productTypeNameResolvers" xsi:type="array">
+                <item name="CustomUrlRedirect" xsi:type="object">MageWorx\SeoRedirectsGraphQl\Model\CustomUrlTypeResolver</item>
+            </argument>
+        </arguments>
+    </type>
+</config>
diff --git a/etc/schema.graphqls b/etc/schema.graphqls
@@ -1,3 +1,5 @@
 enum UrlRewriteEntityTypeEnum @doc(description: "This enumeration adds the CUSTOM entity type.") {
     CUSTOM
 }
+type CustomUrlRedirect implements RoutableInterface @doc(description: "Defines properties of a custom redirect entity. In Progress.") {
+}