Allow customer to specify associated product qtys when adding grouped via REST

Author: engcom-Charlie

app/code/Magento/GroupedProduct/Api/Data/GroupedItemQtyInterface.php

@@ -0,0 +1,45 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GroupedProduct\Api\Data;
+
+use Magento\Framework\Api\ExtensibleDataInterface;
+
+/**
+ * Represents `product item id with qty` of a grouped product.
+ */
+interface GroupedOptionsInterface extends ExtensibleDataInterface
+{
+    /**
+     * Get associated product id
+     *
+     * @return int
+     */
+    public function getId(): int;
+
+    /**
+     * Get associated product qty
+     *
+     * @return float
+     */
+    public function getQty(): float;
+
+    /**
+     * Set extension attributes
+     *
+     * @param \Magento\GroupedProduct\Api\Data\GroupedOptionsExtensionInterface $extensionAttributes
+     * @return void
+     */
+    public function setExtensionAttributes(GroupedOptionsExtensionInterface $extensionAttributes): void;
+
+    /**
+     * Get extension attributes
+     *
+     * @return \Magento\GroupedProduct\Api\Data\GroupedOptionsExtensionInterface|null
+     */
+    public function getExtensionAttributes(): ?GroupedOptionsExtensionInterface;
+}

app/code/Magento/GroupedProduct/Api/Data/GroupedOptionsInterface.php

@@ -389,7 +389,9 @@ protected function _prepareProduct(\Magento\Framework\DataObject $buyRequest, $p
 
             if (is_string($_result)) {
                 return $_result;
-            } elseif (!isset($_result[0])) {
+            }
+
+            if (!isset($_result[0])) {
                 return __('Cannot process the item.')->render();
             }
 
@@ -407,6 +409,11 @@ protected function _prepareProduct(\Magento\Framework\DataObject $buyRequest, $p
                         ]
                     )
                 );
