bug #51345 [AssetMapper] Fixing bug where a circular exception could be thrown while making error message (weaverryan)

nicolas-grekas · nicolas-grekas · commit aba725ff8d05 · 2023-08-14T16:11:31.000+02:00
This PR was squashed before being merged into the 6.3 branch. Discussion ---------- [AssetMapper] Fixing bug where a circular exception could be thrown while making error message | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | yes | New feature? | no | Deprecations? | none | Tickets | Fix #51291 | License | MIT | Doc PR | Not needed AssetMapper's `JavaScriptImportPathCompiler` parses import statements. That process is imperfect and will over-match in some cases (e.g. matching `import()` that is commented-out). but that's not a huge issue: any matches are simply added to the importmap and matches for not-found-files are ignored. However, in #51291, we hit a spot where, while trying to improve the log message (`Try adding ".js" to the end of the import - i.e. "%s.js"`), we triggered a circular exception. This PR suppresses that. We may need to improve the parsing logic later to handle more edge-cases, but we'll handle those if/when they come up. Cheers! Commits ------- 63b9635 [AssetMapper] Fixing bug where a circular exception could be thrown while making error message
diff --git a/src/Symfony/Component/AssetMapper/Compiler/JavaScriptImportPathCompiler.php b/src/Symfony/Component/AssetMapper/Compiler/JavaScriptImportPathCompiler.php
@@ -15,6 +15,7 @@
 use Psr\Log\NullLogger;
 use Symfony\Component\AssetMapper\AssetDependency;
 use Symfony\Component\AssetMapper\AssetMapperInterface;
+use Symfony\Component\AssetMapper\Exception\CircularAssetsException;
 use Symfony\Component\AssetMapper\Exception\RuntimeException;
 use Symfony\Component\AssetMapper\MappedAsset;
 
