MC-23554: Customer custom multiline attribute displays incorrectly

SmVladyslav · SmVladyslav · commit 92f84bea5702 · 2020-11-19T16:13:48.000+02:00
diff --git a/app/code/Magento/Customer/Model/Metadata/Form/Multiline.php b/app/code/Magento/Customer/Model/Metadata/Form/Multiline.php
@@ -10,7 +10,7 @@
 class Multiline extends Text
 {
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function extractValue(\Magento\Framework\App\RequestInterface $request)
     {
@@ -24,7 +24,8 @@ public function extractValue(\Magento\Framework\App\RequestInterface $request)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
+     *
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     public function validateValue($value)
@@ -43,7 +44,8 @@ public function validateValue($value)
         if (!is_array($value)) {
             $value = [$value];
         }
-        for ($i = 0; $i < $attribute->getMultilineCount(); $i++) {
+        $multilineCount = $attribute->getMultilineCount();
+        for ($i = 0; $i < $multilineCount; $i++) {
             if (!isset($value[$i])) {
                 $value[$i] = null;
             }
@@ -57,6 +59,7 @@ public function validateValue($value)
                 if (!empty($value[$i])) {
                     $result = parent::validateValue($value[$i]);
                     if ($result !== true) {
+                        // phpcs:ignore Magento2.Performance.ForeachArrayMerge
                         $errors = array_merge($errors, $result);
                     }
                 }
@@ -70,26 +73,28 @@ public function validateValue($value)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function compactValue($value)
     {
-        if (!is_array($value)) {
-            $value = [$value];
+        if (is_array($value)) {
+            $value = implode("\n", $value);
         }
+        $value = [$value];
+
         return parent::compactValue($value);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function restoreValue($value)
     {
         return $this->compactValue($value);
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritDoc
      */
     public function outputValue($format = \Magento\Customer\Model\Metadata\ElementFactory::OUTPUT_FORMAT_TEXT)
     {
diff --git a/app/code/Magento/Ui/Component/Form/Element/Multiline.php b/app/code/Magento/Ui/Component/Form/Element/Multiline.php
@@ -66,6 +66,7 @@ public function prepare()
     {
         $size = abs((int) $this->getData('config/size'));
         $validation = [$this->getData('config/validation')];
+        $namespace = $this->getContext()->getNamespace();
         while ($size--) {
             $identifier = $this->getName() . '_' . $size;
             $arguments = [
@@ -74,6 +75,8 @@ public function prepare()
                     'config' => [
                         'dataScope' => $size,
                         'dataType' => static::DATA_TYPE,
+                        'deps' => "{$namespace}.areas.customer.customer.{$this->getName()}",
+                        'provider' => $namespace . '.' . $this->getContext()->getDataProvider()->getName(),
                         'formElement' => static::FORM_ELEMENT,
                         'sortOrder' => $size,
                     ]
diff --git a/app/code/Magento/Ui/view/base/ui_component/etc/definition.xml b/app/code/Magento/Ui/view/base/ui_component/etc/definition.xml
@@ -141,7 +141,7 @@
         </settings>
     </multiselect>
     <textarea class="Magento\Ui\Component\Form\Element\Textarea" component="Magento_Ui/js/form/element/textarea" template="ui/form/field"/>
-    <multiline class="Magento\Ui\Component\Form\Element\Multiline" component="Magento_Ui/js/form/components/group"/>
+    <multiline class="Magento\Ui\Component\Form\Element\Multiline" component="Magento_Ui/js/form/components/multiline"/>
     <range class="Magento\Ui\Component\Form\Element\Range" component="Magento_Ui/js/grid/filters/range"/>
     <fileUploader class="Magento\Ui\Component\Form\Element\DataType\Media" component="Magento_Ui/js/form/element/file-uploader" template="ui/form/element/uploader/uploader"/>
     <imageUploader class="Magento\Ui\Component\Form\Element\DataType\Media\Image" component="Magento_Ui/js/form/element/image-uploader" template="ui/form/element/uploader/image">
diff --git a/app/code/Magento/Ui/view/base/web/js/form/components/multiline.js b/app/code/Magento/Ui/view/base/web/js/form/components/multiline.js
@@ -0,0 +1,57 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+/**
+ * @api
+ */
+define([
+    './group'
+], function (Group) {
+    'use strict';
+
+    return Group.extend({
+        defaults: {
+            links: {
+                value: '${ $.provider }:${ $.dataScope }'
+            }
+        },
+
+        /**
+         * Initialize Multiline component.
+         *
+         * @returns {Object}
+         */
+        initialize: function () {
+            return this._super()
+                ._prepareValue();
+        },
+
+        /**
+         * {@inheritdoc}
+         */
+        initObservable: function () {
+            this._super()
+                .observe('value');
+
+            return this;
+        },
+
+        /**
+         * Prepare value for Multiline options.
+         *
+         * @returns {Object} Chainable.
+         * @private
+         */
+        _prepareValue: function () {
+            var value = this.value();
+
+            if (typeof value === 'string') {
+                this.value(value.split('\n'));
+            }
+
+            return this;
+        }
+    });
+});
diff --git a/dev/tests/js/jasmine/tests/app/code/Magento/Ui/base/js/form/components/multiline.test.js b/dev/tests/js/jasmine/tests/app/code/Magento/Ui/base/js/form/components/multiline.test.js
@@ -0,0 +1,63 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+define([
+    'uiRegistry',
+    'Magento_Ui/js/form/components/multiline'
+], function (registry, Constr) {
+    'use strict';
+
+    describe('Magento_Ui/js/form/components/multiline', function () {
+        var obj,
+            dataScope = 'data',
+            providerName = 'provider',
+            prepareDataProvider = function (value) { // jscs:ignore jsDoc
+                registry.set(providerName, {
+                    /** Stub */
+                    on: function () {},
+                    /** Stub */
+                    set: function () {},
+                    /** Stub */
+                    get: function () {
+                        return value;
+                    }
+                });
+            };
+
+        describe('Verify process of preparing value for Multiline options', function () {
+            it('Check _prepareValue method', function () {
+                obj = new Constr({
+                    _prepareValue: jasmine.createSpy()
+                });
+
+                expect(obj._prepareValue).toHaveBeenCalled();
+            });
+
+            it('Check array preparation', function () {
+                var value = ['some_array'];
+
+                prepareDataProvider(value);
+                obj = new Constr({
+                    provider: providerName,
+                    dataScope: dataScope
+                });
+
+                expect(obj.value().slice(0)).toEqual(value);
+            });
+
+            it('Check preparation of string value with line breaks', function () {
+                var value = '\n222\n';
+
+                prepareDataProvider(value);
+                obj = new Constr({
+                    provider: providerName,
+                    dataScope: dataScope
+                });
+
+                expect(obj.value()).toEqual(['', '222', '']);
+            });
+        });
+    });
+});

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`class Multiline extends Text`
`11`	`11`	`{`
`12`	`12`	`/**`
`13`		`- * {@inheritdoc}`
	`13`	`+ * @inheritDoc`
`14`	`14`	`*/`
`15`	`15`	`public function extractValue(\Magento\Framework\App\RequestInterface $request)`
`16`	`16`	`{`
`@@ -24,7 +24,8 @@ public function extractValue(\Magento\Framework\App\RequestInterface $request)`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`/**`
`27`		`- * {@inheritdoc}`
	`27`	`+ * @inheritDoc`
	`28`	`+ *`
`28`	`29`	`* @SuppressWarnings(PHPMD.CyclomaticComplexity)`
`29`	`30`	`*/`
`30`	`31`	`public function validateValue($value)`
`@@ -43,7 +44,8 @@ public function validateValue($value)`
`43`	`44`	`if (!is_array($value)) {`
`44`	`45`	`$value = [$value];`
`45`	`46`	`}`
`46`		`- for ($i = 0; $i < $attribute->getMultilineCount(); $i++) {`
	`47`	`+ $multilineCount = $attribute->getMultilineCount();`
	`48`	`+ for ($i = 0; $i < $multilineCount; $i++) {`
`47`	`49`	`if (!isset($value[$i])) {`
`48`	`50`	`$value[$i] = null;`
`49`	`51`	`}`
`@@ -57,6 +59,7 @@ public function validateValue($value)`
`57`	`59`	`if (!empty($value[$i])) {`
`58`	`60`	`$result = parent::validateValue($value[$i]);`
`59`	`61`	`if ($result !== true) {`
	`62`	`+ // phpcs:ignore Magento2.Performance.ForeachArrayMerge`
`60`	`63`	`$errors = array_merge($errors, $result);`
`61`	`64`	`}`
`62`	`65`	`}`
`@@ -70,26 +73,28 @@ public function validateValue($value)`
`70`	`73`	`}`
`71`	`74`
`72`	`75`	`/**`
`73`		`- * {@inheritdoc}`
	`76`	`+ * @inheritDoc`
`74`	`77`	`*/`
`75`	`78`	`public function compactValue($value)`
`76`	`79`	`{`
`77`		`- if (!is_array($value)) {`
`78`		`- $value = [$value];`
	`80`	`+ if (is_array($value)) {`
	`81`	`+ $value = implode("\n", $value);`
`79`	`82`	`}`
	`83`	`+ $value = [$value];`
	`84`	`+`
`80`	`85`	`return parent::compactValue($value);`
`81`	`86`	`}`
`82`	`87`
`83`	`88`	`/**`
`84`		`- * {@inheritdoc}`
	`89`	`+ * @inheritDoc`
`85`	`90`	`*/`
`86`	`91`	`public function restoreValue($value)`
`87`	`92`	`{`
`88`	`93`	`return $this->compactValue($value);`
`89`	`94`	`}`
`90`	`95`
`91`	`96`	`/**`
`92`		`- * {@inheritdoc}`
	`97`	`+ * @inheritDoc`
`93`	`98`	`*/`
`94`	`99`	`public function outputValue($format = \Magento\Customer\Model\Metadata\ElementFactory::OUTPUT_FORMAT_TEXT)`
`95`	`100`	`{`