During deployment some people will compile their assets with Asset Mapper then delete the rootassets/ directory. This causes Asset Mapper to throw an exception, and a common work around people mentioned in the issue is to create an emptyassets/ directory.

This PR makes it so the exception is only thrown whilekernel.debug is equal to true, letting developers know locally that there's an issue, but allowing people to safely do this in theirproduction environments.

carsonbot added Status: Needs Review AssetMapper Bug labels

Jan 31, 2024

carsonbot added this to the6.4 milestone

Jan 31, 2024

nicolas-grekas reviewed

Jan 31, 2024

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php OutdatedShow resolvedHide resolved

src/Symfony/Bundle/FrameworkBundle/Resources/config/asset_mapper.php OutdatedShow resolvedHide resolved

src/Symfony/Component/AssetMapper/AssetMapperRepository.php OutdatedShow resolvedHide resolved

src/Symfony/Component/AssetMapper/CHANGELOG.md OutdatedShow resolvedHide resolved

src/Symfony/Component/AssetMapper/AssetMapperRepository.php OutdatedShow resolvedHide resolved

Copy link

Member

smnandre commentedJan 31, 2024

With this PR, if someone runs the following command what would happen, exceptions would not be thrown if some directory is missing ?

APP_ENV=prod sf asset-map:compile

Fix exception if assets dir is missing in prod

962a044

rynhndrcksn force-pushed thefix-assetmapper-missing-assets-dir-exception branch from79e49d8 to962a044Compare

January 31, 2024 23:41

Copy link

ContributorAuthor

rynhndrcksn commentedFeb 1, 2024•
edited
Loading

@smnandre I've attached 2 screenshots of what happens when theAPP_ENV=prod symfony console asset-map:compile command is ran.

If theassets/ directory is in place, then this is the output (as expected):

APP_ENV=prod symfony console asset-map:compile being ran with an assets/ directory

If theassets/ directory is missing, then this is the output:

APP_ENV=prod symfony console asset-map:compile being ran with no assets/ directory

So during the deployment/asset compilation process people will still be notified if theassets/ directory is missing :)

Copy link

Member

smnandre commentedFeb 1, 2024

@smnandre I've attached 2 screenshots of what happens whenAPP_ENV=prod symfony console asset-map:compile command is ran.
So during the deployment/asset compilation process people will still be notified if theassets/ directory is missing :)

Perfect for me, thank you very much 👍

nicolas-grekas approved these changes

Feb 1, 2024

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels

Feb 1, 2024

Copy link

Member

nicolas-grekas commentedFeb 1, 2024

Thank you@rynhndrcksn.

nicolas-grekas merged commit30a02c4 intosymfony:6.4

Feb 1, 2024

nicolas-grekas reviewed

Feb 1, 2024

View reviewed changes

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

Copy link

Member

nicolas-grekasFeb 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I set this to true by default inaa469d9

Copy link

ContributorAuthor

rynhndrcksnFeb 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

When I did that locally while my project was set toprod mode, it causes Symfony to crash and return a 500 error.

Screenshot of a 500 internal server error

Is it possible thatparam('kernel.debug'), (link to line) isn't passing infalse when the site is inprod mode, makingAssetMapperRepository.php default to true, making it so the$this->debug checks succeed while the site is inprod mode?

Copy link

Member

stofFeb 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

you can still use the prod environment in debug mode if you want locally. The prod environmentdefaults to non-debug mode, but theAPP_DEBUG env variable still wins over this default.