Merge pull request #2249 from magento-engcom/async-webapi-1

[Engcom] Add extension points to WebAPI to support different request processors

Author: vrann

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

@@ -14,15 +14,13 @@
 use Magento\Framework\Webapi\Request;
 use Magento\Framework\Webapi\Rest\Request as RestRequest;
 use Magento\Framework\Webapi\Rest\Response as RestResponse;
-use Magento\Framework\Webapi\Rest\Response\FieldsFilter;
 use Magento\Framework\Webapi\ServiceInputProcessor;
-use Magento\Framework\Webapi\ServiceOutputProcessor;
 use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\Webapi\Controller\Rest\ParamsOverrider;
 use Magento\Webapi\Controller\Rest\Router;
 use Magento\Webapi\Controller\Rest\Router\Route;
-use Magento\Webapi\Model\Rest\Swagger\Generator;
+use Magento\Webapi\Controller\Rest\RequestProcessorPool;
 
 /**
  * Front controller for WebAPI REST area.
@@ -32,7 +30,11 @@
  */
 class Rest implements \Magento\Framework\App\FrontControllerInterface
 {
-    /** Path for accessing REST API schema */
+    /**
+     * Path for accessing REST API schema
+     *
+     * @deprecated 100.3.0
+     */
     const SCHEMA_PATH = '/schema';
 
     /**
@@ -94,11 +96,6 @@ class Rest implements \Magento\Framework\App\FrontControllerInterface
      */
     protected $areaList;
 
-    /**
-     * @var \Magento\Framework\Webapi\Rest\Response\FieldsFilter
-     */
-    protected $fieldsFilter;
-
     /**
      * @var \Magento\Framework\Session\Generic
      */
@@ -111,31 +108,16 @@ class Rest implements \Magento\Framework\App\FrontControllerInterface
     protected $paramsOverrider;
 
     /**
-     * @var \Magento\Framework\Webapi\ServiceOutputProcessor
-     */
-    protected $serviceOutputProcessor;
-
-    /**
-     * @var \Magento\Webapi\Model\Rest\Swagger\Generator
+     * @var RequestProcessorPool
      */
-    protected $swaggerGenerator;
+    protected $requestProcessorPool;
 
     /**
      * @var StoreManagerInterface
      * @deprecated 100.1.0
      */
     private $storeManager;
 
-    /**
-     * @var DeploymentConfig
-     */
-    private $deploymentConfig;
-
-    /**
-     * @var Rest\InputParamsResolver
-     */
-    private $inputParamsResolver;
-
     /**
      * Initialize dependencies
      *
@@ -149,11 +131,9 @@ class Rest implements \Magento\Framework\App\FrontControllerInterface
      * @param ErrorProcessor $errorProcessor
      * @param PathProcessor $pathProcessor
      * @param \Magento\Framework\App\AreaList $areaList
-     * @param FieldsFilter $fieldsFilter
      * @param ParamsOverrider $paramsOverrider
-     * @param ServiceOutputProcessor $serviceOutputProcessor
-     * @param Generator $swaggerGenerator ,
      * @param StoreManagerInterface $storeManager
+     * @param RequestProcessorPool $requestProcessorPool
      *
      * TODO: Consider removal of warning suppression
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
@@ -169,11 +149,9 @@ public function __construct(
         ErrorProcessor $errorProcessor,
         PathProcessor $pathProcessor,
         \Magento\Framework\App\AreaList $areaList,
-        FieldsFilter $fieldsFilter,
         ParamsOverrider $paramsOverrider,
-        ServiceOutputProcessor $serviceOutputProcessor,
-        Generator $swaggerGenerator,
-        StoreManagerInterface $storeManager
+        StoreManagerInterface $storeManager,
+        RequestProcessorPool $requestProcessorPool
     ) {
         $this->_router = $router;
         $this->_request = $request;
@@ -185,37 +163,9 @@ public function __construct(
         $this->_errorProcessor = $errorProcessor;
         $this->_pathProcessor = $pathProcessor;
         $this->areaList = $areaList;
-        $this->fieldsFilter = $fieldsFilter;
         $this->paramsOverrider = $paramsOverrider;
-        $this->serviceOutputProcessor = $serviceOutputProcessor;
-        $this->swaggerGenerator = $swaggerGenerator;
         $this->storeManager = $storeManager;
-    }
-
-    /**
-     * Get deployment config
-     *
-     * @return DeploymentConfig
-     */
-    private function getDeploymentConfig()
-    {
-        if (!$this->deploymentConfig instanceof \Magento\Framework\App\DeploymentConfig) {
-            $this->deploymentConfig = \Magento\Framework\App\ObjectManager::getInstance()
-                ->get(\Magento\Framework\App\DeploymentConfig::class);
-        }
-        return $this->deploymentConfig;
-    }
-
-    /**
-     * Set deployment config
-     *
-     * @param \Magento\Framework\App\DeploymentConfig $deploymentConfig
-     * @return void
-     * @deprecated 100.1.0
-     */
-    public function setDeploymentConfig(\Magento\Framework\App\DeploymentConfig $deploymentConfig)
-    {
-        $this->deploymentConfig = $deploymentConfig;
+        $this->requestProcessorPool = $requestProcessorPool;
     }
 
     /**
@@ -234,15 +184,13 @@ public function dispatch(\Magento\Framework\App\RequestInterface $request)
         $this->areaList->getArea($this->_appState->getAreaCode())
             ->load(\Magento\Framework\App\Area::PART_TRANSLATE);
         try {
-            if ($this->isSchemaRequest()) {
-                $this->processSchemaRequest();
-            } else {
-                $this->processApiRequest();
-            }
+            $processor = $this->requestProcessorPool->getProcessor($this->_request);
+            $processor->process($this->_request);
         } catch (\Exception $e) {
             $maskedException = $this->_errorProcessor->maskException($e);
             $this->_response->setException($maskedException);
         }
+
         return $this->_response;
     }
 
@@ -268,6 +216,7 @@ protected function getCurrentRoute()
         if (!$this->_route) {
             $this->_route = $this->_router->match($this->_request);
         }
+
         return $this->_route;
     }
 
@@ -290,60 +239,6 @@ protected function checkPermissions()
         }
     }
 
-    /**
-     * Execute schema request
-     *
-     * @return void
-     */
-    protected function processSchemaRequest()
-    {
-        $requestedServices = $this->_request->getRequestedServices('all');
-        $requestedServices = $requestedServices == Request::ALL_SERVICES
-            ? $this->swaggerGenerator->getListOfServices()
-            : $requestedServices;
-        $responseBody = $this->swaggerGenerator->generate(
-            $requestedServices,
-            $this->_request->getScheme(),
-            $this->_request->getHttpHost(false),
-            $this->_request->getRequestUri()
-        );
-        $this->_response->setBody($responseBody)->setHeader('Content-Type', 'application/json');
-    }
-
-    /**
-     * Execute API request
-     *
-     * @return void
-     * @throws AuthorizationException
-     * @throws \Magento\Framework\Exception\InputException
-     * @throws \Magento\Framework\Webapi\Exception
-     */
-    protected function processApiRequest()
-    {
-        $inputParams = $this->getInputParamsResolver()->resolve();
-
-        $route = $this->getInputParamsResolver()->getRoute();
-        $serviceMethodName = $route->getServiceMethod();
-        $serviceClassName = $route->getServiceClass();
-
-        $service = $this->_objectManager->get($serviceClassName);
-        /** @var \Magento\Framework\Api\AbstractExtensibleObject $outputData */
-        $outputData = call_user_func_array([$service, $serviceMethodName], $inputParams);
-        $outputData = $this->serviceOutputProcessor->process(
-            $outputData,
-            $serviceClassName,
-            $serviceMethodName
-        );
-        if ($this->_request->getParam(FieldsFilter::FILTER_PARAMETER) && is_array($outputData)) {
-            $outputData = $this->fieldsFilter->filter($outputData);
-        }
-        $header = $this->getDeploymentConfig()->get(ConfigOptionsListConstants::CONFIG_PATH_X_FRAME_OPT);
-        if ($header) {
-            $this->_response->setHeader('X-Frame-Options', $header);
-        }
-        $this->_response->prepareResponse($outputData);
-    }
-
     /**
      * Validate request
      *
@@ -365,20 +260,4 @@ protected function validateRequest()
             throw new \Magento\Framework\Webapi\Exception(__('Cannot perform GET operation with store code \'all\''));
         }
     }
-
-    /**
-     * The getter function to get InputParamsResolver object
-     *
-     * @return \Magento\Webapi\Controller\Rest\InputParamsResolver
-     *
-     * @deprecated 100.1.0
-     */
-    private function getInputParamsResolver()
-    {
-        if ($this->inputParamsResolver === null) {
-            $this->inputParamsResolver = \Magento\Framework\App\ObjectManager::getInstance()
-                ->get(\Magento\Webapi\Controller\Rest\InputParamsResolver::class);
-        }
-        return $this->inputParamsResolver;
-    }
 }

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

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Webapi\Controller\Rest;
+
+/**
+ *  Request processor interface
+ */
+interface RequestProcessorInterface
+{
+    /**
+     * Executes the logic to process the request
+     *
+     * @param \Magento\Framework\Webapi\Rest\Request $request
+     * @return void
+     * @throws \Magento\Framework\Exception\AuthorizationException
+     * @throws \Magento\Framework\Exception\InputException
+     * @throws \Magento\Framework\Webapi\Exception
+     */
+    public function process(\Magento\Framework\Webapi\Rest\Request $request);
+
+    /**
+     * Method should return true for all the request current processor can process.
+     *
+     * Invoked in the loop for all registered request processors. The first one wins.
+     *
+     * @param \Magento\Framework\Webapi\Rest\Request $request
+     * @return bool
+     */
+    public function canProcess(\Magento\Framework\Webapi\Rest\Request $request);
+}

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

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Webapi\Controller\Rest;
+
+/**
+ *  Request Processor Pool
+ */
+class RequestProcessorPool
+{
+
+    /**
+     * @var array
+     */
+    private $requestProcessors;
+
+    /**
+     * Initial dependencies
+     *
+     * @param RequestProcessorInterface[] $requestProcessors
+     */
+    public function __construct($requestProcessors = [])
+    {
+        $this->requestProcessors = $requestProcessors;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @throws \Magento\Framework\Webapi\Exception
+     * return RequestProcessorInterface
+     */
+    public function getProcessor(\Magento\Framework\Webapi\Rest\Request $request)
+    {
+        foreach ($this->requestProcessors as $processor) {
+            if ($processor->canProcess($request)) {
+                return $processor;
+            }
+        }
+
+        throw new \Magento\Framework\Webapi\Exception(
+            __('Specified request cannot be processed.'),
+            0,
+            \Magento\Framework\Webapi\Exception::HTTP_BAD_REQUEST
+        );
+    }
+}

app/code/Magento/Webapi/Controller/Rest/Router/Route.php

@@ -241,4 +241,14 @@ public function getParameters()
     {
         return $this->parameters;
     }
+
+    /**
+     * Get route path.
+     *
+     * @return string
+     */
+    public function getRoutePath()
+    {
+        return $this->route;
+    }
 }