[12.x] Add context remember functions (#56156)

* Add context remember methods

* Update PHPDoc

* Fix styling

* Accept mixed value

* Update PHPDoc

* formatting

---------

Co-authored-by: Taylor Otwell <taylor@laravel.com>

Author: btaskew

src/Illuminate/Log/Context/Repository.php

@@ -249,6 +249,42 @@ public function addHidden($key, #[\SensitiveParameter] $value = null)
         return $this;
     }
 
+    /**
+     * Add a context value if it does not exist yet, and return the value.
+     *
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return mixed
+     */
+    public function remember($key, $value)
+    {
+        if ($this->has($key)) {
+            return $this->get($key);
+        }
+
+        return tap(value($value), function ($value) use ($key) {
+            $this->add($key, $value);
+        });
+    }
+
+    /**
+     * Add a hidden context value if it does not exist yet, and return the value.
+     *
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return mixed
+     */
+    public function rememberHidden($key, #[\SensitiveParameter] $value)
+    {
+        if ($this->hasHidden($key)) {
+            return $this->getHidden($key);
+        }
+
+        return tap(value($value), function ($value) use ($key) {
+            $this->addHidden($key, $value);
+        });
+    }
+
     /**
      * Forget the given context key.
      *

src/Illuminate/Support/Facades/Context.php

@@ -44,6 +44,8 @@
  * @method static bool hasMacro(string $name)
  * @method static void flushMacros()
  * @method static \Illuminate\Database\Eloquent\Model restoreModel(\Illuminate\Contracts\Database\ModelIdentifier $value)
+ * @method static mixed remember(string $key, mixed $value)
+ * @method static mixed rememberHidden(string $key, mixed $value)
  *
  * @see \Illuminate\Log\Context\Repository
  */

tests/Log/ContextTest.php

@@ -662,6 +662,42 @@ public function test_it_custom_decrements_a_counter()
         Context::decrement('foo', 2);
         $this->assertSame(0, Context::get('foo'));
     }
+
+    public function test_it_remembers_a_value()
+    {
+        $this->assertSame(1, Context::remember('int', 1));
+
+        $closureRunCount = 0;
+        $closure = function () use (&$closureRunCount) {
+            $closureRunCount++;
+
+            return 'bar';
+        };
+
+        $this->assertSame('bar', Context::remember('foo', $closure));
+        $this->assertSame('bar', Context::get('foo'));
+
+        Context::remember('foo', $closure);
+        $this->assertSame(1, $closureRunCount);
+    }
+
+    public function test_it_remembers_a_hidden_value()
+    {
+        $this->assertSame(1, Context::rememberHidden('int', 1));
+
+        $closureRunCount = 0;
+        $closure = function () use (&$closureRunCount) {
+            $closureRunCount++;
+
+            return 'bar';
+        };
+
+        $this->assertSame('bar', Context::rememberHidden('foo', $closure));
+        $this->assertSame('bar', Context::getHidden('foo'));
+
+        Context::rememberHidden('foo', $closure);
+        $this->assertSame(1, $closureRunCount);
+    }
 }
 
 enum Suit