[Cache] Support decorated Dbal drivers in PdoAdapter #42011

Jeroeny · 2021-07-07T07:57:55Z

Q	A
Branch?	4.4
Bug fix?	yes
New feature?	no
Deprecations?	no
Tickets	Explanation in this PR
License	MIT

Doctrine v3 supports middleware for Drivers. Upon creating the Connection, middleware->wrap(Driver): Driver is called, in which the middleware can wrap/decorate the Driver class. So that it can perform tracing for example.

When this happens, the Driver class inside the Connection is no longer one of Doctrine's well known Driver classes. The PdoAdapter uses this class to determine the database platform. Which breaks once the Driver is decorated and no longer one of the classes listed in the PdoAdapter.

Since Dbal exposes this middleware as a feature, I think it would be nice for the PdoAdapter to support this.

To solve this, the getDatabasePlatform can be used. This returns a Doctrine\DBAL\Platforms\AbstractPlatform which defines the abstract method getName. This returns a value very similar to the list in the PdoAdapter. The names don't match exactly, so therefor a small mapping is done to get right the name used in the adapter. As far as a I know, there'd be no other implications with this change.

Related: getsentry/sentry-symfony#530

derrabus · 2021-07-07T08:33:49Z

Can you provide a test for this change, please? I think we should target 4.4 and file this as a bugfix.

Jeroeny · 2021-07-07T12:26:13Z

Can you provide a test for this change, please? I think we should target 4.4 and file this as a bugfix.

Test added and rebased on 4.4.

Jeroeny · 2021-07-07T12:28:07Z

src/Symfony/Component/Cache/Tests/Adapter/PdoDbalAdapterTest.php

+            $config->setMiddlewares([$middleware]);
+
+            $connection = DriverManager::getConnection(['driver' => 'pdo_sqlite', 'path' => self::$dbFile], $config);
+        } else {


This is for doctrine/dbal v2, which doesn't have the middleware. Not sure if the test should cover this or something like a SkippedTestSuiteError should be thrown.

I'd rather call $this->markTestSkipped as the feature does not exist properly for v2

I agree. If the test is irrelevant for DBAL 2, just skip it if we‘re not testing against DBAL 3.

I agree. If the test is irrelevant for DBAL 2, just skip it if we‘re not testing against DBAL 3.

I don't think that this fix is irrelevant for DBAL 2, because you could still decorate/wrap the driver manually anyway, see #42022 and the originating issue getsentry/sentry-symfony#530.

In general, I think we should change the switch to use $this->conn->getDatabasePlatform()->getName() as a reliable source of information.

because you could still decorate/wrap the driver manually anyway

But not as official dbal v2 functionality right? You can pass a driverClass to the configuration, which is then constructed without arguments, making it less usable to function as decorator. Or it'd be via Reflection changing the private property _driver to public at runtime. Which is in my opinion already such an edge case, that Symfony shouldn't have to test against that.

src/Symfony/Component/Cache/Tests/Adapter/PdoDbalAdapterTest.php

Jean85

Thanks for this PR! This should fix #42022

I don't understand why you didn't use $this->conn->getDatabasePlatform()->getName() as you suggested yourself though...

Jean85 · 2021-07-08T05:44:48Z

src/Symfony/Component/Cache/Tests/Adapter/PdoDbalAdapterTest.php

+            $config->setMiddlewares([$middleware]);
+
+            $connection = DriverManager::getConnection(['driver' => 'pdo_sqlite', 'path' => self::$dbFile], $config);
+        } else {


I agree. If the test is irrelevant for DBAL 2, just skip it if we‘re not testing against DBAL 3.

I don't think that this fix is irrelevant for DBAL 2, because you could still decorate/wrap the driver manually anyway, see #42022 and the originating issue getsentry/sentry-symfony#530.

In general, I think we should change the switch to use $this->conn->getDatabasePlatform()->getName() as a reliable source of information.

Jeroeny · 2021-07-08T07:22:21Z

I don't understand why you didn't use $this->conn->getDatabasePlatform()->getName() as you suggested yourself though...

I did though? See PdoTrait:458

Edit: I see there's a slight difference ($driver->getDatabasePlatform()->getName()), but I'm not sure how important that difference is?

Jean85 · 2021-07-08T13:57:45Z

I don't understand why you didn't use $this->conn->getDatabasePlatform()->getName() as you suggested yourself though...

I did though? See PdoTrait:458

Edit: I see there's a slight difference ($driver->getDatabasePlatform()->getName()), but I'm not sure how important that difference is?

My suggestion is to change the whole switch to drive the choice using $driver->getDatabasePlatform()->getName(), because the instaceof will be broken by wrappers.

Jeroeny · 2021-07-12T14:22:00Z

My suggestion is to change the whole switch to drive the choice using $driver->getDatabasePlatform()->getName(), because the instaceof will be broken by wrappers.

That's good feedback 👍 . Though I'd like to get some feedback on that from a Symfony maintainer as well, if possible. They're the ones to approve the PR after all.

Jean85 · 2021-07-12T16:36:51Z

My suggestion is to change the whole switch to drive the choice using $driver->getDatabasePlatform()->getName(), because the instaceof will be broken by wrappers.

That's good feedback +1 . Though I'd like to get some feedback on that from a Symfony maintainer as well, if possible. They're the ones to approve the PR after all.

@nicolas-grekas already weighed in in #42022 (comment), but I'm not sure if he got the full implication of my suggestion.

.github/patch-types.php

nicolas-grekas · 2021-07-12T16:56:18Z

change the whole switch

That works for me if the resulting code remains compatible with the range of dbal versions we support currently.

derrabus

In patch-types.php, we maintain a list of files that should be ignored by that script. Please add your new DriverWrapper fixture there to make the tests pass.

derrabus · 2021-07-14T17:42:51Z

LGTM, but I'd turn the @return annotations of the DriverWrapper fixture into proper return types. This way, it does not matter that much if we exclude it from the patch-types script.

Tobion · 2021-07-14T20:18:13Z

Thank you @Jeroeny.

This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [Lock] Use platform to identify the PDO driver | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #43048 | License | MIT This should fix the issue in the same way we did for #42011. I'm not sure if I should add/change any test... Commits ------- 687a7ed [Lock] Use platform to identify the PDO driver

carsonbot added Status: Needs Review Cache Feature labels Jul 7, 2021

derrabus added this to the 4.4 milestone Jul 7, 2021

Jeroeny force-pushed the dbal branch from 3000ccf to 3d46b81 Compare July 7, 2021 12:24

Jeroeny changed the base branch from 5.4 to 4.4 July 7, 2021 12:25

Jeroeny commented Jul 7, 2021

View reviewed changes

derrabus reviewed Jul 7, 2021

View reviewed changes

src/Symfony/Component/Cache/Tests/Adapter/PdoDbalAdapterTest.php Outdated Show resolved Hide resolved

derrabus reviewed Jul 7, 2021

View reviewed changes

src/Symfony/Component/Cache/Tests/Adapter/PdoDbalAdapterTest.php Outdated Show resolved Hide resolved

nicolas-grekas mentioned this pull request Jul 8, 2021

[Cache] Using instanceof to identify DBAL driver is no longer reliable with DBAL v3 #42022

Closed

Jean85 mentioned this pull request Jul 8, 2021

Sentry bundle breaks Symfony cache adapter getsentry/sentry-symfony#530

Closed

Jean85 suggested changes Jul 8, 2021

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jul 8, 2021

Jeroeny requested a review from derrabus July 8, 2021 08:56

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jul 8, 2021

nicolas-grekas reviewed Jul 12, 2021

View reviewed changes

.github/patch-types.php Show resolved Hide resolved

Jeroeny requested a review from nicolas-grekas July 13, 2021 11:22

derrabus requested changes Jul 14, 2021

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jul 14, 2021

Jeroeny force-pushed the dbal branch from ef7e059 to 5ffd426 Compare July 14, 2021 17:30

Jeroeny requested a review from derrabus July 14, 2021 17:33

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jul 14, 2021

derrabus approved these changes Jul 14, 2021

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jul 14, 2021

Tobion approved these changes Jul 14, 2021

View reviewed changes

[Cache] Support decorated Dbal drivers in PdoAdapter

58d74e3

Tobion force-pushed the dbal branch from b963e49 to 58d74e3 Compare July 14, 2021 20:18

Tobion merged commit e5c96c4 into symfony:4.4 Jul 14, 2021

This was referenced Jul 26, 2021

Release v5.2.12 #42264

Merged

Release v4.4.27 #42266

Merged

Release v5.3.4 #42267

Merged

derrabus mentioned this pull request Aug 19, 2021

RFC: deprecate AbstractPlatform::getName() doctrine/dbal#4749

Closed

FractalizeR mentioned this pull request Sep 16, 2021

PostgreSqlStore breaks Sentry usage due to hard-coded instanceof checks. #43048

Closed

Jean85 mentioned this pull request Oct 1, 2021

[Lock] Use platform to identify the PDO driver #43281

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cache] Support decorated Dbal drivers in PdoAdapter #42011

