ACP2E-2631: Hidden directories in pub/media/catalog/product cause disk space issues

Author: thiaramus

app/code/Magento/Catalog/Model/Product/Image.php

@@ -46,7 +46,8 @@ class Image extends \Magento\Framework\Model\AbstractModel
      * Default quality value (for JPEG images only).
      *
      * @var int
-     * @deprecated 103.0.1 use config setting with path self::XML_PATH_JPEG_QUALITY
+     * @deprecated 103.0.1
+     * @see Use config setting with path self::XML_PATH_JPEG_QUALITY
      */
     protected $_quality = null;
 
@@ -102,7 +103,8 @@ class Image extends \Magento\Framework\Model\AbstractModel
 
     /**
      * @var int
-     * @deprecated unused
+     * @deprecated
+     * @see Not used anymore
      */
     protected $_angle;
 
@@ -308,7 +310,8 @@ public function getHeight()
      *
      * @param int $quality
      * @return $this
-     * @deprecated 103.0.1 use config setting with path self::XML_PATH_JPEG_QUALITY
+     * @deprecated 103.0.1
+     * @see Use config setting with path self::XML_PATH_JPEG_QUALITY
      */
     public function setQuality($quality)
     {
@@ -458,6 +461,7 @@ public function getBaseFile()
      * Get new file
      *
      * @deprecated 102.0.0
+     * @see Image::getBaseFile
      * @return bool|string
      */
     public function getNewFile()
@@ -837,10 +841,15 @@ public function getWatermarkHeight()
     public function clearCache()
     {
         $directory = $this->_catalogProductMediaConfig->getBaseMediaPath() . '/cache';
+
+        // If the directory cannot be deleted, it is likely because it is not empty anymore due to lazy loading from
+        // the storefront triggering new cache file creation.
+        // This is expected behavior and is not a cause for concern. Deletable files were deleted as expected.
+        // To avoid errors on the storefront, we wrap the deletion in a try/catch block and silently handle any
+        // exceptions, allowing the process to continue smoothly.
         try {
             $this->_mediaDirectory->delete($directory);
-        }
-        // phpcs:ignore Magento2.CodeAnalysis.EmptyBlock.DetectedCatch
+        } // phpcs:ignore Magento2.CodeAnalysis.EmptyBlock.DetectedCatch
         catch (FileSystemException $e) {
         }
 

app/code/Magento/Catalog/Test/Unit/Model/Product/ImageTest.php

@@ -14,10 +14,10 @@
 use Magento\Catalog\Model\View\Asset\PlaceholderFactory;
 use Magento\Framework\App\CacheInterface;
 use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Directory\Write;
 use Magento\Framework\Filesystem\Directory\WriteInterface;
-use Magento\Framework\Filesystem\DriverInterface;
 use Magento\Framework\Image\Factory;
 use Magento\Framework\Model\Context;
 use Magento\Framework\Serialize\SerializerInterface;
@@ -141,7 +141,7 @@ protected function setUp(): void
 
         $this->mediaDirectory = $this->getMockBuilder(Write::class)
             ->disableOriginalConstructor()
-            ->onlyMethods(['create', 'isFile', 'isExist', 'getAbsolutePath', 'isDirectory', 'getDriver', 'delete'])
+            ->onlyMethods(['create', 'isFile', 'isExist', 'getAbsolutePath', 'delete'])
             ->getMock();
 
         $this->filesystem = $this->createMock(Filesystem::class);
@@ -504,54 +504,35 @@ public function testIsCached(): void
     }
 
     /**
-     * @param bool $isRenameSuccessful
-     * @param string $expectedDirectoryToDelete
      * @return void
-     * @throws \Magento\Framework\Exception\FileSystemException
-     * @dataProvider clearCacheDataProvider
-     */
-    public function testClearCache(
-        bool $isRenameSuccessful,
-        string $expectedDirectoryToDelete
-    ): void {
-        $driver = $this->createMock(DriverInterface::class);
-        $this->mediaDirectory->method('getAbsolutePath')
-            ->willReturnCallback(
-                function (string $path) {
-                    return 'path/to/media/' . $path;
-                }
-            );
-        $this->mediaDirectory->expects($this->exactly(2))
-            ->method('isDirectory')
-            ->willReturnOnConsecutiveCalls(false, true);
-        $this->mediaDirectory->expects($this->once())
-            ->method('getDriver')
-            ->willReturn($driver);
-        $driver->expects($this->once())
-            ->method('rename')
-            ->with(
-                'path/to/media/catalog/product/cache',
-                $this->matchesRegularExpression('/^path\/to\/media\/catalog\/product\/\.[0-9A-ZA-z-_]{3}$/')
-            )
-            ->willReturn($isRenameSuccessful);
-        $this->mediaDirectory->expects($this->once())
-            ->method('delete')
-            ->with($this->matchesRegularExpression($expectedDirectoryToDelete));
-
+     * @throws FileSystemException
+     */
+    public function testClearCache(): void
+    {
         $this->coreFileHelper->expects($this->once())->method('deleteFolder')->willReturn(true);
         $this->cacheManager->expects($this->once())->method('clean');
         $this->image->clearCache();
     }
 
     /**
-     * @return array
+     * This test verifies that if the cache directory cannot be deleted because it is no longer empty (due to newly
+     * cached files being created after the old ones were deleted), the cache clean method should handle the exception
+     * and complete the clean. This is expected behavior and is not a cause for concern.
+     * The test asserts that the cache cleaning process completes successfully even if the directory cannot be deleted.
+     *
+     * @return void
+     * @throws FileSystemException
      */
-    public function clearCacheDataProvider(): array
-    {
-        return [
-            [true, '/^catalog\/product\/\.[0-9A-ZA-z-_]{3}$/'],
-            [false, '/^catalog\/product\/cache$/'],
-        ];
+    public function testClearCacheWithUnableToDeleteDirectory(): void {
+        $this->mediaDirectory->expects($this->once())
+            ->method('delete')
+            ->willThrowException(new FileSystemException(__('Cannot delete non-empty dir.')));
+
+        // Image cache should complete successfully even if the directory cannot be deleted.
+        $this->coreFileHelper->expects($this->once())->method('deleteFolder')->willReturn(true);
+        $this->cacheManager->expects($this->once())->method('clean');
+
+        $this->image->clearCache();
     }
 
     /**