Expand references

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - New #155: Add ability to specify recursion depth for recursive modifier (@vjik)
 - Enh #157: Remove unnecessary code in `PackagesListBuilder` (@vjik)
+- Bug #153: Do not throw "Duplicate key…" exception when using nested groups (@vjik)
 
 ## 1.4.0 November 17, 2023
 

src/Composer/MergePlanCollector.php

@@ -0,0 +1,180 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Config\Composer;
+
+use ErrorException;
+use Yiisoft\Config\MergePlan;
+use Yiisoft\Config\Options;
+
+use function in_array;
+
+/**
+ * @internal
+ *
+ * @psalm-import-type FileType from MergePlan
+ * @psalm-import-type MergePlanType from MergePlan
+ */
+final class MergePlanCollector
+{
+    private const PACKAGES_ORDER = [
+        Options::VENDOR_OVERRIDE_PACKAGE_NAME => 1,
+        Options::ROOT_PACKAGE_NAME => 2,
+    ];
+
+    /**
+     * @psalm-var array<string, array<string, list<FileType>>>
+     */
+    private array $mergePlan = [];
+
+    /**
+     * @psalm-var array<string,true|null>
+     */
+    private array $processedGroups = [];
+
+    /**
+     * Adds an item to the merge plan.
+     *
+     * @param array|string $file The config file.
+     * @param string $package The package name.
+     * @param string $group The group name.
+     *
+     * @psalm-param array{0:string,1:string}|string $file
+     */
+    public function add(array|string $file, string $package, string $group): void
+    {
+        $this->mergePlan[$group][$package][] = $file;
+    }
+
+    /**
+     * Adds a multiple items to the merge plan.
+     *
+     * @param array $files The config files.
+     * @param string $package The package name.
+     * @param string $group The group name.
+     *
+     * @psalm-param list<string|array{0:string,1:string}> $files
+     */
+    public function addMultiple(
+        array $files,
+        string $package,
+        string $group,
+    ): void {
+        $this->mergePlan[$group][$package] = $files;
+    }
+
+    /**
+     * Add empty group if it doesn't exist.
+     *
+     * @param string $group The group name.
+     */
+    public function addGroup(string $group): void
+    {
+        if (!isset($this->mergePlan[$group])) {
+            $this->mergePlan[$group] = [];
+        }
+    }
+
+    /**
+     * Returns the merge plan as an array.
+     *
+     * @psalm-return MergePlanType
+     */
+    public function asArray(): array
+    {
+        $groups = [];
+        foreach ($this->mergePlan as $group => $packages) {
+            $groups[$group] = $this->expandVariablesInPackages($packages);
+        }
+
+        $environments = [];
+        foreach ($groups as $packages) {
+            foreach ($packages as $files) {
+                foreach ($files as $file) {
+                    if (is_array($file)) {
+                        $environments[$file[0]] = true;
+                    }
+                }
+            }
+        }
+
+        return [
+            'groups' => $groups,
+            'environments' => array_keys($environments),
+        ];
+    }
+
+    /**
+     * @throws ErrorException
+     *
+     * @psalm-param array<string, list<FileType>> $packages
+     * @psalm-return array<string, list<FileType>>
+     */
+    private function expandVariablesInPackages(array $packages, ?string $targetGroup = null): array
+    {
+        if ($targetGroup !== null) {
+            if (!isset($this->mergePlan[$targetGroup])) {
+                throw new ErrorException(
+                    sprintf('The "%s" configuration group does not exist.', $targetGroup),
+                    severity: E_USER_ERROR
+                );
+            }
+
+            if (isset($this->processedGroups[$targetGroup])) {
+                throw new ErrorException('Circular references in configuration.', severity: E_USER_ERROR);
+            }
+            $this->processedGroups[$targetGroup] = true;
+            $groupPackages = $this->expandVariablesInPackages($this->mergePlan[$targetGroup]);
+            $this->processedGroups[$targetGroup] = null;
+
+            $variable = '$' . $targetGroup;
+            foreach ($groupPackages as $groupPackage => $groupItems) {
+                $packageItems = $packages[$groupPackage] ?? [];
+                $packages[$groupPackage] = in_array($variable, $packageItems, true)
+                    ? $this->replaceVariableToFiles($packageItems, $variable, $groupItems)
+                    : array_merge($packageItems, $groupItems);
+            }
+            foreach ($packages as $package => $items) {
+                $packages[$package] = array_values(
+                    array_filter(
+                        $items,
+                        static fn($item) => $item !== $variable,
+                    )
+                );
+            }
+            uksort(
+                $packages,
+                static fn(string $a, string $b) => (self::PACKAGES_ORDER[$a] ?? 0) <=> (self::PACKAGES_ORDER[$b] ?? 0),
+            );
+        }
+
+        foreach ($packages as $items) {
+            foreach ($items as $item) {
+                if (!is_array($item) && Options::isVariable($item)) {
+                    return $this->expandVariablesInPackages($packages, substr($item, 1));
+                }
+            }
+        }
+
+        return $packages;
+    }
+
+    /**
+     * @psalm-param list<FileType> $items
+     * @psalm-param list<FileType> $files
+     * @psalm-return list<FileType>
+     */
+    private function replaceVariableToFiles(array $items, string $variable, array $files): array
+    {
+        $result = [];
+        foreach ($items as $item) {
+            if ($item === $variable) {
+                $result = array_merge($result, $files);
+            } else {
+                $result[] = $item;
+            }
+        }
+        return $result;
+    }
+}

