Skip to content

feat(symfony): named autowiring aliases for state services #8635

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

Draft
soyuka wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(symfony): named autowiring aliases for state services #8635

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
24 changes: 19 additions & 5 deletions src/Symfony/Bundle/Resources/config/doctrine_mongodb_odm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
use ApiPlatform\Doctrine\Odm\State\CollectionProvider;
use ApiPlatform\Doctrine\Odm\State\ItemProvider;
use ApiPlatform\Doctrine\Odm\State\LinksHandler;
use ApiPlatform\State\ProcessorInterface;
use ApiPlatform\State\ProviderInterface;
use Doctrine\Persistence\Mapping\ClassMetadataFactory;

return function (ContainerConfigurator $container) {
Expand All @@ -55,14 +57,20 @@
->tag('api_platform.state_processor', ['priority' => -100, 'key' => 'api_platform.doctrine_mongodb.odm.state.remove_processor'])
->tag('api_platform.state_processor', ['priority' => -100, 'key' => 'ApiPlatform\Doctrine\Common\State\RemoveProcessor']);

$services->alias(RemoveProcessor::class, 'api_platform.doctrine_mongodb.odm.state.remove_processor');
$services->alias(RemoveProcessor::class, 'api_platform.doctrine_mongodb.odm.state.remove_processor')
->deprecate('api-platform/core', '5.1', 'The "%alias_id%" service alias is deprecated, use "#[Target(\'odmRemove\')] ProcessorInterface $processor" instead.');

$services->alias(ProcessorInterface::class.' $odmRemove', 'api_platform.doctrine_mongodb.odm.state.remove_processor');

$services->set('api_platform.doctrine_mongodb.odm.state.persist_processor', PersistProcessor::class)
->args([service('doctrine_mongodb')])
->tag('api_platform.state_processor', ['priority' => -100, 'key' => 'api_platform.doctrine_mongodb.odm.state.persist_processor'])
->tag('api_platform.state_processor', ['priority' => -100, 'key' => 'ApiPlatform\Doctrine\Common\State\PersistProcessor']);

$services->alias(PersistProcessor::class, 'api_platform.doctrine_mongodb.odm.state.persist_processor');
$services->alias(PersistProcessor::class, 'api_platform.doctrine_mongodb.odm.state.persist_processor')
->deprecate('api-platform/core', '5.1', 'The "%alias_id%" service alias is deprecated, use "#[Target(\'odmPersist\')] ProcessorInterface $processor" instead.');

$services->alias(ProcessorInterface::class.' $odmPersist', 'api_platform.doctrine_mongodb.odm.state.persist_processor');

$services->set('api_platform.doctrine_mongodb.odm.search_filter', SearchFilter::class)
->abstract()
Expand Down Expand Up @@ -215,7 +223,10 @@
->tag('api_platform.state_provider', ['priority' => -100, 'key' => 'ApiPlatform\Doctrine\Odm\State\CollectionProvider'])
->tag('api_platform.state_provider', ['priority' => -100, 'key' => 'api_platform.doctrine_mongodb.odm.state.collection_provider']);

$services->alias(CollectionProvider::class, 'api_platform.doctrine_mongodb.odm.state.collection_provider');
$services->alias(CollectionProvider::class, 'api_platform.doctrine_mongodb.odm.state.collection_provider')
->deprecate('api-platform/core', '5.1', 'The "%alias_id%" service alias is deprecated, use "#[Target(\'odmCollection\')] ProviderInterface $provider" instead.');

$services->alias(ProviderInterface::class.' $odmCollection', 'api_platform.doctrine_mongodb.odm.state.collection_provider');

$services->set('api_platform.doctrine_mongodb.odm.state.item_provider', ItemProvider::class)
->args([
Expand All @@ -227,9 +238,12 @@
->tag('api_platform.state_provider', ['priority' => -100, 'key' => 'ApiPlatform\Doctrine\Odm\State\ItemProvider'])
->tag('api_platform.state_provider', ['priority' => -100, 'key' => 'api_platform.doctrine_mongodb.odm.state.item_provider']);

$services->alias(ItemProvider::class, 'api_platform.doctrine_mongodb.odm.state.item_provider');
$services->alias(ItemProvider::class, 'api_platform.doctrine_mongodb.odm.state.item_provider')
->deprecate('api-platform/core', '5.1', 'The "%alias_id%" service alias is deprecated, use "#[Target(\'odmItem\')] ProviderInterface $provider" instead.');

$services->alias(ProviderInterface::class.' $odmItem', 'api_platform.doctrine_mongodb.odm.state.item_provider');

$services->alias('api_platform.state.item_provider', 'ApiPlatform\Doctrine\Odm\State\ItemProvider');
$services->alias('api_platform.state.item_provider', 'api_platform.doctrine_mongodb.odm.state.item_provider');

$services->set('api_platform.doctrine.odm.metadata.resource.metadata_collection_factory', DoctrineMongoDbOdmResourceCollectionMetadataFactory::class)
->decorate('api_platform.metadata.resource.metadata_collection_factory', null, -50)
Expand Down
24 changes: 19 additions & 5 deletions src/Symfony/Bundle/Resources/config/doctrine_orm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
use ApiPlatform\Doctrine\Orm\State\CollectionProvider;
use ApiPlatform\Doctrine\Orm\State\ItemProvider;
use ApiPlatform\Doctrine\Orm\State\LinksHandler;
use ApiPlatform\State\ProcessorInterface;
use ApiPlatform\State\ProviderInterface;
use Doctrine\Persistence\Mapping\ClassMetadataFactory;

return function (ContainerConfigurator $container) {
Expand All @@ -55,14 +57,20 @@
->tag('api_platform.state_processor', ['priority' => -100, 'key' => 'api_platform.doctrine.orm.state.remove_processor'])
->tag('api_platform.state_processor', ['priority' => -100, 'key' => 'ApiPlatform\Doctrine\Common\State\RemoveProcessor']);

$services->alias(RemoveProcessor::class, 'api_platform.doctrine.orm.state.remove_processor');
$services->alias(RemoveProcessor::class, 'api_platform.doctrine.orm.state.remove_processor')
->deprecate('api-platform/core', '5.1', 'The "%alias_id%" service alias is deprecated, use "#[Target(\'ormRemove\')] ProcessorInterface $processor" instead.');

$services->alias(ProcessorInterface::class.' $ormRemove', 'api_platform.doctrine.orm.state.remove_processor');

$services->set('api_platform.doctrine.orm.state.persist_processor', PersistProcessor::class)
->args([service('doctrine')])
->tag('api_platform.state_processor', ['priority' => -100, 'key' => 'api_platform.doctrine.orm.state.persist_processor'])
->tag('api_platform.state_processor', ['priority' => -100, 'key' => 'ApiPlatform\Doctrine\Common\State\PersistProcessor']);

$services->alias(PersistProcessor::class, 'api_platform.doctrine.orm.state.persist_processor');
$services->alias(PersistProcessor::class, 'api_platform.doctrine.orm.state.persist_processor')
->deprecate('api-platform/core', '5.1', 'The "%alias_id%" service alias is deprecated, use "#[Target(\'ormPersist\')] ProcessorInterface $processor" instead.');

$services->alias(ProcessorInterface::class.' $ormPersist', 'api_platform.doctrine.orm.state.persist_processor');

$services->set('api_platform.doctrine.orm.order_filter', OrderFilter::class)
->abstract()
Expand Down Expand Up @@ -233,7 +241,10 @@
->tag('api_platform.state_provider', ['priority' => -100, 'key' => 'ApiPlatform\Doctrine\Orm\State\CollectionProvider'])
->tag('api_platform.state_provider', ['priority' => -100, 'key' => 'api_platform.doctrine.orm.state.collection_provider']);

$services->alias(CollectionProvider::class, 'api_platform.doctrine.orm.state.collection_provider');
$services->alias(CollectionProvider::class, 'api_platform.doctrine.orm.state.collection_provider')
->deprecate('api-platform/core', '5.1', 'The "%alias_id%" service alias is deprecated, use "#[Target(\'ormCollection\')] ProviderInterface $provider" instead.');

$services->alias(ProviderInterface::class.' $ormCollection', 'api_platform.doctrine.orm.state.collection_provider');

$services->set('api_platform.doctrine.orm.state.item_provider', ItemProvider::class)
->args([
Expand All @@ -245,9 +256,12 @@
->tag('api_platform.state_provider', ['priority' => -100, 'key' => 'ApiPlatform\Doctrine\Orm\State\ItemProvider'])
->tag('api_platform.state_provider', ['priority' => -100, 'key' => 'api_platform.doctrine.orm.state.item_provider']);

$services->alias(ItemProvider::class, 'api_platform.doctrine.orm.state.item_provider');
$services->alias(ItemProvider::class, 'api_platform.doctrine.orm.state.item_provider')
->deprecate('api-platform/core', '5.1', 'The "%alias_id%" service alias is deprecated, use "#[Target(\'ormItem\')] ProviderInterface $provider" instead.');

$services->alias(ProviderInterface::class.' $ormItem', 'api_platform.doctrine.orm.state.item_provider');

$services->alias('api_platform.state.item_provider', 'ApiPlatform\Doctrine\Orm\State\ItemProvider');
$services->alias('api_platform.state.item_provider', 'api_platform.doctrine.orm.state.item_provider');

$services->set('api_platform.doctrine.orm.search_filter', SearchFilter::class)
->abstract()
Expand Down
11 changes: 9 additions & 2 deletions src/Symfony/Bundle/Resources/config/elasticsearch.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
use ApiPlatform\Elasticsearch\Serializer\NameConverter\InnerFieldsNameConverter;
use ApiPlatform\Elasticsearch\State\CollectionProvider;
use ApiPlatform\Elasticsearch\State\ItemProvider;
use ApiPlatform\State\ProviderInterface;

return function (ContainerConfigurator $container) {
$services = $container->services();
Expand Down Expand Up @@ -119,7 +120,10 @@
->tag('api_platform.state_provider', ['priority' => -100, 'key' => 'ApiPlatform\Elasticsearch\State\ItemProvider'])
->tag('api_platform.state_provider', ['priority' => -100]);

$services->alias(ItemProvider::class, 'api_platform.elasticsearch.state.item_provider');
$services->alias(ItemProvider::class, 'api_platform.elasticsearch.state.item_provider')
->deprecate('api-platform/core', '5.1', 'The "%alias_id%" service alias is deprecated, use "#[Target(\'elasticsearchItem\')] ProviderInterface $provider" instead.');

$services->alias(ProviderInterface::class.' $elasticsearchItem', 'api_platform.elasticsearch.state.item_provider');

$services->set('api_platform.elasticsearch.state.collection_provider', CollectionProvider::class)
->args([
Expand All @@ -132,7 +136,10 @@
->tag('api_platform.state_provider', ['priority' => -100, 'key' => 'ApiPlatform\Elasticsearch\State\CollectionProvider'])
->tag('api_platform.state_provider', ['priority' => -100]);

$services->alias(CollectionProvider::class, 'api_platform.elasticsearch.state.collection_provider');
$services->alias(CollectionProvider::class, 'api_platform.elasticsearch.state.collection_provider')
->deprecate('api-platform/core', '5.1', 'The "%alias_id%" service alias is deprecated, use "#[Target(\'elasticsearchCollection\')] ProviderInterface $provider" instead.');

$services->alias(ProviderInterface::class.' $elasticsearchCollection', 'api_platform.elasticsearch.state.collection_provider');

$services->set('api_platform.elasticsearch.metadata.resource.metadata_collection_factory', ElasticsearchProviderResourceMetadataCollectionFactory::class)
->decorate('api_platform.metadata.resource.metadata_collection_factory', null, 40)
Expand Down
56 changes: 56 additions & 0 deletions src/Symfony/Tests/Bundle/DependencyInjection/ApiPlatformExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@

namespace ApiPlatform\Symfony\Tests\Bundle\DependencyInjection;

use ApiPlatform\Doctrine\Common\State\PersistProcessor;
use ApiPlatform\Doctrine\Common\State\RemoveProcessor;
use ApiPlatform\Doctrine\Odm\State\CollectionProvider as OdmCollectionProvider;
use ApiPlatform\Doctrine\Odm\State\ItemProvider as OdmItemProvider;
use ApiPlatform\Doctrine\Orm\State\CollectionProvider as OrmCollectionProvider;
use ApiPlatform\Doctrine\Orm\State\ItemProvider as OrmItemProvider;
use ApiPlatform\Elasticsearch\State\CollectionProvider as ElasticsearchCollectionProvider;
use ApiPlatform\Elasticsearch\State\ItemProvider as ElasticsearchItemProvider;
use ApiPlatform\Metadata\Exception\ExceptionInterface;
use ApiPlatform\Metadata\Exception\InvalidArgumentException;
use ApiPlatform\Metadata\IdentifiersExtractorInterface;
Expand All @@ -23,6 +31,8 @@
use ApiPlatform\Serializer\Filter\PropertyFilter;
use ApiPlatform\State\Pagination\Pagination;
use ApiPlatform\State\Pagination\PaginationOptions;
use ApiPlatform\State\ProcessorInterface;
use ApiPlatform\State\ProviderInterface;
use ApiPlatform\State\SerializerContextBuilderInterface;
use ApiPlatform\Symfony\Action\NotFoundAction;
use ApiPlatform\Symfony\Bundle\DependencyInjection\ApiPlatformExtension;
Expand Down Expand Up @@ -594,4 +604,50 @@ public function testHttpCachePurgersAndListenerRegisteredWhenInvalidationEnabled
$this->assertContainerHasService('api_platform.http_cache_purger.processor.add_tags');
$this->assertContainerHasAlias('api_platform.http_cache.purger');
}

public function testStateServicesHaveNamedAutowiringAliases(): void
{
$config = self::DEFAULT_CONFIG;
$config['api_platform']['elasticsearch']['enabled'] = true;
(new ApiPlatformExtension())->load($config, $this->container);

$aliases = [
ProcessorInterface::class.' $ormPersist' => 'api_platform.doctrine.orm.state.persist_processor',
ProcessorInterface::class.' $ormRemove' => 'api_platform.doctrine.orm.state.remove_processor',
ProviderInterface::class.' $ormItem' => 'api_platform.doctrine.orm.state.item_provider',
ProviderInterface::class.' $ormCollection' => 'api_platform.doctrine.orm.state.collection_provider',
ProcessorInterface::class.' $odmPersist' => 'api_platform.doctrine_mongodb.odm.state.persist_processor',
ProcessorInterface::class.' $odmRemove' => 'api_platform.doctrine_mongodb.odm.state.remove_processor',
ProviderInterface::class.' $odmItem' => 'api_platform.doctrine_mongodb.odm.state.item_provider',
ProviderInterface::class.' $odmCollection' => 'api_platform.doctrine_mongodb.odm.state.collection_provider',
ProviderInterface::class.' $elasticsearchItem' => 'api_platform.elasticsearch.state.item_provider',
ProviderInterface::class.' $elasticsearchCollection' => 'api_platform.elasticsearch.state.collection_provider',
];

foreach ($aliases as $alias => $serviceId) {
$this->assertContainerHasAlias($alias);
$this->assertSame($serviceId, (string) $this->container->getAlias($alias));
}
}

public function testFinalStateServiceFqcnAliasesAreDeprecated(): void
{
$config = self::DEFAULT_CONFIG;
$config['api_platform']['elasticsearch']['enabled'] = true;
(new ApiPlatformExtension())->load($config, $this->container);

foreach ([
PersistProcessor::class,
RemoveProcessor::class,
OrmItemProvider::class,
OrmCollectionProvider::class,
OdmItemProvider::class,
OdmCollectionProvider::class,
ElasticsearchItemProvider::class,
ElasticsearchCollectionProvider::class,
] as $fqcn) {
$this->assertContainerHasAlias($fqcn);
$this->assertTrue($this->container->getAlias($fqcn)->isDeprecated(), \sprintf('Alias "%s" is not deprecated.', $fqcn));
}
}
}
Loading