MC-15991: Category image return only image name

Author: danielrenaud

app/code/Magento/CatalogGraphQl/Model/Config/CategoryAttributeReader.php

@@ -51,16 +51,24 @@ class CategoryAttributeReader implements ReaderInterface
      */
     private $collectionFactory;
 
+    /**
+     * @var array
+     */
+    private $categoryAttributeResolvers;
+
     /**
      * @param Type $typeLocator
      * @param CollectionFactory $collectionFactory
+     * @param array $categoryAttributeResolvers
      */
     public function __construct(
         Type $typeLocator,
-        CollectionFactory $collectionFactory
+        CollectionFactory $collectionFactory,
+        array $categoryAttributeResolvers = []
     ) {
         $this->typeLocator = $typeLocator;
         $this->collectionFactory = $collectionFactory;
+        $this->categoryAttributeResolvers = $categoryAttributeResolvers;
     }
 
     /**
@@ -93,6 +101,9 @@ public function read($scope = null) : array
             $data['fields'][$attributeCode]['name'] = $attributeCode;
             $data['fields'][$attributeCode]['type'] = $locatedType;
             $data['fields'][$attributeCode]['arguments'] = [];
+            if (isset($this->categoryAttributeResolvers[$attributeCode])) {
+                $data['fields'][$attributeCode]['resolver'] = $this->categoryAttributeResolvers[$attributeCode];
+            }
         }
 
         $config['CategoryInterface'] = $data;

app/code/Magento/CatalogGraphQl/Model/Resolver/Category/Image.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogGraphQl\Model\Resolver\Category;
+
+use Magento\Framework\GraphQl\Config\Element\Field;
+use Magento\Framework\GraphQl\Query\ResolverInterface;
+use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Store\Api\Data\StoreInterface;
+
+/**
+ * Resolve category image to a fully qualified URL
+ */
+class Image implements ResolverInterface
+{
+    /**
+     * @inheritdoc
+     */
+    public function resolve(
+        Field $field,
+        $context,
+        ResolveInfo $info,
+        array $value = null,
+        array $args = null
+    ) {
+        if (!isset($value['model'])) {
+            throw new LocalizedException(__('"model" value should be specified'));
+        }
+        $category = $value['model'];
+        $imagePath = $category->getImage();
+        if (empty($imagePath)) {
+            return null;
+        }
+        /** @var StoreInterface $store */
+        $store = $context->getExtensionAttributes()->getStore();
+        $baseUrl = $store->getBaseUrl();
+        $imageUrl = rtrim($baseUrl, '/') . '/' . ltrim($imagePath, '/');
+
+        return $imageUrl;
+    }
+}

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

@@ -137,4 +137,12 @@
             </argument>
         </arguments>
     </type>
+
+    <type name="Magento\CatalogGraphQl\Model\Config\CategoryAttributeReader">
+        <arguments>
+            <argument name="categoryAttributeResolvers" xsi:type="array">
+                <item name="image" xsi:type="string">Magento\CatalogGraphQl\Model\Resolver\Category\Image</item>
+            </argument>
+        </arguments>
+    </type>
 </config>

dev/tests/api-functional/testsuite/Magento/GraphQl/Catalog/CategoryTest.php

@@ -13,6 +13,7 @@
 use Magento\Catalog\Model\CategoryRepository;
 use Magento\Catalog\Model\ResourceModel\Category\Collection as CategoryCollection;
 use Magento\Framework\DataObject;
+use Magento\Store\Model\StoreManagerInterface;
 use Magento\TestFramework\ObjectManager;
 use Magento\TestFramework\TestCase\GraphQl\ResponseContainsErrorsException;
 use Magento\TestFramework\TestCase\GraphQlAbstract;
@@ -553,6 +554,53 @@ public function testBreadCrumbs()
         $this->assertEquals($expectedResponse, $response);
     }
 
+    /**
+     * Test category image is returned as full url (not relative path)
+     *
+     * @magentoApiDataFixture Magento/Catalog/_files/catalog_category_with_image.php
+     */
+    public function testCategoryImage()
+    {
+        $categoryCollection = $this->objectManager->get(CategoryCollection::class);
+        $categoryModel = $categoryCollection
+            ->addAttributeToSelect('image')
+            ->addAttributeToFilter('name', ['eq' => 'Parent Image Category'])
+            ->getFirstItem();
+        $categoryId = $categoryModel->getId();
+
+        $query = <<<QUERY
+    {
+  category(id: {$categoryId}) {
+    id
+    name
+    url_key
+    image
+    children {
+      id
+      name
+      url_key
+      image
+    }
+  }
+}
+QUERY;
+
+        $response = $this->graphQlQuery($query);
+        $this->assertArrayNotHasKey('errors', $response);
+        $this->assertNotEmpty($response['category']);
+        $category = $response['category'];
+        $storeBaseUrl = $this->objectManager->get(StoreManagerInterface::class)->getStore()->getBaseUrl();
+        $expectedImageUrl = rtrim($storeBaseUrl, '/') . '/' . ltrim($categoryModel->getImage(), '/');
+
+        $this->assertEquals($categoryId, $category['id']);
+        $this->assertEquals('Parent Image Category', $category['name']);
+        $this->assertEquals($expectedImageUrl, $category['image']);
+
+        $childCategory = $category['children'][0];
+        $this->assertEquals('Child Image Category', $childCategory['name']);
+        $this->assertEquals($expectedImageUrl, $childCategory['image']);
+    }
+
     /**
      * @param ProductInterface $product
      * @param array $actualResponse

dev/tests/integration/testsuite/Magento/Catalog/_files/catalog_category_with_image.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+require_once 'catalog_category_image.php';
+
+/** @var $category \Magento\Catalog\Model\Category */
+$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
+
+$categoryParent = $objectManager->create(\Magento\Catalog\Model\Category::class);
+$categoryParent->setName('Parent Image Category')
+    ->setPath('1/2')
+    ->setLevel(2)
+    ->setImage($filePath)
+    ->setAvailableSortBy('name')
+    ->setDefaultSortBy('name')
+    ->setIsActive(true)
+    ->setPosition(1)
+    ->save();
+
+$categoryChild = $objectManager->create(\Magento\Catalog\Model\Category::class);
+$categoryChild->setName('Child Image Category')
+    ->setPath($categoryParent->getPath())
+    ->setLevel(3)
+    ->setImage($filePath)
+    ->setAvailableSortBy('name')
+    ->setDefaultSortBy('name')
+    ->setIsActive(true)
+    ->setPosition(2)
+    ->save();

dev/tests/integration/testsuite/Magento/Catalog/_files/catalog_category_with_image_rollback.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+/** @var \Magento\Framework\ObjectManagerInterface $objectManager */
+$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
+
+/** @var \Magento\Framework\Registry $registry */
+$registry = $objectManager->get(\Magento\Framework\Registry::class);
+
+$registry->unregister('isSecureArea');
+$registry->register('isSecureArea', true);
+
+/** @var \Magento\Catalog\Model\ResourceModel\Product\Collection $collection */
+$collection = $objectManager->create(\Magento\Catalog\Model\ResourceModel\Category\Collection::class);
+$collection
+    ->addAttributeToFilter('name', ['in' => ['Parent Image Category', 'Child Image Category']])
+    ->load()
+    ->delete();
+
+$registry->unregister('isSecureArea');
+$registry->register('isSecureArea', false);