bug #47695 [FrameworkBundle] Filter out trans paths that are covered by a parent folder path (natewiebe13)

nicolas-grekas · nicolas-grekas · commit 65dd59a671aa · 2022-09-28T17:35:14.000+02:00
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [FrameworkBundle] Filter out trans paths that are covered by a parent folder path | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Partially Fixes #45645 | License | MIT | Doc PR | N/A It was possible to end up with duplicated paths which would could result in many files being scanned more than once. This prevents that. Commits ------- 459ac04 [FrameworkBundle] Filter out trans paths that are covered by a parent folder path
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/TranslationUpdateCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/TranslationUpdateCommand.php
@@ -407,6 +407,7 @@ private function extractMessages(string $locale, array $transPaths, string $pref
     {
         $extractedCatalogue = new MessageCatalogue($locale);
         $this->extractor->setPrefix($prefix);
+        $transPaths = $this->filterDuplicateTransPaths($transPaths);
         foreach ($transPaths as $path) {
             if (is_dir($path) || is_file($path)) {
                 $this->extractor->extract($path, $extractedCatalogue);
@@ -416,6 +417,27 @@ private function extractMessages(string $locale, array $transPaths, string $pref
         return $extractedCatalogue;
     }
 
+    private function filterDuplicateTransPaths(array $transPaths): array
+    {
+        $transPaths = array_filter(array_map('realpath', $transPaths));
+
+        sort($transPaths);
+
+        $filteredPaths = [];
+
+        foreach ($transPaths as $path) {
+            foreach ($filteredPaths as $filteredPath) {
+                if (str_starts_with($path, $filteredPath.\DIRECTORY_SEPARATOR)) {
+                    continue 2;
+                }
+            }
+
+            $filteredPaths[] = $path;
+        }
+
+        return $filteredPaths;
+    }
+
     private function loadCurrentMessages(string $locale, array $transPaths): MessageCatalogue
     {
         $currentCatalogue = new MessageCatalogue($locale);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/TranslationUpdateCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/TranslationUpdateCommandTest.php
@@ -140,6 +140,46 @@ public function testWriteMessagesForSpecificDomain()
         $this->assertMatchesRegularExpression('/Translation files were successfully updated./', $tester->getDisplay());
     }
 
+    public function testFilterDuplicateTransPaths()
+    {
+        $transPaths = [
+            $this->translationDir.'/a/test/folder/with/a/subfolder',
+            $this->translationDir.'/a/test/folder/',
+            $this->translationDir.'/a/test/folder/with/a/subfolder/and/a/file.txt',
+            $this->translationDir.'/a/different/test/folder',
+        ];
+
+        $expectedPaths = [
+            $this->translationDir.'/a/different/test/folder',
+            $this->translationDir.'/a/test/folder',
+        ];
+
+        foreach ($transPaths as $transPath) {
+            if (realpath($transPath)) {
+                continue;
+            }
+
+            if (preg_match('/\.[a-z]+$/', $transPath)) {
+                if (!realpath(\dirname($transPath))) {
+                    mkdir(\dirname($transPath), 0777, true);
+                }
+
+                touch($transPath);
+            } else {
+                mkdir($transPath, 0777, true);
+            }
+        }
+
+        $command = $this->createMock(TranslationUpdateCommand::class);
+
+        $method = new \ReflectionMethod(TranslationUpdateCommand::class, 'filterDuplicateTransPaths');
+        $method->setAccessible(true);
+
+        $filteredTransPaths = $method->invoke($command, $transPaths);
+
+        $this->assertEquals($expectedPaths, $filteredTransPaths);
+    }
+
     protected function setUp(): void
     {
         $this->fs = new Filesystem();
