Allow "json:" env var processor to accept null value #26498

mcfedr · 2018-03-12T14:35:18Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets
License	MIT
Doc PR	Currently no docs for this feature

Edits the EnvVarProcessor so that it allows any type of variable in JSON encoded vars.

Previously it was only possible to use %env(json:ENV)% for array types, but this seems to be an arbitrary restriction, when I could have any other data type in that JSON.

Valid JSON that was previously rejected:

1
null
"string"

nicolas-grekas · 2018-03-12T14:39:04Z

There are reasons for the current restriction:

having a single type (array) makes it easier to validate types, eg for chained processors or config validation
the other JSON types can easily be achieved using other processors (ie int, bool, string, null)

mcfedr · 2018-03-12T14:45:48Z

I wondered if this might be what's happening. I have a case where in passing either an array or null.
What if I changed this to allow null? I feel like this might be a useful case.

nicolas-grekas · 2018-03-12T14:47:08Z

if you want to set null, I think you can already achieve it with the const processor: const:null

javiereguiluz · 2018-03-12T14:53:38Z

@nicolas-grekas but I think he's saying that an external piece of software generates this config that usually is a JSON-encoded array but it can be null when the config is empty (Symfony does the same and we use array|null everywhere instead of array|empty array). But I guess you'll need to change that external software to encode an empty JSON array when the config is empty.

mcfedr · 2018-03-12T14:58:22Z

Exactly, I need to accept either array or null.

nicolas-grekas · 2018-03-14T16:18:29Z

would you mind adding a test case please?

mcfedr · 2018-03-15T11:30:16Z

Sure, also added some more general testing around EnvVarProcessor as there don't seem to exist any at the moment.

nicolas-grekas · 2018-03-15T13:22:03Z

src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php

+use Symfony\Component\DependencyInjection\EnvVarProcessor;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
+
+class EnvVarProcessorTest extends TestCase


would you mind opening a separate PR against branch 3.4 for this test class?

Ok, I moved to #26542, but had to remove the case for json:null because it will fail in 3.4, and i cannot add it here until that PR lands in master. I can probably make another PR later with more cases.

javiereguiluz · 2018-03-16T09:20:16Z

src/Symfony/Component/DependencyInjection/EnvVarProcessor.php

@@ -129,7 +129,7 @@ public function getEnv($prefix, $name, \Closure $getEnv)
                throw new RuntimeException(sprintf('Invalid JSON in env var "%s": '.json_last_error_msg(), $name));
            }

