Allow to override .env files for specific environments #466

dunglas · 2018-09-21T09:03:41Z

Q	A
License	MIT

As discussed in #465 and symfony/symfony#28533, this PR makes Symfony behaving like Create React App, Rails or Sinatra: the following files, starting from the bottom. The first value set (or those already defined in the environment) take precedence:

.env - The Original®
.env.dev, .env.test, .env.prod... - Environment-specific settings.
.env.local - Local overrides. This file is loaded for all environments except test.
.env.dev.local, .env.test.local, .env.prod.local... - Local overrides of environment-specific settings.

The default envs are env and test.

It also fixes #366 (comment): when running bin/console -e=prod, the .env.prod file will be loaded (if APP_ENV is not already defined).

Needs:

Closes #465, #366, #408.

ghost

Pull request does not pass validation.

ghost

Pull request does not pass validation.

ghost

Pull request passes validation.

symfony/framework-bundle/4.2/public/index.php

ogizanagi

symfony/flex#318 would be required after this one for Flex to stop updating the phpunit.xml.dist file in favor of the .env.test file.

symfony/console/4.2/bin/console

dunglas · 2018-09-21T10:08:02Z

@maxhelias @ogizanagi I was thinking about introducing an env var simply called LOAD_ENV. When defined it will always load the given env file. It would resolve both of your comments, and can replace the -e argument in console.

To run the command in prod env: LOAD_ENV=prod bin/console
To run the integrated web server in prod env: LOAD_ENV=prod php -S 127.0.0.1:8000 -t public

WDYT?

sroze

I really like the idea.

symfony/flex/1.0/.env

ghost

Pull request passes validation.

ghost

Pull request passes validation.

ghost

Pull request passes validation.

ghost

Pull request passes validation.

symfony/framework-bundle/4.2/public/index.php

symfony/console/4.2/bin/console

symfony/framework-bundle/4.2/public/index.php

dunglas · 2018-09-21T19:32:22Z

To upgrade, users will have to use a script like this one:

cat composer.json | jq --indent 4 '.require["symfony/flex"] = "^2.0"' > composer.tmp
mv composer.tmp composer.json
cp .env .env.local
cp .env.dist .env
sed -i'' -e 's/\/.env/\/.env.local\
\/.env.*.local/' .gitignore

symfony/framework-bundle/4.2/public/index.php

ghost

Pull request passes validation.

ghost

Pull request passes validation.

B-Galati · 2018-10-30T21:17:50Z

Should we also deprecate the default value notation of services files?
i.e.:

# config/services.yaml
parameters:
    env(DATABASE_HOST): localhost

https://symfony.com/doc/current/configuration/external_parameters.html#environment-variables

symfony/framework-bundle/4.2/src/bootstrap.php

ghost

Pull request passes validation.

symfony/framework-bundle/4.2/src/bootstrap.php

ghost

Pull request passes validation.

ghost

Pull request passes validation.

ghost

Pull request passes validation.

ghost

Pull request passes validation.

fabpot · 2018-10-31T06:05:43Z

symfony/framework-bundle/4.2/public/index.php

-
-    Debug::enable();
-}
+$kernel = require __DIR__.'/../src/bootstrap.php';


I'm not a big fan of having a bootstrap.php file. what about moving the logic to the Kernel class instead?

Unfortunately it won't work for PHPUnit (it is not able to call a method to bootstrap).

The src/bootstrap.php file doesn't bother me. But if you prefer, we could move this logic to the kernel and only keep a test/bootstrap.php file used by phpunit? That's already common to need such a file to add specific code before running tests and would avoid requiring 2 bootstrap.php files

Having a static method on Kernel and then reusing it in a bootstrap file for PHPUnit sounds like a better idea to me.

ogizanagi · 2018-10-31T19:22:40Z

@B-Galati : What do you mean in #466 (comment)?
I fail to understand how it relates with this PR? 🤔

B-Galati · 2018-10-31T21:18:31Z

@ogizanagi it does not relate sorry. I will open an issue on Symfony repository.

dunglas · 2018-11-04T09:22:15Z

symfony/framework-bundle/4.2/src/bootstrap.php

+
+$envFromEnv = $_SERVER['APP_ENV'] ?? $_ENV['APP_ENV'] ?? null;
+$env = $envFromEnv ?? 'dev';
+$prod = 'prod' === $env;


