bug #53893 [AssetMapper] Ignore comment lines in JavaScriptImportPathCompiler (smnandre)

fabpot · fabpot · commit ca8c10d9f785 · 2024-02-11T15:11:21.000+01:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [AssetMapper] Ignore comment lines in JavaScriptImportPathCompiler | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #53849 | License | MIT The following code was wrongly treated as _one_ line of comment ```js // import import "foo.js" ``` This PR updates the regexp to ignore comment lines (and fix #53849) Also added a comment explaining how the regexp works for future maintenance. Commits ------- 41a3489 [AssetMapper] Ignore comment lines in JavaScriptImportPathCompiler
diff --git a/src/Symfony/Component/AssetMapper/Compiler/JavaScriptImportPathCompiler.php b/src/Symfony/Component/AssetMapper/Compiler/JavaScriptImportPathCompiler.php
@@ -27,8 +27,31 @@
  */
 final class JavaScriptImportPathCompiler implements AssetCompilerInterface
 {
-    // https://regex101.com/r/qFoeoR/1
-    private const IMPORT_PATTERN = '/(?:\'(?:[^\'\\\\]|\\\\.)*\'|"(?:[^"\\\\]|\\\\.)*")|(?:import\s*(?:(?:\*\s*as\s+\w+|[\w\s{},*]+)\s*from\s*)?|\bimport\()\s*[\'"`](\.\/[^\'"`]+|(\.\.\/)*[^\'"`]+)[\'"`]\s*[;\)]?/m';
+    /**
+     * @see https://regex101.com/r/1iBAIb/1
+     */
+    private const IMPORT_PATTERN = '/
+        ^
+            (?:\/\/.*)                     # Lines that start with comments
+        |
+            (?:
+                \'(?:[^\'\\\\]|\\\\.)*\'   # Strings enclosed in single quotes
+            |
+                "(?:[^"\\\\]|\\\\.)*"      # Strings enclosed in double quotes
+            )
+        |
+            (?:                            # Import statements (script captured)
+                import\s*
+                    (?:
+                        (?:\*\s*as\s+\w+|\s+[\w\s{},*]+)
+                        \s*from\s*
+                    )?
+            |
+                \bimport\(
+            )
+            \s*[\'"`](\.\/[^\'"`]+|(\.\.\/)*[^\'"`]+)[\'"`]\s*[;\)]
+        ?
+    /mx';
 
     public function __construct(
         private readonly ImportMapConfigReader $importMapConfigReader,
@@ -42,7 +65,7 @@ public function compile(string $content, MappedAsset $asset, AssetMapperInterfac
         return preg_replace_callback(self::IMPORT_PATTERN, function ($matches) use ($asset, $assetMapper, $content) {
             $fullImportString = $matches[0][0];
 
-            // Ignore enquoted strings (e.g. console.log("import 'foo';")
+            // Ignore matches that did not capture import statements
             if (!isset($matches[1][0])) {
                 return $fullImportString;
             }
diff --git a/src/Symfony/Component/AssetMapper/Tests/Compiler/JavaScriptImportPathCompilerTest.php b/src/Symfony/Component/AssetMapper/Tests/Compiler/JavaScriptImportPathCompilerTest.php
@@ -177,6 +177,16 @@ public static function provideCompileTests(): iterable
             'expectedJavaScriptImports' => ['/assets/other.js' => ['lazy' => false, 'asset' => 'other.js', 'add' => true]],
         ];
 
+        yield 'commented_import_on_one_line_then_module_name_on_next_is_not_ok' => [
+            'input' => "// import \n    './other.js';",
+            'expectedJavaScriptImports' => [],
+        ];
+
+        yield 'commented_import_on_one_line_then_import_on_next_is_ok' => [
+            'input' => "// import\nimport { Foo } from './other.js';",
+            'expectedJavaScriptImports' => ['/assets/other.js' => ['lazy' => false, 'asset' => 'other.js', 'add' => true]],
+        ];
+
         yield 'importing_a_css_file_is_included' => [
             'input' => "import './styles.css';",
             'expectedJavaScriptImports' => ['/assets/styles.css' => ['lazy' => false, 'asset' => 'styles.css', 'add' => true]],