-            if (!is_array($env)) {
+            if (null !== $env && !is_array($env)) {
                throw new RuntimeException(sprintf('Invalid JSON env var "%s": array expected, %s given.', $name, gettype($env)));


The error message should be updated: array expected ... -> array or null expected ...

mcfedr · 2018-03-19T10:42:56Z

Rebased on master to see if it would fix the tests, but now seems to fail on some other doctrine tests

This PR was squashed before being merged into the 3.4 branch (closes #26542). Discussion ---------- [DI] Add tests for EnvVarProcessor | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | n/a Add tests for the `EnvVarProcessor` as it doesn't have any at the moment. Originally from this PR against master, #26498 Commits ------- 2992bb3 [DI] Add tests for EnvVarProcessor

nicolas-grekas · 2018-03-19T17:22:33Z

@mcfedr you said had more tests in 26542 before moving it to 3.4. Did you add them back here after the rebase?

mcfedr · 2018-03-19T17:28:01Z

I was thinking it would make sense for the tests in #26542 in to be expanded to include this specific case of paring "null" as valid json, as this commit is based on master I cannot add that here until that commit d818636 is merged into master.

nicolas-grekas · 2018-03-19T17:34:37Z

Indeed. Merge done, rebase unlocked on your side.

mcfedr · 2018-03-19T17:52:01Z

Ok, rebased with extra test cases

Amend EnvVarProcessorTest to include all possible json values

fabpot · 2018-03-27T12:13:13Z

Thank you @mcfedr.

…mcfedr) This PR was merged into the 4.1-dev branch. Discussion ---------- Allow "json:" env var processor to accept null value | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Currently no docs for this feature Edits the EnvVarProcessor so that it allows any type of variable in JSON encoded vars. Previously it was only possible to use `%env(json:ENV)%` for array types, but this seems to be an arbitrary restriction, when I could have any other data type in that JSON. Valid JSON that was previously rejected: - `1` - `null` - `"string"` Commits ------- abc7480 Allow "json:" env var processor to parse null values

ro0NL · 2018-03-27T12:18:18Z

@mcfedr anything to do for this test? https://github.com/symfony/symfony/pull/23888/files#diff-d81d0f25c32e251a89ce524b0495113dR74

mcfedr · 2018-03-27T13:57:11Z

@ro0NL I don't see anything specific to this change, this PR makes it possible for the json: processor to return either an array or null, so it can still never be an int.

carsonbot added Status: Needs Review Feature labels Mar 12, 2018

nicolas-grekas added this to the 4.1 milestone Mar 12, 2018

mcfedr force-pushed the json_env_any branch from e3ce146 to db50d62 Compare March 12, 2018 17:45

mcfedr changed the title ~~Allow "json:" env var processor to parse any json value~~ Allow "json:" env var processor to accept null value Mar 12, 2018

mcfedr force-pushed the json_env_any branch 2 times, most recently from 05ec676 to fdee150 Compare March 15, 2018 11:29

mcfedr force-pushed the json_env_any branch from fdee150 to ebcf075 Compare March 15, 2018 12:02

nicolas-grekas reviewed Mar 15, 2018

View reviewed changes

mcfedr mentioned this pull request Mar 15, 2018

[DI] Add tests for EnvVarProcessor #26542

Closed

mcfedr force-pushed the json_env_any branch from ebcf075 to c5c23c2 Compare March 15, 2018 15:19

javiereguiluz reviewed Mar 16, 2018

View reviewed changes

mcfedr force-pushed the json_env_any branch 2 times, most recently from d523a2c to 98b1ae5 Compare March 19, 2018 10:31

mcfedr force-pushed the json_env_any branch from 98b1ae5 to e7e5cfd Compare March 19, 2018 17:51

Allow "json:" env var processor to parse null values

abc7480

Amend EnvVarProcessorTest to include all possible json values

mcfedr force-pushed the json_env_any branch from e7e5cfd to abc7480 Compare March 19, 2018 17:53

nicolas-grekas approved these changes Mar 22, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Mar 22, 2018

fabpot approved these changes Mar 27, 2018

View reviewed changes

fabpot merged commit abc7480 into symfony:master Mar 27, 2018

mcfedr deleted the json_env_any branch March 27, 2018 14:02

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow "json:" env var processor to accept null value #26498

Allow "json:" env var processor to accept null value #26498

mcfedr commented Mar 12, 2018

nicolas-grekas commented Mar 12, 2018

mcfedr commented Mar 12, 2018

nicolas-grekas commented Mar 12, 2018

javiereguiluz commented Mar 12, 2018

mcfedr commented Mar 12, 2018

nicolas-grekas commented Mar 14, 2018

mcfedr commented Mar 15, 2018

nicolas-grekas Mar 15, 2018

mcfedr Mar 15, 2018 •

edited

Loading

javiereguiluz Mar 16, 2018

mcfedr commented Mar 19, 2018

nicolas-grekas commented Mar 19, 2018

mcfedr commented Mar 19, 2018

nicolas-grekas commented Mar 19, 2018

mcfedr commented Mar 19, 2018

fabpot commented Mar 27, 2018

ro0NL commented Mar 27, 2018

mcfedr commented Mar 27, 2018

Allow "json:" env var processor to accept null value #26498

Allow "json:" env var processor to accept null value #26498

Conversation

mcfedr commented Mar 12, 2018

nicolas-grekas commented Mar 12, 2018

mcfedr commented Mar 12, 2018

nicolas-grekas commented Mar 12, 2018

javiereguiluz commented Mar 12, 2018

mcfedr commented Mar 12, 2018

nicolas-grekas commented Mar 14, 2018

mcfedr commented Mar 15, 2018

nicolas-grekas Mar 15, 2018

Choose a reason for hiding this comment

mcfedr Mar 15, 2018 • edited Loading

Choose a reason for hiding this comment

javiereguiluz Mar 16, 2018

Choose a reason for hiding this comment

mcfedr commented Mar 19, 2018

nicolas-grekas commented Mar 19, 2018

mcfedr commented Mar 19, 2018

nicolas-grekas commented Mar 19, 2018

mcfedr commented Mar 19, 2018

fabpot commented Mar 27, 2018

ro0NL commented Mar 27, 2018

mcfedr commented Mar 27, 2018

mcfedr Mar 15, 2018 •

edited

Loading