[FrameworkBundle][Translation] Invalidate cached catalogues when the scanned directories change #34129
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…scanned directories change
859b50b to
6cbee09
Compare
fancyweb
commented
Oct 29, 2019
| @@ -86,7 +88,7 @@ class Translator implements LegacyTranslatorInterface, TranslatorInterface, Tran | |||
| /** | |||
| * @throws InvalidArgumentException If a locale contains invalid characters | |||
| */ | |||
| public function __construct(?string $locale, MessageFormatterInterface $formatter = null, string $cacheDir = null, bool $debug = false) | |||
| public function __construct(?string $locale, MessageFormatterInterface $formatter = null, string $cacheDir = null, bool $debug = false, array $cacheVary = []) | |||
There was a problem hiding this comment.
I was looking at this again an I'm not sure if we can add a new constructor arg on 4.3?
There was a problem hiding this comment.
As long as it's added with a default value at the end, I think yes.
There was a problem hiding this comment.
Although it would look like a new feature.
nicolas-grekas
approved these changes
Nov 5, 2019
fabpot
approved these changes
Nov 6, 2019
|
Thank you @fancyweb. |
fabpot
added a commit
that referenced
this pull request
Nov 6, 2019
…s when the scanned directories change (fancyweb) This PR was merged into the 4.3 branch. Discussion ---------- [FrameworkBundle][Translation] Invalidate cached catalogues when the scanned directories change | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | #33992 | License | MIT | Doc PR | - The cache file name needs to depend on the scanned directories list. Otherwise, when a new directory is added, even if the container is rebuilt and the `FWB Translator` gets the new scanned directories list, the cached catalogue name is still the same and is resolved accordingly. An alternative would be to make the `Translation Translator` `getCatalogueCachePath()` method and `fallbackLocales` `@internal` and `protected` to just override everything in the `FWB Translator`. The `cacheVary` argument has the benefit to be reusable by all the `Translation` component users. Note that there is a negative minor performance impact that increases when the list of scanned directories grows. Commits ------- 6cbee09 [FrameworkBundle][Translation] Invalidate cached catalogues when the scanned directories change
Merged
fabpot
added a commit
that referenced
this pull request
Nov 17, 2019
… vary scanned directories (fancyweb) This PR was merged into the 4.3 branch. Discussion ---------- [FrameworkBundle] Remove project dir from Translator cache vary scanned directories | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Closes #34395 | License | MIT | Doc PR | - Weird cases such as having different paths for directories found through reflection (cf https://github.com/symfony/symfony/blob/8522a88185a7e283ad342b3539cd088d76968df9/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php#L1105) or using different values on warmup and run for another parameter than `kernel.project_dir` are still unconvered. Unfortunately there is nothing we can do, do we care? If yes, then we might just wanna enable #34129 when the `debug` option is on. Commits ------- e75e01d [FrameworkBundle] Remove project dir from Translator cache vary scanned directories
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The cache file name needs to depend on the scanned directories list. Otherwise, when a new directory is added, even if the container is rebuilt and the
FWB Translatorgets the new scanned directories list, the cached catalogue name is still the same and is resolved accordingly.An alternative would be to make the
Translation TranslatorgetCatalogueCachePath()method andfallbackLocales@internalandprotectedto just override everything in theFWB Translator. ThecacheVaryargument has the benefit to be reusable by all theTranslationcomponent users.Note that there is a negative minor performance impact that increases when the list of scanned directories grows.