🔃 [Magento Community Engineering] Community Contributions - 2.3-develop

magento-engcom-team · web-flow · commit 8eb50bf38cc2 · 2019-09-12T11:01:56.000-05:00
Accepted Community Pull Requests: - magento#24519: Resolve API "V1/attributeMetadata/customerAddress/attribute/prefix" and "V1/attributeMetadata/customerAddress/attribute/suffix" can not get options (by @edenduong) - magento#24499: Resolve "Clear Shopping Cart" button not working in Internet Explorer issue24491 (by @edenduong) Fixed GitHub Issues: - magento#24518: API "V1/attributeMetadata/customerAddress/attribute/prefix" and "V1/attributeMetadata/customerAddress/attribute/suffix" can not get options (reported by @edenduong) has been fixed in magento#24519 by @edenduong in 2.3-develop branch Related commits: 1. 1da4f2a 2. e779423 - magento#21499: Cart is emptied when enter is pressed after changing product quantity (reported by @wojtekn) has been fixed in magento#24499 by @edenduong in 2.3-develop branch Related commits: 1. 7005d99 2. 5847d9f - magento#24491: "Clear Shopping Cart" button not working in Internet Explorer (reported by @andrew-ebsco) has been fixed in magento#24499 by @edenduong in 2.3-develop branch Related commits: 1. 7005d99 2. 5847d9f
diff --git a/app/code/Magento/Checkout/view/frontend/templates/cart/form.phtml b/app/code/Magento/Checkout/view/frontend/templates/cart/form.phtml
@@ -56,7 +56,7 @@
                 <span><?= $block->escapeHtml(__('Continue Shopping')) ?></span>
             </a>
         <?php endif; ?>
-        <button type="submit"
+        <button type="button"
                 name="update_cart_action"
                 data-cart-empty=""
                 value="empty_cart"
