Merge #266

266: Use meilisearch prefix for services r=norkunas a=94noni

# Pull Request

## What does this PR do?
- Improves "best practices/coding standard" as the « search » prefix is to generic, lets be specific for this bundle

This PR can be merged before #265 (as it will require a major release)

TODO:
Assert that the container has all services and that deprecations are triggered 

- https://symfony.com/doc/5.4/bundles/best_practices.html#services
- https://symfony.com/doc/5.4/service_container/alias_private.html#deprecating-service-aliases



---------

# RFC

I found some inconsistency reading the repo:

- Commands namespace: `meili:`
- Bundle config: `meili_search`
- Services: `search` (this PR)

Will it be nice to define them as `meilisearch`everywhere? 


Co-authored-by: Antoine Makdessi <[email protected]>
Co-authored-by: Tomas Norkūnas <[email protected]>

Author: 3 people

config/services.xml

@@ -4,26 +4,35 @@
            xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <services>
-        <defaults autowire="true" autoconfigure="true"/>
+        <defaults autowire="true" autoconfigure="true" />
 
         <prototype namespace="Meilisearch\Bundle\Command\" resource="../src/Command" />
 
-        <service id="search.search_indexer_subscriber"
+        <service id="meilisearch.search_indexer_subscriber"
                  class="Meilisearch\Bundle\EventListener\DoctrineEventSubscriber"
                  public="true">
-            <argument type="service" id="search.service"/>
+            <argument type="service" id="meilisearch.service" />
+        </service>
+        <service id="search.search_indexer_subscriber" alias="meilisearch.search_indexer_subscriber">
+            <deprecated package="meilisearch/search-bundle" version="0.14">The "%alias_id%" service alias is deprecated. Use "meilisearch.search_indexer_subscriber" instead.</deprecated>
         </service>
 
-        <service id="search.client" class="Meilisearch\Client" public="true" lazy="true">
+        <service id="meilisearch.client" class="Meilisearch\Client" public="true" lazy="true">
             <argument key="$url">%meili_url%</argument>
             <argument key="$apiKey">%meili_api_key%</argument>
             <argument key="$httpClient" type="service" id="psr18.http_client" on-invalid="ignore" />
             <argument key="$clientAgents" type="collection">
                 <argument>%meili_symfony_version%</argument>
             </argument>
         </service>
+        <service id="search.client" alias="meilisearch.client" public="true">
+            <deprecated package="meilisearch/search-bundle" version="0.14">The "%alias_id%" service alias is deprecated. Use "meilisearch.client" instead.</deprecated>
+        </service>
 
-        <service id="Meilisearch\Client" alias="search.client"/>
-        <service id="Meilisearch\Bundle\SearchService" alias="search.service"/>
+        <service id="Meilisearch\Client" alias="meilisearch.client" public="true" />
+        <service id="search.client" alias="meilisearch.client" public="true">
+            <deprecated package="meilisearch/search-bundle" version="0.14">The "%alias_id%" service alias is deprecated. Use "meilisearch.client" instead.</deprecated>
+        </service>
+        <service id="Meilisearch\Bundle\SearchService" alias="meilisearch.service" />
     </services>
 </container>

src/DependencyInjection/MeilisearchExtension.php

@@ -40,24 +40,25 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->setParameter('meili_symfony_version', MeilisearchBundle::qualifiedVersion());
 
         if (\count($doctrineEvents = $config['doctrineSubscribedEvents']) > 0) {
-            $subscriber = $container->getDefinition('search.search_indexer_subscriber');
+            $subscriber = $container->getDefinition('meilisearch.search_indexer_subscriber');
 
             foreach ($doctrineEvents as $event) {
                 $subscriber->addTag('doctrine.event_listener', ['event' => $event]);
                 $subscriber->addTag('doctrine_mongodb.odm.event_listener', ['event' => $event]);
             }
         } else {
-            $container->removeDefinition('search.search_indexer_subscriber');
+            $container->removeDefinition('meilisearch.search_indexer_subscriber');
         }
 
-        $engineDefinition = new Definition(Engine::class, [new Reference('search.client')]);
+        $engineDefinition = new Definition(Engine::class, [new Reference('meilisearch.client')]);
 
         $searchDefinition = (new Definition(
             MeilisearchService::class,
             [new Reference($config['serializer']), $engineDefinition, $config]
         ));
 
-        $container->setDefinition('search.service', $searchDefinition->setPublic(true));
+        $container->setDefinition('meilisearch.service', $searchDefinition->setPublic(true));
+        $container->setAlias('search.service', 'meilisearch.service')->setPublic(true);
     }
 
     /**

tests/BaseKernelTestCase.php

@@ -29,7 +29,7 @@ protected function setUp(): void
         self::bootKernel();
 
         $this->entityManager = $this->get('doctrine.orm.entity_manager');
-        $this->searchService = $this->get('search.service');
+        $this->searchService = $this->get('meilisearch.service');
 
         $metaData = $this->entityManager->getMetadataFactory()->getAllMetadata();
         $tool = new SchemaTool($this->entityManager);

tests/Integration/CommandsTest.php

@@ -34,7 +34,7 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        $this->client = $this->get('search.client');
+        $this->client = $this->get('meilisearch.client');
         $this->index = $this->client->index($this->getPrefix().self::$indexName);
         $this->application = new Application(self::createKernel());
     }
@@ -498,7 +498,7 @@ public function testImportWithDynamicSettings(string $command): void
 EOD, $importOutput);
         }
 
-        $settings = $this->get('search.client')->index('sf_phpunit__dynamic_settings')->getSettings();
+        $settings = $this->get('meilisearch.client')->index('sf_phpunit__dynamic_settings')->getSettings();
 
         $getSetting = static fn ($value) => $value instanceof \IteratorAggregate ? iterator_to_array($value) : $value;
 

tests/Integration/DependencyInjectionTest.php

@@ -21,7 +21,7 @@ public function testHasMeilisearchVersionDefinitionAfterLoad(): void
     {
         $this->load();
 
-        $this->assertContainerBuilderHasServiceDefinitionWithArgument('search.client', '$clientAgents', ['%meili_symfony_version%']);
+        $this->assertContainerBuilderHasServiceDefinitionWithArgument('meilisearch.client', '$clientAgents', ['%meili_symfony_version%']);
     }
 
     public function testHasMeilisearchVersionFromConstantAfterLoad(): void

tests/Integration/EngineTest.php

@@ -19,7 +19,7 @@ public function setUp(): void
     {
         parent::setUp();
 
-        $this->engine = new Engine($this->get('search.client'));
+        $this->engine = new Engine($this->get('meilisearch.client'));
     }
 
     /**

tests/Integration/EventListener/DoctrineEventSubscriberTest.php

@@ -22,7 +22,7 @@ public function setUp(): void
     {
         parent::setUp();
 
-        $this->client = $this->get('search.client');
+        $this->client = $this->get('meilisearch.client');
     }
 
     /**

tests/Integration/SearchTest.php

@@ -36,7 +36,7 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        $this->client = $this->get('search.client');
+        $this->client = $this->get('meilisearch.client');
         $this->objectManager = $this->get('doctrine')->getManager();
         $this->index = $this->client->index($this->getPrefix().self::$indexName);
         $this->application = new Application(self::createKernel());

tests/Integration/SettingsTest.php

@@ -37,7 +37,7 @@ public function setUp(): void
     {
         parent::setUp();
 
-        $this->client = $this->get('search.client');
+        $this->client = $this->get('meilisearch.client');
         $this->application = new Application(self::$kernel);
     }