AC-5905: Customer API improvements

Author: nvshivakumar

app/code/Magento/Customer/Plugin/Webapi/Controller/Rest/ValidateCustomerData.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Customer\Plugin\Webapi\Controller\Rest;
+
+use Magento\Webapi\Controller\Rest\ParamsOverrider;
+
+/**
+ * Validates Customer Data
+ */
+class ValidateCustomerData
+{
+    private const CUSTOMER_KEY = 'customer';
+
+    /**
+     * Before Overriding to validate data
+     *
+     * @param ParamsOverrider $subject
+     * @param array $inputData
+     * @param array $parameters
+     * @return array[]
+     *
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function beforeOverride(ParamsOverrider $subject, array $inputData, array $parameters): array
+    {
+        if (isset($inputData[self:: CUSTOMER_KEY])) {
+            $inputData[self:: CUSTOMER_KEY] = $this->validateInputData($inputData[self:: CUSTOMER_KEY]);
+        }
+        return [$inputData, $parameters];
+    }
+
+    /**
+     * Validates InputData
+     *
+     * @param array $inputData
+     * @return array
+     */
+    private function validateInputData(array $inputData): array
+    {
+        $result = [];
+
+        $data = array_filter($inputData, function ($k) use (&$result) {
+            $key = is_string($k) ? strtolower($k) : $k;
+            return !isset($result[$key]) && ($result[$key] = true);
+        }, ARRAY_FILTER_USE_KEY);
+
+        return array_map(function ($value) {
+            return is_array($value) ? $this->validateInputData($value) : $value;
+        }, $data);
+    }
+}

app/code/Magento/Customer/Test/Unit/Plugin/Webapi/Controller/Rest/ValidateCustomerDataTest.php

@@ -0,0 +1,115 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Customer\Test\Unit\Plugin\Webapi\Controller\Rest;
+
+use Exception;
+use Magento\Framework\App\ObjectManager;
+use Magento\Customer\Plugin\Webapi\Controller\Rest\ValidateCustomerData;
+use PHPUnit\Framework\TestCase;
+use ReflectionClass;
+
+/**
+ * Unit test for ValidateCustomerData plugin
+ */
+class ValidateCustomerDataTest extends TestCase
+{
+
+    /**
+     * @var ValidateCustomerData
+     */
+    private $validateCustomerDataObject;
+
+    /**
+     * @var ReflectionClass
+     *
+     */
+    private $reflectionObject;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp(): void
+    {
+        $this->validateCustomerDataObject = ObjectManager::getInstance()->get(ValidateCustomerData::class);
+        $this->reflectionObject = new ReflectionClass(get_class($this->validateCustomerDataObject));
+    }
+
+    /**
+     * Test if the customer Info is valid
+     *
+     * @param array $customerInfo
+     * @param array $result
+     * @dataProvider dataProviderInputData
+     * @throws Exception
+     */
+    public function testValidateInputData(array $customerInfo, array $result)
+    {
+        $this->assertEquals(
+            $result,
+            $this->invokeValidateInputData('validateInputData', [$customerInfo])
+        );
+    }
+
+    /**
+     * @param string $methodName
+     * @param array $arguments
+     * @return mixed
+     * @throws Exception
+     */
+    private function invokeValidateInputData(string $methodName, array $arguments = [])
+    {
+        $validateInputDataMethod = $this->reflectionObject->getMethod($methodName);
+        $validateInputDataMethod->setAccessible(true);
+        return $validateInputDataMethod->invokeArgs($this->validateCustomerDataObject, $arguments);
+    }
+
+    /**
+     * @return array
+     */
+    public function dataProviderInputData(): array
+    {
+        return [
+            [
+                ['customer' =>
+                    [
+                        'id' => -1,
+                        'Id' => 1,
+                        'name' =>
+                            [
+                                'firstName' => 'Test',
+                                'LastName' => 'user'
+                            ],
+                        'isHavingOwnHouse' => 1,
+                        'address' =>
+                            [
+                                'street' => '1st Street',
+                                'Street' => '3rd Street',
+                                'city' => 'London'
+                            ],
+                    ]
+                ],
+                ['customer' =>
+                    [
+                        'id' => -1,
+                        'name' =>
+                            [
+                                'firstName' => 'Test',
+                                'LastName' => 'user'
+                            ],
+                        'isHavingOwnHouse' => 1,
+                        'address' =>
+                            [
+                                'street' => '1st Street',
+                                'city' => 'London'
+                            ],
+                    ]
+                ],
+            ]
+        ];
+    }
+}

app/code/Magento/Customer/etc/webapi_rest/di.xml

@@ -31,6 +31,9 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\Webapi\Controller\Rest\ParamsOverrider">
+        <plugin name="validateCustomerData" type="Magento\Customer\Plugin\Webapi\Controller\Rest\ValidateCustomerData" sortOrder="1" disabled="false" />
+    </type>
     <preference for="Magento\Customer\Api\AccountManagementInterface"
                 type="Magento\Customer\Model\AccountManagementApi" />
 </config>