fix(symfony): Solve SF 7 deprecation (#190)

VincentLanglet · web-flow · commit 6e04fd75a825 · 2024-08-12T11:56:26.000+02:00
diff --git a/composer.json b/composer.json
@@ -53,7 +53,8 @@
     "config": {
         "sort-packages": true,
         "allow-plugins": {
-            "symfony/flex": true
+            "symfony/flex": true,
+            "php-http/discovery": true
         }
     }
 }
diff --git a/src/Bridge/Symfony/DependencyInjection/Configuration.php b/src/Bridge/Symfony/DependencyInjection/Configuration.php
@@ -108,7 +108,7 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->validate()
                 ->ifTrue(fn (array $config): bool => $config['default_connection'] && !\array_key_exists($config['default_connection'], $config['connections']))
                 ->then(function (array $v) {
-                    throw new InvalidConfigurationException(sprintf('The default connection "%s" does not exists. Available connections are: "%s".', $v['default_connection'], implode('", "', array_keys($v['connections']))));
+                    throw new InvalidConfigurationException(\sprintf('The default connection "%s" does not exists. Available connections are: "%s".', $v['default_connection'], implode('", "', array_keys($v['connections']))));
                 })
             ->end()
         ;
diff --git a/src/Bridge/Symfony/DependencyInjection/ElasticallyExtension.php b/src/Bridge/Symfony/DependencyInjection/ElasticallyExtension.php
@@ -18,9 +18,9 @@
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
-use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 class ElasticallyExtension extends Extension
 {
diff --git a/src/IndexBuilder.php b/src/IndexBuilder.php
@@ -40,11 +40,11 @@ public function createIndex(string $indexName, array $context = []): Index
     {
         $mapping = $this->mappingProvider->provideMapping($indexName, $context);
 
-        $realName = sprintf('%s_%s', $indexName, date('Y-m-d-His'));
+        $realName = \sprintf('%s_%s', $indexName, date('Y-m-d-His'));
         $index = $this->client->getIndex($realName);
 
         if ($index->exists()) {
-            throw new RuntimeException(sprintf('Index "%s" is already created, something is wrong.', $index->getName()));
+            throw new RuntimeException(\sprintf('Index "%s" is already created, something is wrong.', $index->getName()));
         }
 
         $index->create($mapping ?? []);
@@ -97,7 +97,7 @@ public function migrate(Index $currentIndex, array $params = [], array $context
         $response = $reindex->run();
 
         if (!$response->isOk()) {
-            throw new RuntimeException(sprintf('Reindex call failed. %s', $response->getError()));
+            throw new RuntimeException(\sprintf('Reindex call failed. %s', $response->getError()));
         }
 
         $taskId = $response->getData()['task'];
@@ -172,14 +172,14 @@ public function purgeOldIndices(string $indexName, bool $dryRun = false): array
                     $index = new \Elastica\Index($this->client, $realIndexName);
                     $index->delete();
                 }
-                $operations[] = sprintf('%s deleted.', $realIndexName);
+                $operations[] = \sprintf('%s deleted.', $realIndexName);
             } elseif ($livePassed && 1 === $afterLiveCounter) {
                 // Close
                 if (false === $dryRun) {
                     $index = new \Elastica\Index($this->client, $realIndexName);
                     $index->close();
                 }
-                $operations[] = sprintf('%s closed.', $realIndexName);
+                $operations[] = \sprintf('%s closed.', $realIndexName);
             }
         }
 
