[TwigBundle][FrameworkBundle] Fixed that Twig cache warmer is not being added as cache warmer #15034
Conversation
…ng added as cache warmer PassConfig::TYPE_OPTIMIZE argument added to 'addCompilerPass' method call when adding the AddCacheWarmerPass to the container
|
Can you add a test to avoid any future regression? |
…ng added as cache warmer Test added to avoid any future regression
4af0aac to
19e8c29
Compare
|
@fabpot Just added a test to avoid any future regression. I doubted a little bit about where I should add this test, because the fix is applied on the |
…ng added as cache warmer * Removed the previous committed TemplateCacheCacheWarmerTest from the TwigBundle * Added a generic CacheWarmerTest to the FrameworkBundle
|
After investigating what causes the Travis CI build to fail I realized that the test I added is never going to pass when the I hope I did everything as it should be. If not, please comment! :-) |
|
there is an issue. This compiler pass should still run before the optimization passes, otherwise it could break optimizations (if you have circular references between your cache warmer and the CacheWarmerAggregate, they won't be detected anymore for instance because the circular reference will be created only after the validation. and there might be other broken cases). So -1 for the current patch. IMO, what is needed is a way to set a priority between all compiler passes running before optimizations (because almost every compiler pass provided by bundles must actually run before optimizing the container) |
|
What would actually happen when added the |
| { | ||
| return true; | ||
| } | ||
| } |
|
Closing for the reasons explained by @stof |
This PR was merged into the 2.7 branch. Discussion ---------- [TwigBundle] Fix Twig cache is not properly warmed | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #15982 | License | MIT | Doc PR | - Alternative to #15034 Commits ------- e704ee4 [TwigBundle] Fix Twig cache is not properly warmed
Description
Since version 2.7 the Twig cache warmer is not being triggered during a
app/console cache:warmup. The bug is introduced with commit 0d537c4 where the tagkernel.cache_warmeris removed from the service definitiontwig.cache_warmerand is added dynamically by theExtensionPass.The problem lies in the fact that the
AddCacheWarmerPassof theFrameworkBundlehas already been processed on the moment theExtensionPassadds the tag to thetwig.cache_warmerservice. Therefore thetwig.cache_warmeris not being picked up by theAddCacheWarmerPassand will not be used during anapp/console cache:warmup.To verify my hypothesis I made a small change in
AppKerneland placedTwigBundleaboveFrameworkBundle, to force a different processing order of compiler passes and that fixed the problem.Steps to reproduce
symfony new testapp/console cache:warmupNotice that the directory
app/cache/dev/twigdoesn't exists.Solution
My suggested fix is small but effective and consists of adding the argument
PassConfig::TYPE_OPTIMIZEto theaddCompilerPassmethod call when adding theAddCacheWarmerPassto the container. This ensures that other bundles were able to add tags to there service definitions, regarding cache warmers, before theAddCacheWarmerPassis being called.