B2B-2058: ImageUploader uses Name class which works only with local FS

Author: NadiyaS

dev/tests/integration/testsuite/Magento/Framework/File/NameTest.php

@@ -8,8 +8,8 @@
 namespace Magento\Framework\File;
 
 use Magento\Framework\App\Filesystem\DirectoryList;
-use Magento\Framework\Filesystem\Directory\WriteInterface;
 use Magento\TestFramework\Helper\Bootstrap;
+use Magento\Framework\Filesystem;
 
 /**
  * Test for \Magento\Framework\File\Uploader
@@ -24,18 +24,17 @@ class NameTest extends \PHPUnit\Framework\TestCase
     private $nameModel;
 
     /**
-     * @var WriteInterface
+     * @var Filesystem
      */
-    private $mediaDirectory;
+    private $fileSystem;
 
     /**
      * @inheritdoc
      */
     protected function setUp(): void
     {
         $objectManager = Bootstrap::getObjectManager();
-        $this->mediaDirectory = $objectManager->get(\Magento\Framework\Filesystem::class)
-            ->getDirectoryWrite(DirectoryList::MEDIA);
+        $this->fileSystem = $objectManager->get(\Magento\Framework\Filesystem::class);
         $this->nameModel = $objectManager->get(Name::class);
     }
 
@@ -48,9 +47,10 @@ protected function setUp(): void
      *
      * @dataProvider getNewFileNameDataProvider
      */
-    public function testGetNewFileName($destinationFile, $expectedFileName)
+    public function testGetNewFileName($directory, $destinationFile, $expectedFileName)
     {
-        $path = $this->mediaDirectory->getAbsolutePath('image/' . $destinationFile);
+        $directory = $this->fileSystem->getDirectoryWrite($directory);
+        $path = $directory->getAbsolutePath('image/' . $destinationFile);
         $name = $this->nameModel->getNewFileName($path);
         $this->assertEquals($expectedFileName, $name);
     }
@@ -62,9 +62,11 @@ public function testGetNewFileName($destinationFile, $expectedFileName)
     public function getNewFileNameDataProvider()
     {
         return [
-            ['image.jpg', 'image.jpg'],
-            ['image_one.jpg', 'image_one_1.jpg'],
-            ['image_two.jpg', 'image_two_2.jpg']
+            [DirectoryList::VAR_DIR, 'image.jpg', 'image.jpg'],
+            [DirectoryList::VAR_DIR, 'image_one.jpg', 'image_one_1.jpg'],
+            [DirectoryList::MEDIA, 'image.jpg', 'image.jpg'],
+            [DirectoryList::MEDIA, 'image_one.jpg', 'image_one_1.jpg'],
+            [DirectoryList::MEDIA, 'image_two.jpg', 'image_two_2.jpg']
         ];
     }
 }

lib/internal/Magento/Framework/File/Name.php

@@ -9,24 +9,25 @@
 
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\App\ObjectManager;
-use Magento\Framework\Filesystem\Directory\TargetDirectory;
+use Magento\Framework\Filesystem;
+use \Magento\Framework\Filesystem\DriverInterface;
 
 /**
  * Utility for generating a unique file name
  */
 class Name
 {
     /**
-     * @var \Magento\Framework\Filesystem\Directory\TargetDirectory
+     * @var Filesystem
      */
-    private $targetDirectory;
+    private $filesystem;
 
     /**
-     * @param TargetDirectory|null $targetDirectory
+     * @param Filesystem|null $filesystem
      */
-    public function __construct(TargetDirectory $targetDirectory = null)
+    public function __construct(Filesystem $filesystem = null)
     {
-        $this->targetDirectory = $targetDirectory ?? ObjectManager::getInstance()->get(TargetDirectory::class);
+        $this->filesystem = $filesystem ?: ObjectManager::getInstance()->get(Filesystem::class);
     }
 
     /**
@@ -39,22 +40,44 @@ public function __construct(TargetDirectory $targetDirectory = null)
     public function getNewFileName(string $destinationFile)
     {
         $fileInfo = $this->getPathInfo($destinationFile);
-        $directory = $this->targetDirectory->getDirectoryWrite(DirectoryList::ROOT);
-        if ($directory->isExist($destinationFile)) {
-            $index = 1;
-            $baseName = $fileInfo['filename'] . '.' . $fileInfo['extension'];
-            while ($directory->isExist($fileInfo['dirname'] . '/' . $baseName)) {
-                $baseName = $fileInfo['filename'] . '_' . $index . '.' . $fileInfo['extension'];
-                $index++;
-            }
-            $destFileName = $baseName;
+        $driver = $this->filesystem->getDirectoryWrite(
+            DirectoryList::ROOT,
+            Filesystem\DriverPool::FILE
+        )->getDriver();
+
+        /**
+         * Try with non-local driver.
+         */
+        if (!$driver->isExists($destinationFile)) {
+            $driver = $this->filesystem->getDirectoryWrite(
+                DirectoryList::ROOT
+            )->getDriver();
+        }
+
+        if ($driver->isExists($destinationFile)) {
+            $destFileName = $this->generateFileName($driver, $fileInfo);
         } else {
             return $fileInfo['basename'];
         }
 
         return $destFileName;
     }
 
+    /**
+     * @param DriverInterface $driver
+     * @param string $fileInfo
+     * @param int $index
+     * @return string
+     */
+    private function generateFileName($driver, $fileInfo, $index = 1)
+    {
+        $baseName = $fileInfo['filename'] . '_' . $index . '.' . $fileInfo['extension'];
+        if ($driver->isExists($fileInfo['dirname'] . '/' . $baseName)) {
+            return $this->generateFileName($driver, $fileInfo, ++$index);
+        }
+        return $baseName;
+    }
+
     /**
      * Get the path information from a given file
      *