Merge pull request #15 from VadymHrechukha/HP-2823_check_rcp_logs_for_kafka_message_processing_errors_after_release

HP-2823: modified Has Context Exception class to returns formatter message with context

Author: SilverFire

src/Infrastructure/Exception/ExceptionDebugFormatter.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace hidev\Infrastructure\Exception;
+
+use hidev\exception\HasContextInterface;
+
+final class ExceptionDebugFormatter
+{
+    public function format(\Throwable $e, bool $skipContext = false): array
+    {
+        $debugInfo = [
+            'class' => \get_class($e),
+            'message' => $e->getMessage(),
+            'thrownAt' => $e->getFile() . ':' . $e->getLine(),
+        ];
+
+        if (!$skipContext && $e instanceof HasContextInterface) {
+            $debugInfo = array_merge($debugInfo, [
+                'context' => $e->getContext(),
+            ]);
+        }
+
+        if ($root = $e->getPrevious()) {
+            $debugInfo['parentException'] = $this->format($root, $skipContext);
+        }
+        return $debugInfo;
+    }
+}

src/exception/HasContext.php

@@ -4,6 +4,7 @@
 
 namespace hidev\exception;
 
+use hidev\Infrastructure\Exception\ExceptionDebugFormatter;
 use Throwable;
 use yii\helpers\ArrayHelper;
 
@@ -37,4 +38,37 @@ public function getContextValue(string $fieldName)
     {
         return ArrayHelper::getValue($this->context, $fieldName, '');
     }
+
+    public function getFormattedContext(): string
+    {
+        $text = '';
+        $context = $this->getContext();
+        if ($previous = $this->getPrevious()) {
+            $context['previousException'] = $this->getExceptionDebugInfo($previous);
+        }
+
+        if ($context) {
+            $text .= PHP_EOL . PHP_EOL . 'Context:';
+
+            foreach ($context as $key => $value) {
+                $stringValue = is_array($value) || is_object($value)
+                    ? $this->jsonEncode($value)
+                    : trim((string)$value);
+
+                $text .= PHP_EOL . '− ' . $key . ': ' . $stringValue;
+            }
+        }
+
+        return $text;
+    }
+
+    private function getExceptionDebugInfo(?Throwable $throwable): array
+    {
+        return (new ExceptionDebugFormatter())->format($throwable);
+    }
+
+    private function jsonEncode($value): string
+    {
+        return \json_encode($value, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT);
+    }
 }

src/exception/HasContextInterface.php

@@ -7,4 +7,6 @@ interface HasContextInterface extends \Throwable
     public function addContext(array $data): self;
 
     public function getContext(): array;
+
+    public function getFormattedContext(): string;
 }

tests/unit/exception/HasContextTest.php

@@ -59,4 +59,59 @@ public function testGetContextValueReturnsDefaultWhenMissing(): void
 
         $this->assertSame('', $e->getContextValue('missing.key'));
     }
+
+    // -----------------------------------------------------
+    // getFormattedContext() Tests
+    // -----------------------------------------------------
+
+    public function testGetFormattedContextReturnsEmptyStringWhenNoContext(): void
+    {
+        $e = new TestException('Error');
+
+        $this->assertSame('', $e->getFormattedContext());
+    }
+
+    public function testGetFormattedContextFormatsSimpleContext(): void
+    {
+        $e = new TestException('Error');
+        $e->addContext([
+            'key' => 'value',
+            'number' => 123,
+        ]);
+
+        $output = $e->getFormattedContext();
+
+        $this->assertStringContainsString('Context:', $output);
+        $this->assertStringContainsString('key: value', $output);
+        $this->assertStringContainsString('number: 123', $output);
+    }
+
+    public function testGetFormattedContextFormatsArrayValuesAsJson(): void
+    {
+        $e = new TestException('Error');
+        $e->addContext([
+            'data' => ['a' => 1, 'b' => 2],
+        ]);
+
+        $output = $e->getFormattedContext();
+
+        // Pretty-printed JSON
+        $this->assertStringContainsString('"a": 1', $output);
+        $this->assertStringContainsString('"b": 2', $output);
+    }
+
+    public function testGetFormattedContextIncludesPreviousException(): void
+    {
+        $previous = new TestException('Previous error');
+        $previous->addContext(['prevKey' => 'prevValue']);
+
+        $e = new TestException('Main error', 0, $previous);
+        $e->addContext(['key' => 'value']);
+
+        $output = $e->getFormattedContext();
+
+        $this->assertStringContainsString('previousException', $output);
+        $this->assertStringContainsString('prevKey', $output);
+        $this->assertStringContainsString('prevValue', $output);
+    }
 }