Update ModelManager to support Doctrine\ORM\Query directly #1691
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Makes life easier when you want to set sorting, caching, etc. directly from an admin, e.g. in configureFormFields
VincentLanglet
requested changes
Aug 27, 2022
There was a problem hiding this comment.
A case could be added for supportsQueryDataProvider
https://github.com/sonata-project/SonataDoctrineORMAdminBundle/blob/4.x/tests/Model/ModelManagerTest.php#L141-L154
Co-authored-by: Vincent Langlet <VincentLanglet@users.noreply.github.com>
Added test for Query class
|
Committed change & added test - I think it should work? |
VincentLanglet
approved these changes
Aug 28, 2022
VincentLanglet
requested changes
Aug 28, 2022
tests/Model/ModelManagerTest.php
Outdated
| @@ -149,6 +149,7 @@ public function testSupportsQuery(bool $expected, object $object): void | |||
| public function supportsQueryDataProvider(): iterable | |||
| { | |||
| yield [true, new ProxyQuery($this->createMock(QueryBuilder::class))]; | |||
| yield [true, $this->createMock(Query::class)]; | |||
There was a problem hiding this comment.
You forgot use Doctrine\ORM\Query;
There was a problem hiding this comment.
So I did! I need to get comfortable doing this via IDE instead of the github website, so I get warnings - added!
There was a problem hiding this comment.
Also with an IDE you can install the vendor and run the tests, seems like it's failing
Forgot use statement for Query
VincentLanglet
approved these changes
Aug 28, 2022
VincentLanglet
requested changes
Aug 28, 2022
tests/Model/ModelManagerTest.php
Outdated
| @@ -149,6 +150,7 @@ public function testSupportsQuery(bool $expected, object $object): void | |||
| public function supportsQueryDataProvider(): iterable | |||
| { | |||
| yield [true, new ProxyQuery($this->createMock(QueryBuilder::class))]; | |||
| yield [true, $this->createMock(Query::class)]; | |||
There was a problem hiding this comment.
You have to use
yield [true, new Query()];
to avoid the error
1) Error
The data provider specified for Sonata\DoctrineORMAdminBundle\Tests\Model\ModelManagerTest::testSupportsQuery is invalid.
PHPUnit\Framework\MockObject\ClassIsFinalException: Class "Doctrine\ORM\Query" is declared "final" and cannot be doubled
/home/runner/work/SonataDoctrineORMAdminBundle/SonataDoctrineORMAdminBundle/tests/Model/ModelManagerTest.php:153
Switch to AbstractQuery since that's where execute() lives, this way we can support NativeQuery, AND AbstractQuery can be mocked for tests.
VincentLanglet
approved these changes
Aug 28, 2022
|
Switched to AbstractQuery - supports NativeQuery + easier to mock |
jordisala1991
approved these changes
Aug 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Makes life easier when you want to set sorting, caching, etc. directly from an admin, e.g. in configureFormFields
Subject
I am hitting use cases in admins where I want to change sort order, add caching, etc. which requires modifying the actual Doctrine query object, not the QueryBuilder, and I need to then be able to pass it in. This worked previously in 3.X because there was a default call to execute() which just happened to work on Doctrine's Query class; I think it should be explicitly supported in ModelManager, to make things easier.
I am targeting this branch, because it does not break BC.
Changelog