Draft: Grouped products functionality

Controller/Product/Card.php

@@ -4,6 +4,8 @@
 
 namespace Tweakwise\Magento2Tweakwise\Controller\Product;
 
+use Magento\Catalog\Model\Product;
+use Magento\PageCache\Model\Cache\Type as PageType;
 use Tweakwise\Magento2Tweakwise\Helper\Cache;
 use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\App\RequestInterface;
@@ -36,13 +38,24 @@ public function __construct(
      */
     public function execute(): HttpInterface
     {
-        $itemId = (string) $this->request->getParam('item_id');
-        $cardType = $this->request->getParam('card_type');
-        $itemHtml = $cardType ? $this->cacheHelper->load($itemId, $cardType) :
-            $this->cacheHelper->load($itemId);
+        $itemId = (string)$this->request->getParam('item_id');
+        $cacheKeyInfo = (string)$this->request->getParam('cache_key_info');
+        $itemHtml = $this->cacheHelper->load($cacheKeyInfo);
 
         $response = $this->httpFactory->create();
         $response->appendBody($itemHtml);
+
+        $response->setHeader(
+            'X-Magento-Tags',
+            implode(
+                ',',
+                [
+                    Product::CACHE_TAG,
+                    sprintf('%s_%s', Product::CACHE_TAG, $itemId),
+                    PageType::CACHE_TAG
+                ]
+            )
+        );
         $response->setPublicHeaders($this->config->getProductCardLifetime());
         return $response;
     }

Helper/Cache.php

@@ -4,15 +4,16 @@
 
 namespace Tweakwise\Magento2Tweakwise\Helper;
 
-use Magento\Customer\Model\Session;
+use Magento\Catalog\Model\Product;
+use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
 use Magento\Framework\App\CacheInterface;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\View\DesignInterface;
 use Magento\PageCache\Model\Config;
-use Magento\Store\Model\StoreManagerInterface;
 use Tweakwise\Magento2Tweakwise\Model\Config as TweakwiseConfig;
 
 class Cache
@@ -27,49 +28,51 @@ class Cache
     private ?bool $isHyvaTheme = null;
 
     /**
-     * @param StoreManagerInterface $storeManager
      * @param CacheInterface $cache
-     * @param Session $customerSession
      * @param RequestInterface $request
      * @param ScopeConfigInterface $scopeConfig
      * @param TweakwiseConfig $config
      * @param DesignInterface $viewDesign
+     * @param Json $jsonSerializer
      */
     public function __construct(
-        private readonly StoreManagerInterface $storeManager,
-        private readonly CacheInterface        $cache,
-        private readonly Session               $customerSession,
-        private readonly RequestInterface      $request,
-        private readonly ScopeConfigInterface  $scopeConfig,
-        private readonly TweakwiseConfig       $config,
-        private readonly DesignInterface       $viewDesign
+        private readonly CacheInterface $cache,
+        private readonly RequestInterface $request,
+        private readonly ScopeConfigInterface $scopeConfig,
+        private readonly TweakwiseConfig $config,
+        private readonly DesignInterface $viewDesign,
+        private readonly Json $jsonSerializer
     ) {
     }
 
     /**
-     * @param string $itemId
-     * @param string $cardType
+     * @param string $hashedCacheKeyInfo
      * @return string
      * @throws LocalizedException
      * @throws NoSuchEntityException
      */
-    public function load(string $itemId, string $cardType = 'default'): string
+    public function load(string $hashedCacheKeyInfo): string
     {
-        $result = $this->cache->load($this->getCacheKey($itemId, $cardType));
+        $result = $this->cache->load($this->getCacheKey($hashedCacheKeyInfo));
         return $result ? $result : '';
     }
 
     /**
      * @param string $data
-     * @param string $itemId
-     * @param string $cardType
+     * @param string $hashedCacheKeyInfo
+     * @param array $tags
      * @return void
      * @throws LocalizedException
      * @throws NoSuchEntityException
      */
-    public function save(string $data, string $itemId, string $cardType = 'default'): void
+    public function save(string $data, string $hashedCacheKeyInfo, array $tags = []): void
     {
-        $this->cache->save($data, $this->getCacheKey($itemId, $cardType));
+        $this->cache->save(
+            $data,
+            $this->getCacheKey($hashedCacheKeyInfo),
+            $tags,
+            $this->config->getProductCardLifetime()
+        );
     }
 
     /**
@@ -88,6 +91,20 @@ public function isVarnishEnabled(): bool
         return $this->scopeConfig->getValue(Config::XML_PAGECACHE_TYPE) === (string) Config::VARNISH;
     }
 
+    /**
+     * @param Product $item
+     * @return string
+     * @throws LocalizedException
+     */
+    public function getImage(Product $item): string
+    {
+        if (!$this->config->isGroupedProductsEnabled() || $item->getTypeId() !== Configurable::TYPE_CODE) {
+            return '';
+        }
+
+        return $item->getImage();
+    }
+
     /**
      * @return bool
      */
@@ -129,23 +146,32 @@ public function isHyvaTheme(): bool
 
     /**
      * @param string $itemId
+     * @param int $storeId
+     * @param int $customerGroupId
+     * @param string $image
      * @param string $cardType
      * @return string
-     * @throws LocalizedException
-     * @throws NoSuchEntityException
      */
-    private function getCacheKey(string $itemId, string $cardType): string
-    {
-        $storeId = $this->storeManager->getStore()->getId();
-        $customerGroupId = $this->customerSession->getCustomerGroupId();
+    public function hashCacheKeyInfo(
+        string $itemId,
+        int $storeId,
+        int $customerGroupId,
+        string $image = '',
+        string $cardType = 'default',
+    ): string {
+        return sha1($this->jsonSerializer->serialize([$itemId, $storeId, $customerGroupId, $image, $cardType]));
+    }
 
+    /**
+     * @param string $hashedCacheKeyInfo
+     * @return string
+     */
+    private function getCacheKey(string $hashedCacheKeyInfo): string
+    {
         return sprintf(
-            '%s_%s_%s_%s_%s',
-            $storeId,
-            $customerGroupId,
-            $itemId,
-            $cardType,
-            self::REDIS_CACHE_KEY
+            '%s_%s',
+            self::REDIS_CACHE_KEY,
+            $hashedCacheKeyInfo
         );
     }
 }

Model/Catalog/Product/Collection.php

@@ -10,6 +10,7 @@
 namespace Tweakwise\Magento2Tweakwise\Model\Catalog\Product;
 
 use Exception;
+use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
 use Tweakwise\Magento2Tweakwise\Model\Config;
 use Tweakwise\Magento2Tweakwise\Model\Enum\ItemType;
 use Tweakwise\Magento2Tweakwise\Api\Data\VisualInterface;
@@ -167,11 +168,33 @@ protected function _afterLoad()
         parent::_afterLoad();
 
         $this->applyCollectionSizeValues();
+        $this->applyProductImages();
         $this->addVisuals();
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
+    protected function applyProductImages(): AbstractCollection
+    {
+        foreach ($this->getProductImages() as $productId => $productImageUrl) {
+            if (
+                !isset($this->_items[$productId]) ||
+                $this->_items[$productId]->getTypeId() !== Configurable::TYPE_CODE
+            ) {
+                continue;
+            }
+
+            $this->_items[$productId]->setData('image', $productImageUrl);
+            $this->_items[$productId]->setData('small_image', $productImageUrl);
+            $this->_items[$productId]->setData('thumbnail', $productImageUrl);
+        }
+
+        return $this;
+    }
+
     /**
      * @return void
      */
@@ -207,4 +230,18 @@ protected function getProductIds()
         $response = $this->navigationContext->getResponse();
         return $response->getProductIds() ?? [];
     }
