In all the projects I use a JSON manifest, when an asset is not listed in manifest.json, the asset file is not generated. The current behavior is permissive as it returns the unmodified path of the asset. Which ends with a 404 when the browser tries to load the asset.

With the optionstrict_mode: true, an exception is thrown when we try to use an asset that is not listed inmanifest.json. Thereby we don't have to check that asset urls are actually working in tests (manual or automated).

Usage:
The optionstrict_mode is optional for backward compatibility. Using the%kernel.debug% value is safe to flush bugs on dev or test mode but keep the application working on production.

# config/packages/assets.yamlframework:assets:packages:app:# Uses a JSON manifest (can be a local path or an url remote file)json_manifest_path:'%kernel.project_dir%/public/build/manifest.json'# Throws an exception when an expected entry is missing in the manifeststrict_mode:'%kernel.debug%'

Todo:

Documentation[Asset] Add option $strictMode to JsonManifestVersionStrategy symfony-docs#14414
Demo[5.2] Strict manifest.json on debug demo#1168
~~Update recipe ?~~

carsonbot added Status: Needs Review Asset Feature labels

Oct 9, 2020

GromNaN force-pushed theassets-strict branch from2a7296a to47e4487Compare

October 9, 2020 08:03

stof reviewed

Oct 9, 2020

View reviewed changes

src/Symfony/Component/Asset/VersionStrategy/RemoteJsonManifestVersionStrategy.php OutdatedShow resolvedHide resolved

nicolas-grekas added this to the5.x milestone

Oct 12, 2020

GromNaN force-pushed theassets-strict branch fromc75560b to92d5fdeCompare

October 14, 2020 20:01

GromNaN mentioned this pull request

Oct 14, 2020

[Asset] Add option $strictMode to JsonManifestVersionStrategysymfony/symfony-docs#14414

Merged

GromNaN marked this pull request as ready for review

October 14, 2020 20:39

GromNaN requested a review fromstof

October 14, 2020 20:39

GromNaN changed the title~~[Asset] Option to make asset manifests strict on missing item~~[DX][Asset] Option to make asset manifests strict on missing item

Oct 15, 2020

GromNaN mentioned this pull request

Oct 15, 2020

[5.2] Strict manifest.json on debugsymfony/demo#1168

Closed

weaverryan reviewed

Oct 15, 2020

View reviewed changes

Copy link

Member

weaverryan left a comment

Choose a reason for hiding this comment

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

I like it! WebpackEncoreBundle has had this option for a long time - called strict_mode - for an entry that doesn’t appear in entrypoints.json

