[Dotenv] add a flag to allow env vars override #26859

fmata · 2018-04-07T21:42:13Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#26846
License	MIT
Doc PR	symfony/symfony-docs#9568

I choose to use a new parameter in the constructor instead of populate() to not add boilerplate code to them who want allow overriding in their current setup. It's just a parameter to add in Dotenv creation instead of change or customize the loading of different .env files.

I targeted 4.1 despite the feature freeze because it's a small change but if you don't agree I can change to 4.2.

~~If you accept this PR I will do the doc PR then.~~
doc ready

natebrunette · 2018-04-07T22:36:58Z

src/Symfony/Component/Dotenv/Dotenv.php

@@ -35,6 +35,12 @@
    private $end;
    private $state;
    private $values;
+    private $enableOverride;
+
+    public function __construct(bool $enableOverride = false)


Maybe a docblock specifying what the parameter is for.

docblock added.

natebrunette · 2018-04-07T22:41:03Z

src/Symfony/Component/Dotenv/Dotenv.php

@@ -73,7 +79,7 @@ public function populate(array $values): void
        foreach ($values as $name => $value) {
            $notHttpName = 0 !== strpos($name, 'HTTP_');
            // don't check existence with getenv() because of thread safety issues
-            if (!isset($loadedVars[$name]) && (isset($_ENV[$name]) || (isset($_SERVER[$name]) && $notHttpName))) {
+            if (!isset($loadedVars[$name]) && ((!$this->enableOverride && isset($_ENV[$name])) || (isset($_SERVER[$name]) && $notHttpName))) {


Shouldn't this be used for all isset checks?

if (!isset($loadedVars[$name]) && (!$this->enableOverride && (isset($_ENV[$name]) || (isset($_SERVER[$name]) && $notHttpName)))) {

Additionally, I prefer an explicit === false check for readability, but I'm not sure what the convention is.

For security reasons I think it's better to not allow overriding $_SERVER['HTTP_*'] values, a previous discussion took place before the creation of this component. Maybe a core team member can confirm this later.

About CS style, there are plenty of examples in the codebase (and in this file too) where shortcut is used. Personaly I think it's very strange to explicitly test a false value against a boolean return type :)

The !$notHttpName already fulfills the stop condition to not overwrite the http server vars. So I think it's safe to include your check on the $_SERVER ?

fmata · 2018-04-08T11:27:51Z

Status: Needs Review

Taluu

Not sure that this will make it to 4.1, as it's a feature freeze, unless it can be made as an exception ?

Taluu · 2018-04-08T11:44:03Z

src/Symfony/Component/Dotenv/Dotenv.php

@@ -73,7 +79,7 @@ public function populate(array $values): void
        foreach ($values as $name => $value) {
            $notHttpName = 0 !== strpos($name, 'HTTP_');
            // don't check existence with getenv() because of thread safety issues
-            if (!isset($loadedVars[$name]) && (isset($_ENV[$name]) || (isset($_SERVER[$name]) && $notHttpName))) {
+            if (!isset($loadedVars[$name]) && ((!$this->enableOverride && isset($_ENV[$name])) || (isset($_SERVER[$name]) && $notHttpName))) {


The !$notHttpName already fulfills the stop condition to not overwrite the http server vars. So I think it's safe to include your check on the $_SERVER ?

Taluu · 2018-04-08T11:44:46Z

src/Symfony/Component/Dotenv/Tests/DotenvTest.php

+        $dotenv = new DotEnv(true);
+        $dotenv->populate(array('TEST_ENV_VAR_OVERRIDEN' => 'new_value'));
+
+        $this->assertSame('new_value', getenv('TEST_ENV_VAR_OVERRIDEN'));


Add some asserts for the _ENV, _SERVER vars too ?

Asserts added.

Don't you want to test they're getting properly overridden from $_SERVER and $_ENV?

nicolas-grekas · 2018-07-07T15:37:22Z

src/Symfony/Component/Dotenv/CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========

+4.1.0


should be 4.2.0 now

nicolas-grekas · 2018-07-07T15:38:11Z

src/Symfony/Component/Dotenv/Dotenv.php

+    private $enableOverride;
+
+    /**
+     * @param bool $enableOverride true if you want to allow env vars overriding


I'd propose to remove this comment and name the option $overrideExistingVars (default false) instead.

~~That would be a BC break~~ Nevermind, I see the name change switches the functionality. That change would of course require a logic change as well, but I’m for it 👍

Why so? That's adding an optional argument on the constructor, which doesn't break BC usually.

Already edited 😀

fmata · 2018-07-09T15:41:07Z

@nicolas-grekas rebased & comments addressed.

javiereguiluz · 2018-07-12T08:41:24Z

I was looking for how did other similar libraries solved this:

PHP vlucas/phpdotenv defines two methods: load() (doesn't overwrite) and overload() (overwrites) https://github.com/vlucas/phpdotenv#immutability
Ruby bkeepers/dotenv defines two methods: load and overload https://github.com/bkeepers/dotenv#why-is-it-not-overriding-existing-env-variables
NodeJS motdotla/dotenv doesn't allow to override in any way. You must do it yourself. https://github.com/motdotla/dotenv#what-happens-to-environment-variables-that-were-already-set
.NET tonerdo/dotnet-env overwrites by default, but you can pass a fourth boolean argument to prevent that: DotNetEnv.Env.Load(false, false, false, false) https://github.com/tonerdo/dotnet-env
Python theskumar/python-dotenv allows overriding passing an argument to load method: load_dotenv(find_dotenv(), override=True) https://github.com/theskumar/python-dotenv/pull/63/files#diff-88b99bb28683bd5b7e3a204826ead112
Go joho/godotenv defines two methods Load and Overload https://github.com/joho/godotenv/blob/1709ab122c988931ad53508747b3c061400c2984/godotenv.go#L64
Haskell stackbuilders/dotenv-hs defines a override option in the load method https://github.com/stackbuilders/dotenv-hs/blob/92ca78c14f0423c91a5897e761d81378aca3f2a0/app/Main.hs#L26

The most popular option seems to be to define two methods called load() and overload(). Maybe we can do the same here?

nicolas-grekas · 2018-08-07T09:01:50Z

Lets' add overload() then?

fabpot · 2018-08-28T06:50:15Z

I would also prefer to add another method.

fmata · 2018-09-02T09:30:49Z

I added Dotenv::overload() method but I had to add an optional parameter in Dotenv::populate() too because this method is public (I don't know why).

Tests failed are unrelated.

nicolas-grekas · 2018-09-03T09:45:44Z

src/Symfony/Component/Dotenv/Dotenv.php

     */
-    public function populate(array $values): void
+    public function populate(array $values, bool $overrideExistingVars = false): void


This should be reverted IMHO: it makes no sense to provide two public interfaces to do the same thing.

I agree but I think the same thing of populate() method, I don't know why it is public because the purpose of Dotenv is to use a file, no directly an array of vars it's so low level IMHO. So I added here to be consistent but let me know if you have no doubt about this revert, I can do it :)

fabpot · 2018-09-04T15:26:43Z

Thank you @fmata.

This PR was merged into the 4.2-dev branch. Discussion ---------- [Dotenv] add a flag to allow env vars override | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #26846 | License | MIT | Doc PR | symfony/symfony-docs#9568 I choose to use a new parameter in the constructor instead of `populate()` to not add boilerplate code to them who want allow overriding in their current setup. It's just a parameter to add in `Dotenv` creation instead of change or customize the loading of different .env files. I targeted 4.1 despite the feature freeze because it's a small change but if you don't agree I can change to 4.2. ~~If you accept this PR I will do the doc PR then.~~ doc ready Commits ------- 228b220 [Dotenv] add Dotenv::overload() to allow env vars override

stof · 2018-09-04T15:31:52Z

src/Symfony/Component/Dotenv/Dotenv.php

-            if (!is_readable($path) || is_dir($path)) {
-                throw new PathException($path);
-            }
+        $this->doLoad(false, $path, ...$paths);


instead of creating a PHP array (with the variadic argument) to spread it again (here) to create another PHP array (variadic argument in the private method), it might make sense to pass an array to the private method instead of making it variadic.

Indeed, we don't need a variadic argument in the private method.

@stof & @fabpot new PR #28359 created :)

…luz) This PR was merged into the master branch. Discussion ---------- Document the DotEnv::overload() method I'm not sure how to update the doc according my PR symfony/symfony#26859 which is pending review but feel free to comment if I did a mistake. Thank you. Commits ------- 38e4f08 Reword f8a3c0d Update dotenv.rst 6325759 Update dotenv.rst c8ad296 Update dotenv.rst

…() (fmata) This PR was merged into the 4.2-dev branch. Discussion ---------- [Dotenv] use array instead of variadic in Dotenv::doLoad() | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT According to comments done after merge in #26859. Commits ------- f3af242 [Dotenv] use array instead of variadic in Dotenv::doLoad()

carsonbot added Status: Needs Review Feature labels Apr 7, 2018

fmata mentioned this pull request Apr 7, 2018

[Dotenv] Tell component to override #26846

Closed

natebrunette suggested changes Apr 7, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Apr 7, 2018

fmata mentioned this pull request Apr 8, 2018

Document the DotEnv::overload() method symfony/symfony-docs#9568

Merged

carsonbot added Status: Needs Review and removed Status: Needs Work labels Apr 8, 2018

Taluu reviewed Apr 8, 2018

View reviewed changes

nicolas-grekas added this to the 4.1 milestone Apr 9, 2018

Tobion approved these changes Apr 26, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Apr 26, 2018

fabpot modified the milestones: 4.1, next May 7, 2018

nicolas-grekas reviewed Jul 7, 2018

View reviewed changes

nicolas-grekas approved these changes Jul 9, 2018

View reviewed changes

[Dotenv] add Dotenv::overload() to allow env vars override

228b220

nicolas-grekas reviewed Sep 3, 2018

View reviewed changes

fabpot approved these changes Sep 4, 2018

View reviewed changes

fabpot merged commit 228b220 into symfony:master Sep 4, 2018

stof reviewed Sep 4, 2018

View reviewed changes

fmata mentioned this pull request Sep 4, 2018

[Dotenv] use array instead of variadic in Dotenv::doLoad() #28359

Merged

fmata deleted the issue-26846 branch September 4, 2018 16:01

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Dotenv] add a flag to allow env vars override #26859

[Dotenv] add a flag to allow env vars override #26859

fmata commented Apr 7, 2018 •

edited

Loading

natebrunette Apr 7, 2018

fmata Apr 7, 2018

natebrunette Apr 7, 2018

fmata Apr 7, 2018

Taluu Apr 8, 2018

fmata Apr 8, 2018

fmata commented Apr 8, 2018

Taluu left a comment

Taluu Apr 8, 2018

Taluu Apr 8, 2018

fmata Apr 8, 2018

natebrunette Apr 9, 2018

natebrunette Apr 16, 2018

nicolas-grekas Jul 7, 2018

nicolas-grekas Jul 7, 2018

natebrunette Jul 7, 2018 •

edited

Loading

nicolas-grekas Jul 7, 2018

natebrunette Jul 7, 2018

fmata commented Jul 9, 2018

javiereguiluz commented Jul 12, 2018

nicolas-grekas commented Aug 7, 2018

fabpot commented Aug 28, 2018

fmata commented Sep 2, 2018

nicolas-grekas Sep 3, 2018

fmata Sep 3, 2018

fabpot commented Sep 4, 2018

stof Sep 4, 2018

fabpot Sep 4, 2018

fmata Sep 4, 2018

[Dotenv] add a flag to allow env vars override #26859

[Dotenv] add a flag to allow env vars override #26859

Conversation

fmata commented Apr 7, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fmata commented Apr 8, 2018

Taluu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natebrunette Jul 7, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fmata commented Jul 9, 2018

javiereguiluz commented Jul 12, 2018

nicolas-grekas commented Aug 7, 2018

fabpot commented Aug 28, 2018

fmata commented Sep 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Sep 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fmata commented Apr 7, 2018 •

edited

Loading

natebrunette Jul 7, 2018 •

edited

Loading