[DependencyInjection] resolve array env vars #27267
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7af7268 to
7af5d6c
Compare
| foreach ($envPlaceholders as $env => $placeholders) { | ||
| foreach ($placeholders as $placeholder) { | ||
| if (false !== stripos($value, $placeholder)) { | ||
| if (\is_string($value) && false !== stripos($value, $placeholder)) { |
There was a problem hiding this comment.
Is the added check useful? I feel like the added break is enough, isn't it?
There was a problem hiding this comment.
Yeah, the break should be enough. I included the is_string() as a sanity check for the stripos() call, but it shouldn't be necessary. I can remove it if that's preferred.
There was a problem hiding this comment.
yes, let's remove the check as it might make ppl spend time wondering when this can be false, when it cannot :)
| /** | ||
| * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException | ||
| * @expectedExceptionMessage A string value must be composed of strings and/or numbers, but found parameter "env(ARRAY)" of type array inside string value "ABC %env(ARRAY)%". | ||
| * @expectedExceptionMessage A string value must be composed of strings and/or numbers, but found parameter "env(json:ARRAY)" of type array inside string value "ABC env_json_ARRAY_ |
There was a problem hiding this comment.
is env_json_ARRAY_ correct? Shouldn't it be "ABC %env(ARRAY)%"?
There was a problem hiding this comment.
My first thought was that env_json_ARRAY_%s was expected due to the below code of EnvPlaceholderParameterBag, but now I'm seeing it should only be called for environment variables that resolve to strings.
$uniqueName = md5($name.uniqid(mt_rand(), true));
$placeholder = sprintf('env_%s_%s', str_replace(':', '_', $env), $uniqueName);There was a problem hiding this comment.
That's a bug that was hidden by the previous test case then.
$value should be processed by resolveEnvPlaceholders before being put in the exception message (with the default $format = null)
nicolas-grekas
approved these changes
May 15, 2018
fabpot
approved these changes
May 18, 2018
d084f73 to
4c3b950
Compare
|
Thank you @jamesthomasonjr. |
fabpot
added a commit
that referenced
this pull request
May 18, 2018
…njr) This PR was squashed before being merged into the 3.4 branch (closes #27267). Discussion ---------- [DependencyInjection] resolve array env vars | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #27239 | License | MIT | Doc PR | n/a ## Why This bugfix solves a problem where environment variables resolved as an array would cause an error while compiling the container if they aren't the last parameter in the ParameterBag: the next parameter to be resolved would fail at the `stripos()` check. More information about the bug is available at #27239 ## Tests - This PR modifies existing ContainerBuilder tests to make use of the EnvVarProcessor to resolve json strings into arrays, instead of relying upon a TestingEnvPlaceholderParameterBag class. - I would liked to have kept EnvVarProcessor logic out of the ContainerBuilder tests, but it was the interaction between the ContainerBuilder and EnvVarProcessor that caused the bug - This PR adds a new ContainerBuilder test to verify that an environment variable resolved into an array doesn't cause an error when the next variable attempts to be resolved ## Code - ~This PR adds an `\is_string()` sanity check before the `stripos()` method call so that only a string are passed into `stripos()`~ - This PR also adds a `$completed` flag so that completely resolved environment variables (currently only determined by `$placeholder === $value`) can break out of the loop early (handled via `break 2;` Commits ------- 4c3b950 [DependencyInjection] resolve array env vars
This was referenced May 21, 2018
Merged
Merged
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
This bugfix solves a problem where environment variables resolved as an array would cause an error while compiling the container if they aren't the last parameter in the ParameterBag: the next parameter to be resolved would fail at the
stripos()check. More information about the bug is available at #27239Tests
Code
This PR adds an\is_string()sanity check before thestripos()method call so that only a string are passed intostripos()$completedflag so that completely resolved environment variables (currently only determined by$placeholder === $value) can break out of the loop early (handled viabreak 2;