[AWS S3] Simple cache (#6299)

Author: shiftedreality

app/code/Magento/AwsS3/Driver/AwsS3.php

@@ -8,7 +8,7 @@
 namespace Magento\AwsS3\Driver;
 
 use Exception;
-use League\Flysystem\AwsS3v3\AwsS3Adapter;
+use League\Flysystem\AdapterInterface;
 use League\Flysystem\Config;
 use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\Filesystem\DriverInterface;
@@ -32,30 +32,38 @@ class AwsS3 implements RemoteDriverInterface
     private const CONFIG = ['ACL' => 'private'];
 
     /**
-     * @var AwsS3Adapter
+     * @var AdapterInterface
      */
     private $adapter;
 
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
     /**
      * @var array
      */
     private $streams = [];
 
     /**
-     * @var LoggerInterface
+     * @var string
      */
-    private $logger;
+    private $objectUrl;
 
     /**
-     * @param AwsS3Adapter $adapter
+     * @param AdapterInterface $adapter
      * @param LoggerInterface $logger
+     * @param string $objectUrl
      */
     public function __construct(
-        AwsS3Adapter $adapter,
-        LoggerInterface $logger
+        AdapterInterface $adapter,
+        LoggerInterface $logger,
+        string $objectUrl
     ) {
         $this->adapter = $adapter;
         $this->logger = $logger;
+        $this->objectUrl = $objectUrl;
     }
 
     /**
@@ -282,26 +290,27 @@ public function getAbsolutePath($basePath, $path, $scheme = null)
      * @param string $path Relative path
      * @return string Absolute path
      */
-    private function normalizeAbsolutePath(string $path = '.'): string
+    private function normalizeAbsolutePath(string $path = '/'): string
     {
         $path = ltrim($path, '/');
-        $path = str_replace(
-            $this->adapter->getClient()->getObjectUrl(
-                $this->adapter->getBucket(),
-                $this->adapter->applyPathPrefix('.')
-            ),
-            '',
-            $path
-        );
+        $path = str_replace($this->getObjectUrl(''), '', $path);
 
         if (!$path) {
-            $path = '.';
+            $path = '/';
         }
 
-        return $this->adapter->getClient()->getObjectUrl(
-            $this->adapter->getBucket(),
-            $this->adapter->applyPathPrefix($path)
-        );
+        return $this->getObjectUrl($path);
+    }
+
+    /**
+     * Retrieves object URL from cache.
+     *
+     * @param string $path
+     * @return string
+     */
+    private function getObjectUrl(string $path): string
+    {
+        return $this->objectUrl . ltrim($path, '/');
     }
 
     /**
@@ -312,11 +321,7 @@ private function normalizeAbsolutePath(string $path = '.'): string
      */
     private function normalizeRelativePath(string $path): string
     {
-        return str_replace(
-            $this->normalizeAbsolutePath(),
-            '',
-            $path
-        );
+        return str_replace($this->normalizeAbsolutePath(), '', $path);
     }
 
     /**

app/code/Magento/AwsS3/Driver/AwsS3Factory.php

@@ -10,6 +10,7 @@
 use Aws\S3\S3Client;
 use League\Flysystem\AwsS3v3\AwsS3Adapter;
 use Magento\Framework\ObjectManagerInterface;
+use Magento\RemoteStorage\Driver\DriverException;
 use Magento\RemoteStorage\Driver\DriverFactoryInterface;
 use Magento\RemoteStorage\Driver\RemoteDriverInterface;
 
@@ -32,11 +33,7 @@ public function __construct(ObjectManagerInterface $objectManager)
     }
 
     /**
-     * Creates an instance of AWS S3 driver.
-     *
-     * @param array $config
-     * @param string $prefix
-     * @return RemoteDriverInterface
+     * @inheritDoc
      */
     public function create(array $config, string $prefix): RemoteDriverInterface
     {
@@ -46,17 +43,18 @@ public function create(array $config, string $prefix): RemoteDriverInterface
             unset($config['credentials']);
         }
 
+        if (empty($config['bucket']) || empty($config['region'])) {
+            throw new DriverException(__('Bucket and region are required values'));
+        }
+
+        $client = new S3Client($config);
+        $adapter = new AwsS3Adapter($client, $config['bucket'], $prefix);
+
         return $this->objectManager->create(
             AwsS3::class,
             [
-                'adapter' => $this->objectManager->create(
-                    AwsS3Adapter::class,
-                    [
-                        'client' => $this->objectManager->create(S3Client::class, ['args' => $config]),
-                        'bucket' => $config['bucket'],
-                        'prefix' => $prefix
-                    ]
-                )
+                'adapter' => $adapter,
+                'objectUrl' => $client->getObjectUrl($adapter->getBucket(), $adapter->applyPathPrefix('.'))
             ]
         );
     }

