Add solution providers

.gitignore

@@ -20,3 +20,5 @@ composer.lock
 /phpunit.phar
 /phpunit.xml
 /.phpunit.cache
+.phpunit.result.cache
+

composer.json

@@ -78,7 +78,8 @@
             "source-directory": "config"
         },
         "config-plugin": {
-            "di-web": "di-web.php"
+            "di-web": "di-web.php",
+            "params": "params.php"
         }
     },
     "config": {

config/di-web.php

@@ -13,5 +13,10 @@
 
 return [
     ThrowableRendererInterface::class => HtmlRenderer::class,
+    HtmlRenderer::class => [
+        '__construct()' => [
+            'solutionProviders' => $params['yiisoft/error-handler']['solutionProviders'],
+        ],
+    ],
     ThrowableResponseFactoryInterface::class => ThrowableResponseFactory::class,
 ];

config/params.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+
+/**
+ * @var array $params
+ */
+
+return [
+    'yiisoft/error-handler' => [
+        'solutionProviders' => [
+            Yiisoft\Definitions\Reference::to(Yiisoft\ErrorHandler\Solution\FriendlyExceptionSolution::class),
+        ],
+    ],
+];

src/Renderer/HtmlRenderer.php

@@ -129,6 +129,7 @@ final class HtmlRenderer implements ThrowableRendererInterface
      *   maxTraceLines?: int,
      *   traceHeaderLine?: string,
      * } $settings
+     * @param \Yiisoft\ErrorHandler\Solution\SolutionProviderInterface[] $solutionProviders
      */
     public function __construct(
         array $settings = [],
@@ -137,11 +138,13 @@ public function __construct(
         ?int $maxSourceLines = null,
         ?int $maxTraceLines = null,
         ?string $traceHeaderLine = null,
+        private readonly array $solutionProviders = []
     ) {
         $this->markdownParser = new GithubMarkdown();
         $this->markdownParser->html5 = true;
 
         $this->defaultTemplatePath = dirname(__DIR__, 2) . '/templates';
+
         $this->template = $template
             ?? $settings['template']
             ?? $this->defaultTemplatePath . '/production.php';
@@ -176,6 +179,7 @@ public function renderVerbose(Throwable $t, ?ServerRequestInterface $request = n
             $this->renderTemplate($this->verboseTemplate, [
                 'request' => $request,
                 'throwable' => $t,
+                'solutions' => $this->solutionProviders,
             ]),
             [Header::CONTENT_TYPE => self::CONTENT_TYPE],
         );
@@ -233,6 +237,9 @@ public function parseMarkdown(string $content): string
             'ol',
             'li',
             'img',
+            'form',
+            'input',
+            'button',
         ]);
     }
 

src/Solution/FriendlyExceptionSolution.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\ErrorHandler\Solution;
+
+use Yiisoft\FriendlyException\FriendlyExceptionInterface;
+
+final class FriendlyExceptionSolution implements SolutionProviderInterface
+{
+    public function supports(\Throwable $e): bool
+    {
+        return $e instanceof FriendlyExceptionInterface && $e->getSolution() !== null;
+    }
+
+    public function generate(\Throwable $e): string
+    {
+        return $e->getSolution();
+    }
+}

src/Solution/SolutionProviderInterface.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\ErrorHandler\Solution;
+
+/**
+* The interface declares an adapter to render a solution for an event.
+* Basically, it renders the error message as-is, but possible could render a button with click-to-fix action that will be handled by an HTTP request (with middleware) back to server.
+*/
+interface SolutionProviderInterface
+{
+    /**
+    * Returns true if the implementation may suggest more than regular provider.
+    */
+    public function supports(\Throwable $e): bool;
+
+    /**
+    * Generates an HTML code with solution which will be clean by {@see \Yiisoft\ErrorHandler\Renderer\HtmlRenderer} and shown to the end user.
+    */
+    public function generate(\Throwable $e): string;
+}

templates/development.php

@@ -4,12 +4,14 @@
 use Yiisoft\ErrorHandler\CompositeException;
 use Yiisoft\ErrorHandler\Exception\ErrorException;
 use Yiisoft\ErrorHandler\Renderer\HtmlRenderer;
+use Yiisoft\ErrorHandler\Solution\SolutionProviderInterface;
 use Yiisoft\FriendlyException\FriendlyExceptionInterface;
 
 /**
  * @var $this HtmlRenderer
  * @var $request ServerRequestInterface|null
  * @var $throwable Throwable
+ * @var $solutions SolutionProviderInterface[]
  */
 
 $theme = $_COOKIE['yii-exception-theme'] ?? '';
@@ -19,7 +21,6 @@
     $throwable = $throwable->getFirstException();
 }
 $isFriendlyException = $throwable instanceof FriendlyExceptionInterface;
-$solution = $isFriendlyException ? $throwable->getSolution() : null;
 $exceptionClass = get_class($throwable);
 $exceptionMessage = $throwable->getMessage();
 
@@ -92,9 +93,18 @@
             <?= nl2br($this->htmlEncode($exceptionMessage)) ?>
         </div>
 
-        <?php if ($solution !== null): ?>
-            <div class="solution"><?= $this->parseMarkdown($solution) ?></div>
-        <?php endif ?>
+        <?php
+        if (!empty($solutions)) {
+            echo '<div class="solutions">';
+            foreach ($solutions as $i => $solution) {
+                if ($solution->supports($throwable)) {
+                    echo '<div class="solution solution-' . $i . '">';
+                    echo $this->parseMarkdown($solution->generate($throwable));
+                    echo '</div>';
+                }
+            }
+        }
+        ?>
 
         <?= $this->renderPreviousExceptions($originalException) ?>
 

tests/ConfigTest.php

@@ -32,6 +32,9 @@ private function createContainer(?string $postfix = null): Container
 
     private function getDiConfig(?string $postfix = null): array
     {
+        $params = [
+            'yiisoft/error-handler' => ['solutionProviders' => []],
+        ];
         return require dirname(__DIR__) . '/config/di' . ($postfix !== null ? '-' . $postfix : '') . '.php';
     }
 }