src/Symfony/Bundle/FrameworkBundle/Resources/config/assets.php Outdated

		->args([
		abstract_arg('manifest url'),
		service('http_client'),
		false,

Copy link

Member

weaverryanOct 15, 2020

Choose a reason for hiding this comment

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

I think these should both be abstract args - as we fill both in always

Copy link

MemberAuthor

GromNaNOct 15, 2020•
edited
Loading

Choose a reason for hiding this comment

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

I used a fixed value to prevent breaking compatibility in the eventuality someone extends this abstract definition.

Copy link

MemberAuthor

GromNaNMay 27, 2021•
edited
Loading

Choose a reason for hiding this comment

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

Is it something I must change ?

src/Symfony/Component/Asset/VersionStrategy/JsonManifestVersionStrategy.php OutdatedShow resolvedHide resolved

weaverryan reviewed

Oct 15, 2020

View reviewed changes

src/Symfony/Component/Asset/VersionStrategy/JsonManifestVersionStrategy.php OutdatedShow resolvedHide resolved

GromNaN force-pushed theassets-strict branch 2 times, most recently from7d60341 toabeb56cCompare

October 16, 2020 07:46

OskarStark reviewed

Oct 24, 2020

View reviewed changes

src/Symfony/Component/Asset/Exception/RuntimeException.php OutdatedShow resolvedHide resolved

src/Symfony/Component/Asset/VersionStrategy/JsonManifestVersionStrategy.php OutdatedShow resolvedHide resolved

src/Symfony/Component/Asset/VersionStrategy/RemoteJsonManifestVersionStrategy.php OutdatedShow resolvedHide resolved

GromNaN force-pushed theassets-strict branch fromabeb56c toed5d943Compare

October 26, 2020 22:22

This comment has been minimized.

GromNaN force-pushed theassets-strict branch 2 times, most recently fromed7d12f toe76aea7Compare

January 30, 2021 22:38

GromNaN requested a review fromweaverryan

January 30, 2021 22:39

Copy link

MemberAuthor

GromNaN commentedJan 30, 2021

Thanks to the refactoring done by@jderusse in#39484, this PR has been simplified.

OskarStark reviewed

Jan 31, 2021

View reviewed changes

src/Symfony/Component/Asset/Exception/AssetNotFoundException.php OutdatedShow resolvedHide resolved

src/Symfony/Component/Asset/Tests/VersionStrategy/JsonManifestVersionStrategyTest.php OutdatedShow resolvedHide resolved

GromNaN force-pushed theassets-strict branch frome76aea7 toe84046eCompare

February 1, 2021 09:15

GromNaN requested a review fromOskarStark

February 1, 2021 09:18

maxhelias approved these changes

Feb 16, 2021

View reviewed changes

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

Feb 16, 2021

carsonbot changed the title~~[DX][Asset] Option to make asset manifests strict on missing item~~[Asset] [DX] Option to make asset manifests strict on missing item

Feb 16, 2021

Copy link

Member

nicolas-grekas commentedFeb 16, 2021

(small rebase needed)

GromNaN force-pushed theassets-strict branch frome84046e to90d903fCompare

February 17, 2021 09:58

Copy link

MemberAuthor

GromNaN commentedFeb 17, 2021

Rebased. The CS fix suggested by fabbot are not related to this PR.

GromNaN force-pushed theassets-strict branch from90d903f to0054d5dCompare

April 26, 2021 16:18

Copy link

MemberAuthor

GromNaN commentedApr 26, 2021

Rebased again.

GromNaN force-pushed theassets-strict branch from0054d5d to39b825bCompare

April 26, 2021 19:02

javiereguiluz approved these changes

May 26, 2021

View reviewed changes

Copy link

Member

javiereguiluz left a comment

Choose a reason for hiding this comment

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

Nice proposal! Jérôme, thanks for contributing this feature. I hope it's merged 👍

fabpot approved these changes

Jul 25, 2021

View reviewed changes

Option to make asset manifests strict on missing item

4cdb921

fabpot force-pushed theassets-strict branch from39b825b to4cdb921Compare

July 25, 2021 15:25

Copy link

Member

fabpot commentedJul 25, 2021

Thank you@GromNaN.

fabpot merged commit7e28580 intosymfony:5.4

Jul 25, 2021

GromNaN deleted the assets-strict branch

October 14, 2021 19:04

GromNaN mentioned this pull request

Oct 14, 2021

[Framework][Assets] Set assets manifest strict by default on debug#43517

Closed

This was referencedNov 5, 2021

Release v5.4.0-BETA1#43937

Merged

Release v6.0.0-BETA1#43939

Merged

javiereguiluz added a commit to symfony/symfony-docs that referenced this pull request

Dec 13, 2021

minor#14414[Asset] Add option $strictMode to JsonManifestVersionStr…

dd89fe0

…ategy (GromNaN)This PR was merged into the 5.4 branch.Discussion----------[Asset] Add option $strictMode to JsonManifestVersionStrategyDocumentation forsymfony/symfony#38495Commits-------c4e19eb [Assets] Add doc for strict mode strategy

nicolas-grekas mentioned this pull request

Jun 15, 2022

[Asset] Ignore missing manifest.json files in non-strict mode#46689

Closed