diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[FrameworkBundle] Add support for doctrine/annotations:1.13 || 2.0

Browse Source
This commit is contained in:
Nyholm 2021-03-01 21:47:33 +01:00 committed by Robin Chalas
parent 252f85c2c2
commit 91e844b517
6 changed files with 85 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
View File

@ -14,6 +14,8 @@ CHANGELOG
* Added `assertResponseFormatSame()` in `BrowserKitAssertionsTrait`
* Add support for configuring UUID factory services
* Add tag `assets.package` to register asset packages
* Add support to use a PSR-6 compatible cache for Doctrine annotations
* Deprecate all other values than "none", "php_array" and "file" for `framework.annotation.cache`
5.2.0
-----

6
src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
View File

@ -12,6 +12,7 @@
namespace Symfony\Bundle\FrameworkBundle\DependencyInjection;
use Doctrine\Common\Annotations\Annotation;
use Doctrine\Common\Annotations\PsrCachedReader;
use Doctrine\Common\Cache\Cache;
use Doctrine\DBAL\Connection;
use Symfony\Bundle\FullStack;
@ -921,13 +922,16 @@ class Configuration implements ConfigurationInterface
private function addAnnotationsSection(ArrayNodeDefinition $rootNode, callable $willBeAvailable)
{
$doctrineCache = $willBeAvailable('doctrine/cache', Cache::class, 'doctrine/annotation');
$psr6Cache = $willBeAvailable('symfony/cache', PsrCachedReader::class, 'doctrine/annotation');
$rootNode
->children()
->arrayNode('annotations')
->info('annotation configuration')
->{$willBeAvailable('doctrine/annotations', Annotation::class) ? 'canBeDisabled' : 'canBeEnabled'}()
->children()
->scalarNode('cache')->defaultValue($willBeAvailable('doctrine/cache', Cache::class, 'doctrine/annotation') ? 'php_array' : 'none')->end()
->scalarNode('cache')->defaultValue(($doctrineCache || $psr6Cache) ? 'php_array' : 'none')->end()
->scalarNode('file_cache_dir')->defaultValue('%kernel.cache_dir%/annotations')->end()
->booleanNode('debug')->defaultValue($this->debug)->end()
->end()

48
src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
View File

@ -1481,12 +1481,49 @@ class FrameworkExtension extends Extension
->setMethodCalls([['registerLoader', ['class_exists']]]);
}
if ('none' !== $config['cache']) {
if (!class_exists(\Doctrine\Common\Cache\CacheProvider::class)) {
throw new LogicException('Annotations cannot be cached as the Doctrine Cache library is not installed. Try running "composer require doctrine/cache".');
if ('none' === $config['cache']) {
$container->removeDefinition('annotations.cached_reader');
$container->removeDefinition('annotations.psr_cached_reader');
return;
}
$cacheService = $config['cache'];
if (\in_array($config['cache'], ['php_array', 'file'])) {
$isPsr6Service = $container->hasDefinition('annotations.psr_cached_reader');
} else {
$isPsr6Service = false;
trigger_deprecation('symfony/framework-bundle', '5.3', 'Using a custom service for "framework.annotation.cache" is deprecated, only values "none", "php_array" and "file" are valid in version 6.0.');
}
if ($isPsr6Service) {
$container->removeDefinition('annotations.cached_reader');
$container->setDefinition('annotations.cached_reader', $container->getDefinition('annotations.psr_cached_reader'));
if ('php_array' === $config['cache']) {
$cacheService = 'annotations.psr_cache';
// Enable warmer only if PHP array is used for cache
$definition = $container->findDefinition('annotations.cache_warmer');
$definition->addTag('kernel.cache_warmer');
} elseif ('file' === $config['cache']) {
$cacheService = 'annotations.filesystem_cache_adapter';
$cacheDir = $container->getParameterBag()->resolveValue($config['file_cache_dir']);
if (!is_dir($cacheDir) && false === @mkdir($cacheDir, 0777, true) && !is_dir($cacheDir)) {
throw new \RuntimeException(sprintf('Could not create cache directory "%s".', $cacheDir));
}
$container
->getDefinition('annotations.filesystem_cache_adapter')
->replaceArgument(2, $cacheDir)
;
}
} else {
// Legacy code for doctrine/annotations:<1.13
if (!class_exists(\Doctrine\Common\Cache\CacheProvider::class)) {
throw new LogicException('Annotations cannot be cached as the Doctrine Cache library is not installed. Try running "composer require doctrine/cache".');
}
if ('php_array' === $config['cache']) {
$cacheService = 'annotations.cache';
@ -1508,6 +1545,7 @@ class FrameworkExtension extends Extension
$cacheService = 'annotations.filesystem_cache';
}
}
$container
->getDefinition('annotations.cached_reader')
@ -1519,9 +1557,7 @@ class FrameworkExtension extends Extension
$container->setAlias('annotation_reader', 'annotations.cached_reader');
$container->setAlias(Reader::class, new Alias('annotations.cached_reader', false));
} else {
$container->removeDefinition('annotations.cached_reader');
}
$container->removeDefinition('annotations.psr_cached_reader');
}
private function registerPropertyAccessConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader)

