[12.x] Log: Add optional keys parameter to Log::withoutContext to remove selected context from future logs (#55181)

* feat(log): pass context keys to withoutContext to forget

* formatting

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: mattroylloyd

src/Illuminate/Log/LogManager.php

@@ -514,13 +514,14 @@ public function sharedContext()
     /**
      * Flush the log context on all currently resolved channels.
      *
+     * @param  string[]|null  $keys
      * @return $this
      */
-    public function withoutContext()
+    public function withoutContext(?array $keys = null)
     {
         foreach ($this->channels as $channel) {
             if (method_exists($channel, 'withoutContext')) {
-                $channel->withoutContext();
+                $channel->withoutContext($keys);
             }
         }
 

src/Illuminate/Log/Logger.php

@@ -202,13 +202,18 @@ public function withContext(array $context = [])
     }
 
     /**
-     * Flush the existing context array.
+     * Flush the log context on all currently resolved channels.
      *
+     * @param  string[]|null  $keys
      * @return $this
      */
-    public function withoutContext()
+    public function withoutContext(?array $keys = null)
     {
-        $this->context = [];
+        if (is_array($keys)) {
+            $this->context = array_diff_key($this->context, array_flip($keys));
+        } else {
+            $this->context = [];
+        }
 
         return $this;
     }

src/Illuminate/Support/Facades/Log.php

@@ -9,7 +9,7 @@
  * @method static \Psr\Log\LoggerInterface driver(string|null $driver = null)
  * @method static \Illuminate\Log\LogManager shareContext(array $context)
  * @method static array sharedContext()
- * @method static \Illuminate\Log\LogManager withoutContext()
+ * @method static \Illuminate\Log\LogManager withoutContext(string[]|null $keys = null)
  * @method static \Illuminate\Log\LogManager flushSharedContext()
  * @method static string|null getDefaultDriver()
  * @method static void setDefaultDriver(string $name)

tests/Log/LogLoggerTest.php

@@ -47,6 +47,17 @@ public function testContextIsFlushed()
         $writer->error('foo');
     }
 
+    public function testContextKeysCanBeRemovedForSubsequentLogs()
+    {
+        $writer = new Logger($monolog = m::mock(Monolog::class));
+        $writer->withContext(['bar' => 'baz', 'forget' => 'me']);
+        $writer->withoutContext(['forget']);
+
+        $monolog->shouldReceive('error')->once()->with('foo', ['bar' => 'baz']);
+
+        $writer->error('foo');
+    }
+
     public function testLoggerFiresEventsDispatcher()
     {
         $writer = new Logger($monolog = m::mock(Monolog::class), $events = new Dispatcher);