bug #53701 [AssetMapper] Fix exception if assets directory is missing in production (rynhndrcksn)

nicolas-grekas · nicolas-grekas · commit 30a02c4936ea · 2024-02-01T09:31:40.000+01:00
This PR was merged into the 6.4 branch. Discussion ---------- [AssetMapper] Fix exception if assets directory is missing in production | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #53669 | License | MIT During deployment some people will compile their assets with Asset Mapper then delete the root `assets/` directory. This causes Asset Mapper to throw an exception, and a common work around people mentioned in the issue is to create an empty `assets/` directory. This PR makes it so the exception is only thrown while `kernel.debug` is equal to true, letting developers know locally that there's an issue, but allowing people to safely do this in their `production` environments. Commits ------- 962a044 Fix exception if assets dir is missing in prod
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/asset_mapper.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/asset_mapper.php
@@ -75,6 +75,7 @@
                 param('kernel.project_dir'),
                 abstract_arg('array of excluded path patterns'),
                 abstract_arg('exclude dot files'),
+                param('kernel.debug'),
             ])
 
         ->set('asset_mapper.public_assets_path_resolver', PublicAssetsPathResolver::class)
diff --git a/src/Symfony/Component/AssetMapper/AssetMapperRepository.php b/src/Symfony/Component/AssetMapper/AssetMapperRepository.php
@@ -34,6 +34,7 @@ public function __construct(
         private readonly string $projectRootDir,
         private readonly array $excludedPathPatterns = [],
         private readonly bool $excludeDotFiles = true,
+        private readonly bool $debug = false
     ) {
     }
 
@@ -147,7 +148,7 @@ private function getDirectories(): array
         $this->absolutePaths = [];
         foreach ($this->paths as $path => $namespace) {
             if ($filesystem->isAbsolutePath($path)) {
-                if (!file_exists($path)) {
+                if (!file_exists($path) && $this->debug) {
                     throw new \InvalidArgumentException(sprintf('The asset mapper directory "%s" does not exist.', $path));
                 }
                 $this->absolutePaths[realpath($path)] = $namespace;
@@ -161,7 +162,9 @@ private function getDirectories(): array
                 continue;
             }
 
-            throw new \InvalidArgumentException(sprintf('The asset mapper directory "%s" does not exist.', $path));
+            if ($this->debug) {
+                throw new \InvalidArgumentException(sprintf('The asset mapper directory "%s" does not exist.', $path));
+            }
         }
 
         return $this->absolutePaths;

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ public function __construct(`
`34`	`34`	`private readonly string $projectRootDir,`
`35`	`35`	`private readonly array $excludedPathPatterns = [],`
`36`	`36`	`private readonly bool $excludeDotFiles = true,`
	`37`	`+ private readonly bool $debug = false`
`37`	`38`	`) {`
`38`	`39`	`}`
`39`	`40`
`@@ -147,7 +148,7 @@ private function getDirectories(): array`
`147`	`148`	`$this->absolutePaths = [];`
`148`	`149`	`foreach ($this->paths as $path => $namespace) {`
`149`	`150`	`if ($filesystem->isAbsolutePath($path)) {`
`150`		`- if (!file_exists($path)) {`
	`151`	`+ if (!file_exists($path) && $this->debug) {`
`151`	`152`	`throw new \InvalidArgumentException(sprintf('The asset mapper directory "%s" does not exist.', $path));`
`152`	`153`	`}`
`153`	`154`	`$this->absolutePaths[realpath($path)] = $namespace;`
`@@ -161,7 +162,9 @@ private function getDirectories(): array`
`161`	`162`	`continue;`
`162`	`163`	`}`
`163`	`164`
`164`		`- throw new \InvalidArgumentException(sprintf('The asset mapper directory "%s" does not exist.', $path));`
	`165`	`+ if ($this->debug) {`
	`166`	`+ throw new \InvalidArgumentException(sprintf('The asset mapper directory "%s" does not exist.', $path));`
	`167`	`+ }`
`165`	`168`	`}`
`166`	`169`
`167`	`170`	`return $this->absolutePaths;`