merge magento/2.3-develop into magento-trigger/elasticsearch_spike

Author: magento-mts-svc

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

@@ -13,6 +13,8 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Store\Api\Data\StoreInterface;
 use Magento\Framework\Filesystem\DirectoryList;
+use Magento\Catalog\Model\Category\FileInfo;
+use Magento\Framework\GraphQl\Exception\GraphQlInputException;
 
 /**
  * Resolve category image to a fully qualified URL
@@ -22,12 +24,19 @@ class Image implements ResolverInterface
     /** @var DirectoryList  */
     private $directoryList;
 
+    /** @var FileInfo  */
+    private $fileInfo;
+
     /**
      * @param DirectoryList $directoryList
+     * @param FileInfo $fileInfo
      */
-    public function __construct(DirectoryList $directoryList)
-    {
+    public function __construct(
+        DirectoryList $directoryList,
+        FileInfo $fileInfo
+    ) {
         $this->directoryList = $directoryList;
+        $this->fileInfo = $fileInfo;
     }
 
     /**
@@ -45,21 +54,40 @@ public function resolve(
         }
         /** @var \Magento\Catalog\Model\Category $category */
         $category = $value['model'];
-        $imagePath = $category->getImage();
+        $imagePath = $category->getData('image');
         if (empty($imagePath)) {
             return null;
         }
         /** @var StoreInterface $store */
         $store = $context->getExtensionAttributes()->getStore();
-        $baseUrl = $store->getBaseUrl('media');
+        $baseUrl = $store->getBaseUrl();
 
-        $mediaPath = $this->directoryList->getUrlPath('media');
-        $pos = strpos($imagePath, $mediaPath);
-        if ($pos !== false) {
-            $imagePath = substr($imagePath, $pos + strlen($mediaPath), strlen($baseUrl));
+        $filenameWithMedia =  $this->fileInfo->isBeginsWithMediaDirectoryPath($imagePath)
+            ? $imagePath : $this->formatFileNameWithMediaCategoryFolder($imagePath);
+
+        if (!$this->fileInfo->isExist($filenameWithMedia)) {
+            throw new GraphQlInputException(__('Category image not found.'));
         }
-        $imageUrl = rtrim($baseUrl, '/') . '/' . ltrim($imagePath, '/');
 
-        return $imageUrl;
+        // return full url
+        return rtrim($baseUrl, '/') . $filenameWithMedia;
+    }
+
+    /**
+     * Format category media folder to filename
+     *
+     * @param string $fileName
+     * @return string
+     */
+    private function formatFileNameWithMediaCategoryFolder(string $fileName): string
+    {
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
+        $baseFileName = basename($fileName);
+        return '/'
+            . $this->directoryList->getUrlPath('media')
+            . '/'
+            . ltrim(FileInfo::ENTITY_MEDIA_PATH, '/')
+            . '/'
+            . $baseFileName;
     }
 }

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

@@ -7,6 +7,8 @@
 
 namespace Magento\GraphQl\Catalog;
 
