[TwigBridge] fix BC for FormExtension if renderer is FormRenderer #24535

dmaicher · 2017-10-12T12:26:09Z

Q	A
Branch?	3.4
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#24533
License	MIT
Doc PR	-

This fixes some issues within FormExtension since the renderer is now a FormRenderer.

stof · 2017-10-12T13:37:06Z

src/Symfony/Bridge/Twig/Extension/FormExtension.php

@@ -54,6 +56,8 @@ public function initRuntime(Environment $environment)
    {
        if ($this->renderer instanceof TwigRendererInterface) {
            $this->renderer->setEnvironment($environment);
+        } elseif ($this->renderer instanceof FormRendererInterface && $this->renderer->getEngine() instanceof TwigRendererEngineInterface) {
+            $this->renderer->getEngine()->setEnvironment($environment);


you should do nothing in this case instead (it already has the environment injected properly)

Ah ok. Done 😉

stof · 2017-10-12T13:38:15Z

src/Symfony/Bridge/Twig/Extension/FormExtension.php

-                    $renderer->setEnvironment($this->renderer[2]);
+                    if ($renderer instanceof TwigRendererInterface) {
+                        $renderer->setEnvironment($this->renderer[2]);
+                    } elseif ($renderer instanceof FormRendererInterface && $renderer->getEngine() instanceof TwigRendererEngineInterface) {


this case should never happen

It can happen if you call ->initRuntime before accessing ->renderer on 3.4?

$twig = $this->get('twig'); $twig ->getExtension('Symfony\Bridge\Twig\Extension\FormExtension') ->initRuntime($twig); $twig ->getExtension('Symfony\Bridge\Twig\Extension\FormExtension') ->renderer;

Results in:

Attempted to call an undefined method named "setEnvironment" of class "Symfony\Component\Form\FormRenderer".

This works fine on 3.3.

xabbuh · 2017-10-12T14:48:34Z

Can't we create a test case that would fail without these changes?

dmaicher · 2017-10-12T15:26:00Z

src/Symfony/Bridge/Twig/Tests/Extension/FormExtensionTest.php

+use Symfony\Component\Form\FormRendererInterface;
+use Twig\Environment;
+
+class FormExtensionTest extends TestCase


should I mark this test somehow as deprecated or similar? There is no need to merge it into master for example as there is nothing to test anymore really

dmaicher · 2017-10-12T15:45:50Z

I don't quite understand this test fail:

1) Warning
The data provider specified for Symfony\Bridge\Twig\Tests\Extension\FormExtensionTest::testInitRuntimeAndAccessRenderer is invalid.
Trying to configure method "get" which cannot be configured because it does not exist, has not been specified, is final, or is static
2) Warning
The data provider specified for Symfony\Bridge\Twig\Tests\Extension\FormExtensionTest::testAccessRendererAndInitRuntime is invalid.
Trying to configure method "get" which cannot be configured because it does not exist, has not been specified, is final, or is static

I'm mocking Symfony\Component\DependencyInjection\ContainerInterface.

xabbuh · 2017-10-12T17:53:21Z

Looks like you need to add your tests to the legacy group.

dmaicher · 2017-10-12T18:15:12Z

@xabbuh thanks looks better now. One test fail left: https://travis-ci.org/symfony/symfony/jobs/287174522

xabbuh · 2017-10-13T06:30:52Z

You need to add symfony/dependency-injection to the require-dev section of TwigBridge's composer.json file.

dmaicher · 2017-10-13T06:46:33Z

thanks again @xabbuh 👍 Can be reviewed then

xabbuh · 2017-10-13T09:35:33Z

src/Symfony/Bridge/Twig/Extension/FormExtension.php

@@ -54,7 +54,7 @@ public function initRuntime(Environment $environment)
    {
        if ($this->renderer instanceof TwigRendererInterface) {
            $this->renderer->setEnvironment($environment);
-        } elseif (null !== $this->renderer) {
+        } elseif (is_array($this->renderer)) {


This was not needed to fix the bug, right?

It is needed:

Testing Symfony\Bridge\Twig\Tests\Extension\FormExtensionTest .....E 6 / 6 (100%) Time: 132 ms, Memory: 4.00MB There was 1 error: 1) Symfony\Bridge\Twig\Tests\Extension\FormExtensionTest::testAccessRendererAndInitRuntime with data set #2 (array(Mock_ContainerInterface_3ca94d5e Object (...), 'service_id'), Mock_FormRendererInterface_d5edefef Object (...)) Error: Cannot use object of type Mock_FormRendererInterface_d5edefef as array /var/www/symfony/src/Symfony/Bridge/Twig/Extension/FormExtension.php:58 /var/www/symfony/src/Symfony/Bridge/Twig/Tests/Extension/FormExtensionTest.php:43 ERRORS! Tests: 6, Assertions: 15, Errors: 1.

Which is the problem reported here: sonata-project/SonataAdminBundle#4652

For anyone else wondering: The array stored in $this->renderer is replaced by the FormRenderInterface instance that is fetched from the container in __get(): https://github.com/dmaicher/symfony/blob/6813a9f1f1251412bf6161dd732e65e853680736/src/Symfony/Bridge/Twig/Extension/FormExtension.php#L124

chalasr · 2017-10-13T10:50:46Z

src/Symfony/Bridge/Twig/composer.json

@@ -22,6 +22,7 @@
    "require-dev": {
        "fig/link-util": "^1.0",
        "symfony/asset": "~2.8|~3.0|~4.0",
+        "symfony/dependency-injection": "~2.8|~3.0|~4.0",


this targets 3.4, should this be ~3.4|~4.0?

I just need the ContainerInterface for the tests. So I guess 2.8 is also fine? Not sure what to do here tbh 😊

fabpot · 2017-10-13T13:28:56Z

Thank you @dmaicher.

…enderer (dmaicher) This PR was squashed before being merged into the 3.4 branch (closes #24535). Discussion ---------- [TwigBridge] fix BC for FormExtension if renderer is FormRenderer | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #24533 | License | MIT | Doc PR | - This fixes some issues within FormExtension since the renderer is now a `FormRenderer`. Commits ------- 4a2f608 [TwigBridge] fix BC for FormExtension if renderer is FormRenderer

xabbuh · 2017-10-13T13:41:59Z

Just noticed: Shouldn't we have merged this into the 3.3 branch?

dmaicher · 2017-10-13T13:44:27Z

@xabbuh this bug did not exist on 3.3 though as the rendering service there was an instance of TwigRendererInterface and no FormRendererInterface yet as on 3.4

This PR was merged into the 4.0-dev branch. Discussion ---------- [TwigBridge] fix merge of 3.4 into master | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes/no | Fixed tickets | - | License | MIT | Doc PR | - Within #24535 I added `FormExtensionTest` which is completely useless now on master 😊 So this PR just removes the test after it has been merged from 3.4 into master. Commits ------- 5c36609 [TwigBridge] fix merge of 3.4 into master

nicolas-grekas · 2017-11-15T11:19:53Z

@dmaicher could you please check sonata-project/SonataAdminBundle#4758, is it somehow related to this one?

dmaicher · 2017-11-15T13:40:44Z

@nicolas-grekas seems not related as my fix was for 3.4 but the problem there actually happens on 3.3

dmaicher · 2017-11-15T13:46:16Z

But I have the feeling 3.4 broke BC by switching from Symfony\Bridge\Twig\Form\TwigRenderer to Symfony\Component\Form\FormRenderer?

This PR only fixes some symptoms of that BC break imho.

carsonbot added Status: Needs Review TwigBridge Bug labels Oct 12, 2017

[TwigBridge] fix BC for FormExtension if renderer is FormRenderer

fb6f02a

dmaicher force-pushed the fix-24533 branch from 9fff3aa to fb6f02a Compare October 12, 2017 12:27

stof reviewed Oct 12, 2017

View reviewed changes

review feedback

ae66719

add test case

0d82d36

dmaicher force-pushed the fix-24533 branch from 44784dd to 0d82d36 Compare October 12, 2017 15:19

dmaicher added 2 commits October 12, 2017 17:20

simplify

b0cc3ab

add assert

047327a

dmaicher commented Oct 12, 2017

View reviewed changes

fix createMock

1845da1

nicolas-grekas added this to the 3.4 milestone Oct 12, 2017

add test to legacy group

27aedb7

add dependency

6813a9f

carsonbot added Status: Reviewed and removed Status: Needs Review labels Oct 13, 2017

garf approved these changes Oct 13, 2017

View reviewed changes

xabbuh reviewed Oct 13, 2017

View reviewed changes

xabbuh approved these changes Oct 13, 2017

View reviewed changes

chalasr approved these changes Oct 13, 2017

View reviewed changes

fabpot approved these changes Oct 13, 2017

View reviewed changes

fabpot closed this Oct 13, 2017

dmaicher deleted the fix-24533 branch October 13, 2017 13:29

dmaicher mentioned this pull request Oct 18, 2017

[TwigBridge] fix merge of 3.4 into master #24603

Merged

dmaicher mentioned this pull request Dec 4, 2017

[TwigBridge] FormExtension/TwigRenderer/FormRenderer BC break on 3.4 #24533

Closed

Uh oh!

[TwigBridge] fix BC for FormExtension if renderer is FormRenderer #24535

[TwigBridge] fix BC for FormExtension if renderer is FormRenderer #24535

Uh oh!

Conversation

dmaicher commented Oct 12, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xabbuh commented Oct 12, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dmaicher commented Oct 12, 2017

Uh oh!

xabbuh commented Oct 12, 2017

Uh oh!

dmaicher commented Oct 12, 2017

Uh oh!

xabbuh commented Oct 13, 2017

Uh oh!

dmaicher commented Oct 13, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabpot commented Oct 13, 2017

Uh oh!

xabbuh commented Oct 13, 2017

Uh oh!

dmaicher commented Oct 13, 2017

Uh oh!

nicolas-grekas commented Nov 15, 2017

Uh oh!

dmaicher commented Nov 15, 2017

Uh oh!

dmaicher commented Nov 15, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

dmaicher commented Nov 15, 2017 •

edited

Loading