[DoctrineBridge][Form] Fix BC break in DoctrineType #14576

malarzm · 2015-05-07T08:10:23Z

Q	A
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#14568
License	MIT
Doc PR	n/a

plozmun · 2015-05-07T10:34:37Z

I have test this with Doctrine/Mongo and i found next error:

Attempted to call an undefined method named "getSQL" of class "Doctrine\ODM\MongoDB\Query\Query".
in vendor/symfony/symfony/src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php at line 127   -

Removing $qbParts and its references it works

                $hash = CachingFactoryDecorator::generateHash(array(
                    $options['em'],
                    $options['class'],
                    $options['loader'],
                ));

malarzm · 2015-05-07T11:35:04Z

@arkadis I've added check if query builder is indeed one from ORM

plozmun · 2015-05-07T11:42:55Z

Now it works perfectly! Thanks!

Tobion · 2015-05-07T11:46:05Z

The allowed types for query builder should then be set on the subclass (entity)

malarzm · 2015-05-07T12:00:11Z

@Tobion in fact you're right, I will move code I have removed to Entity type

malarzm · 2015-05-07T12:51:30Z

@Tobion done, commits are squashed, travis is green

nicolas-grekas · 2015-05-13T14:25:27Z

Would it possible to add a test to prevent any regression?

malarzm · 2015-05-13T14:39:18Z

@nicolas-grekas what do you think about creating new Type for tests that won't override any options, pass some class as query_builder (both object and closure returning it) and expect that exception will not be thrown?

stof · 2015-05-13T17:29:13Z

src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php

@@ -124,7 +122,7 @@ public function configureOptions(OptionsResolver $resolver)
            if (null === $options['choices']) {
                // We consider two query builders with an equal SQL string and
                // equal parameters to be equal
-                $qbParts = $options['query_builder']
+                $qbParts = $options['query_builder'] instanceof \Doctrine\ORM\QueryBuilder
                    ? array(
                        $options['query_builder']->getQuery()->getSQL(),
                        $options['query_builder']->getParameters()->toArray(),


This logic to compare the query builder is specific to the ORM, so it must go in the child class, with a way for other Doctrine implementations (in MongoDBBundle for instance) to provide their own hashing for their query builders.

and in case the query builder cannot be compared (MongoDBBundle not implementing the method yet), the cache should be avoided instead of using the wrong cache.

malarzm · 2015-05-14T11:27:44Z

@stof I have changed the caching logic, can you take a look?

nicolas-grekas · 2015-05-15T12:06:17Z

src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php

+     * @internal This method is public to be usable as callback. It should not
+     *           be used in user code.
+     */
+    public function getQueryBuilderPartsForCachingHash($queryBuilder)


protected would work isn't it ?

It yells that it has to be public as that's how parent class defines it

changing the parent is also possible

Won't it break in PHP 5.3?

I basically followed how it has already been done here: https://github.com/symfony/symfony/pull/14576/files#diff-0b86d71e1a20e98ac050dd33c4e79373R103

please try moving both of them to protected. It should work, and anyway tests will tell if I'm wrong on 5.3 or any other version

malarzm · 2015-05-15T13:48:13Z

@nicolas-grekas https://travis-ci.org/symfony/symfony/jobs/62702058#L1706 - I'm going to throw out last commit

nicolas-grekas · 2015-05-15T13:48:22Z

src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php

+     * @return array|false Array with important QueryBuilder parts or false if
+     *                     they can't be determined
+     */
+    protected function getQueryBuilderPartsForCachingHash($queryBuilder)


my bad, I missed the closure... public required sorry

malarzm · 2015-05-15T13:53:09Z

Ok, so last Travis fail is unrelated to my changes :)

fabpot · 2015-05-20T08:37:50Z

Thank you @malarzm.

malarzm force-pushed the gh-14568 branch from 1c52562 to 4e85fb7 Compare May 7, 2015 08:14

malarzm changed the title ~~[DoctrineBridge][Form] Fix BC break in QueryBuilder normalizer~~ [DoctrineBridge][Form] Remove BC break in QueryBuilder normalizer May 7, 2015

malarzm changed the title ~~[DoctrineBridge][Form] Remove BC break in QueryBuilder normalizer~~ [DoctrineBridge][Form] Remove BC break in DoctrineType May 7, 2015

[DoctrineBridge][Form] Fix BC break in DoctrineType

43d2a0f

malarzm force-pushed the gh-14568 branch from 7d2c728 to 43d2a0f Compare May 7, 2015 12:21

malarzm changed the title ~~[DoctrineBridge][Form] Remove BC break in DoctrineType~~ [DoctrineBridge][Form] Fix BC break in DoctrineType May 7, 2015

jakzal added Form Doctrine labels May 12, 2015

stof reviewed May 13, 2015
View reviewed changes

nicolas-grekas reviewed May 15, 2015
View reviewed changes

malarzm force-pushed the gh-14568 branch from 632b69b to 999c70b Compare May 15, 2015 12:40

nicolas-grekas reviewed May 15, 2015
View reviewed changes

malarzm force-pushed the gh-14568 branch from d95a468 to 999c70b Compare May 15, 2015 13:51

Changed DoctrineChoiceLoader caching logic

07185fb

malarzm force-pushed the gh-14568 branch from 999c70b to 07185fb Compare May 15, 2015 13:59

fabpot closed this in 2213e67 May 20, 2015

Uh oh!

[DoctrineBridge][Form] Fix BC break in DoctrineType #14576

[DoctrineBridge][Form] Fix BC break in DoctrineType #14576

Uh oh!

Conversation

malarzm commented May 7, 2015

Uh oh!

plozmun commented May 7, 2015

Uh oh!

malarzm commented May 7, 2015

Uh oh!

plozmun commented May 7, 2015

Uh oh!

Tobion commented May 7, 2015

Uh oh!

malarzm commented May 7, 2015

Uh oh!

malarzm commented May 7, 2015

Uh oh!

nicolas-grekas commented May 13, 2015

Uh oh!

malarzm commented May 13, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

malarzm commented May 14, 2015

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!

malarzm commented May 15, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

malarzm commented May 15, 2015

Uh oh!

fabpot commented May 20, 2015

Uh oh!

Uh oh!