[Asset] [DX] Option to make asset manifests strict on missing item #38495

GromNaN · 2020-10-09T08:01:18Z

Q	A
Branch?	5.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	-
License	MIT
Doc PR	symfony/symfony-docs#14414

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 option strict_mode: true, an exception is thrown when we try to use an asset that is not listed in manifest.json. Thereby we don't have to check that asset urls are actually working in tests (manual or automated).

Usage:
The option strict_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.yaml

framework:
    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 manifest
                strict_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 ?~~

src/Symfony/Component/Asset/VersionStrategy/RemoteJsonManifestVersionStrategy.php

weaverryan

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

weaverryan · 2020-10-15T13:07:52Z

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

            ])

        ->set('assets.remote_json_manifest_version_strategy', RemoteJsonManifestVersionStrategy::class)
            ->abstract()
            ->args([
                abstract_arg('manifest url'),
                service('http_client'),
+                false,


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

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

Is it something I must change ?

src/Symfony/Component/Asset/VersionStrategy/JsonManifestVersionStrategy.php

src/Symfony/Component/Asset/Exception/RuntimeException.php

src/Symfony/Component/Asset/VersionStrategy/JsonManifestVersionStrategy.php

src/Symfony/Component/Asset/VersionStrategy/RemoteJsonManifestVersionStrategy.php

GromNaN · 2021-01-30T22:41:19Z

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

src/Symfony/Component/Asset/Exception/AssetNotFoundException.php

src/Symfony/Component/Asset/Tests/VersionStrategy/JsonManifestVersionStrategyTest.php

nicolas-grekas · 2021-02-16T17:19:54Z

(small rebase needed)

GromNaN · 2021-02-17T10:00:10Z

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

GromNaN · 2021-04-26T16:56:30Z

Rebased again.

javiereguiluz

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

fabpot · 2021-07-25T15:25:42Z

Thank you @GromNaN.

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

carsonbot added Status: Needs Review Asset Feature labels Oct 9, 2020

GromNaN force-pushed the assets-strict branch from 2a7296a to 47e4487 Compare October 9, 2020 08:03

stof reviewed Oct 9, 2020

View reviewed changes

src/Symfony/Component/Asset/VersionStrategy/RemoteJsonManifestVersionStrategy.php Outdated Show resolved Hide resolved

nicolas-grekas added this to the 5.x milestone Oct 12, 2020

GromNaN force-pushed the assets-strict branch from c75560b to 92d5fde Compare October 14, 2020 20:01

GromNaN mentioned this pull request Oct 14, 2020

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

Merged

GromNaN marked this pull request as ready for review October 14, 2020 20:39

GromNaN requested a review from stof 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 debug symfony/demo#1168

Closed

weaverryan reviewed Oct 15, 2020

View reviewed changes

src/Symfony/Component/Asset/VersionStrategy/JsonManifestVersionStrategy.php Outdated Show resolved Hide resolved

GromNaN force-pushed the assets-strict branch 2 times, most recently from 7d60341 to abeb56c Compare October 16, 2020 07:46

OskarStark reviewed Oct 24, 2020

View reviewed changes

GromNaN force-pushed the assets-strict branch from abeb56c to ed5d943 Compare October 26, 2020 22:22

This comment has been minimized.

Sign in to view

GromNaN force-pushed the assets-strict branch 2 times, most recently from ed7d12f to e76aea7 Compare January 30, 2021 22:38

GromNaN requested a review from weaverryan January 30, 2021 22:39

OskarStark reviewed Jan 31, 2021

View reviewed changes

src/Symfony/Component/Asset/Exception/AssetNotFoundException.php Outdated Show resolved Hide resolved

src/Symfony/Component/Asset/Tests/VersionStrategy/JsonManifestVersionStrategyTest.php Outdated Show resolved Hide resolved

GromNaN force-pushed the assets-strict branch from e76aea7 to e84046e Compare February 1, 2021 09:15

GromNaN requested a review from OskarStark 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

GromNaN force-pushed the assets-strict branch from e84046e to 90d903f Compare February 17, 2021 09:58

GromNaN force-pushed the assets-strict branch from 90d903f to 0054d5d Compare April 26, 2021 16:18

GromNaN force-pushed the assets-strict branch from 0054d5d to 39b825b Compare April 26, 2021 19:02

javiereguiluz approved these changes May 26, 2021

View reviewed changes

fabpot approved these changes Jul 25, 2021

View reviewed changes

Option to make asset manifests strict on missing item

4cdb921

fabpot force-pushed the assets-strict branch from 39b825b to 4cdb921 Compare July 25, 2021 15:25

fabpot merged commit 7e28580 into symfony: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 referenced Nov 5, 2021

Release v5.4.0-BETA1 #43937

Merged

Release v6.0.0-BETA1 #43939

Merged

nicolas-grekas mentioned this pull request Jun 15, 2022

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

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Asset] [DX] Option to make asset manifests strict on missing item #38495

[Asset] [DX] Option to make asset manifests strict on missing item #38495

GromNaN commented Oct 9, 2020 •

edited

Loading

weaverryan left a comment

weaverryan Oct 15, 2020

GromNaN Oct 15, 2020 •

edited

Loading

GromNaN May 27, 2021 •

edited

Loading

This comment has been minimized.

GromNaN commented Jan 30, 2021

nicolas-grekas commented Feb 16, 2021

GromNaN commented Feb 17, 2021

GromNaN commented Apr 26, 2021

javiereguiluz left a comment

fabpot commented Jul 25, 2021

[Asset] [DX] Option to make asset manifests strict on missing item #38495

[Asset] [DX] Option to make asset manifests strict on missing item #38495

Conversation

GromNaN commented Oct 9, 2020 • edited Loading

weaverryan left a comment

Choose a reason for hiding this comment

weaverryan Oct 15, 2020

Choose a reason for hiding this comment

GromNaN Oct 15, 2020 • edited Loading

Choose a reason for hiding this comment

GromNaN May 27, 2021 • edited Loading

Choose a reason for hiding this comment

This comment has been minimized.

GromNaN commented Jan 30, 2021

nicolas-grekas commented Feb 16, 2021

GromNaN commented Feb 17, 2021

GromNaN commented Apr 26, 2021

javiereguiluz left a comment

Choose a reason for hiding this comment

fabpot commented Jul 25, 2021

GromNaN commented Oct 9, 2020 •

edited

Loading

GromNaN Oct 15, 2020 •

edited

Loading

GromNaN May 27, 2021 •

edited

Loading