+use Magento\Catalog\Model\ResourceModel\Category\Collection as CategoryCollection;
+use Magento\Framework\ObjectManagerInterface;
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\TestFramework\TestCase\GraphQlAbstract;
@@ -16,6 +18,16 @@
  */
 class CategoryListTest extends GraphQlAbstract
 {
+    /**
+     * @var ObjectManagerInterface
+     */
+    private $objectManager;
+
+    protected function setUp()
+    {
+        $this->objectManager = Bootstrap::getObjectManager();
+    }
+
     /**
      * @magentoApiDataFixture Magento/Catalog/_files/categories.php
      * @dataProvider filterSingleCategoryDataProvider
@@ -333,7 +345,7 @@ public function testEmptyFiltersReturnRootCategory()
     }
 }
 QUERY;
-        $storeManager = Bootstrap::getObjectManager()->get(StoreManagerInterface::class);
+        $storeManager = $this->objectManager->get(StoreManagerInterface::class);
         $storeRootCategoryId = $storeManager->getStore()->getRootCategoryId();
 
         $result = $this->graphQlQuery($query);
@@ -369,6 +381,46 @@ public function testMinimumMatchQueryLength()
         $this->assertEquals([], $result['categoryList']);
     }
 
+    /**
+     * Test category image full name is returned
+     *
+     * @magentoApiDataFixture Magento/Catalog/_files/catalog_category_with_long_image_name.php
+     */
+    public function testCategoryImageName()
+    {
+        /** @var CategoryCollection $categoryCollection */
+        $categoryCollection = $this->objectManager->get(CategoryCollection::class);
+        $categoryModel = $categoryCollection
+            ->addAttributeToSelect('image')
+            ->addAttributeToFilter('name', ['eq' => 'Parent Image Category'])
+            ->getFirstItem();
+        $categoryId = $categoryModel->getId();
+
+        $query = <<<QUERY
+    {
+categoryList(filters: {ids: {in: ["$categoryId"]}}) {
+  id
+  name
+  image
+ }
+}
+QUERY;
+        $storeManager = $this->objectManager->get(StoreManagerInterface::class);
+        $storeBaseUrl = $storeManager->getStore()->getBaseUrl('media');
+
+        $expected = "catalog/category/magento_long_image_name_magento_long_image_name_magento_long_image_name.jpg";
+        $expectedImageUrl = rtrim($storeBaseUrl, '/') . '/' . $expected;
+
+        $response = $this->graphQlQuery($query);
+        $categoryList = $response['categoryList'];
+        $this->assertArrayNotHasKey('errors', $response);
+        $this->assertNotEmpty($response['categoryList']);
+        $expectedImageUrl = str_replace('index.php/', '', $expectedImageUrl);
+        $categoryList[0]['image'] = str_replace('index.php/', '', $categoryList[0]['image']);
+        $this->assertEquals('Parent Image Category', $categoryList[0]['name']);
+        $this->assertEquals($expectedImageUrl, $categoryList[0]['image']);
+    }
+
     /**
      * @return array
      */

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

@@ -13,6 +13,8 @@
 use Magento\Catalog\Model\CategoryRepository;
 use Magento\Catalog\Model\ResourceModel\Category\Collection as CategoryCollection;
 use Magento\Framework\DataObject;
+use Magento\Framework\EntityManager\MetadataPool;
+use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\TestFramework\ObjectManager;
 use Magento\TestFramework\TestCase\GraphQl\ResponseContainsErrorsException;
@@ -33,10 +35,22 @@ class CategoryTest extends GraphQlAbstract
      */
     private $categoryRepository;
 
+    /**
+     * @var Store
+     */
+    private $store;
+
+    /**
+     * @var MetadataPool
+     */
+    private $metadataPool;
+
     protected function setUp()
     {
         $this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
         $this->categoryRepository = $this->objectManager->get(CategoryRepository::class);
+        $this->store = $this->objectManager->get(Store::class);
+        $this->metadataPool = $this->objectManager->get(MetadataPool::class);
     }
 
     /**
@@ -211,7 +225,7 @@ public function testCategoriesTreeWithDisabledCategory()
         productImagePreview: products(pageSize: 1) {
             items {
                 id
-                } 
+                }
             }
       }
     }
@@ -557,17 +571,49 @@ public function testBreadCrumbs()
     /**
      * Test category image is returned as full url (not relative path)
      *
+     * @param string $imagePrefix
      * @magentoApiDataFixture Magento/Catalog/_files/catalog_category_with_image.php
+     * @dataProvider categoryImageDataProvider
      */
-    public function testCategoryImage()
+    public function testCategoryImage(?string $imagePrefix)
     {
+        /** @var CategoryCollection $categoryCollection */
         $categoryCollection = $this->objectManager->get(CategoryCollection::class);
         $categoryModel = $categoryCollection
             ->addAttributeToSelect('image')
             ->addAttributeToFilter('name', ['eq' => 'Parent Image Category'])
             ->getFirstItem();
         $categoryId = $categoryModel->getId();
 
+        if ($imagePrefix !== null) {
+            // update image to account for different stored image formats
+            $connection = $categoryCollection->getConnection();
+            $productLinkField = $this->metadataPool
+                ->getMetadata(\Magento\Catalog\Api\Data\ProductInterface::class)
+                ->getLinkField();
+
+            $defaultStoreId = $this->store->getId();
+
+            $imageAttributeValue = $imagePrefix . basename($categoryModel->getImage());
+
+            if (!empty($imageAttributeValue)) {
+                $query = sprintf(
+                    'UPDATE %s SET `value` = "%s" ' .
+                    'WHERE `%s` = %d ' .
+                    'AND `store_id`= %d ' .
+                    'AND `attribute_id` = ' .
+                    '(SELECT `ea`.`attribute_id` FROM %s ea WHERE `ea`.`attribute_code` = "image" LIMIT 1)',
+                    $connection->getTableName('catalog_category_entity_varchar'),
+                    $imageAttributeValue,
+                    $productLinkField,
+                    $categoryModel->getData($productLinkField),
+                    $defaultStoreId,
+                    $connection->getTableName('eav_attribute')
+                );
+                $connection->query($query);
+            }
+        }
+
         $query = <<<QUERY
     {
 categoryList(filters: {ids: {in: ["$categoryId"]}}) {
@@ -591,17 +637,41 @@ public function testCategoryImage()
         $this->assertNotEmpty($response['categoryList']);
         $categoryList = $response['categoryList'];
         $storeBaseUrl = $this->objectManager->get(StoreManagerInterface::class)->getStore()->getBaseUrl('media');
-        $expectedImageUrl = rtrim($storeBaseUrl, '/'). '/' . ltrim($categoryModel->getImage(), '/');
+        $expectedImageUrl = rtrim($storeBaseUrl, '/') . '/' . ltrim($categoryModel->getImage(), '/');
+        $expectedImageUrl = str_replace('index.php/', '', $expectedImageUrl);
 
         $this->assertEquals($categoryId, $categoryList[0]['id']);
         $this->assertEquals('Parent Image Category', $categoryList[0]['name']);
+        $categoryList[0]['image'] = str_replace('index.php/', '', $categoryList[0]['image']);
         $this->assertEquals($expectedImageUrl, $categoryList[0]['image']);
 
         $childCategory = $categoryList[0]['children'][0];
         $this->assertEquals('Child Image Category', $childCategory['name']);
+        $childCategory['image'] = str_replace('index.php/', '', $childCategory['image']);
         $this->assertEquals($expectedImageUrl, $childCategory['image']);
     }
 
+    /**
+     * @return array
+     */
+    public function categoryImageDataProvider(): array
+    {
+        return [
+            'default_filename_strategy' => [
+                'image_prefix' => null
+            ],
+            'just_filename_strategy' => [
+                'image_prefix' => ''
+            ],
+            'with_pub_media_strategy' => [
+                'image_prefix' => '/pub/media/catalog/category/'
+            ],
+            'catalog_category_strategy' => [
+                'image_prefix' => 'catalog/category/'
+            ],
+        ];
+    }
+
     /**
      * @param ProductInterface $product
      * @param array $actualResponse

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

@@ -13,7 +13,10 @@
 $mediaDirectory = $objectManager->get(\Magento\Framework\Filesystem::class)
     ->getDirectoryWrite(DirectoryList::MEDIA);
 $fileName = 'magento_small_image.jpg';
+$fileNameLong = 'magento_long_image_name_magento_long_image_name_magento_long_image_name.jpg';
 $filePath = 'catalog/category/' . $fileName;
+$filePathLong = 'catalog/category/' . $fileNameLong;
 $mediaDirectory->create('catalog/category');
 
 copy(__DIR__ . DIRECTORY_SEPARATOR . $fileName, $mediaDirectory->getAbsolutePath($filePath));
+copy(__DIR__ . DIRECTORY_SEPARATOR . $fileNameLong, $mediaDirectory->getAbsolutePath($filePathLong));

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

@@ -4,7 +4,7 @@
  * See COPYING.txt for license details.
  */
 
-require_once 'catalog_category_image.php';
+require 'catalog_category_image.php';
 
 /** @var $category \Magento\Catalog\Model\Category */
 $objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();

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

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+require '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($filePathLong)
+    ->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($fileNameLong)
+    ->setAvailableSortBy('name')
+    ->setDefaultSortBy('name')
+    ->setIsActive(true)
+    ->setPosition(2)
+    ->save();

dev/tests/integration/testsuite/Magento/Catalog/_files/catalog_category_with_long_image_name_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);