ENGCOM-8838: Adding required custom options to simple product removes it from parent composite products without warning #31645

Author: gabrieldagama

app/code/Magento/Catalog/Model/Product/Option/SaveHandler.php

@@ -7,34 +7,55 @@
 
 namespace Magento\Catalog\Model\Product\Option;
 
+use Magento\Catalog\Api\Data\ProductCustomOptionInterface;
+use Magento\Catalog\Api\Data\ProductInterface;
 use Magento\Catalog\Api\ProductCustomOptionRepositoryInterface as OptionRepository;
+use Magento\Catalog\Model\Product\Option;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\EntityManager\Operation\ExtensionInterface;
+use Magento\Catalog\Model\ResourceModel\Product\Relation;
+use Magento\Framework\Exception\CouldNotSaveException;
 
 /**
- * Class SaveHandler
+ * SaveHandler for product option
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class SaveHandler implements ExtensionInterface
 {
+    /**
+     * @var string[]
+     */
+    private $compositeProductTypes = ['grouped', 'configurable', 'bundle'];
+
     /**
      * @var OptionRepository
      */
     protected $optionRepository;
 
+    /**
+     * @var Relation
+     */
+    private $relation;
+
     /**
      * @param OptionRepository $optionRepository
+     * @param Relation|null $relation
      */
     public function __construct(
-        OptionRepository $optionRepository
+        OptionRepository $optionRepository,
+        ?Relation $relation = null
     ) {
         $this->optionRepository = $optionRepository;
+        $this->relation = $relation ?: ObjectManager::getInstance()->get(Relation::class);
     }
 
     /**
      * Perform action on relation/extension attribute
      *
      * @param object $entity
      * @param array $arguments
-     * @return \Magento\Catalog\Api\Data\ProductInterface|object
+     * @return ProductInterface|object
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function execute($entity, $arguments = [])
@@ -47,20 +68,19 @@ public function execute($entity, $arguments = [])
         $optionIds = [];
 
         if ($options) {
-            $optionIds = array_map(function ($option) {
-                /** @var \Magento\Catalog\Model\Product\Option $option */
+            $optionIds = array_map(function (Option $option) {
                 return $option->getOptionId();
             }, $options);
         }
 
-        /** @var \Magento\Catalog\Api\Data\ProductInterface $entity */
+        /** @var ProductInterface $entity */
         foreach ($this->optionRepository->getProductOptions($entity) as $option) {
             if (!in_array($option->getOptionId(), $optionIds)) {
                 $this->optionRepository->delete($option);
             }
         }
         if ($options) {
-            $this->processOptionsSaving($options, (bool)$entity->dataHasChangedFor('sku'), (string)$entity->getSku());
+            $this->processOptionsSaving($options, (bool)$entity->dataHasChangedFor('sku'), $entity);
         }
 
         return $entity;
@@ -71,15 +91,43 @@ public function execute($entity, $arguments = [])
      *
      * @param array $options
      * @param bool $hasChangedSku
-     * @param string $newSku
+     * @param ProductInterface $product
+     * @return void
+     * @throws CouldNotSaveException
      */
-    private function processOptionsSaving(array $options, bool $hasChangedSku, string $newSku)
+    private function processOptionsSaving(array $options, bool $hasChangedSku, ProductInterface $product): void
     {
+        $isProductHasRelations = $this->isProductHasRelations($product);
+        /** @var ProductCustomOptionInterface $option */
         foreach ($options as $option) {
+            if (!$isProductHasRelations && $option->getIsRequire()) {
+                $message = 'Required custom options cannot be added to a simple product'
+                    . ' that is a part of a composite product.';
+                throw new CouldNotSaveException(__($message));
+            }
+
             if ($hasChangedSku && $option->hasData('product_sku')) {
-                $option->setProductSku($newSku);
+                $option->setProductSku($product->getSku());
             }
             $this->optionRepository->save($option);
         }
     }
