[Serializer] Need to clear cache when updating Annotation Groups on Entities #41961
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
src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
Outdated
Show resolved
Hide resolved
nicolas-grekas
approved these changes
Jul 3, 2021
fabpot
approved these changes
Jul 4, 2021
a79719b to
a6829be
Compare
|
Thank you @monteiro. |
Merged
nicolas-grekas
added a commit
that referenced
this pull request
Mar 31, 2023
… disabled (bastnic)
This PR was merged into the 5.4 branch.
Discussion
----------
[FrameworkBundle] enable metadata cache when annotation is disabled
| Q | A
| ------------- | ---
| Branch? | 5.4
| Bug fix? | yes
| New feature? | no
| Deprecations? | no
| Tickets | Fix #... <!-- prefix each issue number with "Fix #", no need to create an issue if none exists, explain below instead -->
| License | MIT
| Doc PR | symfony/symfony-docs#... <!-- required for new features -->
When using Annotations, annotations are cached at `AnnotationLoader` level.
Which is cleared when entities are changed. So the dev experience is optimal.
```
[ClassMetadataFactory.php](vendor/symfony/serializer/Mapping/Factory/ClassMetadataFactory.php") on line 51:
[Symfony\Component\Serializer\Mapping\Loader\LoaderChain](vendor/symfony/serializer/Mapping/Loader/LoaderChain.php&line=28#line28) {#543 ▼
-loaders: array:1 [▼
0 => [Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader](vendor/symfony/serializer/Mapping/Loader/AnnotationLoader.php&line=33#line33) {#544 ▼
-reader: [Doctrine\Common\Annotations\PsrCachedReader](vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/PsrCachedReader.php&line=22#line22) {#262 ▼
-delegate: [Doctrine\Common\Annotations\AnnotationReader](vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/AnnotationReader.php&line=20#line20) {#263 ▶}
-cache: [Symfony\Component\Cache\Adapter\PhpArrayAdapter](vendor/symfony/cache/Adapter/PhpArrayAdapter.php&line=32#line32) {#277 ▶}
-debug: true
-loadedAnnotations: array:14 [▶]
-loadedFilemtimes: array:4 [▶]
}
}
]
}
```
When using yaml files, there is no cache at the loader level so I added in the past the same cache as for the prod env, as the metadata are effectively cleared when using only yaml config files.
#35109
The regression introduced by my patch is for people that do not use mapping files but use annotations.
#41961
But now, we are in the opposite situation: no cache for people using mapping files but not annotations.
On a current project it means loading 83 yaml files for each dev requests. It's not good at all.
A simple local fix is to add that in a dev services files.
```yaml
serializer.mapping.cache_class_metadata_factory:
class: 'Symfony\Component\Serializer\Mapping\Factory\CacheClassMetadataFactory'
decorates: 'serializer.mapping.class_metadata_factory'
arguments: ['`@serializer`.mapping.cache_class_metadata_factory.inner', '`@serializer`.mapping.cache.symfony']
```
A solution in Symfony could be:
1/ only yaml/xml mapping files (`enable_annotations: false`) : cache like prod => that what I did in this PR, as it fixes the current perf regressions on my different projects. There is no cache on yaml/xml file as soon as annotation is enabled (which is the default)
2/ add a cache at reader level for yaml/xml loader
3/ add a cache cleaner at metadata level when annotation are enabled
Commits
-------
1773dff [FrameworkBundle] enable metadata cache when annotation is disabled
symfony-splitter
pushed a commit
to symfony/framework-bundle
that referenced
this pull request
Mar 31, 2023
… disabled (bastnic)
This PR was merged into the 5.4 branch.
Discussion
----------
[FrameworkBundle] enable metadata cache when annotation is disabled
| Q | A
| ------------- | ---
| Branch? | 5.4
| Bug fix? | yes
| New feature? | no
| Deprecations? | no
| Tickets | Fix #... <!-- prefix each issue number with "Fix #", no need to create an issue if none exists, explain below instead -->
| License | MIT
| Doc PR | symfony/symfony-docs#... <!-- required for new features -->
When using Annotations, annotations are cached at `AnnotationLoader` level.
Which is cleared when entities are changed. So the dev experience is optimal.
```
[ClassMetadataFactory.php](vendor/symfony/serializer/Mapping/Factory/ClassMetadataFactory.php") on line 51:
[Symfony\Component\Serializer\Mapping\Loader\LoaderChain](vendor/symfony/serializer/Mapping/Loader/LoaderChain.php&line=28#line28) {#543 ▼
-loaders: array:1 [▼
0 => [Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader](vendor/symfony/serializer/Mapping/Loader/AnnotationLoader.php&line=33#line33) {#544 ▼
-reader: [Doctrine\Common\Annotations\PsrCachedReader](vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/PsrCachedReader.php&line=22#line22) {#262 ▼
-delegate: [Doctrine\Common\Annotations\AnnotationReader](vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/AnnotationReader.php&line=20#line20) {#263 ▶}
-cache: [Symfony\Component\Cache\Adapter\PhpArrayAdapter](vendor/symfony/cache/Adapter/PhpArrayAdapter.php&line=32#line32) {#277 ▶}
-debug: true
-loadedAnnotations: array:14 [▶]
-loadedFilemtimes: array:4 [▶]
}
}
]
}
```
When using yaml files, there is no cache at the loader level so I added in the past the same cache as for the prod env, as the metadata are effectively cleared when using only yaml config files.
symfony/symfony#35109
The regression introduced by my patch is for people that do not use mapping files but use annotations.
symfony/symfony#41961
But now, we are in the opposite situation: no cache for people using mapping files but not annotations.
On a current project it means loading 83 yaml files for each dev requests. It's not good at all.
A simple local fix is to add that in a dev services files.
```yaml
serializer.mapping.cache_class_metadata_factory:
class: 'Symfony\Component\Serializer\Mapping\Factory\CacheClassMetadataFactory'
decorates: 'serializer.mapping.class_metadata_factory'
arguments: ['`@serializer`.mapping.cache_class_metadata_factory.inner', '`@serializer`.mapping.cache.symfony']
```
A solution in Symfony could be:
1/ only yaml/xml mapping files (`enable_annotations: false`) : cache like prod => that what I did in this PR, as it fixes the current perf regressions on my different projects. There is no cache on yaml/xml file as soon as annotation is enabled (which is the default)
2/ add a cache at reader level for yaml/xml loader
3/ add a cache cleaner at metadata level when annotation are enabled
Commits
-------
1773dff5ce [FrameworkBundle] enable metadata cache when annotation is disabled
symfony-splitter
pushed a commit
to symfony/framework-bundle
that referenced
this pull request
Jul 28, 2023
… disabled (bastnic)
This PR was merged into the 5.4 branch.
Discussion
----------
[FrameworkBundle] enable metadata cache when annotation is disabled
| Q | A
| ------------- | ---
| Branch? | 5.4
| Bug fix? | yes
| New feature? | no
| Deprecations? | no
| Tickets | Fix #... <!-- prefix each issue number with "Fix #", no need to create an issue if none exists, explain below instead -->
| License | MIT
| Doc PR | symfony/symfony-docs#... <!-- required for new features -->
When using Annotations, annotations are cached at `AnnotationLoader` level.
Which is cleared when entities are changed. So the dev experience is optimal.
```
[ClassMetadataFactory.php](vendor/symfony/serializer/Mapping/Factory/ClassMetadataFactory.php") on line 51:
[Symfony\Component\Serializer\Mapping\Loader\LoaderChain](vendor/symfony/serializer/Mapping/Loader/LoaderChain.php&line=28#line28) {#543 ▼
-loaders: array:1 [▼
0 => [Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader](vendor/symfony/serializer/Mapping/Loader/AnnotationLoader.php&line=33#line33) {#544 ▼
-reader: [Doctrine\Common\Annotations\PsrCachedReader](vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/PsrCachedReader.php&line=22#line22) {#262 ▼
-delegate: [Doctrine\Common\Annotations\AnnotationReader](vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/AnnotationReader.php&line=20#line20) {#263 ▶}
-cache: [Symfony\Component\Cache\Adapter\PhpArrayAdapter](vendor/symfony/cache/Adapter/PhpArrayAdapter.php&line=32#line32) {#277 ▶}
-debug: true
-loadedAnnotations: array:14 [▶]
-loadedFilemtimes: array:4 [▶]
}
}
]
}
```
When using yaml files, there is no cache at the loader level so I added in the past the same cache as for the prod env, as the metadata are effectively cleared when using only yaml config files.
symfony/symfony#35109
The regression introduced by my patch is for people that do not use mapping files but use annotations.
symfony/symfony#41961
But now, we are in the opposite situation: no cache for people using mapping files but not annotations.
On a current project it means loading 83 yaml files for each dev requests. It's not good at all.
A simple local fix is to add that in a dev services files.
```yaml
serializer.mapping.cache_class_metadata_factory:
class: 'Symfony\Component\Serializer\Mapping\Factory\CacheClassMetadataFactory'
decorates: 'serializer.mapping.class_metadata_factory'
arguments: ['`@serializer`.mapping.cache_class_metadata_factory.inner', '`@serializer`.mapping.cache.symfony']
```
A solution in Symfony could be:
1/ only yaml/xml mapping files (`enable_annotations: false`) : cache like prod => that what I did in this PR, as it fixes the current perf regressions on my different projects. There is no cache on yaml/xml file as soon as annotation is enabled (which is the default)
2/ add a cache at reader level for yaml/xml loader
3/ add a cache cleaner at metadata level when annotation are enabled
Commits
-------
1773dff5ce [FrameworkBundle] enable metadata cache when annotation is disabled
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.
Sample project that mimics this behavior: https://github.com/monteiro/PR-40856
The solution was suggested by @nicolas-grekas here.