MC-32593: var/resource_config.json is regenerated each time an image is requested by get.php

Author: nikita-shcherbatykh

app/code/Magento/MediaStorage/App/Media.php

@@ -20,15 +20,17 @@
 use Magento\Framework\AppInterface;
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Directory\WriteInterface;
+use Magento\Framework\Filesystem\Driver\File;
 use Magento\MediaStorage\Model\File\Storage\Config;
 use Magento\MediaStorage\Model\File\Storage\ConfigFactory;
 use Magento\MediaStorage\Model\File\Storage\Response;
 use Magento\MediaStorage\Model\File\Storage\Synchronization;
 use Magento\MediaStorage\Model\File\Storage\SynchronizationFactory;
 use Magento\MediaStorage\Service\ImageResize;
 
+
 /**
- * Media Storage
+ * The class resize original images
  *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
@@ -70,7 +72,12 @@ class Media implements AppInterface
     /**
      * @var WriteInterface
      */
-    private $directory;
+    private $directoryPub;
+
+    /**
+     * @var \Magento\Framework\Filesystem\Directory\WriteInterface
+     */
+    private $directoryMedia;
 
     /**
      * @var ConfigFactory
@@ -109,6 +116,7 @@ class Media implements AppInterface
      * @param PlaceholderFactory $placeholderFactory
      * @param State $state
      * @param ImageResize $imageResize
+     * @param File $file
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -122,15 +130,17 @@ public function __construct(
         Filesystem $filesystem,
         PlaceholderFactory $placeholderFactory,
         State $state,
-        ImageResize $imageResize
+        ImageResize $imageResize,
+        File $file
     ) {
         $this->response = $response;
         $this->isAllowed = $isAllowed;
-        $this->directory = $filesystem->getDirectoryWrite(DirectoryList::PUB);
+        $this->directoryPub = $filesystem->getDirectoryWrite(DirectoryList::PUB);
+        $this->directoryMedia = $filesystem->getDirectoryWrite(DirectoryList::MEDIA);
         $mediaDirectory = trim($mediaDirectory);
         if (!empty($mediaDirectory)) {
             // phpcs:ignore Magento2.Functions.DiscouragedFunction
-            $this->mediaDirectoryPath = str_replace('\\', '/', realpath($mediaDirectory));
+            $this->mediaDirectoryPath = str_replace('\\', '/', $file->getRealPath($mediaDirectory));
         }
         $this->configCacheFile = $configCacheFile;
         $this->relativeFileName = $relativeFileName;
@@ -151,7 +161,7 @@ public function launch(): ResponseInterface
     {
         $this->appState->setAreaCode(Area::AREA_GLOBAL);
 
-        if ($this->mediaDirectoryPath !== $this->directory->getAbsolutePath()) {
+        if ($this->checkMediaDirectoryChanged()) {
             // Path to media directory changed or absent - update the config
             /** @var Config $config */
             $config = $this->configFactory->create(['cacheFile' => $this->configCacheFile]);