src/Composer/MergePlanProcess.php

@@ -7,7 +7,6 @@
 use Composer\Composer;
 use Composer\Package\PackageInterface;
 use Composer\Util\Filesystem;
-use Yiisoft\Config\MergePlan;
 use Yiisoft\Config\Options;
 use Yiisoft\VarDumper\VarDumper;
 
@@ -24,15 +23,15 @@
  */
 final class MergePlanProcess
 {
-    private MergePlan $mergePlan;
+    private MergePlanCollector $mergePlanCollector;
     private ProcessHelper $helper;
 
     /**
      * @param Composer $composer The composer instance.
      */
     public function __construct(Composer $composer)
     {
-        $this->mergePlan = new MergePlan();
+        $this->mergePlanCollector = new MergePlanCollector();
         $this->helper = new ProcessHelper($composer);
 
         if (!$this->helper->shouldBuildMergePlan()) {
@@ -43,7 +42,6 @@
         $this->addPackagesConfigsToMergePlan(true);
 
         $this->addRootPackageConfigToMergePlan();
-        $this->addEnvironmentsConfigsToMergePlan();
 
         $this->updateMergePlan();
     }
@@ -57,32 +55,32 @@
             $packageName = $isVendorOverrideLayer ? Options::VENDOR_OVERRIDE_PACKAGE_NAME : $name;
 
             foreach ($this->helper->getPackageConfig($package) as $group => $files) {
-                $this->mergePlan->addGroup($group);
+                $this->mergePlanCollector->addGroup($group);
 
                 foreach ((array) $files as $file) {
                     $isOptional = false;
 
                     if (Options::isOptional($file)) {
                         $isOptional = true;
                         $file = substr($file, 1);
                     }
 
                     if (Options::isVariable($file)) {
-                        $this->mergePlan->add($file, $packageName, $group);
+                        $this->mergePlanCollector->add($file, $packageName, $group);
                         continue;
                     }
 
                     $absoluteFilePath = $this->helper->getAbsolutePackageFilePath($package, $options, $file);
 
                     if (Options::containsWildcard($file)) {
                         $matches = glob($absoluteFilePath);
 
                         if (empty($matches)) {
                             continue;
                         }
 
                         foreach ($matches as $match) {
-                            $this->mergePlan->add(
+                            $this->mergePlanCollector->add(
                                 $this->normalizePackageFilePath($package, $match, $isVendorOverrideLayer),
                                 $packageName,
                                 $group,
@@ -96,7 +94,7 @@
                         continue;
                     }
 
-                    $this->mergePlan->add(
+                    $this->mergePlanCollector->add(
                         $this->normalizePackageFilePath($package, $absoluteFilePath, $isVendorOverrideLayer),
                         $packageName,
                         $group,
@@ -109,40 +107,17 @@
     private function addRootPackageConfigToMergePlan(): void
     {
         foreach ($this->helper->getRootPackageConfig() as $group => $files) {
-            $this->mergePlan->addMultiple(
+            $this->mergePlanCollector->addMultiple(
                 (array) $files,
                 Options::ROOT_PACKAGE_NAME,
                 $group,
             );
         }
     }
 
-    private function addEnvironmentsConfigsToMergePlan(): void
-    {
-        foreach ($this->helper->getEnvironmentConfig() as $environment => $groups) {
-            if ($environment === Options::DEFAULT_ENVIRONMENT) {
-                continue;
-            }
-
-            if (empty($groups)) {
-                $this->mergePlan->addEnvironmentWithoutConfigs($environment);
-                continue;
-            }
-
-            foreach ($groups as $group => $files) {
-                $this->mergePlan->addMultiple(
-                    (array) $files,
-                    Options::ROOT_PACKAGE_NAME,
-                    $group,
-                    $environment,
-                );
-            }
-        }
-    }
-
     private function updateMergePlan(): void
     {
-        $mergePlan = $this->mergePlan->toArray();
+        $mergePlan = $this->mergePlanCollector->asArray();
         ksort($mergePlan);
 
         $filePath = $this->helper->getPaths()->absolute(

src/Composer/ProcessHelper.php

@@ -190,19 +190,6 @@ public function getRootPackageConfig(): array
         return (array) ($this->rootPackageExtra['config-plugin'] ?? []);
     }
 
-    /**
-     * Returns the environment configuration.
-     *
-     * @return array The environment configuration.
-     *
-     * @psalm-return array<string, array<string, string|string[]>>
-     * @psalm-suppress MixedReturnTypeCoercion
-     */
-    public function getEnvironmentConfig(): array
-    {
-        return (array) ($this->rootPackageExtra['config-plugin-environments'] ?? []);
-    }
-
     /**
      * Returns the config paths instance.
      *

src/Config.php

@@ -11,7 +11,6 @@
 use function restore_error_handler;
 use function set_error_handler;
 use function sprintf;
-use function substr;
 
 /**
  * Config takes merge plan prepared by {@see \Yiisoft\Config\Composer\EventHandler}
@@ -39,17 +38,14 @@ final class Config implements ConfigInterface
      */
     public function __construct(
         ConfigPaths $paths,
-        string $environment = null,
+        ?string $environment = null,
         array $modifiers = [],
         private ?string $paramsGroup = 'params',
         string $mergePlanFile = Options::DEFAULT_MERGE_PLAN_FILE,
     ) {
-        $environment = empty($environment) ? Options::DEFAULT_ENVIRONMENT : $environment;
+        $mergePlan = new MergePlan($paths->absolute($mergePlanFile));
 
-        /** @psalm-suppress UnresolvableInclude, MixedArgument */
-        $mergePlan = new MergePlan(require $paths->absolute($mergePlanFile));
-
-        if (!$mergePlan->hasEnvironment($environment)) {
+        if ($environment !== null && !$mergePlan->hasEnvironment($environment)) {
             $this->throwException(sprintf('The "%s" configuration environment does not exist.', $environment));
         }
 
@@ -117,46 +113,14 @@ private function buildGroup(string $group): void
         $this->build[$group] = [];
 
         foreach ($this->filesExtractor->extract($group) as $file => $context) {
-            if (Options::isVariable($file)) {
-                $variable = $this->prepareVariable($file, $group);
-                $array = $this->get($variable);
-            } else {
-                $array = $this->buildFile($file);
-            }
-
             $this->build[$group] = $this->merger->merge(
                 $context,
                 $this->build[$group],
-                $array,
+                $this->buildFile($file),
             );
         }
     }
 
-    /**
-     * Checks the configuration variable and returns its name.
-     *
-     * @param string $variable The variable.
-     * @param string $group The group name.
-     *
-     * @throws ErrorException If the variable name is not valid.
-     *
-     * @return string The variable name.
-     */
-    private function prepareVariable(string $variable, string $group): string
-    {
-        $name = substr($variable, 1);
-
-        if ($name === $group) {
-            $this->throwException(sprintf(
-                'The variable "%s" must not be located inside the "%s" config group.',
-                "$variable",
-                "$name",
-            ));
-        }
-
-        return $name;
-    }
-
     /**
      * Builds the configuration from the file.
      *