[Process] Deprecate Process::inheritEnvironmentVariables()

ogizanagi · ogizanagi · commit af9bad31c69d · 2019-07-18T18:47:09.000+02:00
diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
@@ -102,6 +102,11 @@ MonologBridge
 --------------
 
  * The `RouteProcessor` has been marked final.
+ 
+Process
+-------
+
+ * Deprecated the `Process::inheritEnvironmentVariables()` method: env variables are always inherited.
 
 PropertyAccess
 --------------
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -319,6 +319,7 @@ MonologBridge
 Process
 -------
 
+ * Removed the `Process::inheritEnvironmentVariables()` method: env variables are always inherited.
  * Removed the `Process::setCommandline()` and the `PhpProcess::setPhpBinary()` methods.
  * Commands must be defined as arrays when creating a `Process` instance.
 
diff --git a/src/Symfony/Bundle/WebServerBundle/WebServer.php b/src/Symfony/Bundle/WebServerBundle/WebServer.php
@@ -167,7 +167,11 @@ private function createServerProcess(WebServerConfig $config)
 
         if (\in_array('APP_ENV', explode(',', getenv('SYMFONY_DOTENV_VARS')))) {
             $process->setEnv(['APP_ENV' => false]);
-            $process->inheritEnvironmentVariables();
+
+            if (!method_exists(Process::class, 'fromShellCommandline')) {
+                // Symfony 3.4 does not inherit env vars by default:
+                $process->inheritEnvironmentVariables();
+            }
         }
 
         return $process;
diff --git a/src/Symfony/Component/Dotenv/Dotenv.php b/src/Symfony/Component/Dotenv/Dotenv.php
@@ -402,7 +402,12 @@ private function resolveCommands($value)
             }
 
             $process = method_exists(Process::class, 'fromShellCommandline') ? Process::fromShellCommandline('echo '.$matches[0]) : new Process('echo '.$matches[0]);
-            $process->inheritEnvironmentVariables(true);
+
+            if (!method_exists(Process::class, 'fromShellCommandline')) {
+                // Symfony 3.4 does not inherit env vars by default:
+                $process->inheritEnvironmentVariables();
+            }
+
             $process->setEnv($this->values);
             try {
                 $process->mustRun();
diff --git a/src/Symfony/Component/Process/CHANGELOG.md b/src/Symfony/Component/Process/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.4.0
+-----
+
+* deprecated `Process::inheritEnvironmentVariables()`: env variables are always inherited.
+
 4.2.0
 -----
 
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -1210,9 +1210,13 @@ public function setInput($input)
      * @param bool $inheritEnv
      *
      * @return self The current Process instance
+     *
+     * @deprecated since Symfony 4.4, env variables are always inherited
      */
     public function inheritEnvironmentVariables($inheritEnv = true)
     {
+        @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.4, env variables are always inherited.', __METHOD__), E_USER_DEPRECATED);
+
         if (!$inheritEnv) {
             throw new InvalidArgumentException('Not inheriting environment variables is not supported.');
         }
diff --git a/src/Symfony/Component/Process/Tests/ProcessTest.php b/src/Symfony/Component/Process/Tests/ProcessTest.php
@@ -1405,7 +1405,6 @@ public function testSetBadEnv()
     {
         $process = $this->getProcess('echo hello');
         $process->setEnv(['bad%%' => '123']);
-        $process->inheritEnvironmentVariables(true);
 
         $process->run();
 
@@ -1419,7 +1418,6 @@ public function testEnvBackupDoesNotDeleteExistingVars()
         $_ENV['existing_var'] = 'foo';
         $process = $this->getProcess('php -r "echo getenv(\'new_test_var\');"');
         $process->setEnv(['existing_var' => 'bar', 'new_test_var' => 'foo']);
-        $process->inheritEnvironmentVariables();
 
         $process->run();
 
@@ -1581,7 +1579,6 @@ private function getProcess($commandline, string $cwd = null, array $env = null,
         } else {
             $process = new Process($commandline, $cwd, $env, $input, $timeout);
         }
-        $process->inheritEnvironmentVariables();
 
         if (self::$process) {
             self::$process->stop(0);
diff --git a/src/Symfony/Component/VarDumper/Tests/Dumper/ServerDumperTest.php b/src/Symfony/Component/VarDumper/Tests/Dumper/ServerDumperTest.php
@@ -88,7 +88,6 @@ private function getServerProcess(): Process
             'COMPONENT_ROOT' => __DIR__.'/../../',
             'VAR_DUMPER_SERVER' => self::VAR_DUMPER_SERVER,
         ]);
-        $process->inheritEnvironmentVariables(true);
 
         return $process->setTimeout(9);
     }
diff --git a/src/Symfony/Component/VarDumper/Tests/Server/ConnectionTest.php b/src/Symfony/Component/VarDumper/Tests/Server/ConnectionTest.php
@@ -81,7 +81,6 @@ private function getServerProcess(): Process
             'COMPONENT_ROOT' => __DIR__.'/../../',
             'VAR_DUMPER_SERVER' => self::VAR_DUMPER_SERVER,
         ]);
-        $process->inheritEnvironmentVariables(true);
 
         return $process->setTimeout(9);
     }
diff --git a/src/Symfony/Component/VarDumper/composer.json b/src/Symfony/Component/VarDumper/composer.json
@@ -23,7 +23,7 @@
     "require-dev": {
         "ext-iconv": "*",
         "symfony/console": "^3.4|^4.0|^5.0",
-        "symfony/process": "^3.4|^4.0|^5.0",
+        "symfony/process": "^4.4|^5.0",
         "twig/twig": "~1.34|~2.4"
     },
     "conflict": {

Original file line number	Diff line number	Diff line change
`@@ -1210,9 +1210,13 @@ public function setInput($input)`
`1210`	`1210`	`* @param bool $inheritEnv`
`1211`	`1211`	`*`
`1212`	`1212`	`* @return self The current Process instance`
	`1213`	`+ *`
	`1214`	`+ * @deprecated since Symfony 4.4, env variables are always inherited`
`1213`	`1215`	`*/`
`1214`	`1216`	`public function inheritEnvironmentVariables($inheritEnv = true)`
`1215`	`1217`	`{`
	`1218`	`+ @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.4, env variables are always inherited.', __METHOD__), E_USER_DEPRECATED);`
	`1219`	`+`
`1216`	`1220`	`if (!$inheritEnv) {`
`1217`	`1221`	`throw new InvalidArgumentException('Not inheriting environment variables is not supported.');`
`1218`	`1222`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,6 @@ private function getServerProcess(): Process`
`88`	`88`	`'COMPONENT_ROOT' => __DIR__.'/../../',`
`89`	`89`	`'VAR_DUMPER_SERVER' => self::VAR_DUMPER_SERVER,`
`90`	`90`	`]);`
`91`		`- $process->inheritEnvironmentVariables(true);`
`92`	`91`
`93`	`92`	`return $process->setTimeout(9);`
`94`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,6 @@ private function getServerProcess(): Process`
`81`	`81`	`'COMPONENT_ROOT' => __DIR__.'/../../',`
`82`	`82`	`'VAR_DUMPER_SERVER' => self::VAR_DUMPER_SERVER,`
`83`	`83`	`]);`
`84`		`- $process->inheritEnvironmentVariables(true);`
`85`	`84`
`86`	`85`	`return $process->setTimeout(9);`
`87`	`86`	`}`