Merge pull request #979 from phpDocumentor/backport/973

[TASK] Add test to prove proper error handling for plantuml

Author: jaapio

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

@@ -15,6 +15,7 @@
 
 use phpDocumentor\Guides\RenderContext;
 use Psr\Log\LoggerInterface;
+use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 use function Jawira\PlantUml\encodep;
@@ -35,24 +36,36 @@ public function render(RenderContext $renderContext, string $diagram): string|nu
 
         $url = $this->plantumlServerUrl . '/svg/' . $encodedDiagram;
 
-        $response = $this->httpClient->request(
-            'GET',
-            $url,
-        );
+        try {
+            $response = $this->httpClient->request(
+                'GET',
+                $url,
+            );
+
+            if ($response->getStatusCode() !== 200) {
+                $this->logger->warning(
+                    sprintf(
+                        'Failed to render diagram using url: %s. The server returned status code %s. ',
+                        $url,
+                        $response->getStatusCode(),
+                    ),
+                    $renderContext->getLoggerInformation(),
+                );
 
-        if ($response->getStatusCode() !== 200) {
+                return null;
+            }
+
+            return $response->getContent();
+        } catch (TransportExceptionInterface) {
             $this->logger->warning(
                 sprintf(
-                    'Failed to render diagram using url: %s. The server returned status code %s. ',
+                    'Failed to render diagram using url: %s. ',
                     $url,
-                    $response->getStatusCode(),
                 ),
                 $renderContext->getLoggerInformation(),
             );
 
             return null;
         }
-
-        return $response->getContent();
     }
 }

packages/guides-restructured-text/tests/unit/Parser/Productions/RuleTestCase.php

@@ -67,7 +67,7 @@ protected function givenInlineMarkupRule(): InlineMarkupRule
         $inlineTokenParser->method('parse')->willReturnCallback(
             static fn (string $arg): InlineCompoundNode => new InlineCompoundNode([
                 new PlainTextInlineNode($arg),
-            ])
+            ]),
         );
 
         return new InlineMarkupRule($inlineTokenParser);

packages/guides-restructured-text/tests/unit/Parser/Productions/SectionRuleTest.php

@@ -182,7 +182,7 @@ private function getInlineTokenParserMock(): InlineParser
     {
         $inlineTokenParser = $this->createMock(InlineParser::class);
         $inlineTokenParser->method('parse')->willReturnCallback(
-            static fn (string $arg): InlineCompoundNode => InlineCompoundNode::getPlainTextInlineNode($arg)
+            static fn (string $arg): InlineCompoundNode => InlineCompoundNode::getPlainTextInlineNode($arg),
         );
 
         return $inlineTokenParser;

tests/Integration/tests/graphs/plantuml-server-error/expected/index.html

@@ -0,0 +1,11 @@
+<!-- content start -->
+<div class="section" id="uml-directive">
+    <h1>Uml Directive</h1>
+    <figure
+            class="uml-diagram"
+            style="width: 1000"    ><figcaption>Figure 1-1: Application flow</figcaption></figure>
+    <figure
+            class="uml-diagram"
+            style="width: 1000"    ><figcaption>Figure 1-1: Application flow</figcaption></figure>
+</div>
+<!-- content end -->

tests/Integration/tests/graphs/plantuml-server-error/expected/logs/warning.log

@@ -0,0 +1,2 @@
+app.WARNING: Failed to render diagram using url: https://this-does-not-exist-phpdoc.com/svg/u-9ApaaiBbRGjLF8Byb8BN86ywmKSbEBYnFJKxcu0000.  {"rst-file":"index"} []
+app.WARNING: Failed to render diagram using url: https://this-does-not-exist-phpdoc.com/svg/u-9ApaaiBbRGjLF8Byb8BN86ywmKSbEBYnFJKxcu0000.  {"rst-file":"index"} []

tests/Integration/tests/graphs/plantuml-server-error/input/Plantuml/something.plantuml

@@ -0,0 +1,5 @@
+@startuml
+
+class -> otherClass : message
+
+@enduml

tests/Integration/tests/graphs/plantuml-server-error/input/guides.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<guides xmlns="https://www.phpdoc.org/guides"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd">
+    <extension class="phpDocumentor\Guides\Graphs">
+        <renderer>plantuml-server</renderer>
+        <plantuml-server>https://this-does-not-exist-phpdoc.com</plantuml-server>
+    </extension>
+</guides>

tests/Integration/tests/graphs/plantuml-server-error/input/index.rst

@@ -0,0 +1,14 @@
+==============
+Uml Directive
+==============
+
+.. uml:: /Plantuml/something.plantuml
+   :align: center
+   :caption: Figure 1-1: Application flow
+   :width: 1000
+
+
+.. uml:: Plantuml/something.plantuml
+   :align: center
+   :caption: Figure 1-1: Application flow
+   :width: 1000