+                if ($buyRequest->getSuperGroup()) {
+                    $serializedValue = $this->serializer->serialize($buyRequest->getSuperGroup());
+                    $_result[0]->addCustomOption('super_group', $serializedValue);
+                }
+
                 $products[] = $_result[0];
             } else {
                 $associatedProductsInfo[] = [$subProduct->getId() => $qty];

app/code/Magento/GroupedProduct/Model/Product/Type/Grouped.php

@@ -3,64 +3,94 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\GroupedProduct\Model\Quote\Item;
 
+use Magento\Framework\DataObject;
 use Magento\Framework\DataObject\Factory as ObjectFactory;
+use Magento\Framework\Serialize\Serializer\Json;
+use Magento\GroupedProduct\Api\Data\GroupedOptionsInterface;
+use Magento\GroupedProduct\Api\Data\GroupedOptionsInterfaceFactory;
+use Magento\GroupedProduct\Model\Product\Type\Grouped;
+use Magento\Quote\Api\Data as QuoteApi;
 use Magento\Quote\Api\Data\CartItemInterface;
-use Magento\Quote\Api\Data\ProductOptionInterface;
 use Magento\Quote\Model\Quote\Item\CartItemProcessorInterface;
 
 /**
- * A class that converts the Grouped Product super group, as received over RESTful API,
- * into the format needed within the buy request
- *
- * Class \Magento\GroupedProduct\Model\Quote\Item\CartItemProcessor
+ * Converts grouped_options to super_group for the grouped product.
  */
 class CartItemProcessor implements CartItemProcessorInterface
 {
+    private const SUPER_GROUP_CODE = 'super_group';
+
     /**
      * @var ObjectFactory
      */
     private $objectFactory;
 
     /**
-     * CartItemProcessor constructor.
-     *
+     * @var GroupedOptionsInterface
+     */
+    private $groupedOptionFactory;
+
+    /**
+     * @var Json
+     */
+    private $jsonSerializer;
+
+    /**
+     * @var QuoteApi\ProductOptionExtensionFactory
+     */
+    private $productOptionExtensionFactory;
+
+    /**
+     * @var QuoteApi\ProductOptionInterfaceFactory
+     */
+    private $productOptionFactory;
+
+    /**
      * @param ObjectFactory $objectFactory
+     * @param GroupedOptionsInterfaceFactory $groupedOptionFactory
+     * @param Json $jsonSerializer
+     * @param QuoteApi\ProductOptionExtensionFactory $productOptionExtensionFactory
+     * @param QuoteApi\ProductOptionInterfaceFactory $productOptionFactory
      */
-    public function __construct(ObjectFactory $objectFactory)
-    {
+    public function __construct(
+        ObjectFactory $objectFactory,
+        GroupedOptionsInterfaceFactory $groupedOptionFactory,
+        Json $jsonSerializer,
+        QuoteApi\ProductOptionExtensionFactory $productOptionExtensionFactory,
+        QuoteApi\ProductOptionInterfaceFactory $productOptionFactory
+    ) {
         $this->objectFactory = $objectFactory;
+        $this->groupedOptionFactory = $groupedOptionFactory;
+        $this->jsonSerializer = $jsonSerializer;
+        $this->productOptionExtensionFactory = $productOptionExtensionFactory;
+        $this->productOptionFactory = $productOptionFactory;
     }
 
     /**
-     * Converts the super_group request data into the same format as native frontend add-to-cart
+     * Converts the grouped_options request data into the same format as native frontend add-to-cart
      *
      * @param CartItemInterface $cartItem
-     *
-     * @return \Magento\Framework\DataObject|null
+     * @return DataObject|null
      */
-    public function convertToBuyRequest(CartItemInterface $cartItem)
+    public function convertToBuyRequest(CartItemInterface $cartItem): ?DataObject
     {
-        $productOption = $cartItem->getProductOption();
-        if ($productOption instanceof ProductOptionInterface && $productOption->getExtensionAttributes()) {
-            $superGroup = $productOption->getExtensionAttributes()->getSuperGroup();
-            if (is_array($superGroup)) {
+        $extensionAttributes = $cartItem->getProductOption()
+            ? $cartItem->getProductOption()->getExtensionAttributes()
+            : null;
+        if ($extensionAttributes) {
+            $groupedOptions = $extensionAttributes->getGroupedOptions();
+            if ($groupedOptions) {
                 $requestData = [];
 
-                /** @var GroupedItemQty $item */
-                foreach ($superGroup as $item) {
-                    if (!isset($requestData['super_group'])) {
-                        $requestData['super_group'] = [];
-                    }
-
-                    $requestData['super_group'][$item->getProductId()] = $item->getQty();
+                foreach ($groupedOptions as $item) {
+                    $requestData[self::SUPER_GROUP_CODE][$item->getId()] = $item->getQty();
                 }
 
-                if (!empty($requestData)) {
-                    return $this->objectFactory->create($requestData);
-                }
+                return $this->objectFactory->create($requestData);
             }
         }
 
@@ -71,11 +101,29 @@ public function convertToBuyRequest(CartItemInterface $cartItem)
      * Option processor
      *
      * @param CartItemInterface $cartItem
-     *
      * @return CartItemInterface
      */
-    public function processOptions(CartItemInterface $cartItem)
+    public function processOptions(CartItemInterface $cartItem): CartItemInterface
     {
+        if ($cartItem->getProductType() !== Grouped::TYPE_CODE) {
+            return $cartItem;
+        }
+
+        $superGroup = $cartItem->getOptionByCode(self::SUPER_GROUP_CODE);
+        $superGroupValues = $superGroup ? $this->jsonSerializer->unserialize($superGroup->getValue()) : null;
+        if ($superGroupValues) {
+            $productOptions = [];
+            foreach ($superGroupValues as $id => $qty) {
+                $productOptions[] = $this->groupedOptionFactory->create(['id' => $id, 'qty' => $qty]);
+            }
+
+            $extension = $this->productOptionExtensionFactory->create()->setGroupedOptions($productOptions);
+            if (!$cartItem->getProductOption()) {
+                $cartItem->setProductOption($this->productOptionFactory->create());
+            }
+            $cartItem->getProductOption()->setExtensionAttributes($extension);
+        }
+
         return $cartItem;
     }
 }