+
+    /**
+     * @return array
+     */
+    protected function getProductImages(): array
+    {
+        try {
+            $response = $this->navigationContext->getResponse();
+        } catch (Exception $e) {
+            return [];
+        }
+
+        return $response->getProductImages() ?? [];
+    }
 }

Model/Client/Request.php

@@ -29,6 +29,11 @@ class Request
      */
     protected $path;
 
+    /**
+     * @var string
+     */
+    protected $groupedPath;
+
     /**
      * @var array
      */
@@ -76,6 +81,10 @@ public function getResponseType()
      */
     public function getPath()
     {
+        if ($this->config->isGroupedProductsEnabled($this->storeManager->getStore()) && !empty($this->groupedPath)) {
+            return $this->groupedPath;
+        }
+
         return $this->path;
     }
 

Model/Client/Request/AutocompleteRequest.php

@@ -19,6 +19,11 @@ class AutocompleteRequest extends Request
      */
     protected $path = 'autocomplete';
 
+    /**
+     * @var string
+     */
+    protected $groupedPath = 'autocomplete/grouped';
+
     /**
      * {@inheritDoc}
      */

Model/Client/Request/ProductNavigationRequest.php

@@ -9,11 +9,22 @@
 
 namespace Tweakwise\Magento2Tweakwise\Model\Client\Request;
 
