ENGCOM-3638: Change WebapiAsync topic to use Service contract name #21

Author: sivaschenko

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

@@ -15,6 +15,9 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Webapi\Model\Config\Converter;
 
+/**
+ * Class for accessing to Webapi_Async configuration.
+ */
 class Config implements \Magento\AsynchronousOperations\Model\ConfigInterface
 {
     /**
@@ -55,7 +58,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getServices()
     {
@@ -73,26 +76,30 @@ public function getServices()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     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];
     }
 
     /**
+     * Generate topic data for all defined services
+     *
+     * Topic data is indexed by a lookup key that is derived from route data
+     *
      * @return array
      */
     private function generateTopicsDataFromWebapiConfig()
@@ -105,11 +112,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 +136,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 +145,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 $serviceInterface
+     * @param string $serviceMethod
+     * @param string $httpMethod
+     * @return string
+     */
+    private function generateTopicNameFromService($serviceInterface, $serviceMethod, $httpMethod)
+    {
+        $typeName = strtolower(sprintf('%s.%s', $serviceInterface, $serviceMethod));
+        return strtolower(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

@@ -0,0 +1,91 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\WebapiAsync\Test\Unit\Model;
+
+use Magento\Framework\Serialize\SerializerInterface;
+use Magento\Webapi\Model\Cache\Type\Webapi;
+use Magento\Webapi\Model\Config as WebapiConfig;
+use Magento\WebapiAsync\Model\Config;
+use Magento\Webapi\Model\Config\Converter;
+
+class ConfigTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @var Config
+     */
+    private $config;
+
+    /**
+     * @var Webapi|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $webapiCacheMock;
+
+    /**
+     * @var WebapiConfig|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $configMock;
+
+    /**
+     * @var SerializerInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $serializerMock;
+
+    protected function setUp()
+    {
+        $objectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
+
+        $this->webapiCacheMock = $this->createMock(\Magento\Webapi\Model\Cache\Type\Webapi::class);
+        $this->configMock = $this->createMock(WebapiConfig::class);
+        $this->serializerMock = $this->createMock(SerializerInterface::class);
+
+        $this->config = $objectManager->getObject(
+            Config::class,
+            [
+                'cache' => $this->webapiCacheMock,
+                'webApiConfig' => $this->configMock,
+                'serializer' => $this->serializerMock
+            ]
+        );
+    }
+
+    public function testGetServicesSetsTopicFromServiceContractName()
+    {
+        $services = [
+            Converter::KEY_ROUTES => [
+                '/V1/products' => [
+                    'POST' => [
+                        'service' => [
+                            'class' => \Magento\Catalog\Api\ProductRepositoryInterface::class,
+                            'method' => 'save',
+                        ]
+                    ]
+                ]
+            ]
+        ];
+        $this->configMock->expects($this->once())
+            ->method('getServices')
+            ->willReturn($services);
+
+        /* example of what $this->config->getServices() returns
+        $result = [
+            'async.V1.products.POST' => [
+                'interface' => 'Magento\Catalog\Api\ProductRepositoryInterface',
+                'method' => 'save',
+                'topic' => 'async.magento.catalog.api.productrepositoryinterface.save.post',
+            ]
+        ];
+        */
+        $result = $this->config->getServices();
+
+        $expectedTopic = 'async.magento.catalog.api.productrepositoryinterface.save.post';
+        $lookupKey = 'async.V1.products.POST';
+        $this->assertArrayHasKey($lookupKey, $result);
+        $this->assertEquals($result[$lookupKey]['topic'], $expectedTopic);
+    }
+}

dev/tests/integration/testsuite/Magento/AsynchronousOperations/Model/MassScheduleTest.php

@@ -128,7 +128,10 @@ public function sendBulk($products)
         }
         $this->clearProducts();
 
-        $result = $this->massSchedule->publishMass('async.V1.products.POST', $products);
+        $result = $this->massSchedule->publishMass(
+            'async.magento.catalog.api.productrepositoryinterface.save.post',
+            $products
+        );
 
         //assert bulk accepted with no errors
         $this->assertFalse($result->isErrors());
@@ -206,7 +209,7 @@ public function testScheduleMassOneEntityFailure($products)
 
             $expectedErrorMessage = "Data item corresponding to \"product\" " .
                 "must be specified in the message with topic " .
-                "\"async.V1.products.POST\".";
+                "\"async.magento.catalog.api.productrepositoryinterface.save.post\".";
             $this->assertEquals(
                 $expectedErrorMessage,
                 $reasonException->getMessage()