diff --git a/app/code/Magento/Checkout/view/frontend/web/js/shopping-cart.js b/app/code/Magento/Checkout/view/frontend/web/js/shopping-cart.js
@@ -14,14 +14,14 @@ define([
         _create: function () {
             var items, i, reload;
 
-            $(this.options.emptyCartButton).on('click', $.proxy(function (event) {
-                if (event.detail === 0) {
-                    return;
-                }
-
+            $(this.options.emptyCartButton).on('click', $.proxy(function () {
                 $(this.options.emptyCartButton).attr('name', 'update_cart_action_temp');
                 $(this.options.updateCartActionContainer)
                     .attr('name', 'update_cart_action').attr('value', 'empty_cart');
+
+                if ($(this.options.emptyCartButton).parents('form').length > 0) {
+                    $(this.options.emptyCartButton).parents('form').submit();
+                }
             }, this));
             items = $.find('[data-role="cart-item-qty"]');
 
diff --git a/app/code/Magento/Customer/Model/AttributeMetadataConverter.php b/app/code/Magento/Customer/Model/AttributeMetadataConverter.php
@@ -3,18 +3,36 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Customer\Model;
 
 use Magento\Customer\Api\Data\OptionInterfaceFactory;
 use Magento\Customer\Api\Data\ValidationRuleInterfaceFactory;
 use Magento\Customer\Api\Data\AttributeMetadataInterfaceFactory;
 use Magento\Eav\Api\Data\AttributeDefaultValueInterface;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\ObjectManager;
 
 /**
  * Converter for AttributeMetadata
  */
 class AttributeMetadataConverter
 {
+    /**
+     * Attribute Code get options from system config
+     *
+     * @var array
+     */
+    private const ATTRIBUTE_CODE_LIST_FROM_SYSTEM_CONFIG = ['prefix', 'suffix'];
+
+    /**
+     * XML Path to get address config
+     *
+     * @var string
+     */
+    private const XML_CUSTOMER_ADDRESS = 'customer/address/';
+
     /**
      * @var OptionInterfaceFactory
      */
@@ -35,24 +53,32 @@ class AttributeMetadataConverter
      */
     protected $dataObjectHelper;
 
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
     /**
      * Initialize the Converter
      *
      * @param OptionInterfaceFactory $optionFactory
      * @param ValidationRuleInterfaceFactory $validationRuleFactory
      * @param AttributeMetadataInterfaceFactory $attributeMetadataFactory
      * @param \Magento\Framework\Api\DataObjectHelper $dataObjectHelper
+     * @param ScopeConfigInterface $scopeConfig
      */
     public function __construct(
         OptionInterfaceFactory $optionFactory,
         ValidationRuleInterfaceFactory $validationRuleFactory,
         AttributeMetadataInterfaceFactory $attributeMetadataFactory,
-        \Magento\Framework\Api\DataObjectHelper $dataObjectHelper
+        \Magento\Framework\Api\DataObjectHelper $dataObjectHelper,
+        ScopeConfigInterface $scopeConfig = null
     ) {
         $this->optionFactory = $optionFactory;
         $this->validationRuleFactory = $validationRuleFactory;
         $this->attributeMetadataFactory = $attributeMetadataFactory;
         $this->dataObjectHelper = $dataObjectHelper;
+        $this->scopeConfig = $scopeConfig ?? ObjectManager::getInstance()->get(ScopeConfigInterface::class);
     }
 
     /**
@@ -64,28 +90,34 @@ public function __construct(
     public function createMetadataAttribute($attribute)
     {
         $options = [];
-        if ($attribute->usesSource()) {
-            foreach ($attribute->getSource()->getAllOptions() as $option) {
-                $optionDataObject = $this->optionFactory->create();
-                if (!is_array($option['value'])) {
-                    $optionDataObject->setValue($option['value']);
-                } else {
-                    $optionArray = [];
-                    foreach ($option['value'] as $optionArrayValues) {
-                        $optionObject = $this->optionFactory->create();
-                        $this->dataObjectHelper->populateWithArray(
-                            $optionObject,
-                            $optionArrayValues,
-                            \Magento\Customer\Api\Data\OptionInterface::class
-                        );
-                        $optionArray[] = $optionObject;
+
+        if (in_array($attribute->getAttributeCode(), self::ATTRIBUTE_CODE_LIST_FROM_SYSTEM_CONFIG)) {
+            $options = $this->getOptionFromConfig($attribute->getAttributeCode());
+        } else {
+            if ($attribute->usesSource()) {
+                foreach ($attribute->getSource()->getAllOptions() as $option) {
+                    $optionDataObject = $this->optionFactory->create();
+                    if (!is_array($option['value'])) {
+                        $optionDataObject->setValue($option['value']);
+                    } else {
+                        $optionArray = [];
+                        foreach ($option['value'] as $optionArrayValues) {
+                            $optionObject = $this->optionFactory->create();
+                            $this->dataObjectHelper->populateWithArray(
+                                $optionObject,
+                                $optionArrayValues,
+                                \Magento\Customer\Api\Data\OptionInterface::class
+                            );
+                            $optionArray[] = $optionObject;
+                        }
+                        $optionDataObject->setOptions($optionArray);
                     }
-                    $optionDataObject->setOptions($optionArray);
+                    $optionDataObject->setLabel($option['label']);
+                    $options[] = $optionDataObject;
                 }
-                $optionDataObject->setLabel($option['label']);
-                $options[] = $optionDataObject;
             }
         }
+
         $validationRules = [];
         foreach ((array)$attribute->getValidateRules() as $name => $value) {
             $validationRule = $this->validationRuleFactory->create()
@@ -122,4 +154,26 @@ public function createMetadataAttribute($attribute)
             ->setIsFilterableInGrid($attribute->getIsFilterableInGrid())
             ->setIsSearchableInGrid($attribute->getIsSearchableInGrid());
     }
+
+    /**
+     * Get option from System Config instead of Use Source (Prefix, Suffix)
+     *
+     * @param string $attributeCode
+     * @return \Magento\Customer\Api\Data\OptionInterface[]
+     */
+    private function getOptionFromConfig($attributeCode)
+    {
+        $result = [];
+        $value = $this->scopeConfig->getValue(self::XML_CUSTOMER_ADDRESS . $attributeCode . '_options');
+        if ($value) {
+            $optionArray = explode(';', $value);
+            foreach ($optionArray as $value) {
+                $optionObject = $this->optionFactory->create();
+                $optionObject->setLabel($value);
+                $optionObject->setValue($value);
+                $result[] = $optionObject;
+            }
+        }
+        return $result;
+    }
 }
diff --git a/dev/tests/api-functional/testsuite/Magento/Customer/Api/AddressMetadataTest.php b/dev/tests/api-functional/testsuite/Magento/Customer/Api/AddressMetadataTest.php
@@ -6,8 +6,11 @@
 
 namespace Magento\Customer\Api;
 
+use Magento\Config\Model\ResourceModel\Config;
 use Magento\Customer\Api\Data\AddressInterface as Address;
 use Magento\Customer\Model\Data\AttributeMetadata;
+use Magento\Framework\App\Config\ReinitableConfigInterface;
+use Magento\TestFramework\ObjectManager;
 use Magento\TestFramework\TestCase\WebapiAbstract;
 
 /**
@@ -19,15 +22,40 @@ class AddressMetadataTest extends WebapiAbstract
     const SERVICE_VERSION = "V1";
     const RESOURCE_PATH = "/V1/attributeMetadata/customerAddress";
 
+    /**
+     * @var Config $config
+     */
+    private $resourceConfig;
+
+    /**
+     * @var ReinitableConfigInterface
+     */
+    private $reinitConfig;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $objectManager = ObjectManager::getInstance();
+        $this->resourceConfig = $objectManager->get(Config::class);
+        $this->reinitConfig = $objectManager->get(ReinitableConfigInterface::class);
+    }
+
     /**
      * Test retrieval of attribute metadata for the address entity type.
      *
      * @param string $attributeCode The attribute code of the requested metadata.
      * @param array $expectedMetadata Expected entity metadata for the attribute code.
      * @dataProvider getAttributeMetadataDataProvider
+     * @magentoDbIsolation disabled
      */
-    public function testGetAttributeMetadata($attributeCode, $expectedMetadata)
+    public function testGetAttributeMetadata($attributeCode, $configOptions, $expectedMetadata)
     {
+        $this->initConfig($configOptions);
+
         $serviceInfo = [
             'rest' => [
                 'resourcePath' => self::RESOURCE_PATH . "/attribute/$attributeCode",
@@ -54,12 +82,14 @@ public function testGetAttributeMetadata($attributeCode, $expectedMetadata)
      * Data provider for testGetAttributeMetadata.
      *
      * @return array
+     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
     public function getAttributeMetadataDataProvider()
     {
         return [
             Address::POSTCODE => [
                 Address::POSTCODE,
+                [],
                 [
                     AttributeMetadata::FRONTEND_INPUT => 'text',
                     AttributeMetadata::INPUT_FILTER => '',
@@ -83,7 +113,85 @@ public function getAttributeMetadataDataProvider()
                     AttributeMetadata::IS_SEARCHABLE_IN_GRID => true,
                     AttributeMetadata::ATTRIBUTE_CODE => 'postcode',
                 ],
-            ]
+            ],
+            'prefix' => [
+                'prefix',
+                [
+                    ['path' => 'customer/address/prefix_show', 'value' => 'opt'],
+                    ['path' => 'customer/address/prefix_options', 'value' => 'prefA;prefB']
+                ],
+                [
+                    AttributeMetadata::FRONTEND_INPUT => 'text',
+                    AttributeMetadata::INPUT_FILTER => '',
+                    AttributeMetadata::STORE_LABEL => 'Name Prefix',
+                    AttributeMetadata::MULTILINE_COUNT => 0,
+                    AttributeMetadata::VALIDATION_RULES => [],
+                    AttributeMetadata::VISIBLE => false,
+                    AttributeMetadata::REQUIRED => false,
+                    AttributeMetadata::DATA_MODEL => '',
+                    AttributeMetadata::OPTIONS => [
+                        [
+                            'label' => 'prefA',
+                            'value' => 'prefA',
+                        ],
+                        [
+                            'label' => 'prefB',
+                            'value' => 'prefB',
+                        ],
+                    ],
+                    AttributeMetadata::FRONTEND_CLASS => '',
+                    AttributeMetadata::USER_DEFINED => false,
+                    AttributeMetadata::SORT_ORDER => 10,
+                    AttributeMetadata::FRONTEND_LABEL => 'Name Prefix',
+                    AttributeMetadata::NOTE => '',
+                    AttributeMetadata::SYSTEM => false,
+                    AttributeMetadata::BACKEND_TYPE => 'static',
+                    AttributeMetadata::IS_USED_IN_GRID => false,
+                    AttributeMetadata::IS_VISIBLE_IN_GRID => false,
+                    AttributeMetadata::IS_FILTERABLE_IN_GRID => false,
+                    AttributeMetadata::IS_SEARCHABLE_IN_GRID => false,
+                    AttributeMetadata::ATTRIBUTE_CODE => 'prefix',
+                ],
+            ],
+            'suffix' => [
+                'suffix',
+                [
+                    ['path' => 'customer/address/suffix_show', 'value' => 'opt'],
+                    ['path' => 'customer/address/suffix_options', 'value' => 'suffA;suffB']
+                ],
+                [
+                    AttributeMetadata::FRONTEND_INPUT => 'text',
+                    AttributeMetadata::INPUT_FILTER => '',
+                    AttributeMetadata::STORE_LABEL => 'Name Suffix',
+                    AttributeMetadata::MULTILINE_COUNT => 0,
+                    AttributeMetadata::VALIDATION_RULES => [],
+                    AttributeMetadata::VISIBLE => false,
+                    AttributeMetadata::REQUIRED => false,
+                    AttributeMetadata::DATA_MODEL => '',
+                    AttributeMetadata::OPTIONS => [
+                        [
+                            'label' => 'suffA',
+                            'value' => 'suffA',
+                        ],
+                        [
+                            'label' => 'suffB',
+                            'value' => 'suffB',
+                        ],
+                    ],
+                    AttributeMetadata::FRONTEND_CLASS => '',
+                    AttributeMetadata::USER_DEFINED => false,
+                    AttributeMetadata::SORT_ORDER => 50,
+                    AttributeMetadata::FRONTEND_LABEL => 'Name Suffix',
+                    AttributeMetadata::NOTE => '',
+                    AttributeMetadata::SYSTEM => false,
+                    AttributeMetadata::BACKEND_TYPE => 'static',
+                    AttributeMetadata::IS_USED_IN_GRID => false,
+                    AttributeMetadata::IS_VISIBLE_IN_GRID => false,
+                    AttributeMetadata::IS_FILTERABLE_IN_GRID => false,
+                    AttributeMetadata::IS_SEARCHABLE_IN_GRID => false,
+                    AttributeMetadata::ATTRIBUTE_CODE => 'suffix',
+                ],
+            ],
         ];
     }
 
@@ -106,7 +214,7 @@ public function testGetAllAttributesMetadata()
 
         $attributeMetadata = $this->_webApiCall($serviceInfo);
         $this->assertCount(19, $attributeMetadata);
-        $postcode = $this->getAttributeMetadataDataProvider()[Address::POSTCODE][1];
+        $postcode = $this->getAttributeMetadataDataProvider()[Address::POSTCODE][2];
         $validationResult = $this->checkMultipleAttributesValidationRules($postcode, $attributeMetadata);
         list($postcode, $attributeMetadata) = $validationResult;
         $this->assertContains($postcode, $attributeMetadata);
@@ -187,7 +295,7 @@ public function getAttributesDataProvider()
         return [
             [
                 'customer_address_edit',
-                $attributeMetadata[Address::POSTCODE][1],
+                $attributeMetadata[Address::POSTCODE][2],
             ]
         ];
     }
@@ -200,6 +308,7 @@ public function getAttributesDataProvider()
      * @param array $actualResult
      * @return array
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * phpcs:disable Generic.Metrics.NestingLevel
      */
     public function checkValidationRules($expectedResult, $actualResult)
     {
@@ -235,6 +344,7 @@ public function checkValidationRules($expectedResult, $actualResult)
         }
         return [$expectedResult, $actualResult];
     }
+    //phpcs:enable
 
     /**
      * Check specific attribute validation rules in set of multiple attributes
@@ -277,4 +387,19 @@ public static function tearDownAfterClass()
             $attribute->delete();
         }
     }
+
+    /**
+     * Set core config data.
+     *
+     * @param $configOptions
+     */
+    private function initConfig(array $configOptions): void
+    {
+        if ($configOptions) {
+            foreach ($configOptions as $option) {
+                $this->resourceConfig->saveConfig($option['path'], $option['value']);
+            }
+        }
+        $this->reinitConfig->reinit();
+    }
 }