[Cache] Support decorated Dbal drivers in PdoAdapter #42011

Jeroeny commented Jul 7, 2021 •

edited

derrabus commented Jul 7, 2021

Jeroeny commented Jul 7, 2021

Jeroeny Jul 7, 2021

stof Jul 7, 2021

derrabus Jul 7, 2021

Jean85 Jul 8, 2021

Jeroeny Jul 8, 2021

Jean85 left a comment

Jean85 Jul 8, 2021

Jeroeny commented Jul 8, 2021 •

edited

Jean85 commented Jul 8, 2021

Jeroeny commented Jul 12, 2021

Jean85 commented Jul 12, 2021

nicolas-grekas commented Jul 12, 2021

derrabus left a comment

derrabus commented Jul 14, 2021

Tobion commented Jul 14, 2021

[Cache] Support decorated Dbal drivers in PdoAdapter #42011

[Cache] Support decorated Dbal drivers in PdoAdapter #42011

Conversation

Jeroeny commented Jul 7, 2021 • edited

derrabus commented Jul 7, 2021

Jeroeny commented Jul 7, 2021

Jeroeny Jul 7, 2021

Choose a reason for hiding this comment

stof Jul 7, 2021

Choose a reason for hiding this comment

derrabus Jul 7, 2021

Choose a reason for hiding this comment

Jean85 Jul 8, 2021

Choose a reason for hiding this comment

Jeroeny Jul 8, 2021

Choose a reason for hiding this comment

Jean85 left a comment

Choose a reason for hiding this comment

Jean85 Jul 8, 2021

Choose a reason for hiding this comment

Jeroeny commented Jul 8, 2021 • edited

Jean85 commented Jul 8, 2021

Jeroeny commented Jul 12, 2021

Jean85 commented Jul 12, 2021

nicolas-grekas commented Jul 12, 2021

derrabus left a comment

Choose a reason for hiding this comment

derrabus commented Jul 14, 2021

Tobion commented Jul 14, 2021

Jeroeny commented Jul 7, 2021 •

edited

Jeroeny commented Jul 8, 2021 •

edited