AC-465: Allow to configure input limit for RESTful endpoints

Author: arhiopterecs

app/code/Magento/Webapi/Controller/Rest/InputParamsResolver.php

@@ -17,6 +17,7 @@
 use Magento\Framework\Webapi\Exception;
 use Magento\Framework\Webapi\ServiceInputProcessor;
 use Magento\Framework\Webapi\Rest\Request as RestRequest;
+use Magento\Framework\Webapi\Validator\EntityArrayValidator\InputArraySizeLimitValue;
 use Magento\Webapi\Controller\Rest\Router\Route;
 
 /**
@@ -60,6 +61,11 @@ class InputParamsResolver
      */
     private $methodsMap;
 
+    /**
+     * @var InputArraySizeLimitValue
+     */
+    private $inputArraySizeLimitValue;
+
     /**
      * Initialize dependencies
      *
@@ -69,14 +75,16 @@ class InputParamsResolver
      * @param Router $router
      * @param RequestValidator $requestValidator
      * @param MethodsMap|null $methodsMap
+     * @param InputArraySizeLimitValue|null $inputArraySizeLimitValue
      */
     public function __construct(
         RestRequest $request,
         ParamsOverrider $paramsOverrider,
         ServiceInputProcessor $serviceInputProcessor,
         Router $router,
         RequestValidator $requestValidator,
-        MethodsMap $methodsMap = null
+        MethodsMap $methodsMap = null,
+        ?InputArraySizeLimitValue $inputArraySizeLimitValue = null
     ) {
         $this->request = $request;
         $this->paramsOverrider = $paramsOverrider;
@@ -85,6 +93,8 @@ public function __construct(
         $this->requestValidator = $requestValidator;
         $this->methodsMap = $methodsMap ?: ObjectManager::getInstance()
             ->get(MethodsMap::class);
+        $this->inputArraySizeLimitValue = $inputArraySizeLimitValue ?? ObjectManager::getInstance()
+                ->get(InputArraySizeLimitValue::class);
     }
 
     /**
@@ -97,12 +107,12 @@ public function resolve()
     {
         $this->requestValidator->validate();
         $route = $this->getRoute();
+        $this->inputArraySizeLimitValue->set($route->getInputArraySizeLimit());
 
         return $this->serviceInputProcessor->process(
             $route->getServiceClass(),
             $route->getServiceMethod(),
             $this->getInputData(),
-            $route->getInputArraySizeLimit()
         );
     }
 

app/code/Magento/Webapi/Controller/Soap/Request/Handler.php

@@ -8,16 +8,19 @@
 
 namespace Magento\Webapi\Controller\Soap\Request;
 
+use InvalidArgumentException;
 use Magento\Framework\Api\ExtensibleDataInterface;
 use Magento\Framework\Api\MetadataObjectInterface;
 use Magento\Framework\Api\SimpleDataObjectConverter;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\ObjectManagerInterface;
 use Magento\Framework\Webapi\Authorization;
 use Magento\Framework\Exception\AuthorizationException;
 use Magento\Framework\Reflection\DataObjectProcessor;
 use Magento\Framework\Webapi\ServiceInputProcessor;
 use Magento\Framework\Webapi\Request as SoapRequest;
 use Magento\Framework\Webapi\Exception as WebapiException;
+use Magento\Framework\Webapi\Validator\EntityArrayValidator\InputArraySizeLimitValue;
 use Magento\Webapi\Controller\Rest\ParamsOverrider;
 use Magento\Webapi\Model\Soap\Config as SoapConfig;
 use Magento\Framework\Reflection\MethodsMap;
@@ -40,7 +43,7 @@ class Handler
     protected $_request;
 
     /**
-     * @var \Magento\Framework\ObjectManagerInterface
+     * @var ObjectManagerInterface
      */
     protected $_objectManager;
 
@@ -79,29 +82,36 @@ class Handler
      */
     private $paramsOverrider;
 
+    /**
+     * @var InputArraySizeLimitValue
+     */
+    private $inputArraySizeLimitValue;
+
     /**
      * Initialize dependencies.
      *
      * @param SoapRequest $request
-     * @param \Magento\Framework\ObjectManagerInterface $objectManager
+     * @param ObjectManagerInterface $objectManager
      * @param SoapConfig $apiConfig
      * @param Authorization $authorization
      * @param SimpleDataObjectConverter $dataObjectConverter
      * @param ServiceInputProcessor $serviceInputProcessor
      * @param DataObjectProcessor $dataObjectProcessor
      * @param MethodsMap $methodsMapProcessor
      * @param ParamsOverrider|null $paramsOverrider
+     * @param InputArraySizeLimitValue|null $inputArraySizeLimitValue
      */
     public function __construct(
         SoapRequest $request,
-        \Magento\Framework\ObjectManagerInterface $objectManager,
+        ObjectManagerInterface $objectManager,
         SoapConfig $apiConfig,
         Authorization $authorization,
         SimpleDataObjectConverter $dataObjectConverter,
         ServiceInputProcessor $serviceInputProcessor,
         DataObjectProcessor $dataObjectProcessor,
         MethodsMap $methodsMapProcessor,
-        ?ParamsOverrider $paramsOverrider = null
+        ?ParamsOverrider $paramsOverrider = null,
+        ?InputArraySizeLimitValue $inputArraySizeLimitValue = null
     ) {
         $this->_request = $request;
         $this->_objectManager = $objectManager;
@@ -112,6 +122,8 @@ public function __construct(
         $this->_dataObjectProcessor = $dataObjectProcessor;
         $this->methodsMapProcessor = $methodsMapProcessor;
         $this->paramsOverrider = $paramsOverrider ?? ObjectManager::getInstance()->get(ParamsOverrider::class);
+        $this->inputArraySizeLimitValue = $inputArraySizeLimitValue ?? ObjectManager::getInstance()
+                ->get(InputArraySizeLimitValue::class);
     }
 
     /**
@@ -179,12 +191,12 @@ private function prepareOperationInput(string $serviceClass, array $methodMetada
         $arguments = reset($arguments);
         $arguments = $this->_dataObjectConverter->convertStdObjectToArray($arguments, true);
         $arguments = $this->paramsOverrider->override($arguments, $methodMetadata[ServiceMetadata::KEY_ROUTE_PARAMS]);
+        $this->inputArraySizeLimitValue->set($methodMetadata[ServiceMetadata::KEY_INPUT_ARRAY_SIZE_LIMIT]);
 
         return $this->serviceInputProcessor->process(
             $serviceClass,
             $methodMetadata[ServiceMetadata::KEY_METHOD],
-            $arguments,
-            $methodMetadata[ServiceMetadata::KEY_INPUT_ARRAY_SIZE_LIMIT]
+            $arguments
         );
     }
 
@@ -195,8 +207,9 @@ private function prepareOperationInput(string $serviceClass, array $methodMetada
      * @param string $serviceMethod
      * @param array $arguments
      * @return array
-     * @deprecated 100.3.2
+     * @throws WebapiException
      * @see Handler::prepareOperationInput()
+     * @deprecated 100.3.2
      */
     protected function _prepareRequestData($serviceClass, $serviceMethod, $arguments)
     {
@@ -214,7 +227,7 @@ protected function _prepareRequestData($serviceClass, $serviceMethod, $arguments
      * @param string $serviceClassName
      * @param string $serviceMethodName
      * @return array
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     protected function _prepareResponseData($data, $serviceClassName, $serviceMethodName)
     {
@@ -241,7 +254,7 @@ protected function _prepareResponseData($data, $serviceClassName, $serviceMethod
         } elseif (is_scalar($data) || $data === null) {
             $result = $data;
         } else {
-            throw new \InvalidArgumentException("Service returned result in invalid format.");
+            throw new InvalidArgumentException("Service returned result in invalid format.");
         }
         return [self::RESULT_NODE_NAME => $result];
     }

app/code/Magento/WebapiAsync/Controller/Rest/Asynchronous/InputParamsResolver.php

@@ -8,11 +8,14 @@
 
 namespace Magento\WebapiAsync\Controller\Rest\Asynchronous;
 
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\AuthorizationException;
 use Magento\Framework\Exception\InputException;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Webapi\Exception;
 use Magento\Framework\Webapi\Rest\Request as RestRequest;
 use Magento\Framework\Webapi\ServiceInputProcessor;
+use Magento\Framework\Webapi\Validator\EntityArrayValidator\InputArraySizeLimitValue;
 use Magento\Webapi\Controller\Rest\InputParamsResolver as WebapiInputParamsResolver;
 use Magento\Webapi\Controller\Rest\ParamsOverrider;
 use Magento\Webapi\Controller\Rest\RequestValidator;
@@ -53,6 +56,11 @@ class InputParamsResolver
      */
     private $isBulk;
 
+    /**
+     * @var InputArraySizeLimitValue|null
+     */
+    private $inputArraySizeLimitValue;
+
     /**
      * Initialize dependencies.
      *
@@ -62,6 +70,7 @@ class InputParamsResolver
      * @param Router $router
      * @param RequestValidator $requestValidator
      * @param WebapiInputParamsResolver $inputParamsResolver
+     * @param InputArraySizeLimitValue|null $inputArraySizeLimitValue
      * @param bool $isBulk
      */
     public function __construct(
@@ -71,7 +80,8 @@ public function __construct(
         Router $router,
         RequestValidator $requestValidator,
         WebapiInputParamsResolver $inputParamsResolver,
-        $isBulk = false
+        bool $isBulk = false,
+        ?InputArraySizeLimitValue $inputArraySizeLimitValue = null
     ) {
         $this->request = $request;
         $this->paramsOverrider = $paramsOverrider;
@@ -80,6 +90,8 @@ public function __construct(
         $this->requestValidator = $requestValidator;
         $this->inputParamsResolver = $inputParamsResolver;
         $this->isBulk = $isBulk;
+        $this->inputArraySizeLimitValue = $inputArraySizeLimitValue ?? ObjectManager::getInstance()
+                ->get(InputArraySizeLimitValue::class);
     }
 
     /**
@@ -91,20 +103,29 @@ public function __construct(
      * @return array
      * @throws InputException if no value is provided for required parameters
      * @throws Exception
-     * @throws AuthorizationException
+     * @throws AuthorizationException|LocalizedException
      */
     public function resolve()
     {
         if ($this->isBulk === false) {
             return [$this->inputParamsResolver->resolve()];
         }
+
         $this->requestValidator->validate();
         $webapiResolvedParams = [];
         $route = $this->getRoute();
+        $routeServiceClass = $route->getServiceClass();
+        $routeServiceMethod = $route->getServiceMethod();
+        $this->inputArraySizeLimitValue->set($route->getInputArraySizeLimit());
 
         foreach ($this->getInputData() as $key => $singleEntityParams) {
-            $webapiResolvedParams[$key] = $this->resolveBulkItemParams($singleEntityParams, $route);
+            $webapiResolvedParams[$key] = $this->resolveBulkItemParams(
+                $singleEntityParams,
+                $routeServiceClass,
+                $routeServiceMethod
+            );
         }
+
         return $webapiResolvedParams;
     }
 
@@ -132,6 +153,7 @@ public function getInputData()
      * Returns route.
      *
      * @return Route
+     * @throws Exception
      */
     public function getRoute()
     {
@@ -148,17 +170,13 @@ public function getRoute()
      * we don't need to merge body params with url params and use only body params
      *
      * @param array $inputData data to send to method in key-value format
-     * @param Route $route
+     * @param string $serviceClass route Service Class
+     * @param string $serviceMethod route Service Method
      * @return array list of parameters that can be used to call the service method
-     * @throws Exception
+     * @throws Exception|LocalizedException
      */
-    private function resolveBulkItemParams(array $inputData, Route $route): array
+    private function resolveBulkItemParams(array $inputData, string $serviceClass, string $serviceMethod): array
     {
-        return $this->serviceInputProcessor->process(
-            $route->getServiceClass(),
-            $route->getServiceMethod(),
-            $inputData,
-            $route->getInputArraySizeLimit()
-        );
+        return $this->serviceInputProcessor->process($serviceClass, $serviceMethod, $inputData);
     }
 }

lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php

@@ -23,7 +23,6 @@
 use Magento\Framework\Webapi\Exception as WebapiException;
 use Magento\Framework\Webapi\CustomAttribute\PreprocessorInterface;
 use Laminas\Code\Reflection\ClassReflection;
-use Magento\Framework\Webapi\Validator\EntityArrayValidator\InputArraySizeLimitValue;
 use Magento\Framework\Webapi\Validator\IOLimit\DefaultPageSizeSetter;
 use Magento\Framework\Webapi\Validator\ServiceInputValidatorInterface;
 
@@ -103,11 +102,6 @@ class ServiceInputProcessor implements ServicePayloadConverterInterface
      */
     private $defaultPageSizeSetter;
 
-    /**
-     * @var InputArraySizeLimitValue
-     */
-    private $inputArraySizeLimitValue;
-
     /**
      * Initialize dependencies.
      *
@@ -122,7 +116,6 @@ class ServiceInputProcessor implements ServicePayloadConverterInterface
      * @param ServiceInputValidatorInterface|null $serviceInputValidator
      * @param int $defaultPageSize
      * @param DefaultPageSizeSetter|null $defaultPageSizeSetter
-     * @param InputArraySizeLimitValue|null $inputArraySizeLimitValue
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -136,8 +129,7 @@ public function __construct(
         array $customAttributePreprocessors = [],
         ServiceInputValidatorInterface $serviceInputValidator = null,
         int $defaultPageSize = 20,
-        ?DefaultPageSizeSetter $defaultPageSizeSetter = null,
-        ?InputArraySizeLimitValue $inputArraySizeLimitValue = null
+        ?DefaultPageSizeSetter $defaultPageSizeSetter = null
     ) {
         $this->typeProcessor = $typeProcessor;
         $this->objectManager = $objectManager;
@@ -154,8 +146,6 @@ public function __construct(
         $this->defaultPageSize = $defaultPageSize >= 10 ? $defaultPageSize : 10;
         $this->defaultPageSizeSetter = $defaultPageSizeSetter ?? ObjectManager::getInstance()
             ->get(DefaultPageSizeSetter::class);
-        $this->inputArraySizeLimitValue = $inputArraySizeLimitValue ?? ObjectManager::getInstance()
-                ->get(InputArraySizeLimitValue::class);
     }
 
     /**
@@ -186,16 +176,14 @@ private function getNameFinder()
      * @param string $serviceClassName name of the service class that we are trying to call
      * @param string $serviceMethodName name of the method that we are trying to call
      * @param array $inputArray data to send to method in key-value format
-     * @param int|null $inputArraySizeLimit size limit for input array
      * @return array list of parameters that can be used to call the service method
      * @throws Exception
      * @throws LocalizedException
      */
-    public function process($serviceClassName, $serviceMethodName, array $inputArray, ?int $inputArraySizeLimit = null)
+    public function process($serviceClassName, $serviceMethodName, array $inputArray)
     {
         $inputData = [];
         $inputError = [];
-        $this->inputArraySizeLimitValue->set($inputArraySizeLimit);
 
         foreach ($this->methodsMap->getMethodParams($serviceClassName, $serviceMethodName) as $param) {
             $paramName = $param[MethodsMap::METHOD_META_NAME];