@@ -166,11 +176,11 @@ public function launch(): ResponseInterface
 
         try {
             /** @var Synchronization $sync */
-            $sync = $this->syncFactory->create(['directory' => $this->directory]);
+            $sync = $this->syncFactory->create(['directory' => $this->directoryPub]);
             $sync->synchronize($this->relativeFileName);
             $this->imageResize->resizeFromImageName($this->getOriginalImage($this->relativeFileName));
-            if ($this->directory->isReadable($this->relativeFileName)) {
-                $this->response->setFilePath($this->directory->getAbsolutePath($this->relativeFileName));
+            if ($this->directoryPub->isReadable($this->relativeFileName)) {
+                $this->response->setFilePath($this->directoryPub->getAbsolutePath($this->relativeFileName));
             } else {
                 $this->setPlaceholderImage();
             }
@@ -182,7 +192,17 @@ public function launch(): ResponseInterface
     }
 
     /**
-     * Set Placeholder as a response
+     * Check if media directory changed
+     *
+     * @return bool
+     */
+    private function checkMediaDirectoryChanged(): bool
+    {
+        return rtrim($this->mediaDirectoryPath, '/') !== rtrim($this->directoryMedia->getAbsolutePath(), '/');
+    }
+
+    /**
+     * Set placeholder image into response
      *
      * @return void
      */

app/code/Magento/MediaStorage/Test/Unit/App/MediaTest.php

@@ -15,6 +15,7 @@
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Directory\Read;
 use Magento\Framework\Filesystem\Directory\WriteInterface;
+use Magento\Framework\Filesystem\DriverPool;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use Magento\MediaStorage\App\Media;
 use Magento\MediaStorage\Model\File\Storage\Config;
@@ -74,7 +75,12 @@ class MediaTest extends TestCase
     /**
      * @var Read|MockObject
      */
-    private $directoryMock;
+    private $directoryMediaMock;
+
+    /**
+     * @var \Magento\Framework\Filesystem\Directory\Read|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $directoryPubMock;
 
     protected function setUp()
     {
@@ -96,12 +102,30 @@ protected function setUp()
             ->will($this->returnValue($this->sync));
 
         $this->filesystemMock = $this->createMock(Filesystem::class);
-        $this->directoryMock = $this->getMockForAbstractClass(WriteInterface::class);
-
+        $this->directoryPubMock = $this->getMockForAbstractClass(
+            WriteInterface::class,
+            [],
+            '',
+            false,
+            true,
+            true,
+            ['isReadable', 'getAbsolutePath']
+        );
+        $this->directoryMediaMock = $this->getMockForAbstractClass(
+            WriteInterface::class,
+            [],
+            '',
+            false,
+            true,
+            true,
+            ['getAbsolutePath']
+        );
         $this->filesystemMock->expects($this->any())
             ->method('getDirectoryWrite')
-            ->with(DirectoryList::PUB)
-            ->will($this->returnValue($this->directoryMock));
+            ->willReturnMap([
+                [DirectoryList::PUB, DriverPool::FILE, $this->directoryPubMock],
+                [DirectoryList::MEDIA, DriverPool::FILE, $this->directoryMediaMock],
+            ]);
 
         $this->responseMock = $this->createMock(Response::class);
     }
@@ -116,17 +140,17 @@ public function testProcessRequestCreatesConfigFileMediaDirectoryIsNotProvided()
         $this->mediaModel = $this->getMediaModel();
 
         $filePath = '/absolute/path/to/test/file.png';
-        $this->directoryMock->expects($this->any())
+        $this->directoryMediaMock->expects($this->once())
+            ->method('getAbsolutePath')
+            ->with(null)
+            ->will($this->returnValue(self::MEDIA_DIRECTORY));
+        $this->directoryPubMock->expects($this->once())
             ->method('getAbsolutePath')
-            ->will($this->returnValueMap(
-                [
-                    [null, self::MEDIA_DIRECTORY],
-                    [self::RELATIVE_FILE_PATH, $filePath],
-                ]
-            ));
+            ->with(self::RELATIVE_FILE_PATH)
+            ->will($this->returnValue($filePath));
         $this->configMock->expects($this->once())->method('save');
         $this->sync->expects($this->once())->method('synchronize')->with(self::RELATIVE_FILE_PATH);
-        $this->directoryMock->expects($this->once())
+        $this->directoryPubMock->expects($this->once())
             ->method('isReadable')
             ->with(self::RELATIVE_FILE_PATH)
             ->will($this->returnValue(true));
@@ -140,18 +164,18 @@ public function testProcessRequestReturnsFileIfItsProperlySynchronized()
 
         $filePath = '/absolute/path/to/test/file.png';
         $this->sync->expects($this->once())->method('synchronize')->with(self::RELATIVE_FILE_PATH);
-        $this->directoryMock->expects($this->once())
+        $this->directoryMediaMock->expects($this->once())
+            ->method('getAbsolutePath')
+            ->with(null)
+            ->will($this->returnValue(self::MEDIA_DIRECTORY));
+        $this->directoryPubMock->expects($this->once())
             ->method('isReadable')
             ->with(self::RELATIVE_FILE_PATH)
             ->will($this->returnValue(true));
-        $this->directoryMock->expects($this->any())
+        $this->directoryPubMock->expects($this->once())
             ->method('getAbsolutePath')
-            ->will($this->returnValueMap(
-                [
-                    [null, self::MEDIA_DIRECTORY],
-                    [self::RELATIVE_FILE_PATH, $filePath],
-                ]
-            ));
+            ->with(self::RELATIVE_FILE_PATH)
+            ->will($this->returnValue($filePath));
         $this->responseMock->expects($this->once())->method('setFilePath')->with($filePath);
         $this->assertSame($this->responseMock, $this->mediaModel->launch());
     }
@@ -161,11 +185,11 @@ public function testProcessRequestReturnsNotFoundIfFileIsNotSynchronized()
         $this->mediaModel = $this->getMediaModel();
 
         $this->sync->expects($this->once())->method('synchronize')->with(self::RELATIVE_FILE_PATH);
-        $this->directoryMock->expects($this->once())
+        $this->directoryMediaMock->expects($this->once())
             ->method('getAbsolutePath')
-            ->with()
+            ->with(null)
             ->will($this->returnValue(self::MEDIA_DIRECTORY));
-        $this->directoryMock->expects($this->once())
+        $this->directoryPubMock->expects($this->once())
             ->method('isReadable')
             ->with(self::RELATIVE_FILE_PATH)
             ->will($this->returnValue(false));
@@ -205,16 +229,10 @@ public function testCatchException($isDeveloper, $setBodyCalls)
     public function testExceptionWhenIsAllowedReturnsFalse()
     {
         $this->mediaModel = $this->getMediaModel(false);
-
-        $filePath = '/absolute/path/to/test/file.png';
-        $this->directoryMock->expects($this->any())
+        $this->directoryMediaMock->expects($this->once())
             ->method('getAbsolutePath')
-            ->will($this->returnValueMap(
-                [
-                    [null, self::MEDIA_DIRECTORY],
-                    [self::RELATIVE_FILE_PATH, $filePath],
-                ]
-            ));
+            ->with(null)
+            ->will($this->returnValue(self::MEDIA_DIRECTORY));
         $this->configMock->expects($this->once())->method('save');
 
         $this->expectException(LogicException::class);