ENGCOM-5237: [2.2][Backport] Database Media Storage - Admin Product Edit Page handles recreates images correctly when pub/media/catalog is cleared. #21606

Author: VladimirZaets

app/code/Magento/Catalog/Block/Adminhtml/Product/Helper/Form/Gallery/Content.php

@@ -19,6 +19,7 @@
 use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\App\ObjectManager;
 use Magento\Backend\Block\DataProviders\UploadConfig as ImageUploadConfigDataProvider;
+use Magento\MediaStorage\Helper\File\Storage\Database;
 
 class Content extends \Magento\Backend\Block\Widget
 {
@@ -47,25 +48,34 @@ class Content extends \Magento\Backend\Block\Widget
      */
     private $imageHelper;
 
+    /**
+     * @var Database
+     */
+    private $fileStorageDatabase;
+
     /**
      * @param \Magento\Backend\Block\Template\Context $context
      * @param \Magento\Framework\Json\EncoderInterface $jsonEncoder
      * @param \Magento\Catalog\Model\Product\Media\Config $mediaConfig
      * @param array $data
      * @param ImageUploadConfigDataProvider $imageUploadConfigDataProvider
+     * @param Database $fileStorageDatabase
      */
     public function __construct(
         \Magento\Backend\Block\Template\Context $context,
         \Magento\Framework\Json\EncoderInterface $jsonEncoder,
         \Magento\Catalog\Model\Product\Media\Config $mediaConfig,
         array $data = [],
-        ImageUploadConfigDataProvider $imageUploadConfigDataProvider = null
+        ImageUploadConfigDataProvider $imageUploadConfigDataProvider = null,
+        Database $fileStorageDatabase = null
     ) {
         $this->_jsonEncoder = $jsonEncoder;
         $this->_mediaConfig = $mediaConfig;
         parent::__construct($context, $data);
         $this->imageUploadConfigDataProvider = $imageUploadConfigDataProvider
             ?: ObjectManager::getInstance()->get(ImageUploadConfigDataProvider::class);
+        $this->fileStorageDatabase = $fileStorageDatabase
+            ?: ObjectManager::getInstance()->get(Database::class);
     }
 
     /**
@@ -153,6 +163,13 @@ public function getImagesJson()
             $images = $this->sortImagesByPosition($value['images']);
             foreach ($images as &$image) {
                 $image['url'] = $this->_mediaConfig->getMediaUrl($image['file']);
+                if ($this->fileStorageDatabase->checkDbUsage() &&
+                    !$mediaDir->isFile($this->_mediaConfig->getMediaPath($image['file']))
+                ) {
+                    $this->fileStorageDatabase->saveFileToFilesystem(
+                        $this->_mediaConfig->getMediaPath($image['file'])
+                    );
+                }
                 try {
                     $fileHandler = $mediaDir->stat($this->_mediaConfig->getMediaPath($image['file']));
                     $image['size'] = $fileHandler['size'];

app/code/Magento/Catalog/Test/Unit/Block/Adminhtml/Product/Helper/Form/Gallery/ContentTest.php

@@ -9,6 +9,7 @@
 use Magento\Catalog\Model\Entity\Attribute;
 use Magento\Catalog\Model\Product;
 use Magento\Framework\Phrase;
+use Magento\MediaStorage\Helper\File\Storage\Database;
 
 /**
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
@@ -50,6 +51,11 @@ class ContentTest extends \PHPUnit\Framework\TestCase
      */
     protected $imageHelper;
 
+    /**
+     * @var \Magento\MediaStorage\Helper\File\Storage\Database|\PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $databaseMock;
+
     /**
      * @var \Magento\Framework\TestFramework\Unit\Helper\ObjectManager
      */
@@ -71,13 +77,18 @@ public function setUp()
             ->disableOriginalConstructor()
             ->getMock();
 
+        $this->databaseMock = $this->getMockBuilder(Database::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
         $this->objectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
         $this->content = $this->objectManager->getObject(
             \Magento\Catalog\Block\Adminhtml\Product\Helper\Form\Gallery\Content::class,
             [
                 'mediaConfig' => $this->mediaConfigMock,
                 'jsonEncoder' => $this->jsonEncoderMock,
-                'filesystem' => $this->fileSystemMock
+                'filesystem' => $this->fileSystemMock,
+                'fileStorageDatabase' => $this->databaseMock
             ]
         );
     }
@@ -143,6 +154,13 @@ public function testGetImagesJson()
         $this->readMock->expects($this->any())->method('stat')->willReturnMap($sizeMap);
         $this->jsonEncoderMock->expects($this->once())->method('encode')->willReturnCallback('json_encode');
 
+        $this->readMock->expects($this->any())
+            ->method('isFile')
+            ->will($this->returnValue(true));
+        $this->databaseMock->expects($this->any())
+            ->method('checkDbUsage')
+            ->will($this->returnValue(false));
+
         $this->assertSame(json_encode($imagesResult), $this->content->getImagesJson());
     }
 
@@ -221,6 +239,13 @@ public function testGetImagesJsonWithException()
         $this->imageHelper->expects($this->any())->method('getDefaultPlaceholderUrl')->willReturn($placeholderUrl);
         $this->jsonEncoderMock->expects($this->once())->method('encode')->willReturnCallback('json_encode');
 
+        $this->readMock->expects($this->any())
+            ->method('isFile')
+            ->will($this->returnValue(true));
+        $this->databaseMock->expects($this->any())
+            ->method('checkDbUsage')
+            ->will($this->returnValue(false));
+
         $this->assertSame(json_encode($imagesResult), $this->content->getImagesJson());
     }
 
@@ -365,4 +390,52 @@ private function getMediaAttribute(string $label, string $attributeCode)
 
         return $mediaAttribute;
     }
+
+    /**
+     * Test GetImagesJson() calls MediaStorage functions to obtain image from DB prior to stat call
+     *
+     * @return void
+     */
+    public function testGetImagesJsonMediaStorageMode()
+    {
+        $images = [
+            'images' => [
+                [
+                    'value_id' => '0',
+                    'file' => 'file_1.jpg',
+                    'media_type' => 'image',
+                    'position' => '0'
+                ]
+            ]
+        ];
+
+        $mediaPath = [
+            ['file_1.jpg', 'catalog/product/image_1.jpg']
+        ];
+
+        $this->content->setElement($this->galleryMock);
+
+        $this->galleryMock->expects($this->once())
+            ->method('getImages')
+            ->willReturn($images);
+        $this->fileSystemMock->expects($this->once())
+            ->method('getDirectoryRead')
+            ->willReturn($this->readMock);
+        $this->mediaConfigMock->expects($this->any())
+            ->method('getMediaPath')
+            ->willReturnMap($mediaPath);
+
+        $this->readMock->expects($this->any())
+            ->method('isFile')
+            ->will($this->returnValue(false));
+        $this->databaseMock->expects($this->any())
+            ->method('checkDbUsage')
+            ->will($this->returnValue(true));
+
+        $this->databaseMock->expects($this->once())
+            ->method('saveFileToFilesystem')
+            ->with('catalog/product/image_1.jpg');
+
+        $this->content->getImagesJson();
+    }
 }