Allow Symfony 7 versions (#37)

alexander-schranz · web-flow · commit 095a3a44ed4b · 2024-07-17T09:13:34.000+02:00
diff --git a/.github/workflows/test-application.yaml b/.github/workflows/test-application.yaml
@@ -70,6 +70,30 @@ jobs:
                       elasticsearch-package-constraint: '^7.0'
                       env: {}
 
+                    - php-version: '8.2'
+                      job-name-prefix: 'Allow to fail: '
+                      elasticsearch-version: '7.11.1'
+                      lint: true
+                      symfony-version: '^7.0'
+                      elasticsearch-package-constraint: '^7.0'
+                      env: {}
+
+                    - php-version: '8.3'
+                      job-name-prefix: 'Allow to fail: '
+                      elasticsearch-version: '7.11.1'
+                      lint: true
+                      symfony-version: '^7.0'
+                      elasticsearch-package-constraint: '^7.0'
+                      env: {}
+
+                    - php-version: '8.4'
+                      job-name-prefix: 'Allow to fail: '
+                      elasticsearch-version: '7.11.1'
+                      lint: true
+                      symfony-version: '^7.0'
+                      elasticsearch-package-constraint: '^7.0'
+                      env: {}
+
         services:
             elasticsearch:
                 image: docker.elastic.co/elasticsearch/elasticsearch:${{ matrix.elasticsearch-version }}
@@ -107,9 +131,12 @@ jobs:
             - name: Install dependencies
               run: |
                   composer validate
-                  composer require --no-update symfony/symfony:${{ matrix.symfony-version }}
+                  composer require --no-update symfony/flex:"^1.0 || ^2.0"
+                  composer config --no-plugins allow-plugins.symfony/flex true
                   composer require --no-update elasticsearch/elasticsearch:${{ matrix.elasticsearch-package-constraint }}
-                  composer install --no-interaction --prefer-dist
+                  composer update --no-interaction --prefer-dist --no-scripts
+              env:
+                  SYMFONY_VERSION: ${{ matrix.symfony-version }}
 
             - name: Fix code style
               if: ${{ matrix.lint }}
diff --git a/Command/AbstractManagerAwareCommand.php b/Command/AbstractManagerAwareCommand.php
@@ -34,7 +34,7 @@ public function __construct(array $managers, $name = null)
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         $this->addOption(
             'manager',
diff --git a/Command/CacheClearCommand.php b/Command/CacheClearCommand.php
@@ -30,7 +30,7 @@ public function __construct(array $managers = [])
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -42,7 +42,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
         $this
diff --git a/Command/DocumentGenerateCommand.php b/Command/DocumentGenerateCommand.php
@@ -78,7 +78,7 @@ public function __construct(
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -90,7 +90,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         if ($input->hasParameterOption(['--no-interaction', '-n'])) {
             throw $this->getException('No interaction mode is not allowed!');
diff --git a/Command/IndexCreateCommand.php b/Command/IndexCreateCommand.php
@@ -39,7 +39,7 @@ public function __construct(IndexSuffixFinder $indexSuffixFinder, array $manager
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -66,7 +66,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output):int
     {
         $io = new SymfonyStyle($input, $output);
         $manager = $this->getManager($input->getOption('manager'));
diff --git a/Command/IndexDropCommand.php b/Command/IndexDropCommand.php
@@ -26,7 +26,7 @@ class IndexDropCommand extends AbstractManagerAwareCommand
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -44,7 +44,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
         if ($input->getOption('force')) {
diff --git a/Command/IndexExportCommand.php b/Command/IndexExportCommand.php
@@ -40,7 +40,7 @@ public function __construct(ExportService $exportService, array $managers = [])
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -74,7 +74,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
         $manager = $this->getManager($input->getOption('manager'));
diff --git a/Command/IndexImportCommand.php b/Command/IndexImportCommand.php
@@ -40,7 +40,7 @@ public function __construct(ImportService $importService, array $managers = [])
     /**
      * {@inheritdoc}
      */
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
 
@@ -70,7 +70,7 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
         $manager = $this->getManager($input->getOption('manager'));
diff --git a/DependencyInjection/Compiler/AnnotationReaderPass.php b/DependencyInjection/Compiler/AnnotationReaderPass.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace ONGR\ElasticsearchBundle\DependencyInjection\Compiler;
+
+use Doctrine\Common\Annotations\AnnotationReader;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+
+/**
+ * @internal
+ */
+class AnnotationReaderPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        if ($container->hasDefinition('es.annotations.reader')) {
+            return;
+        }
+
+        $definition = new Definition(AnnotationReader::class);
+        $definition->addMethodCall('addGlobalIgnoredName', ['required']);
+        $container->setDefinition('es.annotations.reader', $definition);
+    }
+}
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -23,7 +23,7 @@ class Configuration implements ConfigurationInterface
     /**
      * {@inheritdoc}
      */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('ongr_elasticsearch');
 
diff --git a/ONGRElasticsearchBundle.php b/ONGRElasticsearchBundle.php
@@ -11,6 +11,7 @@
 
 namespace ONGR\ElasticsearchBundle;
 
+use ONGR\ElasticsearchBundle\DependencyInjection\Compiler\AnnotationReaderPass;
 use ONGR\ElasticsearchBundle\DependencyInjection\Compiler\ManagerPass;
 use ONGR\ElasticsearchBundle\DependencyInjection\Compiler\MappingPass;
 use ONGR\ElasticsearchBundle\DependencyInjection\Compiler\RepositoryPass;
@@ -32,6 +33,7 @@ public function build(ContainerBuilder $container)
 
         $container->addCompilerPass(new MappingPass());
         $container->addCompilerPass(new ManagerPass());
+        $container->addCompilerPass(new AnnotationReaderPass());
         // The `RepositoryPass` need to be behind the Symfony `DecoratorServicePass`
         // to allow decorating the annotation reader
         $container->addCompilerPass(new RepositoryPass(), PassConfig::TYPE_OPTIMIZE, -10);
diff --git a/README.md b/README.md
@@ -3,10 +3,10 @@
 This is a fork of the [ongr/elasticsearch-bundle](https://github.com/ongr-io/elasticsearchbundle).
 With some basic changes to support wider range of Symfony Versions.
 
-| Version   | Supported Elasticsearch Version | Supported Symfony Version      |
-|-----------|---------------------------------|--------------------------------|
-| `5.x`     | `^7.0, ^6.0, ^5.0`              | `^6.0, ^5.0, ^4.0, ^3.4, ^2.8` |
-| `1.x`     | `^1.0, ^2.0`                    | `^3.0, ^2.7`                   |
+| Version   | Supported Elasticsearch Version | Supported Symfony Version            |
+|-----------|---------------------------------|--------------------------------------|
+| `5.x`     | `^7.0, ^6.0, ^5.0`              | `^7.0, ^6.0, ^5.0, ^4.0, ^3.4, ^2.8` |
+| `1.x`     | `^1.0, ^2.0`                    | `^3.0, ^2.7`                         |
 
 ## Documentation
 
diff --git a/Resources/config/services.yml b/Resources/config/services.yml
@@ -23,7 +23,7 @@ services:
     es.annotations.cached_reader:
         class: 'Doctrine\Common\Annotations\CachedReader'
         public: true
-        arguments: ["@annotations.reader", "@es.cache_engine", "%kernel.debug%"]
+        arguments: ["@es.annotations.reader", "@es.cache_engine", "%kernel.debug%"]
 
     es.document_finder:
         class: 'ONGR\ElasticsearchBundle\Mapping\DocumentFinder'
diff --git a/Test/AbstractElasticsearchTestCase.php b/Test/AbstractElasticsearchTestCase.php
@@ -169,7 +169,7 @@ protected function doTearDown()
      *
      * @return ContainerInterface
      */
-    protected static function getContainer(): ContainerInterface
+    protected static function getKernelContainer(): ContainerInterface
     {
         if (null === self::$container) {
             self::bootKernel();
@@ -197,9 +197,9 @@ protected function getManager($name = 'default')
             $this->ignoreVersions($this->managers[$name]);
 
             return $this->managers[$name];
-        } elseif ($this->getContainer()->has($serviceName)) {
+        } elseif ($this->getKernelContainer()->has($serviceName)) {
             /** @var Manager $manager */
-            $manager = $this->getContainer()->get($serviceName);
+            $manager = $this->getKernelContainer()->get($serviceName);
             $this->managers[$name] = $manager;
         } else {
             throw new \LogicException(sprintf("Manager '%s' does not exist", $name));
diff --git a/Tests/Functional/Command/CreateIndexCommandTest.php b/Tests/Functional/Command/CreateIndexCommandTest.php
@@ -186,7 +186,7 @@ public function testIndexMappingDump()
     private function getCommandTester()
     {
         $indexCreateCommand = new IndexCreateCommand(
-            $this->getContainer()->get('es.client.index_suffix_finder'),
+            $this->getKernelContainer()->get('es.client.index_suffix_finder'),
             ['es.manager.default' => $this->getManager()]
         );
 
diff --git a/Tests/Functional/Command/IndexExportCommandTest.php b/Tests/Functional/Command/IndexExportCommandTest.php
@@ -163,7 +163,7 @@ public function testIndexExport($options, $expectedResults)
     private function getCommandTester()
     {
         $indexExportCommand = new IndexExportCommand(
-            $this->getContainer()->get('es.export'),
+            $this->getKernelContainer()->get('es.export'),
             ['es.manager.default' => $this->getManager()]
         );
 
diff --git a/Tests/Functional/Command/IndexImportCommandTest.php b/Tests/Functional/Command/IndexImportCommandTest.php
@@ -143,7 +143,7 @@ public function testIndexImportWithGzipOption($bulkSize, $realSize, $filename)
     private function getImportCommand()
     {
         return new IndexImportCommand(
-            $this->getContainer()->get('es.import'),
+            $this->getKernelContainer()->get('es.import'),
             ['es.manager.default' => $this->getManager()]
         );
     }
diff --git a/Tests/Functional/Mapping/DocumentFinderTest.php b/Tests/Functional/Mapping/DocumentFinderTest.php
@@ -14,6 +14,7 @@
 use ONGR\ElasticsearchBundle\Mapping\DocumentFinder;
 use ONGR\ElasticsearchBundle\Tests\WebTestCase;
 use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Container;
 
 class DocumentFinderTest extends WebTestCase
 {
@@ -22,7 +23,7 @@ class DocumentFinderTest extends WebTestCase
      */
     public function testGetBundleDocumentClasses()
     {
-        $finder = new DocumentFinder($this->getContainer()->getParameter('kernel.bundles'));
+        $finder = new DocumentFinder($this->getClientContainer()->getParameter('kernel.bundles'));
         $this->assertGreaterThan(0, count($finder->getBundleDocumentClasses('TestBundle')));
         $this->assertEquals(0, count($finder->getBundleDocumentClasses('FrameworkBundle')));
     }
@@ -35,7 +36,7 @@ public function testGetBundleClassException()
         $this->expectException(\LogicException::class);
         $this->expectExceptionMessage('Bundle \'NotExistingBundle\' does not exist.');
 
-        $finder = new DocumentFinder($this->getContainer()->getParameter('kernel.bundles'));
+        $finder = new DocumentFinder($this->getClientContainer()->getParameter('kernel.bundles'));
         $finder->getBundleClass('NotExistingBundle');
     }
 
@@ -44,7 +45,7 @@ public function testGetBundleClassException()
      *
      * @return ContainerInterface
      */
-    protected static function getContainer(): ContainerInterface
+    protected static function getClientContainer(): ContainerInterface
     {
         return static::createClient()->getContainer();
     }
diff --git a/Tests/Functional/Profiler/ElasticsearchProfilerTest.php b/Tests/Functional/Profiler/ElasticsearchProfilerTest.php
@@ -172,7 +172,7 @@ public function checkQueryParameters(&$query)
      */
     private function getCollector()
     {
-        $collector = $this->getContainer()->get('es.profiler');
+        $collector = $this->getKernelContainer()->get('es.profiler');
         $collector->collect(new Request(), new Response());
 
         return $collector;
diff --git a/Tests/Unit/DependencyInjection/Compiler/MappingPassTest.php b/Tests/Unit/DependencyInjection/Compiler/MappingPassTest.php
@@ -15,6 +15,7 @@
 use ONGR\ElasticsearchBundle\DependencyInjection\Compiler\RepositoryPass;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\Alias;
+use Symfony\Component\DependencyInjection\Definition;
 
 /**
  * Unit tests for MappingPass.
@@ -105,7 +106,7 @@ function ($parameter) use ($metadataCollectorMock) {
                 [$this->equalTo('es.manager.default')],
                 [$this->equalTo('es.manager.default.product')]
             )
-            ->willReturn(null);
+            ->willReturn(new Definition());
 
         $containerMock
             ->expects($this->exactly(1))
diff --git a/composer.json b/composer.json
diff --git a/phpunit.xml.dist b/phpunit.xml.dist

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function __construct(array $managers, $name = null)`
`34`	`34`	`/**`
`35`	`35`	`* {@inheritdoc}`
`36`	`36`	`*/`
`37`		`- protected function configure()`
	`37`	`+ protected function configure(): void`
`38`	`38`	`{`
`39`	`39`	`$this->addOption(`
`40`	`40`	`'manager',`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class Configuration implements ConfigurationInterface`
`23`	`23`	`/**`
`24`	`24`	`* {@inheritdoc}`
`25`	`25`	`*/`
`26`		`- public function getConfigTreeBuilder()`
	`26`	`+ public function getConfigTreeBuilder(): TreeBuilder`
`27`	`27`	`{`
`28`	`28`	`$treeBuilder = new TreeBuilder('ongr_elasticsearch');`
`29`	`29`