ACP2E-3797: New Files Created Instead of Replacing Existing Images

Author: abukatar

app/code/Magento/Catalog/Model/Product/Gallery/CreateHandler.php

@@ -219,13 +219,18 @@ public function execute($product, $arguments = [])
                     $clearImages[] = $image['file'];
                 } elseif (empty($image['value_id']) || !empty($image['recreate'])) {
                     $newFile = $this->moveImageFromTmp($image['file'] ?? '');
-                    $image['new_file'] = $newFile;
-                    $newImages[$image['file']] = $image;
-                    if (!empty($image['recreate'])) {
+                    if (!empty($image['recreate']) && $newFile !== $image['file']) {
                         //delete old image
-                        $this->mediaDirectory->delete($this->mediaConfig->getMediaPath($image['file']));
+                        $this->mediaDirectory->renameFile(
+                            $this->mediaConfig->getMediaPath($newFile),
+                            $this->mediaConfig->getMediaPath($image['file'])
+                        );
+                        $existImages[$image['file']] = $image;
+                    } else {
+                        $image['new_file'] = $newFile;
+                        $newImages[$image['file']] = $image;
+                        $image['file'] = $newFile;
                     }
-                    $image['file'] = $newFile;
                 } else {
                     $existImages[$image['file']] = $image;
                 }

dev/tests/api-functional/testsuite/Magento/Catalog/Api/ProductAttributeMediaGalleryManagementInterfaceTest.php

@@ -9,9 +9,6 @@
 
 use Magento\Catalog\Test\Fixture\Product as ProductFixture;
 use Magento\Framework\Api\Data\ImageContentInterface;
-use Magento\Framework\App\Filesystem\DirectoryList;
-use Magento\Framework\Filesystem;
-use Magento\Framework\Filesystem\Directory\WriteInterface;
 use Magento\Store\Test\Fixture\Store as StoreFixture;
 use Magento\TestFramework\Fixture\DataFixture;
 use Magento\TestFramework\Fixture\DataFixtureStorage;
@@ -25,7 +22,7 @@
 use Magento\Framework\ObjectManagerInterface;
 
 /**
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * Class ProductAttributeMediaGalleryManagementInterfaceTest
  */
 class ProductAttributeMediaGalleryManagementInterfaceTest extends WebapiAbstract
 {
@@ -71,11 +68,6 @@ class ProductAttributeMediaGalleryManagementInterfaceTest extends WebapiAbstract
      */
     private $fixtures;
 
-    /**
-     * @var WriteInterface
-     */
-    private $mediaDirectory;
-
     /**
      * @inheritDoc
      */
@@ -120,8 +112,6 @@ protected function setUp(): void
 
         $this->testImagePath = __DIR__ . DIRECTORY_SEPARATOR . '_files' . DIRECTORY_SEPARATOR . 'test_image.jpg';
         $this->fixtures = $this->objectManager->get(DataFixtureStorageManager::class)->getStorage();
-        $this->mediaDirectory = $this->objectManager->get(Filesystem::class)
-            ->getDirectoryWrite(DirectoryList::MEDIA);
     }
 
     /**
@@ -906,7 +896,7 @@ public function testContentAttributeInGet(): void
     }
 
     /**
-     * Test update() method when existing image gets overwritten
+     * Test update() method when existing image gets overwritten and name is not changed
      *
      * @magentoApiDataFixture Magento/Catalog/_files/product_with_image.php
      */
@@ -916,7 +906,6 @@ public function testUpdateExistingImage()
         /** @var \Magento\Catalog\Api\Data\ProductInterface $product */
         $product = $productRepository->get('simple');
         $imageId = (int)$product->getMediaGalleryImages()->getFirstItem()->getValueId();
-        $originalImagePath = $product->getMediaGalleryImages()->getFirstItem()->getFile();
         $requestData = [
             'sku' => 'simple',
             'entry' => [
@@ -929,7 +918,7 @@ public function testUpdateExistingImage()
                 'content' => [
                     'base64_encoded_data' => base64_encode(file_get_contents($this->testImagePath)),
                     'type' => 'image/jpeg',
-                    'name' => 'test_image.jpg',
+                    'name' => 'magento_image.jpg',
                 ]
             ]
         ];
@@ -938,10 +927,8 @@ public function testUpdateExistingImage()
             . '/' . $this->getTargetGalleryEntryId();
 
         $this->assertTrue($this->_webApiCall($this->updateServiceInfo, $requestData, null, 'all'));
-        $updatedImage = $this->assertMediaGalleryData($imageId, '/t/e/test_image.jpg', 'Updated Image Text');
+        $updatedImage = $this->assertMediaGalleryData($imageId, '/m/a/magento_image.jpg', 'Updated Image Text');
         $this->assertEquals(10, $updatedImage['position_default']);
         $this->assertEquals(1, $updatedImage['disabled_default']);
-        $this->assertStringStartsWith('/t/e/test_image.jpg', $updatedImage['file']);
-        $this->assertFalse($this->mediaDirectory->isExist($originalImagePath));
     }
 }