fix for support schema request CommunicationConfig::TOPIC_REQUEST_TYPE_METHOD, added new attribute is_synchronous for topic to communication.xsd schema

Author: Vasiliev.A

app/code/Magento/WebapiAsync/Plugin/Communication/Config/CompositeReader.php

@@ -42,9 +42,6 @@
             <argument name="processorPath" xsi:type="const">Magento\WebapiAsync\Controller\Rest\AsynchronousSchemaRequestProcessor::BULK_PROCESSOR_PATH</argument>
         </arguments>
     </virtualType>
-    <type name="Magento\Framework\Communication\Config\CompositeReader">
-        <plugin name="forceTopicsTypeToAsync" type="Magento\WebapiAsync\Plugin\Communication\Config\CompositeReader" />
-    </type>
     <type name="Magento\Webapi\Controller\Rest">
         <plugin name="webapiContorllerRestAsync" type="Magento\WebapiAsync\Plugin\ControllerRest" />
     </type>

app/code/Magento/WebapiAsync/etc/di.xml

@@ -124,6 +124,7 @@ protected function extractTopics($config)
                 $requestSchema,
                 $responseSchema
             );
+            $isSynchronous = $this->extractTopicIsSynchronous($topicNode) ?? null;
             if ($serviceMethod) {
                 $output[$topicName] = $this->reflectionGenerator->generateTopicConfigForServiceMethod(
                     $topicName,
@@ -134,7 +135,7 @@ protected function extractTopics($config)
             } elseif ($requestSchema && $responseSchema) {
                 $output[$topicName] = [
                     Config::TOPIC_NAME => $topicName,
-                    Config::TOPIC_IS_SYNCHRONOUS => true,
+                    Config::TOPIC_IS_SYNCHRONOUS => $isSynchronous ?? true,
                     Config::TOPIC_REQUEST => $requestSchema,
                     Config::TOPIC_REQUEST_TYPE => Config::TOPIC_REQUEST_TYPE_CLASS,
                     Config::TOPIC_RESPONSE => $responseSchema,
@@ -143,7 +144,7 @@ protected function extractTopics($config)
             } elseif ($requestSchema) {
                 $output[$topicName] = [
                     Config::TOPIC_NAME => $topicName,
-                    Config::TOPIC_IS_SYNCHRONOUS => false,
+                    Config::TOPIC_IS_SYNCHRONOUS => $isSynchronous ?? false,
                     Config::TOPIC_REQUEST => $requestSchema,
                     Config::TOPIC_REQUEST_TYPE => Config::TOPIC_REQUEST_TYPE_CLASS,
                     Config::TOPIC_RESPONSE => null,
@@ -258,4 +259,22 @@ protected function parseServiceMethod($serviceMethod, $topicName)
         );
         return $parsedServiceMethod;
     }
+
+    /**
+     * Extract is_synchronous topic value.
+     *
+     * @param \DOMNode $topicNode
+     * @return boolean|null
+     */
+    protected function extractTopicIsSynchronous($topicNode)
+    {
+        $attributeName = Config::TOPIC_IS_SYNCHRONOUS;
+        $topicAttributes = $topicNode->attributes;
+        if (!$topicAttributes->getNamedItem($attributeName)) {
+            return null;
+        }
+        $value = $topicAttributes->getNamedItem($attributeName)->nodeValue;
+        $isSynchronous = filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
+        return $isSynchronous;
+    }
 }

lib/internal/Magento/Framework/Communication/Config/Reader/XmlReader/Converter.php

@@ -42,7 +42,10 @@ public function extractMethodMetadata($className, $methodName)
         $result = [
             Config::SCHEMA_METHOD_PARAMS => [],
             Config::SCHEMA_METHOD_RETURN_TYPE => $this->methodsMap->getMethodReturnType($className, $methodName),
-            Config::SCHEMA_METHOD_HANDLER => [Config::HANDLER_TYPE => $className, Config::HANDLER_METHOD => $methodName]
+            Config::SCHEMA_METHOD_HANDLER => [
+                Config::HANDLER_TYPE => $className,
+                Config::HANDLER_METHOD => $methodName
+            ]
         ];
         $paramsMeta = $this->methodsMap->getMethodParams($className, $methodName);
         foreach ($paramsMeta as $paramPosition => $paramMeta) {
@@ -63,29 +66,33 @@ public function extractMethodMetadata($className, $methodName)
      * @param string $serviceType
      * @param string $serviceMethod
      * @param array|null $handlers
+     * @param bool|null $isSynchronous
      * @return array
      */
-    public function generateTopicConfigForServiceMethod($topicName, $serviceType, $serviceMethod, $handlers = [])
+    public function generateTopicConfigForServiceMethod($topicName, $serviceType, $serviceMethod, $handlers = [], $isSynchronous = null)
     {
         $methodMetadata = $this->extractMethodMetadata($serviceType, $serviceMethod);
         $returnType = $methodMetadata[Config::SCHEMA_METHOD_RETURN_TYPE];
         $returnType = ($returnType != 'void' && $returnType != 'null') ? $returnType : null;
+        if (!isset($isSynchronous)) {
+            $isSynchronous = $returnType ? true : false;
+        }
         return [
             Config::TOPIC_NAME => $topicName,
-            Config::TOPIC_IS_SYNCHRONOUS => $returnType ? true : false,
+            Config::TOPIC_IS_SYNCHRONOUS => $isSynchronous,
             Config::TOPIC_REQUEST => $methodMetadata[Config::SCHEMA_METHOD_PARAMS],
             Config::TOPIC_REQUEST_TYPE => Config::TOPIC_REQUEST_TYPE_METHOD,
             Config::TOPIC_RESPONSE => $returnType,
             Config::TOPIC_HANDLERS => $handlers
-                ?: [self::DEFAULT_HANDLER => $methodMetadata[Config::SCHEMA_METHOD_HANDLER]]
+                ? : [self::DEFAULT_HANDLER => $methodMetadata[Config::SCHEMA_METHOD_HANDLER]]
         ];
     }
 
     /**
      * Generate topic name based on service type and method name.
-     *
      * Perform the following conversion:
-     * \Magento\Customer\Api\RepositoryInterface + getById => magento.customer.api.repositoryInterface.getById
+     * \Magento\Customer\Api\RepositoryInterface + getById =>
+     * magento.customer.api.repositoryInterface.getById
      *
      * @param string $typeName
      * @param string $methodName

lib/internal/Magento/Framework/Communication/Config/ReflectionGenerator.php

@@ -40,6 +40,7 @@
         <xs:attribute type="schemaType" name="schema" use="optional"/>
         <xs:attribute type="xs:string" name="request" use="optional"/>
         <xs:attribute type="xs:string" name="response" use="optional"/>
+        <xs:attribute type="xs:boolean" name="is_synchronous" use="optional"/>
     </xs:complexType>
     <xs:complexType name="handlerType">
         <xs:attribute type="xs:string" name="name" use="required"/>