+
+    /**
+     * Check if product doesn't belong to composite product
+     *
+     * @param ProductInterface $product
+     * @return bool
+     */
+    private function isProductHasRelations(ProductInterface $product): bool
+    {
+        $result = true;
+        if (!in_array($product->getId(), $this->compositeProductTypes)
+            && $this->relation->getRelationsByChildren([$product->getId()])
+        ) {
+            $result = false;
+        }
+
+        return $result;
+    }
 }

app/code/Magento/Catalog/Test/Unit/Model/Product/Option/SaveHandlerTest.php

@@ -11,9 +11,13 @@
 use Magento\Catalog\Model\Product\Option;
 use Magento\Catalog\Model\Product\Option\Repository;
 use Magento\Catalog\Model\Product\Option\SaveHandler;
+use Magento\Catalog\Model\ResourceModel\Product\Relation;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
+/**
+ * Test for \Magento\Catalog\Model\Product\Option\SaveHandler.
+ */
 class SaveHandlerTest extends TestCase
 {
     /**
@@ -36,6 +40,14 @@ class SaveHandlerTest extends TestCase
      */
     protected $optionRepository;
 
+    /**
+     * @var Relation|MockObject
+     */
+    private $relationMock;
+
+    /**
+     * @inheridoc
+     */
     protected function setUp(): void
     {
         $this->entity = $this->getMockBuilder(Product::class)
@@ -47,11 +59,19 @@ protected function setUp(): void
         $this->optionRepository = $this->getMockBuilder(Repository::class)
             ->disableOriginalConstructor()
             ->getMock();
+        $this->relationMock = $this->getMockBuilder(Relation::class)
+            ->disableOriginalConstructor()
+            ->getMock();
 
-        $this->model = new SaveHandler($this->optionRepository);
+        $this->model = new SaveHandler($this->optionRepository, $this->relationMock);
     }
 
-    public function testExecute()
+    /**
+     * Test for execute
+     *
+     * @return void
+     */
+    public function testExecute(): void
     {
         $this->optionMock->expects($this->any())->method('getOptionId')->willReturn(5);
         $this->entity->expects($this->once())->method('getOptions')->willReturn([$this->optionMock]);

dev/tests/integration/testsuite/Magento/ConfigurableProduct/Model/Product/Type/ConfigurableTest.php

@@ -12,13 +12,15 @@
 use Magento\Catalog\Api\ProductRepositoryInterface;
 use Magento\Catalog\Model\Product;
 use Magento\TestFramework\Helper\Bootstrap;
+use Magento\Catalog\Api\Data\ProductCustomOptionInterfaceFactory;
+use PHPUnit\Framework\TestCase;
 
 /**
  * Class ConfigurableTest
  *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
-class ConfigurableTest extends \PHPUnit\Framework\TestCase
+class ConfigurableTest extends TestCase
 {
     /**
      * Object under test
@@ -645,4 +647,30 @@ protected function getUsedProducts()
         $product->load(1);
         return $this->model->getUsedProducts($product);
     }
+
+    /**
+     * Unable to save product required option to product which is a part of configurable product
+     *
+     * @magentoDataFixture Magento/ConfigurableProduct/_files/configurable_product_with_two_child_products.php
+     * @return void
+     */
+    public function testAddCustomOptionToConfigurableChildProduct(): void
+    {
+        $this->expectErrorMessage(
+            'Required custom options cannot be added to a simple product that is a part of a composite product.'
+        );
+
+        $sku = 'Simple option 1';
+        $product = $this->productRepository->get($sku);
+        $optionRepository = Bootstrap::getObjectManager()->get(ProductCustomOptionInterfaceFactory::class);
+        $createdOption = $optionRepository->create(
+            ['data' => ['title' => 'drop_down option', 'type' => 'drop_down', 'sort_order' => 4, 'is_require' => 1]]
+        );
+        $createdOption->setProductSku($product->getSku());
+        $product->setOptions([$createdOption]);
+        $this->productRepository->save($product);
+
+        $product = $this->productRepository->get($sku);
+        $this->assertEmpty($product->getOptions());
+    }
 }