ENGCOM-3804: Fix Swagger caching issue #31

magento-engcom · Jan 27, 2019 · 0c2f1d3 · 0c2f1d3
2 parents 2952946 + 3f9ec69
commit 0c2f1d3
Show file tree

Hide file tree

Showing 2 changed files with 109 additions and 0 deletions.
diff --git a/app/code/Magento/WebapiAsync/Plugin/Cache/Webapi.php b/app/code/Magento/WebapiAsync/Plugin/Cache/Webapi.php
@@ -0,0 +1,106 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\WebapiAsync\Plugin\Cache;
+
+use Magento\WebapiAsync\Controller\Rest\AsynchronousSchemaRequestProcessor;
+use Magento\Framework\Webapi\Rest\Request;
+
+/**
+ * Class Webapi
+ */
+class Webapi
+{
+    /**
+     * Cache key for Async Routes
+     */
+    const ASYNC_ROUTES_CONFIG_CACHE_ID = 'async-routes-services-config';
+
+    /**
+     * @var AsynchronousSchemaRequestProcessor
+     */
+    private $asynchronousSchemaRequestProcessor;
+
+    /**
+     * @var \Magento\Framework\Webapi\Rest\Request
+     */
+    private $request;
+
+    /**
+     * ServiceMetadata constructor.
+     *
+     * @param Request $request
+     * @param AsynchronousSchemaRequestProcessor $asynchronousSchemaRequestProcessor
+     */
+    public function __construct(
+        \Magento\Framework\Webapi\Rest\Request $request,
+        AsynchronousSchemaRequestProcessor $asynchronousSchemaRequestProcessor
+    ) {
+        $this->request = $request;
+        $this->asynchronousSchemaRequestProcessor = $asynchronousSchemaRequestProcessor;
+    }
+
+    /**
+     * Change identifier in case if Async request before cache load
+     *
+     * @param \Magento\Webapi\Model\Cache\Type\Webapi $subject
+     * @param string $identifier
+     * @return null|string
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function beforeLoad(\Magento\Webapi\Model\Cache\Type\Webapi $subject, $identifier)
+    {
+        if ($this->asynchronousSchemaRequestProcessor->canProcess($this->request)
+            && $identifier === \Magento\Webapi\Model\ServiceMetadata::ROUTES_CONFIG_CACHE_ID) {
+            return self::ASYNC_ROUTES_CONFIG_CACHE_ID;
+        }
+        return null;
+    }
+
+    /**
+     * Change identifier in case if Async request before cache save
+     *
+     * @param \Magento\Webapi\Model\Cache\Type\Webapi $subject
+     * @param string $data
+     * @param string $identifier
+     * @param array $tags
+     * @param int|bool|null $lifeTime
+     * @return array|null
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function beforeSave(
+        \Magento\Webapi\Model\Cache\Type\Webapi $subject,
+        $data,
+        $identifier,
+        array $tags = [],
+        $lifeTime = null
+    ) {
+        if ($this->asynchronousSchemaRequestProcessor->canProcess($this->request)
+            && $identifier === \Magento\Webapi\Model\ServiceMetadata::ROUTES_CONFIG_CACHE_ID) {
+            return [$data, self::ASYNC_ROUTES_CONFIG_CACHE_ID, $tags, $lifeTime];
+        }
+        return null;
+    }
+
+    /**
+     * Change identifier in case if Async request before remove cache
+     *
+     * @param \Magento\Webapi\Model\Cache\Type\Webapi $subject
+     * @param string $identifier
+     * @return null|string
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function beforeRemove(\Magento\Webapi\Model\Cache\Type\Webapi $subject, $identifier)
+    {
+        if ($this->asynchronousSchemaRequestProcessor->canProcess($this->request)
+            && $identifier === \Magento\Webapi\Model\ServiceMetadata::ROUTES_CONFIG_CACHE_ID) {
+            return self::ASYNC_ROUTES_CONFIG_CACHE_ID;
+        }
+        return null;
+    }
+}
diff --git a/app/code/Magento/WebapiAsync/etc/di.xml b/app/code/Magento/WebapiAsync/etc/di.xml
@@ -10,6 +10,9 @@
     <type name="Magento\Webapi\Model\ServiceMetadata">
         <plugin name="webapiServiceMetadataAsync" type="Magento\WebapiAsync\Plugin\ServiceMetadata" />
     </type>
+    <type name="Magento\Webapi\Model\Cache\Type\Webapi">
+        <plugin name="webapiCacheAsync" type="Magento\WebapiAsync\Plugin\Cache\Webapi" />
+    </type>
     <virtualType name="Magento\WebapiAsync\Model\VirtualType\Rest\Config" type="Magento\Webapi\Model\Rest\Config">
         <arguments>
             <argument name="config" xsi:type="object">Magento\WebapiAsync\Model\BulkServiceConfig</argument>