Adds contextual data to root exception class

Author: jeremeamia

src/AppConfig.php

@@ -65,7 +65,7 @@ public function getEnv(): Env
     public function withId(string $id): self
     {
         $this->id = $id;
-        $this->getLogger()->withData(['app_id' => $id]);
+        $this->getLogger()->addContext(['app_id' => $id]);
 
         return $this;
     }
@@ -89,7 +89,7 @@ public function withAlias(string $alias): self
         $this->alias = $alias;
         $this->getLogger()
             ->withName($alias)
-            ->withData(['app_name' => $alias]);
+            ->addContext(['app_name' => $alias]);
 
         return $this;
     }
@@ -114,7 +114,7 @@ public function withLogger(LoggerInterface $logger): self
     {
         $this->logger = SlackLogger::wrap($logger)
             ->withName($this->getAlias())
-            ->withData(array_filter([
+            ->addContext(array_filter([
                 'app_id' => $this->getId(),
                 'app_name' => $this->getAlias(),
             ]));

src/Context.php

@@ -111,7 +111,7 @@ public function withAppConfig(AppConfig $config): self
 
         // Update the Logger with Context data.
         $this->logger()
-            ->withData($this->payload->getSummary())
+            ->addContext($this->payload->getSummary())
             ->debug('Incoming Slack request', [
                 'context' => $this->toArray(),
             ]);

src/Contexts/HasData.php

@@ -84,6 +84,34 @@ public function getOneOf(array $keys, bool $required = false)
         return null;
     }
 
+    /**
+     * @param string[] $keys
+     * @param bool $required Whether to throw an exception if any of the values are set.
+     * @return array<string, string|array|int|float|bool|null>
+     */
+    public function getAllOf(array $keys, bool $required = false): array
+    {
+        $values = [];
+        $missing = [];
+        foreach ($keys as $key) {
+            $value = $this->get($key);
+            if ($value === null) {
+                $missing[] = $key;
+            } else {
+                $values[$key] = $value;
+            }
+        }
+
+        if ($required && !empty($missing)) {
+            $class = static::class;
+            $list = implode(', ', array_map(fn (string $key) => "\"{$key}\"", $missing));
+
+            throw new Exception("Missing required values from {$class}: all of {$list}.");
+        }
+
+        return $values;
+    }
+
     /**
      * @param array $keys
      * @param array $data

src/Exception.php

@@ -5,8 +5,27 @@
 namespace SlackPhp\Framework;
 
 use RuntimeException;
+use Throwable;
 
 class Exception extends RuntimeException
 {
-    // No difference from RuntimeException.
+    protected array $context;
+
+    public function __construct($message = "", $code = 0, Throwable $previous = null, array $context = [])
+    {
+        $this->context = $context;
+        parent::__construct($message, $code, $previous);
+    }
+
+    public function addContext(array $context): self
+    {
+        $this->context = $context + $this->context;
+
+        return $this;
+    }
+
+    public function getContext(): array
+    {
+        return $this->context;
+    }
 }

src/Interceptors/Filter.php

@@ -22,7 +22,7 @@ public function __construct($defaultListener = null)
     public function intercept(Context $context, Listener $listener): void
     {
         $matched = $this->matches($context);
-        $context->logger()->withData(['filter:' . static::class => $matched ? 'match' : 'not-match']);
+        $context->logger()->addContext(['filter:' . static::class => $matched ? 'match' : 'not-match']);
 
         if (!$matched) {
             $listener = $this->defaultListener;

src/SlackLogger.php

@@ -58,13 +58,25 @@ public function withName(?string $name): self
         return $this;
     }
 
+    /**
+     * @deprecated use addContext() instead
+     * @param array $context
+     * @return $this
+     */
     public function withData(array $context): self
     {
         $this->context = $context + $this->context;
 
         return $this;
     }
 
+    public function addContext(array $context): self
+    {
+        $this->context = $context + $this->context;
+
+        return $this;
+    }
+
     public function log($level, $message, array $context = []): void
     {
         $this->logger->log($level, "[{$this->name}] {$message}", $context + $this->context);

src/StderrLogger.php

@@ -59,7 +59,12 @@ public function log($level, $message, array $context = [])
 
         // Apply special formatting for "exception" fields.
         if (isset($context['exception'])) {
-            $context['exception'] = explode("\n", (string) $context['exception']);
+            $exception = $context['exception'];
+            if ($exception instanceof Exception) {
+                $context = $exception->getContext() + $context;
+            }
+
+            $context['exception'] = explode("\n", (string) $exception);
         }
 
         fwrite($this->stream, json_encode(compact('level', 'message', 'context')) . "\n");