!!![FEATURE] Improve Plantuml debug output

For this we have to pass the rendercontext to the DiagramRenderer, a breaking change if the interface was implemented externally.

Author: linawolf

packages/guides-graphs/src/Graphs/Renderer/DiagramRenderer.php

@@ -13,7 +13,9 @@
 
 namespace phpDocumentor\Guides\Graphs\Renderer;
 
+use phpDocumentor\Guides\RenderContext;
+
 interface DiagramRenderer
 {
-    public function render(string $diagram): string|null;
+    public function render(RenderContext $renderContext, string $diagram): string|null;
 }

packages/guides-graphs/src/Graphs/Renderer/PlantumlRenderer.php

@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\Graphs\Renderer;
 
+use phpDocumentor\Guides\RenderContext;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Process\Exception\RuntimeException;
 use Symfony\Component\Process\Process;
 
+use function array_merge;
 use function file_get_contents;
 use function file_put_contents;
 use function sys_get_temp_dir;
@@ -28,7 +30,7 @@ public function __construct(private readonly LoggerInterface $logger, private re
     {
     }
 
-    public function render(string $diagram): string|null
+    public function render(RenderContext $renderContext, string $diagram): string|null
     {
         $output = <<<PUML
 @startuml
@@ -50,12 +52,24 @@ public function render(string $diagram): string|null
             $process->run();
 
             if (!$process->isSuccessful()) {
-                $this->logger->error('Generating the class diagram failed', ['error' => $process->getErrorOutput()]);
+                $this->logger->error(
+                    'Generating the class diagram failed',
+                    array_merge(
+                        ['error' => $process->getErrorOutput()],
+                        $renderContext->getLoggerInformation(),
+                    ),
+                );
 
                 return null;
             }
         } catch (RuntimeException $e) {
-            $this->logger->error('Generating the class diagram failed', ['error' => $e->getMessage()]);
+            $this->logger->error(
+                'Generating the class diagram failed',
+                array_merge(
+                    ['error' => $e->getMessage()],
+                    $renderContext->getLoggerInformation(),
+                ),
+            );
 
             return null;
         }

packages/guides-graphs/src/Graphs/Renderer/PlantumlServerRenderer.php

@@ -4,10 +4,12 @@
 
 namespace phpDocumentor\Guides\Graphs\Renderer;
 
+use phpDocumentor\Guides\RenderContext;
 use Psr\Log\LoggerInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 use function Jawira\PlantUml\encodep;
+use function sprintf;
 
 final class PlantumlServerRenderer implements DiagramRenderer
 {
@@ -18,17 +20,26 @@ public function __construct(
     ) {
     }
 
-    public function render(string $diagram): string|null
+    public function render(RenderContext $renderContext, string $diagram): string|null
     {
         $encodedDiagram = encodep($diagram);
 
+        $url = $this->plantumlServerUrl . '/svg/' . $encodedDiagram;
+
         $response = $this->httpClient->request(
             'GET',
-            $this->plantumlServerUrl . '/svg/' . $encodedDiagram,
+            $url,
         );
 
         if ($response->getStatusCode() !== 200) {
-            $this->logger->error('Failed to render diagram using server:' . $this->plantumlServerUrl);
+            $this->logger->warning(
+                sprintf(
+                    'Failed to render diagram using url: %s. The server returned status code %s. ',
+                    $url,
+                    $response->getStatusCode(),
+                ),
+                $renderContext->getLoggerInformation(),
+            );
 
             return null;
         }

packages/guides-graphs/src/Graphs/Renderer/TestRenderer.php

@@ -4,11 +4,13 @@
 
 namespace phpDocumentor\Guides\Graphs\Renderer;
 
+use phpDocumentor\Guides\RenderContext;
+
 use function md5;
 
 final class TestRenderer implements DiagramRenderer
 {
-    public function render(string $diagram): string|null
+    public function render(RenderContext $renderContext, string $diagram): string|null
     {
         return md5($diagram);
     }

packages/guides-graphs/src/Graphs/Twig/UmlExtension.php

@@ -14,9 +14,12 @@
 namespace phpDocumentor\Guides\Graphs\Twig;
 
 use phpDocumentor\Guides\Graphs\Renderer\DiagramRenderer;
+use phpDocumentor\Guides\RenderContext;
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFunction;
 
+use function assert;
+
 final class UmlExtension extends AbstractExtension
 {
     private DiagramRenderer $diagramRenderer;
@@ -37,12 +40,16 @@ public function __construct(iterable $renderers, string $rendererAlias)
     public function getFunctions(): array
     {
         return [
-            new TwigFunction('uml', $this->uml(...), ['is_safe' => ['html']]),
+            new TwigFunction('uml', $this->uml(...), ['is_safe' => ['html'], 'needs_context' => true]),
         ];
     }
 
-    public function uml(string $source): string|null
+    /** @param array{env: RenderContext} $context */
+    public function uml(array $context, string $source): string|null
     {
-        return $this->diagramRenderer->render($source);
+        $renderContext = $context['env'];
+        assert($renderContext instanceof RenderContext);
+
+        return $this->diagramRenderer->render($renderContext, $source);
     }
 }