ACP2E-645: Filtering products by colour swatch on search page does not display correct image for some products

Author: viktym

app/code/Magento/Swatches/Block/Product/Renderer/Listing/Configurable.php

@@ -102,6 +102,23 @@ public function __construct(
         $this->layerResolver = $layerResolver ?: ObjectManager::getInstance()->get(Resolver::class);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getCacheKey()
+    {
+        $key = parent::getCacheKey();
+        $configurableAttributes = $this->getLayeredAttributesIfExists(
+            $this->getProduct(),
+            $this->getRequest()->getQuery()->toArray()
+        );
+        if (!empty($configurableAttributes)) {
+            $key .= '-' . sha1(json_encode($configurableAttributes));
+        }
+
+        return $key;
+    }
+
     /**
      * @inheritdoc
      */

app/code/Magento/Swatches/Test/Unit/Block/Product/Renderer/Listing/ConfigurableTest.php

@@ -7,6 +7,7 @@
 
 namespace Magento\Swatches\Test\Unit\Block\Product\Renderer\Listing;
 
+use Magento\Catalog\Block\Product\Context;
 use Magento\Catalog\Helper\Image;
 use Magento\Catalog\Helper\Product;
 use Magento\Catalog\Model\Product\Attribute\Source\Status;
@@ -17,13 +18,18 @@
 use Magento\ConfigurableProduct\Model\Product\Type\Configurable\Attribute;
 use Magento\ConfigurableProduct\Model\Product\Type\Configurable\Variations\Prices;
 use Magento\Customer\Helper\Session\CurrentCustomer;
+use Magento\Eav\Api\Data\AttributeInterface;
 use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
 use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\Request\Http;
+use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Json\EncoderInterface;
+use Magento\Framework\Model\AbstractModel;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
 use Magento\Framework\Pricing\PriceInfo\Base;
 use Magento\Framework\Stdlib\ArrayUtils;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\Store\Model\StoreManagerInterface;
 use Magento\Swatches\Block\Product\Renderer\Configurable;
 use Magento\Swatches\Block\Product\Renderer\Listing\Configurable as ConfigurableRenderer;
 use Magento\Swatches\Helper\Media;
@@ -84,6 +90,11 @@ class ConfigurableTest extends TestCase
     /** @var MockObject */
     private $variationPricesMock;
 
+    /**
+     * @var RequestInterface|MockObject
+     */
+    private $request;
+
     protected function setUp(): void
     {
         $this->arrayUtils = $this->createMock(ArrayUtils::class);
@@ -105,11 +116,22 @@ protected function setUp(): void
         $this->variationPricesMock = $this->createMock(
             Prices::class
         );
+        $customerSession = $this->createMock(\Magento\Customer\Model\Session::class);
+        $this->request = $this->getMockBuilder(Http::class)
+            ->addMethods(['toArray'])
+            ->onlyMethods(['getQuery'])
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->request->method('getQuery')->willReturnSelf();
+        $context = $this->getContextMock();
+        $context->method('getRequest')->willReturn($this->request);
 
         $objectManagerHelper = new ObjectManager($this);
         $this->configurable = $objectManagerHelper->getObject(
             ConfigurableRenderer::class,
             [
+                'context' => $context,
                 'scopeConfig' => $this->scopeConfig,
                 'imageHelper' => $this->imageHelper,
                 'imageUrlBuilder' => $this->imageUrlBuilder,
@@ -123,7 +145,8 @@ protected function setUp(): void
                 'priceCurrency' => $this->priceCurrency,
                 'configurableAttributeData' => $this->configurableAttributeData,
                 'data' => [],
-                'variationPrices' => $this->variationPricesMock
+                'variationPrices' => $this->variationPricesMock,
+                'customerSession' => $customerSession,
             ]
         );
     }
@@ -262,4 +285,61 @@ public function testGetPricesJson()
         $this->jsonEncoder->expects($this->once())->method('encode')->with($expectedPrices);
         $this->configurable->getPricesJson();
     }
+
+    /**
+     * Tests that cache key contains query params.
+     *
+     * @return void
+     */
+    public function testGetCacheKey()
+    {
+        $requestParams = ['color' => 59, 'size' => 1, 'random_param' => '123'];
+
+        $attr1 = $this->getMockForAbstractClass(AttributeInterface::class);
+        $attr1->method('getAttributeCode')->willReturn('color');
+        $attr2 = $this->getMockForAbstractClass(AttributeInterface::class);
+        $attr2->method('getAttributeCode')->willReturn('size');
+        $configurableAttributes = [$attr1, $attr2];
+
+        $currency = $this->createMock(AbstractModel::class);
+        $this->priceCurrency->method('getCurrency')->willReturn($currency);
+        $this->swatchHelper->method('getAttributesFromConfigurable')
+            ->with($this->product)
+            ->willReturn($configurableAttributes);
+
+        $this->request->method('toArray')->willReturn($requestParams);
+        $this->assertStringContainsString(
+            sha1(json_encode(['color' => 59, 'size' => 1])),
+            $this->configurable->getCacheKey()
+        );
+    }
+
+    /**
+     * Returns context object mock.
+     *
+     * @return Context|MockObject
+     */
+    private function getContextMock()
+    {
+        $context = $this->createMock(Context::class);
+        $storeManager = $this->getMockForAbstractClass(StoreManagerInterface::class);
+        $store = $this->getMockForAbstractClass(\Magento\Store\Api\Data\StoreInterface::class);
+        $storeManager->method('getStore')->willReturn($store);
+        $appState = $this->createMock(\Magento\Framework\App\State::class);
+        $resolver = $this->createMock(\Magento\Framework\View\Element\Template\File\Resolver::class);
+        $urlBuilder = $this->getMockForAbstractClass(\Magento\Framework\UrlInterface::class);
+        $registry = $this->createMock(\Magento\Framework\Registry::class);
+        $product = $this->createMock(\Magento\Catalog\Model\Product::class);
+        $productType = $this->createMock(\Magento\Catalog\Model\Product\Type\AbstractType::class);
+        $product->method('getTypeInstance')->willReturn($productType);
+        $product->method('getId')->willReturn(1);
+        $registry->method('registry')->with('product')->willReturn($product);
+        $context->method('getStoreManager')->willReturn($storeManager);
+        $context->method('getAppState')->willReturn($appState);
+        $context->method('getResolver')->willReturn($resolver);
+        $context->method('getUrlBuilder')->willReturn($urlBuilder);
+        $context->method('getRegistry')->willReturn($registry);
+
+        return $context;
+    }
 }