I suggest to go one step further and to not load .env if the environment name doesn't start with dev or test (.env.test-e2e will be loaded, but not .staging). WDYT?

My opinion is that it complicates everything to introduce more and more exceptions and would make it far from intuitive. The prod env restriction has a reason, it's a safeguard for real production environments.
For other env, I don't understand the reasons yet. The main reason for this feature to exist is env.test and that's how it'll be used 95% of the time. But some applications defines their own specific symfony env(s) and may also benefit from this. And if you don't, then you shouldn't care putting arbitrary restrictions on a feature already based on conventions :)

I’m fine with this

XavierVallot · 2018-11-05T15:05:05Z

symfony/console/4.2/bin/console

+
+$kernel = require __DIR__.'/../src/bootstrap.php';
+$application = new Application($kernel);
+$application->run($input);


this variable $input is not defined though the code cannot work

XavierVallot · 2018-11-05T15:06:17Z

symfony/console/4.2/bin/console

+
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+
+if (!class_exists(Application::class)) {


the autoload has not yet been called at this point so this condition is always false and always throw the exception even if framework-bundle is installed

Maybe because there is no require __DIR__.'/../vendor/autoload.php'; in this file

XavierVallot · 2018-11-05T15:21:28Z

symfony/framework-bundle/4.2/src/bootstrap.php

@@ -0,0 +1,29 @@
+<?php


this class lives under src/ which is autoloaded, so composer excepts a class which this file is not. It gives the following error :

In FileLoader.php line 168: The autoloader expected class "App\bootstrap" to be defined in file "/srv/app/vendor/composer/../../src/bootstrap.php". The file was found but the c lass was not in it, the class name or namespace probably has a typo in /srv/app/config/services.yaml (which is loaded in resource "/srv/app/config/s ervices.yaml"). In DebugClassLoader.php line 204: The autoloader expected class "App\bootstrap" to be defined in file "/srv/app/vendor/composer/../../src/bootstrap.php". The file was found but the c lass was not in it, the class name or namespace probably has a typo.

dunglas · 2018-11-08T17:58:13Z

Closing in favor of #481

dunglas requested review from fabpot, weaverryan and nicolas-grekas September 21, 2018 09:03

ghost suggested changes Sep 21, 2018

View reviewed changes

dunglas force-pushed the loadenv branch from 7581f2e to 61bed6d Compare September 21, 2018 09:05

ghost suggested changes Sep 21, 2018

View reviewed changes

dunglas force-pushed the loadenv branch from 61bed6d to f40f384 Compare September 21, 2018 09:05

ghost deployed to staging September 21, 2018 09:06 View deployment

ghost approved these changes Sep 21, 2018

View reviewed changes

maxhelias reviewed Sep 21, 2018

View reviewed changes

symfony/framework-bundle/4.2/public/index.php Outdated Show resolved Hide resolved

ogizanagi reviewed Sep 21, 2018

View reviewed changes

symfony/console/4.2/bin/console Outdated Show resolved Hide resolved

sroze suggested changes Sep 21, 2018

View reviewed changes

symfony/flex/1.0/.env Outdated Show resolved Hide resolved

This was referenced Sep 21, 2018

PHPUnit: use a .env file #465

Closed

[DotEnv] Add a new loadForEnv() method mimicking Ruby's dotenv behavior symfony/symfony#28533

Merged

ghost deployed to staging September 21, 2018 10:31 View deployment

ghost approved these changes Sep 21, 2018

View reviewed changes

dunglas mentioned this pull request Sep 21, 2018

Change the EnvConfigurator to only handle the .env file symfony/flex#423

Closed

ghost deployed to staging September 21, 2018 10:44 View deployment

ghost approved these changes Sep 21, 2018

View reviewed changes

ghost deployed to staging September 21, 2018 12:30 View deployment

ghost approved these changes Sep 21, 2018

View reviewed changes

ghost deployed to staging September 21, 2018 13:28 View deployment

ghost approved these changes Sep 21, 2018

View reviewed changes

ogizanagi reviewed Sep 21, 2018

View reviewed changes

symfony/framework-bundle/4.2/public/index.php Outdated Show resolved Hide resolved

joshlopes reviewed Sep 21, 2018

View reviewed changes

symfony/console/4.2/bin/console Outdated Show resolved Hide resolved

symfony/framework-bundle/4.2/public/index.php Outdated Show resolved Hide resolved

weaverryan reviewed Sep 21, 2018

View reviewed changes

symfony/framework-bundle/4.2/public/index.php Outdated Show resolved Hide resolved

ghost deployed to staging September 21, 2018 22:48 View deployment

ghost approved these changes Sep 21, 2018

View reviewed changes

ghost approved these changes Oct 30, 2018

View reviewed changes

ogizanagi reviewed Oct 30, 2018

View reviewed changes

symfony/framework-bundle/4.2/src/bootstrap.php Outdated Show resolved Hide resolved

dunglas force-pushed the loadenv branch from 12fee2d to bafbfd0 Compare October 30, 2018 22:18

ghost deployed to staging October 30, 2018 22:18 View deployment

ghost approved these changes Oct 30, 2018

View reviewed changes

ogizanagi reviewed Oct 30, 2018

View reviewed changes

symfony/framework-bundle/4.2/src/bootstrap.php Show resolved Hide resolved

Improve env handling

b819c9a

dunglas force-pushed the loadenv branch from bafbfd0 to b819c9a Compare October 30, 2018 22:20

ghost deployed to staging October 30, 2018 22:20 View deployment

ghost approved these changes Oct 30, 2018

View reviewed changes

ghost deployed to staging October 30, 2018 22:25 View deployment

ghost approved these changes Oct 30, 2018

View reviewed changes

Factorize code

eb279c0

dunglas force-pushed the loadenv branch from c9cc535 to eb279c0 Compare October 30, 2018 22:27

ghost deployed to staging October 30, 2018 22:27 View deployment

ghost approved these changes Oct 30, 2018

View reviewed changes

ogizanagi's review

337bc74

ghost deployed to staging October 30, 2018 22:29 View deployment

ghost approved these changes Oct 30, 2018

View reviewed changes

fabpot reviewed Oct 31, 2018

View reviewed changes

dunglas commented Nov 4, 2018

View reviewed changes

XavierVallot reviewed Nov 5, 2018

View reviewed changes

nicolas-grekas mentioned this pull request Nov 8, 2018

Allow to override .env files per env #481

Merged

dunglas closed this Nov 8, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow to override .env files for specific environments #466

Allow to override .env files for specific environments #466

dunglas commented Sep 21, 2018 •

edited

Loading

ghost left a comment

ghost left a comment

ghost left a comment

ogizanagi left a comment

dunglas commented Sep 21, 2018 •

edited

Loading

sroze left a comment

ghost left a comment

ghost left a comment

ghost left a comment

ghost left a comment

dunglas commented Sep 21, 2018

ghost left a comment

ghost left a comment

B-Galati commented Oct 30, 2018 •

edited

Loading

ghost left a comment

ghost left a comment

ghost left a comment

ghost left a comment

ghost left a comment

fabpot Oct 31, 2018

dunglas Oct 31, 2018

ogizanagi Oct 31, 2018

fabpot Nov 4, 2018

ogizanagi commented Oct 31, 2018

B-Galati commented Oct 31, 2018

dunglas Nov 4, 2018

ogizanagi Nov 4, 2018

dunglas Nov 4, 2018

XavierVallot Nov 5, 2018

XavierVallot Nov 5, 2018

Kocal Nov 5, 2018

XavierVallot Nov 5, 2018

dunglas commented Nov 8, 2018


		use Symfony\Bundle\FrameworkBundle\Console\Application;

		if (!class_exists(Application::class)) {

Allow to override .env files for specific environments #466

Allow to override .env files for specific environments #466

Conversation

dunglas commented Sep 21, 2018 • edited Loading

ghost left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

ogizanagi left a comment

Choose a reason for hiding this comment

dunglas commented Sep 21, 2018 • edited Loading

sroze left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

dunglas commented Sep 21, 2018

ghost left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

B-Galati commented Oct 30, 2018 • edited Loading

ghost left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

ghost 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

ogizanagi commented Oct 31, 2018

B-Galati commented Oct 31, 2018

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

dunglas commented Nov 8, 2018

dunglas commented Sep 21, 2018 •

edited

Loading

dunglas commented Sep 21, 2018 •

edited

Loading

B-Galati commented Oct 30, 2018 •

edited

Loading