change topic generation to be based on service contract rather than route info

Author: vaimo-wilko

app/code/Magento/WebapiAsync/Model/Config.php

@@ -78,18 +78,18 @@ public function getServices()
     public function getTopicName($routeUrl, $httpMethod)
     {
         $services = $this->getServices();
-        $topicName = $this->generateTopicNameByRouteData(
+        $lookupKey = $this->generateLookupKeyByRouteData(
             $routeUrl,
             $httpMethod
         );
 
-        if (array_key_exists($topicName, $services) === false) {
+        if (array_key_exists($lookupKey, $services) === false) {
             throw new LocalizedException(
-                __('WebapiAsync config for "%topicName" does not exist.', ['topicName' => $topicName])
+                __('WebapiAsync config for "%lookupKey" does not exist.', ['lookupKey' => $lookupKey])
             );
         }
 
-        return $services[$topicName][self::SERVICE_PARAM_KEY_TOPIC];
+        return $services[$lookupKey][self::SERVICE_PARAM_KEY_TOPIC];
     }
 
     /**
@@ -105,11 +105,18 @@ private function generateTopicsDataFromWebapiConfig()
                     $serviceInterface = $httpMethodData[Converter::KEY_SERVICE][Converter::KEY_SERVICE_CLASS];
                     $serviceMethod = $httpMethodData[Converter::KEY_SERVICE][Converter::KEY_SERVICE_METHOD];
 
-                    $topicName = $this->generateTopicNameByRouteData(
+                    $lookupKey = $this->generateLookupKeyByRouteData(
                         $routeUrl,
                         $httpMethod
                     );
-                    $services[$topicName] = [
+
+                    $topicName = $this->generateTopicNameFromService(
+                        $serviceInterface,
+                        $serviceMethod,
+                        $httpMethod
+                    );
+
+                    $services[$lookupKey] = [
                         self::SERVICE_PARAM_KEY_INTERFACE => $serviceInterface,
                         self::SERVICE_PARAM_KEY_METHOD    => $serviceMethod,
                         self::SERVICE_PARAM_KEY_TOPIC     => $topicName,
@@ -122,7 +129,7 @@ private function generateTopicsDataFromWebapiConfig()
     }
 
     /**
-     * Generate topic name based on service type and method name.
+     * Generate lookup key name based on route and method
      *
      * Perform the following conversion:
      * self::TOPIC_PREFIX + /V1/products + POST => async.V1.products.POST
@@ -131,19 +138,39 @@ private function generateTopicsDataFromWebapiConfig()
      * @param string $httpMethod
      * @return string
      */
-    private function generateTopicNameByRouteData($routeUrl, $httpMethod)
+    private function generateLookupKeyByRouteData($routeUrl, $httpMethod)
     {
-        return self::TOPIC_PREFIX . $this->generateTopicName($routeUrl, $httpMethod, '/', false);
+        return self::TOPIC_PREFIX . $this->generateKey($routeUrl, $httpMethod, '/', false);
     }
 
     /**
+     * Generate topic name based on service type and method name.
+     *
+     * Perform the following conversion:
+     * self::TOPIC_PREFIX + Magento\Catalog\Api\ProductRepositoryInterface + save + POST
+     *   => async.magento.catalog.api.productrepositoryinterface.save.POST
+     *
+     * @param string $serviceMethod
+     * @param string $serviceInterface
+     * @param string $httpMethod
+     * @return string
+     */
+    private function generateTopicNameFromService($serviceInterface, $serviceMethod, $httpMethod)
+    {
+        $typeName = strtolower(sprintf('%s.%s', $serviceInterface, $serviceMethod));
+        return self::TOPIC_PREFIX . $this->generateKey($typeName, $httpMethod, '\\', false);
+    }
+
+    /**
+     * Join and simplify input type and method into a string that can be used as an array key
+     *
      * @param string $typeName
      * @param string $methodName
      * @param string $delimiter
      * @param bool $lcfirst
      * @return string
      */
-    private function generateTopicName($typeName, $methodName, $delimiter = '\\', $lcfirst = true)
+    private function generateKey($typeName, $methodName, $delimiter = '\\', $lcfirst = true)
     {
         $parts = explode($delimiter, ltrim($typeName, $delimiter));
         foreach ($parts as &$part) {

app/code/Magento/WebapiAsync/Test/Unit/Model/ConfigTest.php

@@ -54,7 +54,7 @@ protected function setUp()
         );
     }
 
-    public function testGetServicesSetsTopicFromRoute()
+    public function testGetServicesSetsTopicFromServiceContractName()
     {
         $services = [
             Converter::KEY_ROUTES => [
@@ -77,14 +77,14 @@ public function testGetServicesSetsTopicFromRoute()
             'async.V1.products.POST' => [
                 'interface' => 'Magento\Catalog\Api\ProductRepositoryInterface',
                 'method' => 'save',
-                'topic' => 'async.V1.products.POST',
+                'topic' => 'async.magento.catalog.api.productrepositoryinterface.save.POST',
             ]
         ];
         */
         $result = $this->config->getServices();
 
-        $expectedTopic = 'async.V1.products.POST';
-        $this->assertArrayHasKey($expectedTopic, $result);
-        $this->assertEquals($result[$expectedTopic]['topic'], $expectedTopic);
-    }
-}
+        $expectedTopic = 'async.magento.catalog.api.productrepositoryinterface.save.POST';
+        $lookupKey = 'async.V1.products.POST';
+        $this->assertArrayHasKey($lookupKey, $result);
+        $this->assertEquals($result[$lookupKey]['topic'], $expectedTopic);
+    }}