8000 Fix/broken merging of parameter bag env placeholders by mickadoo · Pull Request #20214 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

Fix/broken merging of parameter bag env placeholders #20214

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

Closed
wants to merge 3 commits into from
Closed

Fix/broken merging of parameter bag env placeholders #20214

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bfa4b63
[DependencyInjection] Ensure env placeholders are not duplicated and …
mickadoo Oct 13, 2016
60d0847
[DependencyInjection] Add test in case where original parameter bag i…
mickadoo Oct 13, 2016
fe8c172
[DependencyInjection] Changes from code review. Add tests for more co…
mickadoo Oct 13, 2016
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
Next Next commit
[DependencyInjection] Ensure env placeholders are not duplicated and … 
…add test for bug
  • Loading branch information
@mickadoo
mickadoo committed Oct 13, 2016
commit bfa4b6384cfa07e103aecf64631708ec821891d9
10 changes: 8 additions & 2 deletions src/Symfony/Component/DependencyInjection/ParameterBag/EnvPlaceholderParameterBag.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public function get($name)

$uniqueName = md5($name.uniqid(mt_rand(), true));
$placeholder = sprintf('env_%s_%s', $env, $uniqueName);
$this->envPlaceholders[$env][$placeholder] = $placeholder;
$this->envPlaceholders[$env][] = $placeholder;

return $placeholder;
}
Expand All @@ -71,6 +71,12 8000 @@ public function getEnvPlaceholders()
*/
public function mergeEnvPlaceholders(self $bag)
{
$this->envPlaceholders = array_merge_recursive($this->envPlaceholders, $bag->getEnvPlaceholders());
$newPlaceholders = $bag->getEnvPlaceholders();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose keeping the above $placeholder index and use this here:

@@ -71,6 +71,12 @@ class EnvPlaceholderParameterBag extends ParameterBag
      */
     public function mergeEnvPlaceholders(self $bag)
     {
-        $this->envPlaceholders = array_merge_recursive($this->envPlaceholders, $bag->getEnvPlaceholders());
+        if ($newPlaceholders = $bag->getEnvPlaceholders()) {
+            $this->envPlaceholders += $newPlaceholders;
+
+            foreach ($newPlaceholders as $env => $placeholders) {
+                $this->envPlaceholders[$env] += $placeholders;
+            }
+        }
     }
 }

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicolas-grekas Can you maybe explain the reason for the change here a bit more, I'm not seeing it.
With $this->envPlaceholders += $newPlaceholders; you're saying merge the new into the existing, fair enough. Then it's looping through each of the new ones and merging the existing ones with it? Won't this already have been done by the first merge?

Copy link
Member
@nicolas-grekas nicolas-grekas Oct 13, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The array is recursive, but the + isn't. So: the 1st + adds the new keys to the property, then + in the foreach adds the new entries to previously existing keys.

Copy link
Contributor Author
@mickadoo mickadoo Oct 13, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case why not just use a single array_merge then?
(edit) bad suggestion. that would not merge the individual elements from, instead just overwrite them using the second value

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicolas-grekas I was trying to make a test for this but I need your input.

param bag A has placeholders:
'DB_USER' => ['env_DB_USER_1']

param bag B has placeholders:
'DB_USER' => ['env_DB_USER_1'], 'DB_HOST_1' => ['env_DB_HOST_1]

After the merge I would expect param bag A to have placeholders:
'DB_USER' => ['env_DB_USER_1'], 'DB_HOST_1' => ['env_DB_HOST_1]

right?

Now lets make things a little more interesting with param bag C which has a different unique identifier for one of the placeholders:

'DB_USER' => ['env_DB_USER_2']

So now we go and merge that into param bag A (after merging B). Do you expect:

A) 'DB_USER' => ['env_DB_USER_2'], 'DB_HOST_1' => ['env_DB_HOST_1]

or

B) 'DB_USER' => ['env_DB_USER_1', 'env_DB_USER_2'], 'DB_HOST_1' => ['env_DB_HOST_1]

If you're expecting B) like I am then I'll happily make your changes (which work as expected) once I reintroduce the $this->envPlaceholders[$env][$placeholder] = $placeholder; from above. If I left it without it your suggestion wouldn't work. The changes on my branch as they are now work in either case. I'm happy with both, using += looks nice and neat.

Just let me know the decision and i'll push the changes and the new test.

Sorry for the delay, just want to be sure I get this right this time.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

B) is the only right answer. We though array_merge_recursive would do it, but you proved us wrong. Now we're trying to achieve B), nothing else :)

just want to be sure I get this right this time.

I ran my proposal with your tests, so we're safe, isn't it ;)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed changes, and this time I actually tried it out on a project. I think I put too much faith in the tests last time. That or I didn't write enough tests...
Are there tests for actual retrieving of a parameter after the bag has been merged?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there tests for actual retrieving of a parameter after the bag has been merged?

I don't think so


foreach ($newPlaceholders as $key => $newEntries) {
$existingEntries = isset($this->envPlaceholders[$key]) ? $this->envPlaceholders[$key] : array();
$merged BFD3 Entries = array_merge($existingEntries, $newEntries);
$this->envPlaceholders[$key] = array_unique($mergedEntries);
}
}
}
14 changes: 10 additions & 4 deletions ...mfony/Component/DependencyInjection/Tests/ParameterBag/EnvPlaceholderParameterBagTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,22 @@ public function testGetThrowsInvalidArgumentExceptionIfEnvNameContainsNonWordCha

public function testMergeWillNotDuplicateIdenticalParameters()
{
$originalPlaceholders = array('database_host' => array('localhost'));
$firstBag = new EnvPlaceholderParameterBag($originalPlaceholders);
$envVariableName = 'DB_HOST';
$parameter = sprintf('env(%s)', $envVariableName);
$firstBag = new EnvPlaceholderParameterBag();

// initialize placeholders
$firstBag->get('env(database_host)');
$firstBag->get($parameter);
$secondBag = clone $firstBag;

$firstBag->mergeEnvPlaceholders($secondBag);
$mergedPlaceholders = $firstBag->getEnvPlaceholders();

$this->assertCount(1, $mergedPlaceholders['database_host']);
$placeholderForVariable = $mergedPlaceholders[$envVariableName];
$placeholder = array_values($placeholderForVariable)[0];

$this->assertCount(1, $placeholderForVariable);
$this->assertInternalType('string', $placeholder);
$this->assertContains($envVariableName, $placeholder);
}
}
0