Skip to content

[DockerComposeConfigurator] Fix duplicate top-level key on reconfigure #1090

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicolas-grekas merged 1 commit into from
May 29, 2026
+33 −2
Merged

[DockerComposeConfigurator] Fix duplicate top-level key on reconfigure #1090

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/Configurator/DockerComposeConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,13 @@ private function configureDockerCompose(Recipe $recipe, array $config, bool $upd
// Keep end in memory (check break line on previous line)
if (null !== $node) {
$endAt[$node] = !$i || '' !== trim($lines[$i - 1]) ? $i : $i - 1;
// Prune nodesLines[old node] to match the range the splice will replace.
if (isset($nodesLines[$node][$i])) {
unset($nodesLines[$node][$i]);
if ('' === trim($lines[$i - 1])) {
unset($nodesLines[$node][$i - 1]);
}
}
}
$node = $matches[1];
if (!isset($nodesLines[$node])) {
Expand Down Expand Up @@ -307,14 +314,15 @@ private function configureDockerCompose(Recipe $recipe, array $config, bool $upd
array_splice($lines, $startAt[$key], $length, ltrim($updatedContents, "\n"));

// reset any start/end positions after this to the new positions
$shift = $length - 1;
foreach ($startAt as $sectionKey => $at) {
if ($at > $originalEndAt) {
$startAt[$sectionKey] = $at - $length - 1;
$startAt[$sectionKey] = $at - $shift;
}
}
foreach ($endAt as $sectionKey => $at) {
if ($at > $originalEndAt) {
$endAt[$sectionKey] = $at - $length;
$endAt[$sectionKey] = $at - $shift;
}
}

Expand Down
23 changes: 23 additions & 0 deletions tests/Configurator/DockerComposeConfiguratorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,29 @@ public function testConfigure(string $fileName)
$this->assertEquals(self::ORIGINAL_CONTENT, file_get_contents($dockerComposeFile));
}

public function testReconfigureDoesNotDuplicateLaterTopLevelKey()
{
$this->configurator->configure($this->recipeDb, self::CONFIG_DB, $this->lock);

$servicesOnlyRecipe = $this->getMockBuilder(Recipe::class)->disableOriginalConstructor()->getMock();
$servicesOnlyRecipe->method('getName')->willReturn('acme/services-only');
$servicesOnlyConfig = [
'services' => [
'cache:',
' image: redis:alpine',
],
];

$this->configurator->configure($servicesOnlyRecipe, $servicesOnlyConfig, $this->lock);
$afterFirstConfigure = file_get_contents(FLEX_TEST_DIR.'/compose.yaml');

$this->configurator->configure($servicesOnlyRecipe, $servicesOnlyConfig, $this->lock, ['force' => true]);
$afterSecondConfigure = file_get_contents(FLEX_TEST_DIR.'/compose.yaml');

$this->assertSame(1, substr_count($afterSecondConfigure, "\nvolumes:\n"), 'compose.yaml must contain exactly one top-level "volumes:" key');
$this->assertSame($afterFirstConfigure, $afterSecondConfigure, 'configure must be idempotent when re-run');
}

public function testNotConfiguredIfConfigSet()
{
$this->package->setExtra(['symfony' => ['docker' => false]]);
Expand Down
Loading