21
src/Symfony/Bundle/FrameworkBundle/Resources/config/annotations.php
View File

@ -14,6 +14,7 @@ namespace Symfony\Component\DependencyInjection\Loader\Configurator;
use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Annotations\AnnotationRegistry;
use Doctrine\Common\Annotations\CachedReader;
use Doctrine\Common\Annotations\PsrCachedReader;
use Doctrine\Common\Annotations\Reader;
use Symfony\Bundle\FrameworkBundle\CacheWarmer\AnnotationsCacheWarmer;
use Symfony\Component\Cache\Adapter\ArrayAdapter;
@ -36,7 +37,7 @@ return static function (ContainerConfigurator $container) {
->args([
service('annotations.reader'),
inline_service(DoctrineProvider::class)->args([
inline_service(ArrayAdapter::class)
inline_service(ArrayAdapter::class),
]),
abstract_arg('Debug-Flag'),
])
@ -74,4 +75,22 @@ return static function (ContainerConfigurator $container) {
->alias('annotation_reader', 'annotations.reader')
->alias(Reader::class, 'annotation_reader');
if (class_exists(PsrCachedReader::class)) {
$container->services()
->set('annotations.psr_cached_reader', PsrCachedReader::class)
->args([
service('annotations.reader'),
inline_service(ArrayAdapter::class),
abstract_arg('Debug-Flag'),
])
->set('annotations.psr_cache', PhpArrayAdapter::class)
->factory([PhpArrayAdapter::class, 'create'])
->args([
param('kernel.cache_dir').'/annotations.php',
service('cache.annotations'),
])
->tag('container.hot_path')
;
}
};

7
src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
View File

@ -12,6 +12,7 @@
namespace Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection;
use Doctrine\Common\Annotations\Annotation;
use Doctrine\Common\Annotations\PsrCachedReader;
use Psr\Cache\CacheItemPoolInterface;
use Psr\Log\LoggerAwareInterface;
use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
@ -578,7 +579,7 @@ abstract class FrameworkExtensionTest extends TestCase
$expected = ['session', 'initialized_session', 'logger', 'session_collector'];
$this->assertEquals($expected, array_keys($container->getDefinition('session_listener')->getArgument(0)->getValues()));
$this->assertSame(false, $container->getDefinition('session.storage.factory.native')->getArgument(3));
$this->assertFalse($container->getDefinition('session.storage.factory.native')->getArgument(3));
}
/**
@ -597,7 +598,7 @@ abstract class FrameworkExtensionTest extends TestCase
$expected = ['session', 'initialized_session', 'logger', 'session_collector'];
$this->assertEquals($expected, array_keys($container->getDefinition('session_listener')->getArgument(0)->getValues()));
$this->assertSame(false, $container->getDefinition('session.storage.factory.native')->getArgument(3));
$this->assertFalse($container->getDefinition('session.storage.factory.native')->getArgument(3));
}
public function testRequest()
@ -980,7 +981,7 @@ abstract class FrameworkExtensionTest extends TestCase
$container->compile();
$this->assertEquals($container->getParameter('kernel.cache_dir').'/annotations', $container->getDefinition('annotations.filesystem_cache_adapter')->getArgument(2));
$this->assertSame('annotations.filesystem_cache', (string) $container->getDefinition('annotation_reader')->getArgument(1));
$this->assertSame(class_exists(PsrCachedReader::class) ? 'annotations.filesystem_cache_adapter' : 'annotations.filesystem_cache', (string) $container->getDefinition('annotation_reader')->getArgument(1));
}
public function testFileLinkFormat()

3
src/Symfony/Bundle/FrameworkBundle/Tests/Functional/AutowiringTypesTest.php
View File

@ -13,6 +13,7 @@ namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Annotations\CachedReader;
use Doctrine\Common\Annotations\PsrCachedReader;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\HttpKernel\Debug\TraceableEventDispatcher;
@ -33,7 +34,7 @@ class AutowiringTypesTest extends AbstractWebTestCase
static::bootKernel();
$annotationReader = static::$container->get('test.autowiring_types.autowired_services')->getAnnotationReader();
$this->assertInstanceOf(CachedReader::class, $annotationReader);
$this->assertInstanceOf(class_exists(PsrCachedReader::class) ? PsrCachedReader::class : CachedReader::class, $annotationReader);
}
public function testEventDispatcherAutowiring()