Skip to content

Commit

Permalink
Fix rendering Twig hook message exception (#126)
Browse files Browse the repository at this point in the history
  • Loading branch information
GSadee authored Nov 10, 2024
2 parents fbe5619 + fb7deeb commit 5444413
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,22 @@

namespace Sylius\TwigHooks\Hookable\Renderer\Exception;

use Twig\Error\Error;
use Twig\Error\RuntimeError;
use Twig\Source;

class HookRenderException extends RuntimeError
{
public function __construct(string $message, ?int $lineno = null, ?Source $source = null, ?\Throwable $previous = null)
{
$lineno ??= $previous?->getLine() ?? -1;
$source ??= $previous instanceof Error ? $previous->getSourceContext() : null;

parent::__construct(
$message,
$lineno,
$source,
$previous,
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,15 @@ public function render(AbstractHookable $hookable, HookableMetadata $metadata):
return $this->twig->render($hookable->template, [
HooksRuntime::HOOKABLE_METADATA => $metadata,
]);
} catch (HookRenderException $exception) {
throw $exception;
} catch (\Throwable $exception) {
throw new HookRenderException(
sprintf(
'An error occurred during rendering the "%s" hook in the "%s" hookable',
'An error occurred during rendering the "%s" hook in the "%s" hookable. %s',
$hookable->name,
$hookable->hookName,
$exception->getMessage(),
),
previous: $exception,
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use Sylius\TwigHooks\Hookable\Metadata\HookableMetadata;
use Sylius\TwigHooks\Hookable\Renderer\Exception\HookRenderException;
use Sylius\TwigHooks\Hookable\Renderer\HookableTemplateRenderer;
use Tests\Sylius\TwigHooks\Utils\MotherObject\HookableComponentMotherObject;
use Tests\Sylius\TwigHooks\Utils\MotherObject\HookableTemplateMotherObject;
use Twig\Environment as Twig;
use Twig\Error\Error;

final class HookableTemplateRendererTest extends TestCase
{
Expand Down Expand Up @@ -65,6 +67,22 @@ public function testItRendersHookableTemplate(): void
$this->assertSame('some-rendered-template', $renderedTemplate);
}

public function testItThrowsAnExceptionWhenTwigThrowsAnError(): void
{
$metadata = $this->createMock(HookableMetadata::class);

$this->twig->expects($this->once())->method('render')->with('some-template', [
'hookable_metadata' => $metadata,
])->willThrowException(new Error('Unable to find the template.'));

$hookable = HookableTemplateMotherObject::withTarget('some-template');

$this->expectException(HookRenderException::class);
$this->expectExceptionMessage('An error occurred during rendering the "some_name" hook in the "some_hook" hookable. Unable to find the template at line 76.');

$this->getTestSubject()->render($hookable, $metadata);
}

private function getTestSubject(): HookableTemplateRenderer
{
return new HookableTemplateRenderer($this->twig);
Expand Down

0 comments on commit 5444413

Please sign in to comment.