Add Data providers extension point

Author: norkunas

.github/workflows/tests.yml

@@ -28,7 +28,7 @@ jobs:
     strategy:
       matrix:
         php-version: [ '7.4', '8.1', '8.2', '8.3', '8.4' ]
-        sf-version: [ '5.4', '6.4', '7.0', '7.1', '7.2', '7.3' ]
+        sf-version: ['6.4', '7.0', '7.1', '7.2', '7.3' ]
         dependencies: [ 'default' ]
         exclude:
           - php-version: '7.4'
@@ -41,8 +41,6 @@ jobs:
             sf-version: '7.2'
           - php-version: '7.4'
             sf-version: '7.3'
-          - php-version: '8.1'
-            sf-version: '5.4'
           - php-version: '8.1'
             sf-version: '7.0'
           - php-version: '8.1'
@@ -51,19 +49,7 @@ jobs:
             sf-version: '7.2'
           - php-version: '8.1'
             sf-version: '7.3'
-          - php-version: '8.2'
-            sf-version: '5.4'
-          - php-version: '8.3'
-            sf-version: '5.4'
-          - php-version: '8.4'
-            sf-version: '5.4'
         include:
-          - php-version: '7.4'
-            sf-version: '5.4'
-            dependencies: 'lowest'
-          - php-version: '7.4'
-            sf-version: '5.4'
-            dependencies: 'highest'
           - php-version: '8.4'
             sf-version: '6.4'
             dependencies: 'lowest'

composer.json

