fix

Author: Florian-Merle

phpstan-baseline.neon

@@ -0,0 +1,6 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Dead catch \\- Throwable is never thrown in the try block\\.$#"
+			count: 1
+			path: src/Component/FieldTypes/CallableFieldType.php

phpstan.neon

@@ -1,4 +1,6 @@
 includes:
+    - phpstan-baseline.neon
+
     - vendor/phpstan/phpstan-webmozart-assert/extension.neon
     - vendor/phpstan/phpstan-phpunit/extension.neon
 

src/Bundle/Renderer/TwigGridRenderer.php

@@ -37,32 +37,42 @@ final class TwigGridRenderer implements GridRendererInterface
 
     private FormTypeRegistryInterface $formTypeRegistry;
 
-    private OptionsParserInterface $optionsParser;
-
     private string $defaultTemplate;
 
     private array $actionTemplates;
 
     private array $filterTemplates;
 
+    private OptionsParserInterface $optionsParser;
+
     public function __construct(
         Environment $twig,
         ServiceRegistryInterface $fieldsRegistry,
         FormFactoryInterface $formFactory,
         FormTypeRegistryInterface $formTypeRegistry,
-        OptionsParserInterface $optionsParser,
         string $defaultTemplate,
         array $actionTemplates = [],
         array $filterTemplates = [],
+        ?OptionsParserInterface $optionsParser = null,
     ) {
         $this->twig = $twig;
         $this->fieldsRegistry = $fieldsRegistry;
         $this->formFactory = $formFactory;
         $this->formTypeRegistry = $formTypeRegistry;
-        $this->optionsParser = $optionsParser;
         $this->defaultTemplate = $defaultTemplate;
         $this->actionTemplates = $actionTemplates;
         $this->filterTemplates = $filterTemplates;
+        $this->optionsParser = $optionsParser;
+
+        if (null === $optionsParser) {
+            trigger_deprecation(
+                'sylius/grid-bundle',
+                '1.14',
+                'Not passing an instance of "%s" as the eighth constructor argument of "%s" is deprecated.',
+                OptionsParserInterface::class,
+                self::class,
+            );
+        }
     }
 
     public function render(GridViewInterface $gridView, ?string $template = null)
@@ -77,7 +87,11 @@ public function renderField(GridViewInterface $gridView, Field $field, $data)
         $resolver = new OptionsResolver();
         $fieldType->configureOptions($resolver);
 
-        $options = $resolver->resolve($this->optionsParser->parseOptions($field->getOptions()));
+        $options = $field->getOptions();
+        if (null !== $this->optionsParser) {
+            $options = $this->optionsParser->parseOptions($options);
+        }
+        $options = $resolver->resolve($options);
 
         return $fieldType->render($field, $data, $options);
     }

src/Bundle/Resources/config/services/twig.xml

@@ -20,10 +20,10 @@
             <argument type="service" id="sylius.registry.grid_field" />
             <argument type="service" id="form.factory" />
             <argument type="service" id="sylius.form_registry.grid_filter" />
-            <argument type="service" id="sylius.grid.options_parser" />
             <argument>@SyliusGrid/_grid.html.twig</argument>
             <argument>%sylius.grid.templates.action%</argument>
             <argument>%sylius.grid.templates.filter%</argument>
+            <argument type="service" id="sylius.grid.options_parser" />
         </service>
         <service id="Sylius\Bundle\GridBundle\Renderer\TwigGridRenderer" alias="sylius.grid.renderer.twig" />
 

src/Bundle/Tests/Unit/Parser/OptionsParserTest.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\GridBundle\Tests\Unit\Parser;
+
+use PHPUnit\Framework\TestCase;
+use Sylius\Bundle\GridBundle\Parser\OptionsParser;
+use Sylius\Bundle\GridBundle\Parser\OptionsParserInterface;
+
+final class OptionsParserTest extends TestCase
+{
+    public function testItImplementsOptionsParserInterface(): void
+    {
+        $this->assertInstanceOf(OptionsParserInterface::class, new OptionsParser());
+    }
+
+    public function testItParserOptionsWithCallable(): void
+    {
+        $options = (new OptionsParser())->parseOptions([
+            'type' => 'callable',
+            'option' => [
+                'callable' => 'callable:strtoupper',
+            ],
+            'label' => 'app.ui.id',
+        ]);
+
+        $this->assertArrayHasKey('type', $options);
+        $this->assertArrayHasKey('option', $options);
+        $this->assertArrayHasKey('label', $options);
+
+        $this->assertIsCallable($options['option']['callable'] ?? null);
+    }
+
+    public function testItFailsWhileParsingOptionsWithInvalidCallable(): void
+    {
+        $this->expectException(\RuntimeException::class);
+
+        $options = (new OptionsParser())->parseOptions([
+            'type' => 'callable',
+            'option' => [
+                'callable' => 'callable:foobar',
+            ],
+            'label' => 'app.ui.id',
+        ]);
+    }
+}

src/Bundle/spec/Parser/OptionsParserSpec.php

@@ -26,7 +26,13 @@ public function __construct(private DataExtractorInterface $dataExtractor)
     public function render(Field $field, $data, array $options): string
     {
         $value = $this->dataExtractor->get($field, $data);
-        $value = (string) call_user_func($options['callable'], $value);
+        $value = call_user_func($options['callable'], $value);
+
+        try {
+            $value = (string) $value;
+        } catch (\Throwable $e) {
+            throw new \RuntimeException(\sprintf('The callback for field "%s" returned a value that could not be converted to string.', $field->getName()));
+        }
 
         if ($options['htmlspecialchars']) {
             $value = htmlspecialchars($value);

src/Component/FieldTypes/CallableFieldType.php

@@ -78,6 +78,25 @@ function it_uses_data_extractor_to_obtain_data_and_passes_it_to_a_static_callabl
         ])->shouldReturn('bar');
     }
 
+    function it_throws_an_exception_when_a_callable_return_value_cannot_be_casted_to_string(
+        DataExtractorInterface $dataExtractor,
+        Field $field,
+    ): void {
+        $field->getName()->willReturn('id');
+        $dataExtractor->get($field, ['foo' => 'bar'])->willReturn('BAR');
+
+        $this
+            ->shouldThrow(\RuntimeException::class)
+            ->during('render', [
+                $field,
+                ['foo' => 'bar'],
+                [
+                    'callable' => fn () => new \stdclass(),
+                    'htmlspecialchars' => true,
+                ],
+            ]);
+    }
+
     static function callable(mixed $value): string
     {
         return strtolower($value);