@@ -57,8 +58,12 @@ public function compile(string $content, MappedAsset $asset, AssetMapperInterfac
             if (!$dependentAsset) {
                 $message = sprintf('Unable to find asset "%s" imported from "%s".', $matches[1], $asset->sourcePath);
 
-                if (null !== $assetMapper->getAsset(sprintf('%s.js', $resolvedPath))) {
-                    $message .= sprintf(' Try adding ".js" to the end of the import - i.e. "%s.js".', $matches[1]);
+                try {
+                    if (null !== $assetMapper->getAsset(sprintf('%s.js', $resolvedPath))) {
+                        $message .= sprintf(' Try adding ".js" to the end of the import - i.e. "%s.js".', $matches[1]);
+                    }
+                } catch (CircularAssetsException $e) {
+                    // avoid circular error if there is self-referencing import comments
                 }
 
                 $this->handleMissingImport($message);
diff --git a/src/Symfony/Component/AssetMapper/Exception/CircularAssetsException.php b/src/Symfony/Component/AssetMapper/Exception/CircularAssetsException.php
@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\AssetMapper\Exception;
+
+/**
+ * Thrown when a circular reference is detected while creating an asset.
+ */
+class CircularAssetsException extends RuntimeException
+{
+}
diff --git a/src/Symfony/Component/AssetMapper/Factory/MappedAssetFactory.php b/src/Symfony/Component/AssetMapper/Factory/MappedAssetFactory.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\AssetMapper\Factory;
 
 use Symfony\Component\AssetMapper\AssetMapperCompiler;
+use Symfony\Component\AssetMapper\Exception\CircularAssetsException;
 use Symfony\Component\AssetMapper\Exception\RuntimeException;
 use Symfony\Component\AssetMapper\MappedAsset;
 use Symfony\Component\AssetMapper\Path\PublicAssetsPathResolverInterface;
@@ -36,7 +37,7 @@ public function __construct(
     public function createMappedAsset(string $logicalPath, string $sourcePath): ?MappedAsset
     {
         if (\in_array($logicalPath, $this->assetsBeingCreated, true)) {
-            throw new RuntimeException(sprintf('Circular reference detected while creating asset for "%s": "%s".', $logicalPath, implode(' -> ', $this->assetsBeingCreated).' -> '.$logicalPath));
+            throw new CircularAssetsException(sprintf('Circular reference detected while creating asset for "%s": "%s".', $logicalPath, implode(' -> ', $this->assetsBeingCreated).' -> '.$logicalPath));
         }
 
         if (!isset($this->assetsCache[$logicalPath])) {
diff --git a/src/Symfony/Component/AssetMapper/Tests/Compiler/JavaScriptImportPathCompilerTest.php b/src/Symfony/Component/AssetMapper/Tests/Compiler/JavaScriptImportPathCompilerTest.php
@@ -16,6 +16,7 @@
 use Symfony\Component\AssetMapper\AssetMapperInterface;
 use Symfony\Component\AssetMapper\Compiler\AssetCompilerInterface;
 use Symfony\Component\AssetMapper\Compiler\JavaScriptImportPathCompiler;
+use Symfony\Component\AssetMapper\Exception\CircularAssetsException;
 use Symfony\Component\AssetMapper\Exception\RuntimeException;
 use Symfony\Component\AssetMapper\MappedAsset;
 
@@ -277,6 +278,31 @@ public static function provideMissingImportModeTests(): iterable
         ];
     }
 
+    public function testErrorMessageAvoidsCircularException()
+    {
+        $assetMapper = $this->createMock(AssetMapperInterface::class);
+        $assetMapper->expects($this->any())
+            ->method('getAsset')
+            ->willReturnCallback(function ($logicalPath) {
+                if ('htmx' === $logicalPath) {
+                    return null;
+                }
+
+                if ('htmx.js' === $logicalPath) {
+                    throw new CircularAssetsException();
+                }
+            });
+
+        $asset = new MappedAsset('htmx.js', '/path/to/app.js');
+        $compiler = new JavaScriptImportPathCompiler();
+        $content = '//** @type {import("./htmx").HtmxApi} */';
+        $compiled = $compiler->compile($content, $asset, $assetMapper);
+        // To form a good exception message, the compiler will check for the
+        // htmx.js asset, which will throw a CircularAssetsException. This
+        // should not be caught.
+        $this->assertSame($content, $compiled);
+    }
+
     private function createAssetMapper(): AssetMapperInterface
     {
         $assetMapper = $this->createMock(AssetMapperInterface::class);

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\AssetMapper\Factory;`
`13`	`13`
`14`	`14`	`use Symfony\Component\AssetMapper\AssetMapperCompiler;`
	`15`	`+use Symfony\Component\AssetMapper\Exception\CircularAssetsException;`
`15`	`16`	`use Symfony\Component\AssetMapper\Exception\RuntimeException;`
`16`	`17`	`use Symfony\Component\AssetMapper\MappedAsset;`
`17`	`18`	`use Symfony\Component\AssetMapper\Path\PublicAssetsPathResolverInterface;`
`@@ -36,7 +37,7 @@ public function __construct(`
`36`	`37`	`public function createMappedAsset(string $logicalPath, string $sourcePath): ?MappedAsset`
`37`	`38`	`{`
`38`	`39`	`if (\in_array($logicalPath, $this->assetsBeingCreated, true)) {`
`39`		`- throw new RuntimeException(sprintf('Circular reference detected while creating asset for "%s": "%s".', $logicalPath, implode(' -> ', $this->assetsBeingCreated).' -> '.$logicalPath));`
	`40`	`+ throw new CircularAssetsException(sprintf('Circular reference detected while creating asset for "%s": "%s".', $logicalPath, implode(' -> ', $this->assetsBeingCreated).' -> '.$logicalPath));`
`40`	`41`	`}`
`41`	`42`
`42`	`43`	`if (!isset($this->assetsCache[$logicalPath])) {`