@@ -18,39 +18,39 @@
     }
   ],
   "require": {
-    "php": "^7.4|^8.0",
+    "php": "^8.1",
     "ext-json": "*",
-    "doctrine/doctrine-bundle": "^2.10 || ^3.0",
     "meilisearch/meilisearch-php": "^1.16",
-    "symfony/config": "^5.4 || ^6.0 || ^7.0",
-    "symfony/dependency-injection": "^5.4.17 || ^6.0 || ^7.0",
-    "symfony/event-dispatcher": "^5.4 || ^6.0 || ^7.0",
-    "symfony/http-kernel": "^5.4 || ^6.0 || ^7.0",
-    "symfony/polyfill-php80": "^1.27",
-    "symfony/property-access": "^5.4 || ^6.0 || ^7.0",
-    "symfony/serializer": "^5.4 || ^6.0 || ^7.0"
+    "symfony/config": "^6.4 || ^7.0",
+    "symfony/dependency-injection": "^6.4 || ^7.0",
+    "symfony/event-dispatcher": "^6.4 || ^7.0",
+    "symfony/http-kernel": "^6.4 || ^7.0",
+    "symfony/polyfill-php80": "^1.33",
+    "symfony/property-access": "^6.4 || ^7.0",
+    "symfony/serializer": "^6.4 || ^7.0"
   },
   "require-dev": {
-    "doctrine/annotations": "^2.0.0",
+    "doctrine/annotations": "^2.0.2",
+    "doctrine/doctrine-bundle": "^2.10 || ^3.0",
     "doctrine/orm": "^2.12 || ^3.0",
     "matthiasnoback/symfony-config-test": "^4.3 || ^5.2",
     "matthiasnoback/symfony-dependency-injection-test": "^4.3 || ^5.1",
     "nikic/php-parser": "^5.6.2",
     "nyholm/psr7": "^1.8.2",
-    "php-cs-fixer/shim": "^3.88.2",
+    "php-cs-fixer/shim": "^3.90.0",
     "phpmd/phpmd": "^2.15",
     "phpstan/extension-installer": "^1.4.3",
-    "phpstan/phpstan": "^2.1.31",
-    "phpstan/phpstan-doctrine": "^2.0.10",
-    "phpstan/phpstan-phpunit": "^2.0.7",
+    "phpstan/phpstan": "^2.1.32",
+    "phpstan/phpstan-doctrine": "^2.0.11",
+    "phpstan/phpstan-phpunit": "^2.0.8",
     "phpstan/phpstan-symfony": "^2.0.8",
     "phpunit/php-code-coverage": "^9.2.32",
-    "symfony/doctrine-bridge": "^5.4.19 || ^6.0.7 || ^7.0",
-    "symfony/filesystem": "^5.4 || ^6.0 || ^7.0",
-    "symfony/framework-bundle": "^5.4.17 || ^6.0 || ^7.0",
-    "symfony/http-client": "^5.4.47 || ^6.4.15 || ^7.1.8",
+    "symfony/doctrine-bridge": "^6.4 || ^7.0",
+    "symfony/filesystem": "^6.4 || ^7.0",
+    "symfony/framework-bundle": "^6.4 || ^7.0",
+    "symfony/http-client": "^6.4.15 || ^7.1.8",
     "symfony/phpunit-bridge": "^7.3",
-    "symfony/yaml": "^5.4 || ^6.0 || ^7.0"
+    "symfony/yaml": "^6.4 || ^7.0"
   },
   "autoload": {
     "psr-4": {

config/services.php

@@ -9,7 +9,9 @@
 use Meilisearch\Bundle\Command\MeilisearchUpdateSettingsCommand;
 use Meilisearch\Bundle\Engine;
 use Meilisearch\Bundle\EventListener\DoctrineEventSubscriber;
+use Meilisearch\Bundle\SearchManagerInterface;
 use Meilisearch\Bundle\SearchService;
+use Meilisearch\Bundle\Services\MeilisearchManager;
 use Meilisearch\Bundle\Services\MeilisearchService;
 use Meilisearch\Bundle\Services\SettingsUpdater;
 use Meilisearch\Bundle\Services\UnixTimestampNormalizer;
@@ -36,9 +38,11 @@
         ->public()
         ->deprecate('meilisearch/search-bundle', '0.14', 'The "%alias_id%" service alias is deprecated. Use "meilisearch.service" instead.');
 
+    $services->alias(SearchService::class, 'meilisearch.service');
+
     $services->set('meilisearch.search_indexer_subscriber', DoctrineEventSubscriber::class)
         ->public()
-        ->args([service('meilisearch.service')]);
+        ->args([service('meilisearch.manager')]);
 
     $services->alias('search.search_indexer_subscriber', 'meilisearch.search_indexer_subscriber')
         ->deprecate('meilisearch/search-bundle', '0.14', 'The "%alias_id%" service alias is deprecated. Use "meilisearch.search_indexer_subscriber" instead.');
@@ -62,38 +66,45 @@
     $services->alias(Client::class, 'meilisearch.client')
         ->public();
 
-    $services->alias(SearchService::class, 'meilisearch.service');
+    $services->set('meilisearch.manager', MeilisearchManager::class)
+        ->args([
+            abstract_arg('normalizer'),
+            service('meilisearch.engine'),
+            service('property_accessor'),
+            abstract_arg('configuration'),
+            tagged_iterator('meilisearch.data_provider', 'key'),
+        ]);
+    $services->alias(SearchManagerInterface::class, 'meilisearch.manager');
 
     $services->set('meilisearch.settings_updater', SettingsUpdater::class)
         ->args([
-            service('meilisearch.service'),
+            service('meilisearch.manager'),
             service('meilisearch.client'),
             service('event_dispatcher'),
         ]);
 
     $services->alias(SettingsUpdater::class, 'meilisearch.settings_updater');
 
     $services->set(MeilisearchClearCommand::class)
-        ->args([service('meilisearch.service')])
+        ->args([service('meilisearch.manager')])
         ->tag('console.command', ['command' => 'meilisearch:clear|meili:clear', 'description' => 'Clear the index documents']);
 
     $services->set(MeilisearchCreateCommand::class)
         ->args([
-            service('meilisearch.service'),
+            service('meilisearch.manager'),
             service('meilisearch.client'),
             service('meilisearch.settings_updater'),
             service('event_dispatcher'),
         ])
         ->tag('console.command', ['command' => 'meilisearch:create|meili:create', 'description' => 'Create indexes']);
 
     $services->set(MeilisearchDeleteCommand::class)
-        ->args([service('meilisearch.service')])
+        ->args([service('meilisearch.manager')])
         ->tag('console.command', ['command' => 'meilisearch:delete|meili:delete', 'description' => 'Delete the indexes']);
 
     $services->set(MeilisearchImportCommand::class)
         ->args([
-            service('meilisearch.service'),
-            service('doctrine'),
+            service('meilisearch.manager'),
             service('meilisearch.client'),
             service('meilisearch.settings_updater'),
             service('event_dispatcher'),
@@ -102,7 +113,7 @@
 
     $services->set(MeilisearchUpdateSettingsCommand::class)
         ->args([
-            service('meilisearch.service'),
+            service('meilisearch.manager'),
             service('meilisearch.settings_updater'),
             service('event_dispatcher'),
         ])

phpstan-baseline.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types = 1);
+
+$ignoreErrors = [];
+$ignoreErrors[] = [
+	'message' => '#^Call to static method getClass\\(\\) on an unknown class Doctrine\\\\Common\\\\Util\\\\ClassUtils\\.$#',
+	'identifier' => 'class.notFound',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Services/MeilisearchManager.php',
+];
+$ignoreErrors[] = [
+	'message' => '#^Call to static method getClass\\(\\) on an unknown class Doctrine\\\\Common\\\\Util\\\\ClassUtils\\.$#',
+	'identifier' => 'class.notFound',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Services/MeilisearchService.php',
+];
+
+return ['parameters' => ['ignoreErrors' => $ignoreErrors]];

phpstan.dist.neon

@@ -1,10 +1,10 @@
+includes:
+	- phpstan-baseline.php
+
 parameters:
 	bootstrapFiles:
 		- vendor/bin/.phpunit/phpunit/vendor/autoload.php
 	level: 5
 	paths:
 		- src
 		- tests
-	ignoreErrors:
-		- '#Call to static method getClass\(\) on an unknown class Doctrine\\Common\\Util\\ClassUtils#'
-		- '#Parameter \#1 \$array of function array_unique expects an array of values castable to string, list<class-string<Meilisearch\\Bundle\\Entity\\Aggregator>\|Meilisearch\\Bundle\\Entity\\Aggregator> given#'

src/Command/IndexCommand.php

@@ -5,7 +5,7 @@
 namespace Meilisearch\Bundle\Command;
 
 use Meilisearch\Bundle\Collection;
-use Meilisearch\Bundle\SearchService;
+use Meilisearch\Bundle\SearchManagerInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -14,21 +14,18 @@ abstract class IndexCommand extends Command
 {
     protected const DEFAULT_RESPONSE_TIMEOUT = 5000;
 
-    protected SearchService $searchService;
-
     private string $prefix;
 
-    public function __construct(SearchService $searchService)
+    public function __construct(protected SearchManagerInterface $searchManager)
     {
-        $this->searchService = $searchService;
-        $this->prefix = $this->searchService->getConfiguration()->get('prefix');
+        $this->prefix = $this->searchManager->getConfiguration()->get('prefix');
 
         parent::__construct();
     }
 
     protected function getEntitiesFromArgs(InputInterface $input, OutputInterface $output): Collection
     {
-        $indices = new Collection($this->searchService->getConfiguration()->get('indices'));
+        $indices = new Collection($this->searchManager->getConfiguration()->get('indices'));
         $indexNames = new Collection();
 
         if ($indexList = $input->getOption('indices')) {

src/Command/MeilisearchClearCommand.php

@@ -27,7 +27,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $indexName = $index['prefixed_name'];
             $className = $index['class'];
             $msg = "Cleared <info>$indexName</info> index of <comment>$className</comment>";
-            $array = $this->searchService->clear($className);
+            $array = $this->searchManager->clear($className);
 
             if ('failed' === $array['status']) {
                 $msg = "<error>Index <info>$indexName</info>  couldn\'t be cleared</error>";

src/Command/MeilisearchCreateCommand.php

@@ -7,7 +7,7 @@
 use Meilisearch\Bundle\Collection;
 use Meilisearch\Bundle\EventListener\ConsoleOutputSubscriber;
 use Meilisearch\Bundle\Model\Aggregator;
-use Meilisearch\Bundle\SearchService;
+use Meilisearch\Bundle\SearchManagerInterface;
 use Meilisearch\Bundle\Services\SettingsUpdater;
 use Meilisearch\Client;
 use Symfony\Component\Console\Attribute\AsCommand;
@@ -20,17 +20,13 @@
 #[AsCommand(name: 'meilisearch:create', description: 'Create indexes', aliases: ['meili:create'])]
 final class MeilisearchCreateCommand extends IndexCommand
 {
-    private Client $searchClient;
-    private SettingsUpdater $settingsUpdater;
-    private EventDispatcherInterface $eventDispatcher;
-
-    public function __construct(SearchService $searchService, Client $searchClient, SettingsUpdater $settingsUpdater, EventDispatcherInterface $eventDispatcher)
-    {
-        parent::__construct($searchService);
-
-        $this->searchClient = $searchClient;
-        $this->settingsUpdater = $settingsUpdater;
-        $this->eventDispatcher = $eventDispatcher;
+    public function __construct(
+        SearchManagerInterface $searchManager,
+        private readonly Client $searchClient,
+        private readonly SettingsUpdater $settingsUpdater,
+        private readonly EventDispatcherInterface $eventDispatcher,
+    ) {
+        parent::__construct($searchManager);
     }
 
     protected function configure(): void
@@ -67,7 +63,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         foreach ($entitiesToIndex as $index) {
             $entityClassName = $index['class'];
 
-            if (!$this->searchService->isSearchable($entityClassName)) {
+            if (!$this->searchManager->isSearchable($entityClassName)) {
                 continue;
             }
 

src/Command/MeilisearchDeleteCommand.php

@@ -29,7 +29,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $indexName = $index['prefixed_name'];
 
             try {
-                $this->searchService->deleteByIndexName($indexName);
+                $this->searchManager->deleteByIndexName($indexName);
             } catch (ApiException $e) {
                 $output->writeln('Cannot delete '.$indexName.': '.$e->getMessage());