Skip to content

[Cache] Fix CacheCollectorPass with decorated cache pools #38059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fabpot merged 1 commit into from
Sep 4, 2020
Merged

[Cache] Fix CacheCollectorPass with decorated cache pools #38059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions src/Symfony/Component/Cache/DependencyInjection/CacheCollectorPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,13 @@ public function process(ContainerBuilder $container)
}

foreach ($container->findTaggedServiceIds($this->cachePoolTag) as $id => $attributes) {
$this->addToCollector($id, $container);
$poolName = $attributes[0]['name'] ?? $id;

if (($attributes[0]['name'] ?? $id) !== $id) {
$this->addToCollector($attributes[0]['name'], $container);
}
$this->addToCollector($id, $poolName, $container);
}
}

private function addToCollector(string $id, ContainerBuilder $container)
private function addToCollector(string $id, string $name, ContainerBuilder $container)
{
$definition = $container->getDefinition($id);
if ($definition->isAbstract()) {
Expand All @@ -77,7 +75,7 @@ private function addToCollector(string $id, ContainerBuilder $container)
$container->setDefinition($id, $recorder);

// Tell the collector to add the new instance
$collectorDefinition->addMethodCall('addInstance', [$id, new Reference($id)]);
$collectorDefinition->addMethodCall('addInstance', [$name, new Reference($id)]);
$collectorDefinition->setPublic(false);
}
}
43 changes: 40 additions & 3 deletions src/Symfony/Component/Cache/Tests/DependencyInjection/CacheCollectorPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
use Symfony\Component\Cache\Adapter\TraceableTagAwareAdapter;
use Symfony\Component\Cache\DataCollector\CacheDataCollector;
use Symfony\Component\Cache\DependencyInjection\CacheCollectorPass;
use Symfony\Component\Cache\Tests\Fixtures\ArrayCache;
use Symfony\Component\DependencyInjection\Compiler\PassConfig;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;

Expand Down Expand Up @@ -48,16 +50,51 @@ public function testProcess()
$this->assertEquals([
['addInstance', ['fs', new Reference('fs')]],
['addInstance', ['tagged_fs', new Reference('tagged_fs')]],
['addInstance', ['.php.inner', new Reference('.php.inner')]],
['addInstance', ['php', new Reference('php')]],
['addInstance', ['php', new Reference('.php.inner')]],
], $collector->getMethodCalls());

$this->assertSame(TraceableAdapter::class, $container->findDefinition('fs')->getClass());
$this->assertSame(TraceableTagAwareAdapter::class, $container->getDefinition('tagged_fs')->getClass());

$this->assertSame(TraceableAdapter::class, $container->findDefinition('.php.inner')->getClass());
$this->assertSame(TraceableTagAwareAdapter::class, $container->getDefinition('php')->getClass());
$this->assertSame(TagAwareAdapter::class, $container->getDefinition('php')->getClass());

$this->assertFalse($collector->isPublic(), 'The "data_collector.cache" should be private after processing');
}

public function testProcessCacheObjectsAreDecorated()
{
$container = new ContainerBuilder();
$collector = $container->register('data_collector.cache', CacheDataCollector::class);

$container
->register('cache.object', ArrayCache::class)
->addTag('cache.pool', ['name' => 'cache.object']);

$container
->register('something_is_decorating_cache_object', TagAwareAdapter::class)
->setPublic(true)
->setDecoratedService('cache.object');

$container->register('some_service_using_cache_object', TraceableAdapter::class)
->setPublic(true)
->addArgument(new Reference('cache.object'));

$container->addCompilerPass(new CacheCollectorPass(), PassConfig::TYPE_BEFORE_REMOVING);

$container->compile();
$this->assertCount(1, $collector->getMethodCalls());
$this->assertEquals(
[
[
'addInstance',
[
'cache.object',
new Reference('something_is_decorating_cache_object'),
],
],
],
$collector->getMethodCalls()
);
}
}