MAGETWO-8709: [GITHUB] Child product image should be shown in Wishist if options are selected for configurable product #8168

- refactoring to consolidate code for both cart and wishlist with a composite class
- removing and deprecating old references

Author: cpartica

app/code/Magento/Catalog/Model/Product/Configuration/Item/ItemResolverComposite.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Catalog\Model\Product\Configuration\Item;
+
+/**
+ * Composite implementation for @see ItemResolverInterface
+ */
+class ItemResolverComposite implements ItemResolverInterface
+{
+    /** @var ItemResolverInterface[] */
+    private $itemResolvers = [];
+
+    /**
+     * @param ItemResolverInterface[] $itemResolvers
+     */
+    public function __construct(array $itemResolvers)
+    {
+        $this->itemResolvers = $itemResolvers;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFinalProduct(
+        \Magento\Catalog\Model\Product\Configuration\Item\ItemInterface $item
+    ) : \Magento\Catalog\Api\Data\ProductInterface {
+        $product = $item->getProduct();
+        foreach ($this->itemResolvers as $resolver) {
+            $resolvedProduct = $resolver->getFinalProduct($item);
+            if ($resolvedProduct !== $product) {
+                return $resolvedProduct;
+            }
+        }
+        return $product;
+    }
+}

app/code/Magento/Catalog/Model/Product/Configuration/Item/ItemResolverInterface.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Catalog\Model\Product\Configuration\Item;
+
+/**
+ * Resolves the product for a configured item
+ *
+ * @api
+ */
+interface ItemResolverInterface
+{
+    /**
+     * Get the final product from a configured item by product type and selection
+     *
+     * @param ItemInterface $item
+     * @return \Magento\Catalog\Api\Data\ProductInterface
+     */
+    public function getFinalProduct(\Magento\Catalog\Model\Product\Configuration\Item\ItemInterface $item)
+    : \Magento\Catalog\Api\Data\ProductInterface;
+}

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

@@ -70,7 +70,8 @@
     <preference for="Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface" type="Magento\Catalog\Model\ProductRender\FormattedPriceInfo" />
     <preference for="Magento\Framework\Indexer\BatchProviderInterface" type="Magento\Framework\Indexer\BatchProvider" />
     <preference for="Magento\Catalog\Model\Indexer\Product\Price\UpdateIndexInterface" type="Magento\Catalog\Model\Indexer\Product\Price\InvalidateIndex" />
-    <preference for="\Magento\Catalog\Model\Product\Gallery\ImagesConfigFactoryInterface" type="\Magento\Catalog\Model\Product\Gallery\ImagesConfigFactory" />
+    <preference for="Magento\Catalog\Model\Product\Gallery\ImagesConfigFactoryInterface" type="Magento\Catalog\Model\Product\Gallery\ImagesConfigFactory" />
+    <preference for="Magento\Catalog\Model\Product\Configuration\Item\ItemResolverInterface" type="Magento\Catalog\Model\Product\Configuration\Item\ItemResolverComposite" />
     <type name="Magento\Customer\Model\ResourceModel\Visitor">
         <plugin name="catalogLog" type="Magento\Catalog\Model\Plugin\Log" />
     </type>

app/code/Magento/Checkout/Block/Cart/Item/Renderer.php

@@ -11,6 +11,8 @@
 use Magento\Framework\View\Element\AbstractBlock;
 use Magento\Framework\View\Element\Message\InterpretationStrategyInterface;
 use Magento\Quote\Model\Quote\Item\AbstractItem;
+use Magento\Framework\App\ObjectManager;
+use Magento\Catalog\Model\Product\Configuration\Item\ItemResolverInterface;
 
 /**
  * Shopping cart item render block
@@ -21,6 +23,7 @@
  * @method \Magento\Checkout\Block\Cart\Item\Renderer setProductName(string)
  * @method \Magento\Checkout\Block\Cart\Item\Renderer setDeleteUrl(string)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
  */
 class Renderer extends \Magento\Framework\View\Element\Template implements
     \Magento\Framework\DataObject\IdentityInterface
@@ -91,6 +94,9 @@ class Renderer extends \Magento\Framework\View\Element\Template implements
      */
     private $messageInterpretationStrategy;
 
+    /** @var ItemResolverInterface */
+    private $itemResolver;
+
     /**
      * @param \Magento\Framework\View\Element\Template\Context $context
      * @param \Magento\Catalog\Helper\Product\Configuration $productConfig
@@ -102,6 +108,7 @@ class Renderer extends \Magento\Framework\View\Element\Template implements
      * @param \Magento\Framework\Module\Manager $moduleManager
      * @param InterpretationStrategyInterface $messageInterpretationStrategy
      * @param array $data
+     * @param ItemResolverInterface|null $itemResolver
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      * @codeCoverageIgnore
      */
@@ -115,7 +122,8 @@ public function __construct(
         PriceCurrencyInterface $priceCurrency,
         \Magento\Framework\Module\Manager $moduleManager,
         InterpretationStrategyInterface $messageInterpretationStrategy,
-        array $data = []
+        array $data = [],
+        ItemResolverInterface $itemResolver = null
     ) {
         $this->priceCurrency = $priceCurrency;
         $this->imageBuilder = $imageBuilder;
@@ -127,6 +135,7 @@ public function __construct(
         $this->_isScopePrivate = true;
         $this->moduleManager = $moduleManager;
         $this->messageInterpretationStrategy = $messageInterpretationStrategy;
+        $this->itemResolver = $itemResolver ?: ObjectManager::getInstance()->get(ItemResolverInterface::class);
     }
 
     /**
@@ -172,7 +181,7 @@ public function getProduct()
      */
     public function getProductForThumbnail()
     {
-        return $this->getProduct();
+        return $this->itemResolver->getFinalProduct($this->getItem());
     }
 
     /**

app/code/Magento/Checkout/CustomerData/DefaultItem.php

@@ -7,6 +7,7 @@
 namespace Magento\Checkout\CustomerData;
 
 use Magento\Framework\App\ObjectManager;
+use Magento\Catalog\Model\Product\Configuration\Item\ItemResolverInterface;
 
 /**
  * Default item
@@ -45,13 +46,17 @@ class DefaultItem extends AbstractItem
      */
     private $escaper;
 
+    /** @var ItemResolverInterface */
+    private $itemResolver;
+
     /**
      * @param \Magento\Catalog\Helper\Image $imageHelper
      * @param \Magento\Msrp\Helper\Data $msrpHelper
      * @param \Magento\Framework\UrlInterface $urlBuilder
      * @param \Magento\Catalog\Helper\Product\ConfigurationPool $configurationPool
      * @param \Magento\Checkout\Helper\Data $checkoutHelper
      * @param \Magento\Framework\Escaper|null $escaper
+     * @param ItemResolverInterface|null $itemResolver
      * @codeCoverageIgnore
      */
     public function __construct(
@@ -60,22 +65,27 @@ public function __construct(
         \Magento\Framework\UrlInterface $urlBuilder,
         \Magento\Catalog\Helper\Product\ConfigurationPool $configurationPool,
         \Magento\Checkout\Helper\Data $checkoutHelper,
-        \Magento\Framework\Escaper $escaper = null
+        \Magento\Framework\Escaper $escaper = null,
+        ItemResolverInterface $itemResolver = null
     ) {
         $this->configurationPool = $configurationPool;
         $this->imageHelper = $imageHelper;
         $this->msrpHelper = $msrpHelper;
         $this->urlBuilder = $urlBuilder;
         $this->checkoutHelper = $checkoutHelper;
         $this->escaper = $escaper ?: ObjectManager::getInstance()->get(\Magento\Framework\Escaper::class);
+        $this->itemResolver = $itemResolver ?: ObjectManager::getInstance()->get(ItemResolverInterface::class);
     }
 
     /**
      * {@inheritdoc}
      */
     protected function doGetItemData()
     {
-        $imageHelper = $this->imageHelper->init($this->getProductForThumbnail(), 'mini_cart_product_thumbnail');
+        $imageHelper = $this->imageHelper->init(
+            $this->itemResolver->getFinalProduct($this->item),
+            'mini_cart_product_thumbnail'
+        );
         $productName = $this->escaper->escapeHtml($this->item->getProduct()->getName());
 
         return [
@@ -115,11 +125,12 @@ protected function getOptionList()
 
     /**
      * @return \Magento\Catalog\Model\Product
+     * @deprecated
      * @codeCoverageIgnore
      */
     protected function getProductForThumbnail()
     {
-        return $this->getProduct();
+        return $this->itemResolver->getFinalProduct($this->item);
     }
 
     /**

app/code/Magento/Checkout/Model/Cart/ImageProvider.php

@@ -5,8 +5,10 @@
  */
 namespace Magento\Checkout\Model\Cart;
 
+use Magento\Checkout\CustomerData\DefaultItem;
+use Magento\Framework\App\ObjectManager;
+
 /**
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @api
  */
 class ImageProvider
@@ -18,20 +20,26 @@ class ImageProvider
 
     /**
      * @var \Magento\Checkout\CustomerData\ItemPoolInterface
+     * @deprecated
      */
     protected $itemPool;
 
+    /** @var \Magento\Checkout\CustomerData\DefaultItem */
+    protected $customerDataItem;
+
     /**
      * @param \Magento\Quote\Api\CartItemRepositoryInterface $itemRepository
      * @param \Magento\Checkout\CustomerData\ItemPoolInterface $itemPool
-     * @codeCoverageIgnore
+     * @param DefaultItem|null $customerDataItem
      */
     public function __construct(
         \Magento\Quote\Api\CartItemRepositoryInterface $itemRepository,
-        \Magento\Checkout\CustomerData\ItemPoolInterface $itemPool
+        \Magento\Checkout\CustomerData\ItemPoolInterface $itemPool,
+        \Magento\Checkout\CustomerData\DefaultItem $customerDataItem = null
     ) {
         $this->itemRepository = $itemRepository;
         $this->itemPool = $itemPool;
+        $this->customerDataItem = $customerDataItem ?? ObjectManager::getInstance()->get(DefaultItem::class);
     }
 
     /**
@@ -45,7 +53,7 @@ public function getImages($cartId)
         $items = $this->itemRepository->getList($cartId);
         /** @var \Magento\Quote\Model\Quote\Item $cartItem */
         foreach ($items as $cartItem) {
-            $allData = $this->itemPool->getItemData($cartItem);
+            $allData = $this->customerDataItem->getItemData($cartItem);
             $itemData[$cartItem->getItemId()] = $allData['product_image'];
         }
         return $itemData;

app/code/Magento/Checkout/etc/frontend/di.xml

@@ -39,7 +39,7 @@
     </type>
     <preference for="Magento\Checkout\CustomerData\ItemPoolInterface"
                 type="Magento\Checkout\CustomerData\ItemPool"/>
-    <type name="Magento\Checkout\CustomerData\ItemPoolInterface">
+    <type name="Magento\Checkout\CustomerData\ItemPool">
         <arguments>
             <argument name="defaultItemId" xsi:type="string">Magento\Checkout\CustomerData\DefaultItem</argument>
         </arguments>

app/code/Magento/ConfigurableProduct/Block/Cart/Item/Renderer/Configurable.php

@@ -57,25 +57,11 @@ public function getOptionList()
 
     /**
      * {@inheritdoc}
+     * @deprecated
      */
     public function getProductForThumbnail()
     {
-        /**
-         * Show parent product thumbnail if it must be always shown according to the related setting in system config
-         * or if child thumbnail is not available
-         */
-        if ($this->_scopeConfig->getValue(
-            self::CONFIG_THUMBNAIL_SOURCE,
-            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
-        ) == ThumbnailSource::OPTION_USE_PARENT_IMAGE
-          || !($this->getChildProduct()
-          && $this->getChildProduct()->getThumbnail() && $this->getChildProduct()->getThumbnail() != 'no_selection')
-        ) {
-            $product = $this->getProduct();
-        } else {
-            $product = $this->getChildProduct();
-        }
-        return $product;
+        return parent::getProductForThumbnail();
     }
 
     /**