app/code/Magento/AwsS3/Test/Unit/Driver/AwsS3Test.php

@@ -7,8 +7,8 @@
 
 namespace Magento\AwsS3\Test\Unit\Driver;
 
-use Aws\S3\S3ClientInterface;
 use League\Flysystem\AwsS3v3\AwsS3Adapter;
+use League\Flysystem\Cached\CachedAdapter;
 use Magento\AwsS3\Driver\AwsS3;
 use Magento\Framework\Exception\FileSystemException;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -32,41 +32,15 @@ class AwsS3Test extends TestCase
      */
     private $adapterMock;
 
-    /**
-     * @var S3ClientInterface|MockObject
-     */
-    private $clientMock;
-
-    /**
-     * @var LoggerInterface
-     */
-    private $logger;
-
     /**
      * @inheritDoc
      */
     protected function setUp(): void
     {
-        $this->adapterMock = $this->createMock(AwsS3Adapter::class);
-        $this->clientMock = $this->getMockForAbstractClass(S3ClientInterface::class);
-        $this->logger = $this->getMockForAbstractClass(LoggerInterface::class);
-
-        $this->adapterMock->method('applyPathPrefix')
-            ->willReturnArgument(0);
-        $this->adapterMock->method('getBucket')
-            ->willReturn('test');
-        $this->adapterMock->method('getClient')
-            ->willReturn($this->clientMock);
-        $this->clientMock->method('getObjectUrl')
-            ->willReturnCallback(function (string $bucket, string $path) {
-                if ($path === '.') {
-                    $path = '';
-                }
-
-                return self::URL . $path;
-            });
+        $this->adapterMock = $this->createMock(CachedAdapter::class);
+        $loggerMock = $this->getMockForAbstractClass(LoggerInterface::class);
 
-        $this->driver = new AwsS3($this->adapterMock, $this->logger);
+        $this->driver = new AwsS3($this->adapterMock, $loggerMock, self::URL);
     }
 
     /**

app/code/Magento/AwsS3/composer.json

@@ -9,7 +9,8 @@
         "magento/framework": "^100.0.2",
         "magento/module-remote-storage": "*",
         "league/flysystem": "^1.0",
-        "league/flysystem-aws-s3-v3": "^1.0"
+        "league/flysystem-aws-s3-v3": "^1.0",
+        "league/flysystem-cached-adapter": "^1.0"
     },
     "type": "magento2-module",
     "license": [

app/code/Magento/RemoteStorage/Driver/DriverFactoryInterface.php

@@ -18,6 +18,8 @@ interface DriverFactoryInterface
      * @param array $config
      * @param string $prefix
      * @return RemoteDriverInterface
+     *
+     * @throws DriverException
      */
     public function create(array $config, string $prefix): RemoteDriverInterface;
 }

composer.json

@@ -82,7 +82,8 @@
         "webonyx/graphql-php": "^0.13.8",
         "wikimedia/less.php": "~1.8.0",
         "league/flysystem": "^1.0",
-        "league/flysystem-aws-s3-v3": "^1.0"
+        "league/flysystem-aws-s3-v3": "^1.0",
+        "league/flysystem-cached-adapter": "^1.0"
     },
     "require-dev": {
         "allure-framework/allure-phpunit": "~1.2.0",