diff --git a/src/IndexNameMapper.php b/src/IndexNameMapper.php
@@ -28,7 +28,7 @@ public function __construct(?string $prefix, array $indexClassMapping)
     public function getPrefixedIndex(string $name): string
     {
         if ($this->prefix) {
-            return sprintf('%s_%s', $this->prefix, $name);
+            return \sprintf('%s_%s', $this->prefix, $name);
         }
 
         return $name;
@@ -42,7 +42,7 @@ public function getIndexNameFromClass(string $className): string
         $indexName = array_search($className, $this->indexClassMapping, true);
 
         if (!$indexName) {
-            throw new RuntimeException(sprintf('The given type (%s) does not exist in the configuration.', $className));
+            throw new RuntimeException(\sprintf('The given type (%s) does not exist in the configuration.', $className));
         }
 
         return $this->getPrefixedIndex($indexName);
@@ -54,7 +54,7 @@ public function getIndexNameFromClass(string $className): string
     public function getClassFromIndexName(string $indexName): string
     {
         if (!isset($this->indexClassMapping[$indexName])) {
-            throw new RuntimeException(sprintf('Unknown class for index "%s". Please check your configuration.', $indexName));
+            throw new RuntimeException(\sprintf('Unknown class for index "%s". Please check your configuration.', $indexName));
         }
 
         return $this->indexClassMapping[$indexName];
@@ -63,7 +63,7 @@ public function getClassFromIndexName(string $indexName): string
     public function getPureIndexName(string $fullIndexName): string
     {
         if ($this->prefix) {
-            $pattern = sprintf('/%s_(.+)_\d{4}-\d{2}-\d{2}-\d+/i', preg_quote($this->prefix, '/'));
+            $pattern = \sprintf('/%s_(.+)_\d{4}-\d{2}-\d{2}-\d+/i', preg_quote($this->prefix, '/'));
         } else {
             $pattern = '/(.+)_\d{4}-\d{2}-\d{2}-\d+/i';
         }
diff --git a/src/Mapping/PhpProvider.php b/src/Mapping/PhpProvider.php
@@ -29,7 +29,7 @@ public function provideMapping(string $indexName, array $context = []): ?array
         $fileName = $context['filename'] ?? ($indexName . '_mapping.php');
         $mappingFilePath = $this->configurationDirectory . \DIRECTORY_SEPARATOR . $fileName;
         if (!is_file($mappingFilePath)) {
-            throw new InvalidException(sprintf('Mapping file "%s" not found.', $mappingFilePath));
+            throw new InvalidException(\sprintf('Mapping file "%s" not found.', $mappingFilePath));
         }
 
         $mapping = require $mappingFilePath;
diff --git a/src/Mapping/YamlProvider.php b/src/Mapping/YamlProvider.php
@@ -34,7 +34,7 @@ public function provideMapping(string $indexName, array $context = []): ?array
         $fileName = $context['filename'] ?? ($indexName . '_mapping.yaml');
         $mappingFilePath = $this->configurationDirectory . \DIRECTORY_SEPARATOR . $fileName;
         if (!is_file($mappingFilePath)) {
-            throw new InvalidException(sprintf('Mapping file "%s" not found. Please check your configuration.', $mappingFilePath));
+            throw new InvalidException(\sprintf('Mapping file "%s" not found. Please check your configuration.', $mappingFilePath));
         }
 
         $mapping = $this->parser->parseFile($mappingFilePath);
diff --git a/src/Messenger/IndexationRequest.php b/src/Messenger/IndexationRequest.php
@@ -20,7 +20,7 @@ final class IndexationRequest implements IndexationRequestInterface
     public function __construct(string $className, string $id, string $operation = IndexationRequestHandler::OP_INDEX)
     {
         if (!\in_array($operation, IndexationRequestHandler::OPERATIONS, true)) {
-            throw new \InvalidArgumentException(sprintf('Not supported operation "%s" given.', $operation));
+            throw new \InvalidArgumentException(\sprintf('Not supported operation "%s" given.', $operation));
         }
 
         $this->className = $className;
diff --git a/tests/Symfony/TestKernel.php b/tests/Symfony/TestKernel.php
@@ -57,10 +57,10 @@ protected function configureRoutes($routes): void
             $routes->add('/with_response', TestController::class . '::withResponse', 'with_response');
         } else {
             $routeConfigurator = $routes->add('with_exception', '/with_exception');
-            $routeConfigurator->controller(sprintf('%s::withException', TestController::class));
+            $routeConfigurator->controller(\sprintf('%s::withException', TestController::class));
 
             $routeConfigurator = $routes->add('with_response', '/with_response');
-            $routeConfigurator->controller(sprintf('%s::withResponse', TestController::class));
+            $routeConfigurator->controller(\sprintf('%s::withResponse', TestController::class));
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,8 @@`
`53`	`53`	`"config": {`
`54`	`54`	`"sort-packages": true,`
`55`	`55`	`"allow-plugins": {`
`56`		`- "symfony/flex": true`
	`56`	`+ "symfony/flex": true,`
	`57`	`+ "php-http/discovery": true`
`57`	`58`	`}`
`58`	`59`	`}`
`59`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ public function getConfigTreeBuilder(): TreeBuilder`
`108`	`108`	`->validate()`
`109`	`109`	`->ifTrue(fn (array $config): bool => $config['default_connection'] && !\array_key_exists($config['default_connection'], $config['connections']))`
`110`	`110`	`->then(function (array $v) {`
`111`		`- throw new InvalidConfigurationException(sprintf('The default connection "%s" does not exists. Available connections are: "%s".', $v['default_connection'], implode('", "', array_keys($v['connections']))));`
	`111`	`+ throw new InvalidConfigurationException(\sprintf('The default connection "%s" does not exists. Available connections are: "%s".', $v['default_connection'], implode('", "', array_keys($v['connections']))));`
`112`	`112`	`})`
`113`	`113`	`->end()`
`114`	`114`	`;`
Original file line number	Diff line number	Diff line change
`@@ -40,11 +40,11 @@ public function createIndex(string $indexName, array $context = []): Index`
`40`	`40`	`{`
`41`	`41`	`$mapping = $this->mappingProvider->provideMapping($indexName, $context);`
`42`	`42`
`43`		`- $realName = sprintf('%s_%s', $indexName, date('Y-m-d-His'));`
	`43`	`+ $realName = \sprintf('%s_%s', $indexName, date('Y-m-d-His'));`
`44`	`44`	`$index = $this->client->getIndex($realName);`
`45`	`45`
`46`	`46`	`if ($index->exists()) {`
`47`		`- throw new RuntimeException(sprintf('Index "%s" is already created, something is wrong.', $index->getName()));`
	`47`	`+ throw new RuntimeException(\sprintf('Index "%s" is already created, something is wrong.', $index->getName()));`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`$index->create($mapping ?? []);`
`@@ -97,7 +97,7 @@ public function migrate(Index $currentIndex, array $params = [], array $context`
`97`	`97`	`$response = $reindex->run();`
`98`	`98`
`99`	`99`	`if (!$response->isOk()) {`
`100`		`- throw new RuntimeException(sprintf('Reindex call failed. %s', $response->getError()));`
	`100`	`+ throw new RuntimeException(\sprintf('Reindex call failed. %s', $response->getError()));`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`$taskId = $response->getData()['task'];`
`@@ -172,14 +172,14 @@ public function purgeOldIndices(string $indexName, bool $dryRun = false): array`
`172`	`172`	`$index = new \Elastica\Index($this->client, $realIndexName);`
`173`	`173`	`$index->delete();`
`174`	`174`	`}`
`175`		`- $operations[] = sprintf('%s deleted.', $realIndexName);`
	`175`	`+ $operations[] = \sprintf('%s deleted.', $realIndexName);`
`176`	`176`	`} elseif ($livePassed && 1 === $afterLiveCounter) {`
`177`	`177`	`// Close`
`178`	`178`	`if (false === $dryRun) {`
`179`	`179`	`$index = new \Elastica\Index($this->client, $realIndexName);`
`180`	`180`	`$index->close();`
`181`	`181`	`}`
`182`		`- $operations[] = sprintf('%s closed.', $realIndexName);`
	`182`	`+ $operations[] = \sprintf('%s closed.', $realIndexName);`
`183`	`183`	`}`
`184`	`184`	`}`
`185`	`185`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function __construct(?string $prefix, array $indexClassMapping)`
`28`	`28`	`public function getPrefixedIndex(string $name): string`
`29`	`29`	`{`
`30`	`30`	`if ($this->prefix) {`
`31`		`- return sprintf('%s_%s', $this->prefix, $name);`
	`31`	`+ return \sprintf('%s_%s', $this->prefix, $name);`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`return $name;`
`@@ -42,7 +42,7 @@ public function getIndexNameFromClass(string $className): string`
`42`	`42`	`$indexName = array_search($className, $this->indexClassMapping, true);`
`43`	`43`
`44`	`44`	`if (!$indexName) {`
`45`		`- throw new RuntimeException(sprintf('The given type (%s) does not exist in the configuration.', $className));`
	`45`	`+ throw new RuntimeException(\sprintf('The given type (%s) does not exist in the configuration.', $className));`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`return $this->getPrefixedIndex($indexName);`
`@@ -54,7 +54,7 @@ public function getIndexNameFromClass(string $className): string`
`54`	`54`	`public function getClassFromIndexName(string $indexName): string`
`55`	`55`	`{`
`56`	`56`	`if (!isset($this->indexClassMapping[$indexName])) {`
`57`		`- throw new RuntimeException(sprintf('Unknown class for index "%s". Please check your configuration.', $indexName));`
	`57`	`+ throw new RuntimeException(\sprintf('Unknown class for index "%s". Please check your configuration.', $indexName));`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`return $this->indexClassMapping[$indexName];`
`@@ -63,7 +63,7 @@ public function getClassFromIndexName(string $indexName): string`
`63`	`63`	`public function getPureIndexName(string $fullIndexName): string`
`64`	`64`	`{`
`65`	`65`	`if ($this->prefix) {`
`66`		`- $pattern = sprintf('/%s_(.+)_\d{4}-\d{2}-\d{2}-\d+/i', preg_quote($this->prefix, '/'));`
	`66`	`+ $pattern = \sprintf('/%s_(.+)_\d{4}-\d{2}-\d{2}-\d+/i', preg_quote($this->prefix, '/'));`
`67`	`67`	`} else {`
`68`	`68`	`$pattern = '/(.+)_\d{4}-\d{2}-\d{2}-\d+/i';`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public function provideMapping(string $indexName, array $context = []): ?array`
`29`	`29`	`$fileName = $context['filename'] ?? ($indexName . '_mapping.php');`
`30`	`30`	`$mappingFilePath = $this->configurationDirectory . \DIRECTORY_SEPARATOR . $fileName;`
`31`	`31`	`if (!is_file($mappingFilePath)) {`
`32`		`- throw new InvalidException(sprintf('Mapping file "%s" not found.', $mappingFilePath));`
	`32`	`+ throw new InvalidException(\sprintf('Mapping file "%s" not found.', $mappingFilePath));`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`$mapping = require $mappingFilePath;`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function provideMapping(string $indexName, array $context = []): ?array`
`34`	`34`	`$fileName = $context['filename'] ?? ($indexName . '_mapping.yaml');`
`35`	`35`	`$mappingFilePath = $this->configurationDirectory . \DIRECTORY_SEPARATOR . $fileName;`
`36`	`36`	`if (!is_file($mappingFilePath)) {`
`37`		`- throw new InvalidException(sprintf('Mapping file "%s" not found. Please check your configuration.', $mappingFilePath));`
	`37`	`+ throw new InvalidException(\sprintf('Mapping file "%s" not found. Please check your configuration.', $mappingFilePath));`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`$mapping = $this->parser->parseFile($mappingFilePath);`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ final class IndexationRequest implements IndexationRequestInterface`
`20`	`20`	`public function __construct(string $className, string $id, string $operation = IndexationRequestHandler::OP_INDEX)`
`21`	`21`	`{`
`22`	`22`	`if (!\in_array($operation, IndexationRequestHandler::OPERATIONS, true)) {`
`23`		`- throw new \InvalidArgumentException(sprintf('Not supported operation "%s" given.', $operation));`
	`23`	`+ throw new \InvalidArgumentException(\sprintf('Not supported operation "%s" given.', $operation));`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`$this->className = $className;`
Original file line number	Diff line number	Diff line change
`@@ -57,10 +57,10 @@ protected function configureRoutes($routes): void`
`57`	`57`	`$routes->add('/with_response', TestController::class . '::withResponse', 'with_response');`
`58`	`58`	`} else {`
`59`	`59`	`$routeConfigurator = $routes->add('with_exception', '/with_exception');`
`60`		`- $routeConfigurator->controller(sprintf('%s::withException', TestController::class));`
	`60`	`+ $routeConfigurator->controller(\sprintf('%s::withException', TestController::class));`
`61`	`61`
`62`	`62`	`$routeConfigurator = $routes->add('with_response', '/with_response');`
`63`		`- $routeConfigurator->controller(sprintf('%s::withResponse', TestController::class));`
	`63`	`+ $routeConfigurator->controller(\sprintf('%s::withResponse', TestController::class));`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`	`}`