MC-19739: Add swatch value via API to existing text swatch or visual swatch

- Fix empty swatch option value created through API

Author: bubasuma

app/code/Magento/Swatches/Model/Plugin/EavAttribute.php

@@ -14,6 +14,8 @@
 
 /**
  * Plugin model for Catalog Resource Attribute
+ *
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
  */
 class EavAttribute
 {
@@ -29,6 +31,11 @@ class EavAttribute
      */
     const BASE_OPTION_TITLE = 'option';
 
+    /**
+     * Prefix added to option value added through API
+     */
+    private const API_OPTION_PREFIX = 'id_';
+
     /**
      * @var \Magento\Swatches\Model\ResourceModel\Swatch\CollectionFactory
      */
@@ -189,7 +196,9 @@ protected function processSwatchOptions(Attribute $attribute)
 
         if (!empty($optionsArray) && is_array($optionsArray)) {
             $optionsArray = $this->prepareOptionIds($optionsArray);
-            $attributeSavedOptions = $attribute->getSource()->getAllOptions();
+            $adminStoreAttribute = clone $attribute;
+            $adminStoreAttribute->setStoreId(self::DEFAULT_STORE_ID);
+            $attributeSavedOptions = $adminStoreAttribute->getSource()->getAllOptions();
             $this->prepareOptionLinks($optionsArray, $attributeSavedOptions);
         }
 
@@ -227,10 +236,9 @@ protected function prepareOptionLinks(array $optionsArray, array $attributeSaved
     {
         $dependencyArray = [];
         if (is_array($optionsArray['value'])) {
-            $optionCounter = 1;
-            foreach (array_keys($optionsArray['value']) as $baseOptionId) {
-                $dependencyArray[$baseOptionId] = $attributeSavedOptions[$optionCounter]['value'];
-                $optionCounter++;
+            $options = array_column($attributeSavedOptions, 'value', 'label');
+            foreach ($optionsArray['value'] as $id => $labels) {
+                $dependencyArray[$id] = $options[$labels[self::DEFAULT_STORE_ID]];
             }
         }
 
@@ -285,7 +293,7 @@ protected function processVisualSwatch(Attribute $attribute)
      * Clean swatch option values after switching to the dropdown type.
      *
      * @param array $attributeOptions
-     * @param int|null  $swatchType
+     * @param int|null $swatchType
      * @throws \Magento\Framework\Exception\LocalizedException
      */
     private function cleanEavAttributeOptionSwatchValues(array $attributeOptions, int $swatchType = null)
@@ -309,6 +317,8 @@ private function cleanTextSwatchValuesAfterSwitch(array $attributeOptions)
     }
 
     /**
+     * Get the visual swatch type based on its value
+     *
      * @param string $value
      * @return int
      */
@@ -368,7 +378,7 @@ protected function processTextualSwatch(Attribute $attribute)
      */
     protected function getAttributeOptionId($optionId)
     {
-        if (substr($optionId, 0, 6) == self::BASE_OPTION_TITLE) {
+        if (substr($optionId, 0, 6) == self::BASE_OPTION_TITLE || substr($optionId, 0, 3) == self::API_OPTION_PREFIX) {
             $optionId = isset($this->dependencyArray[$optionId]) ? $this->dependencyArray[$optionId] : null;
         }
         return $optionId;
@@ -447,13 +457,10 @@ protected function saveDefaultSwatchOptionValue(Attribute $attribute)
         if (!empty($defaultValue)) {
             /** @var \Magento\Swatches\Model\Swatch $swatch */
             $swatch = $this->swatchFactory->create();
-            // created and removed on frontend option not exists in dependency array
-            if (substr($defaultValue, 0, 6) == self::BASE_OPTION_TITLE &&
-                isset($this->dependencyArray[$defaultValue])
-            ) {
-                $defaultValue = $this->dependencyArray[$defaultValue];
-            }
-            $swatch->getResource()->saveDefaultSwatchOption($attribute->getId(), $defaultValue);
+            $swatch->getResource()->saveDefaultSwatchOption(
+                $attribute->getId(),
+                $this->getAttributeOptionId($defaultValue)
+            );
         }
     }
 
@@ -503,6 +510,10 @@ protected function isOptionsValid(array $options, Attribute $attribute)
     }
 
     /**
+     * Modifies Attribute::usesSource() response
+     *
+     * Returns true if attribute type is swatch
+     *
      * @param Attribute $attribute
      * @param bool $result
      * @return bool

app/code/Magento/Swatches/Plugin/Eav/Model/Entity/Attribute/OptionManagement.php

@@ -0,0 +1,92 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types = 1);
+
+namespace Magento\Swatches\Plugin\Eav\Model\Entity\Attribute;
+
+use Magento\Catalog\Api\Data\ProductAttributeInterface;
+use Magento\Eav\Model\AttributeRepository;
+use Magento\Store\Model\Store;
+use Magento\Swatches\Helper\Data;
+
+/**
+ * OptionManagement Plugin
+ */
+class OptionManagement
+{
+    /**
+     * @var AttributeRepository
+     */
+    private $attributeRepository;
+    /**
+     * @var Data
+     */
+    private $swatchHelper;
+
+    /**
+     * @param AttributeRepository $attributeRepository
+     * @param Data $swatchHelper
+     */
+    public function __construct(
+        AttributeRepository $attributeRepository,
+        Data $swatchHelper
+    ) {
+        $this->attributeRepository = $attributeRepository;
+        $this->swatchHelper = $swatchHelper;
+    }
+
+    /**
+     * Add swatch value to the attribute option
+     *
+     * @param \Magento\Catalog\Model\Product\Attribute\OptionManagement $subject
+     * @param string $attributeCode
+     * @param \Magento\Eav\Api\Data\AttributeOptionInterface $option
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function beforeAdd(
+        \Magento\Catalog\Model\Product\Attribute\OptionManagement $subject,
+        ?string $attributeCode,
+        \Magento\Eav\Api\Data\AttributeOptionInterface $option
+    ) {
+        if (empty($attributeCode)) {
+            return;
+        }
+        $attribute = $this->attributeRepository->get(
+            ProductAttributeInterface::ENTITY_TYPE_CODE,
+            $attributeCode
+        );
+        if (!$attribute || !$this->swatchHelper->isSwatchAttribute($attribute)) {
+            return;
+        }
+        $optionId = $this->getOptionId($option);
+        $optionsValue = $option->getValue();
+        if ($this->swatchHelper->isVisualSwatch($attribute)) {
+            $attribute->setData('swatchvisual', ['value' => [$optionId => $optionsValue]]);
+        } else {
+            $options = [];
+            $options['value'][$optionId][Store::DEFAULT_STORE_ID] = $optionsValue;
+            if (is_array($option->getStoreLabels())) {
+                foreach ($option->getStoreLabels() as $label) {
+                    if (!isset($options['value'][$optionId][$label->getStoreId()])) {
+                        $options['value'][$optionId][$label->getStoreId()] = null;
+                    }
+                }
+            }
+            $attribute->setData('swatchtext', $options);
+        }
+    }
+
+    /**
+     * Returns option id
+     *
+     * @param \Magento\Eav\Api\Data\AttributeOptionInterface $option
+     * @return string
+     */
+    private function getOptionId(\Magento\Eav\Api\Data\AttributeOptionInterface $option) : string
+    {
+        return 'id_' . ($option->getValue() ?: 'new_option');
+    }
+}