Merge pull request #1663 from deguif/better-exception-messages

Improve exception messages

Author: XWB

src/Command/DeleteCommand.php

@@ -78,7 +78,7 @@ private function deleteIndex(string $indexName): void
             $path = sprintf('%s', $indexName);
             $this->client->request($path, Request::DELETE);
         } catch (ExceptionInterface $deleteOldIndexException) {
-            throw new \RuntimeException(sprintf('Failed to delete index %s with message: %s', $indexName, $deleteOldIndexException->getMessage()), 0, $deleteOldIndexException);
+            throw new \RuntimeException(sprintf('Failed to delete index "%s" with message: "%s"', $indexName, $deleteOldIndexException->getMessage()), 0, $deleteOldIndexException);
         }
     }
 }

src/Configuration/ConfigManager.php

@@ -34,7 +34,7 @@ public function __construct(array $sources)
     public function getIndexConfiguration(string $indexName): IndexConfigInterface
     {
         if (!$this->hasIndexConfiguration($indexName)) {
-            throw new \InvalidArgumentException(sprintf('Index with name "%s" is not configured.', $indexName));
+            throw new \InvalidArgumentException(sprintf('Index "%s" is not configured.', $indexName));
         }
 
         return $this->indexes[$indexName];

src/DependencyInjection/FOSElasticaExtension.php

@@ -319,7 +319,7 @@ private function buildCallback($indexCallback, $indexName)
     {
         if (is_array($indexCallback)) {
             if (!isset($indexCallback[0])) {
-                throw new \InvalidArgumentException(sprintf('Invalid indexable_callback for index %s', $indexName));
+                throw new \InvalidArgumentException(sprintf('Invalid indexable_callback for index "%s"', $indexName));
             }
 
             $classOrServiceRef = $this->transformServiceReference($indexCallback[0]);
@@ -328,7 +328,7 @@ private function buildCallback($indexCallback, $indexName)
             }
 
             if (!isset($indexCallback[1])) {
-                throw new \InvalidArgumentException(sprintf('Invalid indexable_callback for index %s', $indexName));
+                throw new \InvalidArgumentException(sprintf('Invalid indexable_callback for index "%s"', $indexName));
             }
 
             return [$classOrServiceRef, $indexCallback[1]];
@@ -338,7 +338,7 @@ private function buildCallback($indexCallback, $indexName)
             return $this->transformServiceReference($indexCallback);
         }
 
-        throw new \InvalidArgumentException(sprintf('Invalid indexable_callback for index %s', $indexName));
+        throw new \InvalidArgumentException(sprintf('Invalid indexable_callback for index "%s"', $indexName));
     }
 
     private function transformServiceReference($classOrService)

src/Exception/AliasIsIndexException.php

@@ -15,6 +15,6 @@ class AliasIsIndexException extends \Exception
 {
     public function __construct(string $indexName)
     {
-        parent::__construct(sprintf('Expected %s to be an alias but it is an index.', $indexName));
+        parent::__construct(sprintf('Expected "%s" to be an alias but it is an index.', $indexName));
     }
 }

src/Index/AliasProcessor.php

@@ -142,7 +142,7 @@ private function deleteIndex(Client $client, $indexName)
             $path = sprintf('%s', $indexName);
             $client->request($path, Request::DELETE);
         } catch (ExceptionInterface $deleteOldIndexException) {
-            throw new \RuntimeException(sprintf('Failed to delete index %s with message: %s', $indexName, $deleteOldIndexException->getMessage()), 0, $deleteOldIndexException);
+            throw new \RuntimeException(sprintf('Failed to delete index "%s" with message: "%s"', $indexName, $deleteOldIndexException->getMessage()), 0, $deleteOldIndexException);
         }
     }
 
@@ -157,7 +157,7 @@ private function closeIndex(Client $client, $indexName)
             $path = sprintf('%s/_close', $indexName);
             $client->request($path, Request::POST);
         } catch (ExceptionInterface $e) {
-            throw new \RuntimeException(sprintf('Failed to close index %s with message: %s', $indexName, $e->getMessage()), 0, $e);
+            throw new \RuntimeException(sprintf('Failed to close index "%s" with message: "%s"', $indexName, $e->getMessage()), 0, $e);
         }
     }
 
@@ -191,7 +191,7 @@ private function getAliasedIndex(Client $client, $aliasName)
         }
 
         if (count($aliasedIndexes) > 1) {
-            throw new \RuntimeException(sprintf('Alias %s is used for multiple indexes: [%s]. Make sure it\'s'.'either not used or is assigned to one index only', $aliasName, implode(', ', $aliasedIndexes)));
+            throw new \RuntimeException(sprintf('Alias "%s" is used for multiple indexes: ["%s"]. Make sure it\'s'.'either not used or is assigned to one index only', $aliasName, implode('", "', $aliasedIndexes)));
         }
 
         return array_shift($aliasedIndexes);

src/Manager/RepositoryManager.php

@@ -53,7 +53,7 @@ public function getRepository(string $indexName): Repository
         }
 
         if (!$this->hasRepository($indexName)) {
-            throw new \RuntimeException(sprintf('No repository configured for %s', $indexName));
+            throw new \RuntimeException(sprintf('No repository is configured for index "%s"', $indexName));
         }
 
         $repository = $this->createRepository($indexName);
@@ -82,7 +82,7 @@ protected function getRepositoryName(string $indexName): string
     private function createRepository(string $indexName)
     {
         if (!class_exists($repositoryName = $this->getRepositoryName($indexName))) {
-            throw new \RuntimeException(sprintf('%s repository for %s does not exist', $repositoryName, $indexName));
+            throw new \RuntimeException(sprintf('%s repository for index "%s" does not exist', $repositoryName, $indexName));
         }
 
         return new $repositoryName($this->indexes[$indexName]['finder']);