Fix #109: Improve the error message by displaying a name of the group where the error occurred when merging

devanych · web-flow · commit 3f0f7b425ee4 · 2022-01-06T01:27:14.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ## 1.1.1 under development
 
-- no changes in this release.
+- Enh #110: Improve the error message by displaying a name of the group where the error occurred when merging (devanych)
 
 ## 1.1.0 December 31, 2021
 
diff --git a/src/Merger.php b/src/Merger.php
@@ -142,7 +142,7 @@ private function performMerge(
                 );
 
                 if ($file !== null) {
-                    $this->throwDuplicateKeyErrorException($fullKeyPath, [$file, $context->file()]);
+                    $this->throwDuplicateKeyErrorException($context->group(), $fullKeyPath, [$file, $context->file()]);
                 }
             }
 
@@ -213,7 +213,7 @@ private function prepareArrayForReverse(
             );
 
             if ($file !== null) {
-                $this->throwDuplicateKeyErrorException($recursiveKeyPath, [$file, $context->file()]);
+                $this->throwDuplicateKeyErrorException($context->group(), $recursiveKeyPath, [$file, $context->file()]);
             }
 
             /** @var mixed */
@@ -250,13 +250,17 @@ private function setValue(Context $context, array $keyPath, array &$array, strin
     /**
      * Generates a duplicate key error message and throws an exception.
      *
+     * @param string $currentGroupName The name of the group that the error occurred when merging.
      * @param string[] $recursiveKeyPath The key path for recursive merging of arrays in configuration files.
      * @param string[] $absoluteFilePaths The absolute paths to the files in which duplicates are found.
      *
      * @throws ErrorException With a duplicate key error message.
      */
-    private function throwDuplicateKeyErrorException(array $recursiveKeyPath, array $absoluteFilePaths): void
-    {
+    private function throwDuplicateKeyErrorException(
+        string $currentGroupName,
+        array $recursiveKeyPath,
+        array $absoluteFilePaths
+    ): void {
         $filePaths = array_map(
             fn (string $filePath) => ' - ' . $this->paths->relative($filePath),
             $absoluteFilePaths,
@@ -269,8 +273,9 @@ private function throwDuplicateKeyErrorException(array $recursiveKeyPath, array
         });
 
         $message = sprintf(
-            "Duplicate key \"%s\" in configs:\n%s",
+            "Duplicate key \"%s\" in the following configs while building \"%s\" group:\n%s",
             implode(' => ', $recursiveKeyPath),
+            $currentGroupName,
             implode("\n", $filePaths),
         );
 
diff --git a/tests/ConfigTest.php b/tests/ConfigTest.php
@@ -344,7 +344,7 @@ public function testDuplicateRootKeysErrorMessage(): void
 
         $this->expectException(ErrorException::class);
         $this->expectErrorMessage(
-            'Duplicate key "age" in configs:' . "\n" .
+            'Duplicate key "age" in the following configs while building "params" group:' . "\n" .
             ' - config/params/a.php' . "\n" .
             ' - config/params/b.php'
         );
@@ -362,7 +362,7 @@ public function testDuplicateRootKeysErrorMessageWithReverseMerge(): void
 
         $this->expectException(ErrorException::class);
         $this->expectErrorMessage(
-            'Duplicate key "age" in configs:' . "\n" .
+            'Duplicate key "age" in the following configs while building "params" group:' . "\n" .
             ' - config/params/a.php' . "\n" .
             ' - config/params/b.php'
         );
@@ -378,7 +378,7 @@ public function testDuplicateEnvironmentKeysErrorMessage(): void
 
         $this->expectException(ErrorException::class);
         $this->expectErrorMessage(
-            'Duplicate key "age" in configs:' . "\n" .
+            'Duplicate key "age" in the following configs while building "params" group:' . "\n" .
             ' - config/environment/params/a.php' . "\n" .
             ' - config/environment/params/b.php'
         );
@@ -396,7 +396,7 @@ public function testDuplicateEnvironmentKeysErrorMessageWithReverseMerge(): void
 
         $this->expectException(ErrorException::class);
         $this->expectErrorMessage(
-            'Duplicate key "age" in configs:' . "\n" .
+            'Duplicate key "age" in the following configs while building "params" group:' . "\n" .
             ' - config/environment/params/a.php' . "\n" .
             ' - config/environment/params/b.php'
         );
@@ -409,7 +409,7 @@ public function testDuplicateVendorKeysErrorMessage(): void
 
         $this->expectException(ErrorException::class);
         $this->expectErrorMessage(
-            'Duplicate key "age" in configs:' . "\n" .
+            'Duplicate key "age" in the following configs while building "params" group:' . "\n" .
             ' - vendor/package/a/params.php' . "\n" .
             ' - vendor/package/b/params.php'
         );
@@ -427,7 +427,7 @@ public function testDuplicateVendorKeysErrorMessageWithReverseMerge(): void
 
         $this->expectException(ErrorException::class);
         $this->expectErrorMessage(
-            'Duplicate key "age" in configs:' . "\n" .
+            'Duplicate key "age" in the following configs while building "params" group:' . "\n" .
             ' - vendor/package/a/params.php' . "\n" .
             ' - vendor/package/b/params.php'
         );
@@ -444,7 +444,9 @@ public function testDuplicateKeysWithRecursiveKeyPathErrorMessage(): void
         );
 
         $this->expectException(ErrorException::class);
-        $this->expectErrorMessageMatches('~^Duplicate key "name => first-name" in~');
+        $this->expectErrorMessageMatches(
+            '~^Duplicate key "name => first-name" in the following configs while building "params" group~',
+        );
         $config->get('params');
     }
 
