Support to reload .env when using hyperf/watcher. (#6936)

Co-authored-by: 李铭昕 <715557344@qq.com>

Author: albertcht

src/DotenvManager.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
+namespace Hyperf\Support;
+
+use Dotenv\Dotenv;
+use Dotenv\Repository\Adapter\AdapterInterface;
+use Dotenv\Repository\Adapter\PutenvAdapter;
+use Dotenv\Repository\RepositoryBuilder;
+
+class DotenvManager
+{
+    protected static AdapterInterface $adapter;
+
+    protected static Dotenv $dotenv;
+
+    protected static array $cachedValues;
+
+    public static function load(array $paths): void
+    {
+        if (isset(static::$cachedValues)) {
+            return;
+        }
+
+        static::$cachedValues = static::getDotenv($paths)->load();
+    }
+
+    public static function reload(array $paths, bool $force = false): void
+    {
+        if (! isset(static::$cachedValues)) {
+            static::load($paths);
+
+            return;
+        }
+
+        foreach (static::$cachedValues as $deletedEntry => $value) {
+            static::getAdapter()->delete($deletedEntry);
+        }
+
+        static::$cachedValues = static::getDotenv($paths, $force)->load();
+    }
+
+    protected static function getDotenv(array $paths, bool $force = false): Dotenv
+    {
+        if (isset(static::$dotenv) && ! $force) {
+            return static::$dotenv;
+        }
+
+        return static::$dotenv = Dotenv::create(
+            RepositoryBuilder::createWithNoAdapters()
+                ->addAdapter(static::getAdapter($force))
+                ->immutable()
+                ->make(),
+            $paths
+        );
+    }
+
+    protected static function getAdapter(bool $force = false): AdapterInterface
+    {
+        if (isset(static::$adapter) && ! $force) {
+            return static::$adapter;
+        }
+
+        return static::$adapter = PutenvAdapter::create()->get();
+    }
+}

tests/DotenvManagerTest.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
+namespace HyperfTest\Support;
+
+use Hyperf\Support\DotenvManager;
+use PHPUnit\Framework\Attributes\CoversNothing;
+use PHPUnit\Framework\TestCase;
+
+use function Hyperf\Support\env;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+#[CoversNothing]
+class DotenvManagerTest extends TestCase
+{
+    public function testLoad()
+    {
+        DotenvManager::load([__DIR__ . '/envs/oldEnv']);
+
+        $this->assertEquals('1.0', env('TEST_VERSION'));
+        $this->assertTrue(env('OLD_FLAG'));
+    }
+
+    public function testReload()
+    {
+        DotenvManager::load([__DIR__ . '/envs/oldEnv']);
+        $this->assertEquals('1.0', env('TEST_VERSION'));
+        $this->assertTrue(env('OLD_FLAG'));
+
+        DotenvManager::reload([__DIR__ . '/envs/newEnv'], true);
+        $this->assertEquals('2.0', env('TEST_VERSION'));
+        $this->assertNull(env('OLD_FLAG'));
+        $this->assertTrue(env('NEW_FLAG'));
+    }
+
+    public function testGetEnvFromEnvironment()
+    {
+        DotenvManager::load([__DIR__ . '/envs/oldEnv']);
+
+        $this->assertNotEquals('0.0.0', env('SW_VERSION'));
+    }
+}

tests/envs/newEnv/.env

@@ -0,0 +1,3 @@
+TEST_VERSION=2.0
+NEW_FLAG=true
+SW_VERSION="0.0.0"

tests/envs/oldEnv/.env

@@ -0,0 +1,3 @@
+TEST_VERSION=1.0
+OLD_FLAG=true
+SW_VERSION="0.0.0"