ENGCOM-3805: Add support for topic schema defined as ServiceName:methodName #23

Author: sivaschenko

app/code/Magento/WebapiAsync/Code/Generator/Config/RemoteServiceReader/Communication.php

@@ -67,7 +67,8 @@ public function read($scope = null)
                         CommunicationConfig::HANDLER_TYPE   => $serviceClass,
                         CommunicationConfig::HANDLER_METHOD => $serviceMethod,
                     ],
-                ]
+                ],
+                false
             );
             $rewriteTopicParams = [
                 CommunicationConfig::TOPIC_IS_SYNCHRONOUS => false,

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

@@ -124,20 +124,22 @@ protected function extractTopics($config)
                 $requestSchema,
                 $responseSchema
             );
+            $isSynchronous = $this->extractTopicIsSynchronous($topicNode);
             if ($serviceMethod) {
                 $output[$topicName] = $this->reflectionGenerator->generateTopicConfigForServiceMethod(
                     $topicName,
                     $serviceMethod[ConfigParser::TYPE_NAME],
                     $serviceMethod[ConfigParser::METHOD_NAME],
-                    $handlers
+                    $handlers,
+                    $isSynchronous
                 );
             } elseif ($requestSchema && $responseSchema) {
                 $output[$topicName] = [
                     Config::TOPIC_NAME => $topicName,
-                    Config::TOPIC_IS_SYNCHRONOUS => true,
+                    Config::TOPIC_IS_SYNCHRONOUS => $isSynchronous,
                     Config::TOPIC_REQUEST => $requestSchema,
                     Config::TOPIC_REQUEST_TYPE => Config::TOPIC_REQUEST_TYPE_CLASS,
-                    Config::TOPIC_RESPONSE => $responseSchema,
+                    Config::TOPIC_RESPONSE => ($isSynchronous) ? $responseSchema: null,
                     Config::TOPIC_HANDLERS => $handlers
                 ];
             } elseif ($requestSchema) {
@@ -258,4 +260,20 @@ protected function parseServiceMethod($serviceMethod, $topicName)
         );
         return $parsedServiceMethod;
     }
+
+    /**
+     * Extract is_synchronous topic value.
+     *
+     * @param \DOMNode $topicNode
+     * @return bool
+     */
+    private function extractTopicIsSynchronous($topicNode): bool
+    {
+        $attributeName = Config::TOPIC_IS_SYNCHRONOUS;
+        $topicAttributes = $topicNode->attributes;
+        if (!$topicAttributes->getNamedItem($attributeName)) {
+            return true;
+        }
+        return $this->booleanUtils->toBoolean($topicAttributes->getNamedItem($attributeName)->nodeValue);
+    }
 }

lib/internal/Magento/Framework/Communication/Config/ReflectionGenerator.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,16 +66,27 @@ 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;
+        } else {
+            $returnType = ($isSynchronous) ? $returnType : null;
+        }
         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,
@@ -85,7 +99,8 @@ public function generateTopicConfigForServiceMethod($topicName, $serviceType, $s
      * 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/etc/communication.xsd

@@ -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"/>