+use Magento\Framework\Exception\LocalizedException;
 use Tweakwise\Magento2Tweakwise\Model\Client\Request;
 use Tweakwise\Magento2Tweakwise\Model\Client\Response\ProductNavigationResponse;
 
 class ProductNavigationRequest extends Request
 {
+    /**
+     * @var string
+     */
+    protected $path = 'navigation';
+
+    /**
+     * @var string
+     */
+    protected $groupedPath = 'navigation/grouped';
+
     /**
      * Maximum number of products returned for one request
      */
@@ -25,11 +36,6 @@ class ProductNavigationRequest extends Request
     private const SORT_ASC = 'ASC';
     private const SORT_DESC = 'DESC';
 
-    /**
-     * @var string
-     */
-    protected $path = 'navigation';
-
     /**
      * @var array
      */

Model/Client/Request/ProductSearchRequest.php

@@ -21,4 +21,9 @@ class ProductSearchRequest extends ProductNavigationRequest implements SearchReq
      * @var string
      */
     protected $path = 'navigation-search';
+
+    /**
+     * @var string
+     */
+    protected $groupedPath = 'navigation-search/grouped';
 }

Model/Client/Request/Recommendations/ProductRequest.php

@@ -34,6 +34,11 @@ public function getProduct()
     public function setProduct(Product $product)
     {
         $this->product = $product;
+
+        if ($this->config->isGroupedProductsEnabled() && $product->getTypeId() === 'configurable') {
+            $this->product = $this->getSimpleProduct($product);
+        }
+
         return $this;
     }
 
@@ -63,4 +68,18 @@ public function getPathSuffix()
 
         return '/' . $productTweakwiseId . parent::getPathSuffix();
     }
+
+    /**
+     * @param Product $product
+     * @return Product
+     */
+    private function getSimpleProduct(Product $product): Product
+    {
+        $children = $product->getTypeInstance()->getUsedProducts($product);
+        foreach ($children as $child) {
+            if ($child->isSaleable() && $child->getTypeId() === Magento\Catalog\Model\Product\Type::TYPE_SIMPLE) {
+                return $child;
+            }
+        }
+    }
 }

Model/Client/Request/Suggestions/ProductSuggestionsRequest.php

@@ -19,6 +19,8 @@ class ProductSuggestionsRequest extends Request implements SearchRequestInterfac
      */
     protected $path = 'suggestions/products';
 
+    protected $groupedPath = 'suggestions/products/grouped';
+
     /**
      * @return string
      */

Model/Client/Request/Suggestions/SuggestionsRequest.php

@@ -19,6 +19,11 @@ class SuggestionsRequest extends Request implements SearchRequestInterface
      */
     protected $path = 'suggestions';
 
+    /**
+     * @var string
+     */
+    protected $groupedPath = 'suggestions/grouped';
+
     /**
      * @return string
      */