Skip to content

Commit 1bffee8

Browse files
Jean85Jean85
authored
Bump minimum required DBAL version to 2.13 and rework compatibility layer (#527)
1 parent 070486e commit 1bffee8

14 files changed

+108
-67
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- Make the list of commands for which distributed tracing is active configurable (#515)
99
- Introduce `TracingDriverConnection::getWrappedConnection()` (#536)
1010
- Add the `logger` config option to ease setting a PSR-3 logger to debug the SDK (#538)
11+
- Bump requirement for DBAL tracing to `^2.13|^3`; simplify the DBAL tracing feature (#527)
1112

1213
## 4.1.4 (2021-06-18)
1314

‎composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"symfony/security-core": "^3.4.44||^4.4.20||^5.0.11"
3535
},
3636
"require-dev": {
37-
"doctrine/dbal": "^2.10||^3.0",
37+
"doctrine/dbal": "^2.13||^3.0",
3838
"doctrine/doctrine-bundle": "^1.12||^2.0",
3939
"friendsofphp/php-cs-fixer": "^2.18",
4040
"jangregor/phpstan-prophecy": "^0.8",

‎phpstan-baseline.neon

+22-2
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,12 @@ parameters:
5656
path: src/Tracing/Doctrine/DBAL/TracingDriver.php
5757

5858
-
59-
message: "#^Parameter \\#2 \\$query of class Doctrine\\\\DBAL\\\\Exception\\\\DriverException constructor expects Doctrine\\\\DBAL\\\\Query\\|null, Doctrine\\\\DBAL\\\\Driver\\\\Exception given\\.$#"
59+
message: "#^Parameter \\#2 \\$query of class Doctrine\\\\DBAL\\\\Exception\\\\DriverException constructor expects Doctrine\\\\DBAL\\\\Query\\|null, Doctrine\\\\DBAL\\\\Driver\\\\DriverException given\\.$#"
60+
count: 1
61+
path: src/Tracing/Doctrine/DBAL/TracingDriver.php
62+
63+
-
64+
message: "#^Parameter \\$exception of method Sentry\\\\SentryBundle\\\\Tracing\\\\Doctrine\\\\DBAL\\\\TracingDriver\\:\\:convertException\\(\\) has invalid typehint type Doctrine\\\\DBAL\\\\Driver\\\\DriverException\\.$#"
6065
count: 1
6166
path: src/Tracing/Doctrine/DBAL/TracingDriver.php
6267

@@ -115,6 +120,11 @@ parameters:
115120
count: 1
116121
path: src/aliases.php
117122

123+
-
124+
message: "#^Class Symfony\\\\Bundle\\\\FrameworkBundle\\\\Client not found\\.$#"
125+
count: 1
126+
path: tests/End2End/TracingEnd2EndTest.php
127+
118128
-
119129
message: "#^Call to method getException\\(\\) on an unknown class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\GetResponseForExceptionEvent\\.$#"
120130
count: 1
@@ -235,13 +245,23 @@ parameters:
235245
count: 1
236246
path: tests/Tracing/Cache/AbstractTraceableCacheAdapterTest.php
237247

248+
-
249+
message: "#^Class Doctrine\\\\DBAL\\\\Driver\\\\DriverException not found\\.$#"
250+
count: 3
251+
path: tests/Tracing/Doctrine/DBAL/TracingDriverTest.php
252+
238253
-
239254
message: "#^Parameter \\#1 \\$driverException of class Doctrine\\\\DBAL\\\\Exception\\\\DriverException constructor expects Doctrine\\\\DBAL\\\\Driver\\\\Exception, string given\\.$#"
240255
count: 1
241256
path: tests/Tracing/Doctrine/DBAL/TracingDriverTest.php
242257

243258
-
244-
message: "#^Parameter \\#2 \\$query of class Doctrine\\\\DBAL\\\\Exception\\\\DriverException constructor expects Doctrine\\\\DBAL\\\\Query\\|null, Doctrine\\\\DBAL\\\\Driver\\\\Exception&PHPUnit\\\\Framework\\\\MockObject\\\\MockObject given\\.$#"
259+
message: "#^Parameter \\#1 \\$originalClassName of method PHPUnit\\\\Framework\\\\TestCase\\:\\:createMock\\(\\) expects class\\-string\\<Doctrine\\\\DBAL\\\\Driver\\\\DriverException\\>, string given\\.$#"
260+
count: 2
261+
path: tests/Tracing/Doctrine/DBAL/TracingDriverTest.php
262+
263+
-
264+
message: "#^Parameter \\#2 \\$query of class Doctrine\\\\DBAL\\\\Exception\\\\DriverException constructor expects Doctrine\\\\DBAL\\\\Query\\|null, Doctrine\\\\DBAL\\\\Driver\\\\DriverException&PHPUnit\\\\Framework\\\\MockObject\\\\MockObject given\\.$#"
245265
count: 1
246266
path: tests/Tracing/Doctrine/DBAL/TracingDriverTest.php
247267

‎psalm-baseline.xml

+1-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<files psalm-version="4.7.0@d4377c0baf3ffbf0b1ec6998e8d1be2a40971005">
2+
<files psalm-version="4.8.1@f73f2299dbc59a3e6c4d66cff4605176e728ee69">
33
<file src="src/EventListener/ConsoleCommandListener.php">
44
<InvalidExtendClass occurrences="1">
55
<code>ConsoleListener</code>
@@ -8,9 +8,4 @@
88
<code>public function __construct(HubInterface $hub, bool $captureErrors = true)</code>
99
</MethodSignatureMismatch>
1010
</file>
11-
<file src="src/Tracing/Cache/TraceableCacheAdapterTrait.php">
12-
<InvalidReturnType occurrences="1">
13-
<code>getItems</code>
14-
</InvalidReturnType>
15-
</file>
1611
</files>

‎src/DependencyInjection/Compiler/DbalTracingPass.php

+18
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
namespace Sentry\SentryBundle\DependencyInjection\Compiler;
66

77
use Doctrine\DBAL\Driver\ResultStatement;
8+
use Doctrine\DBAL\Result;
89
use Sentry\SentryBundle\Tracing\Doctrine\DBAL\ConnectionConfigurator;
910
use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverMiddleware;
1011
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
@@ -39,6 +40,8 @@ public function process(ContainerBuilder $container): void
3940
return;
4041
}
4142

43+
$this->assertRequiredDbalVersion();
44+
4245
/** @var string[] $connectionsToTrace */
4346
$connectionsToTrace = $container->getParameter('sentry.tracing.dbal.connections');
4447

@@ -92,4 +95,19 @@ private function getSetMiddlewaresMethodCallArguments(Definition $definition): a
9295

9396
return [];
9497
}
98+
99+
private function assertRequiredDbalVersion(): void
100+
{
101+
if (interface_exists(Result::class)) {
102+
// DBAL ^2.13
103+
return;
104+
}
105+
106+
if (class_exists(Result::class)) {
107+
// DBAL ^3
108+
return;
109+
}
110+
111+
throw new \LogicException('Tracing support cannot be enabled as the Doctrine DBAL 2.13+ package is not installed. Try running "composer require doctrine/dbal:^2.13".');
112+
}
95113
}

‎src/Tracing/Doctrine/DBAL/Compatibility/DriverInterface.php

-12
This file was deleted.

‎src/Tracing/Doctrine/DBAL/TracingDriver.php

+1-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
* This is a simple implementation of the {@see DriverInterface} interface that
2020
* decorates an existing driver to support distributed tracing capabilities.
2121
* This implementation IS and MUST be compatible with all versions of Doctrine
22-
* DBAL >= 2.10.
22+
* DBAL >= 2.13.
2323
*
2424
* @internal
2525
*/
@@ -36,8 +36,6 @@ final class TracingDriver implements DriverInterface, VersionAwarePlatformDriver
3636
private $decoratedDriver;
3737

3838
/**
39-
* Constructor.
40-
*
4139
* @param HubInterface $hub The current hub
4240
* @param DriverInterface $decoratedDriver The instance of the driver to decorate
4341
*/

‎src/Tracing/Doctrine/DBAL/TracingDriverMiddleware.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
namespace Sentry\SentryBundle\Tracing\Doctrine\DBAL;
66

7-
use Doctrine\DBAL\Driver as DriverInterface;
8-
use Doctrine\DBAL\Driver\Middleware as MiddlewareInterface;
7+
use Doctrine\DBAL\Driver;
8+
use Doctrine\DBAL\Driver\Middleware;
99
use Sentry\State\HubInterface;
1010

1111
/**
12-
* This middleware wraps a {@see DriverInterface} instance into one that
12+
* This middleware wraps a {@see Driver} instance into one that
1313
* supports the distributed tracing feature of Sentry.
1414
*/
15-
final class TracingDriverMiddleware implements MiddlewareInterface
15+
final class TracingDriverMiddleware implements Middleware
1616
{
1717
/**
1818
* @var HubInterface The current hub
@@ -32,7 +32,7 @@ public function __construct(HubInterface $hub)
3232
/**
3333
* {@inheritdoc}
3434
*/
35-
public function wrap(DriverInterface $driver): DriverInterface
35+
public function wrap(Driver $driver): Driver
3636
{
3737
return new TracingDriver($this->hub, $driver);
3838
}

‎src/aliases.php

-21
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,14 @@
44

55
namespace Sentry\SentryBundle;
66

7-
use Doctrine\DBAL\Driver as DoctrineDriverInterface;
8-
use Doctrine\DBAL\Driver\DriverException as LegacyDriverExceptionInterface;
9-
use Doctrine\DBAL\Driver\Exception as DriverExceptionInterface;
107
use Doctrine\DBAL\Driver\ExceptionConverterDriver as LegacyExceptionConverterDriverInterface;
118
use Doctrine\DBAL\Driver\Middleware as DoctrineMiddlewareInterface;
12-
use Doctrine\DBAL\Driver\Result;
13-
use Doctrine\DBAL\Driver\Statement;
149
use Sentry\SentryBundle\EventListener\ErrorListenerExceptionEvent;
1510
use Sentry\SentryBundle\EventListener\RequestListenerControllerEvent;
1611
use Sentry\SentryBundle\EventListener\RequestListenerRequestEvent;
1712
use Sentry\SentryBundle\EventListener\RequestListenerResponseEvent;
1813
use Sentry\SentryBundle\EventListener\RequestListenerTerminateEvent;
1914
use Sentry\SentryBundle\EventListener\SubRequestListenerRequestEvent;
20-
use Sentry\SentryBundle\Tracing\Doctrine\DBAL\Compatibility\DriverInterface;
2115
use Sentry\SentryBundle\Tracing\Doctrine\DBAL\Compatibility\ExceptionConverterDriverInterface;
2216
use Sentry\SentryBundle\Tracing\Doctrine\DBAL\Compatibility\MiddlewareInterface;
2317
use Symfony\Component\HttpKernel\Event\ControllerEvent;
@@ -94,26 +88,11 @@ class_alias(GetResponseEvent::class, SubRequestListenerRequestEvent::class);
9488
}
9589
}
9690

97-
if (interface_exists(Statement::class) && !interface_exists(Result::class)) {
98-
/** @psalm-suppress UndefinedClass */
99-
class_alias(Statement::class, Result::class);
100-
}
101-
102-
if (interface_exists(DriverExceptionInterface::class) && !interface_exists(LegacyDriverExceptionInterface::class)) {
103-
/** @psalm-suppress UndefinedClass */
104-
class_alias(DriverExceptionInterface::class, LegacyDriverExceptionInterface::class);
105-
}
106-
10791
if (!interface_exists(DoctrineMiddlewareInterface::class)) {
10892
/** @psalm-suppress UndefinedClass */
10993
class_alias(MiddlewareInterface::class, DoctrineMiddlewareInterface::class);
11094
}
11195

112-
if (!interface_exists(DoctrineDriverInterface::class)) {
113-
/** @psalm-suppress UndefinedClass */
114-
class_alias(DriverInterface::class, DoctrineDriverInterface::class);
115-
}
116-
11796
if (!interface_exists(LegacyExceptionConverterDriverInterface::class)) {
11897
/** @psalm-suppress UndefinedClass */
11998
class_alias(ExceptionConverterDriverInterface::class, LegacyExceptionConverterDriverInterface::class);

‎tests/DependencyInjection/Compiler/DbalTracingPassTest.php

+25-2
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ public function testProcessWithDoctrineDBALVersionAtLeast30(): void
8383

8484
public function testProcessWithDoctrineDBALVersionLowerThan30(): void
8585
{
86-
if (self::isDoctrineDBALVersion3Installed()) {
87-
$this->markTestSkipped('This test requires the version of the "doctrine/dbal" Composer package to be < 3.0.');
86+
if (!self::isDoctrineDBALVersion2Installed()) {
87+
$this->markTestSkipped('This test requires the version of the "doctrine/dbal" Composer package to be ^2.13.');
8888
}
8989

9090
$connection1 = (new Definition(Connection::class))->setPublic(true);
@@ -103,11 +103,30 @@ public function testProcessWithDoctrineDBALVersionLowerThan30(): void
103103
$this->assertNull($connection2->getConfigurator());
104104
}
105105

106+
public function testProcessWithDoctrineDBALMissing(): void
107+
{
108+
if (self::isDoctrineDBALInstalled()) {
109+
$this->markTestSkipped('This test requires the version of the "doctrine/dbal" Composer package to be missing.');
110+
}
111+
112+
$container = $this->createContainerBuilder();
113+
$container->setParameter('sentry.tracing.dbal.connections', ['foo', 'baz']);
114+
115+
$this->expectException(\LogicException::class);
116+
$this->expectExceptionMessage('Tracing support cannot be enabled as the Doctrine DBAL 2.13+ package is not installed. Try running "composer require doctrine/dbal:^2.13".');
117+
118+
$container->compile();
119+
}
120+
106121
/**
107122
* @dataProvider processDoesNothingIfConditionsForEnablingTracingAreMissingDataProvider
108123
*/
109124
public function testProcessDoesNothingIfConditionsForEnablingTracingAreMissing(ContainerBuilder $container): void
110125
{
126+
if (!self::isDoctrineDBALInstalled()) {
127+
$this->markTestSkipped('This test requires the "doctrine/dbal" Composer package.');
128+
}
129+
111130
$connectionConfigDefinition = new Definition();
112131
$connectionConfigDefinition->setClass(Configuration::class);
113132
$connectionConfigDefinition->setPublic(true);
@@ -141,6 +160,10 @@ public function processDoesNothingIfConditionsForEnablingTracingAreMissingDataPr
141160

142161
public function testContainerCompilationFailsIfConnectionDoesntExist(): void
143162
{
163+
if (!self::isDoctrineDBALInstalled()) {
164+
$this->markTestSkipped('This test requires the "doctrine/dbal" Composer package.');
165+
}
166+
144167
$container = $this->createContainerBuilder();
145168
$container->setParameter('sentry.tracing.dbal.connections', ['missing']);
146169

‎tests/DoctrineTestCase.php

+14-1
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,27 @@
55
namespace Sentry\SentryBundle\Tests;
66

77
use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
8+
use Doctrine\DBAL\Driver;
89
use Doctrine\DBAL\Driver\ResultStatement;
910
use PHPUnit\Framework\TestCase;
1011

1112
abstract class DoctrineTestCase extends TestCase
1213
{
14+
protected static function isDoctrineDBALInstalled(): bool
15+
{
16+
return interface_exists(Driver::class);
17+
}
18+
19+
protected static function isDoctrineDBALVersion2Installed(): bool
20+
{
21+
return self::isDoctrineDBALInstalled()
22+
&& interface_exists(ResultStatement::class);
23+
}
24+
1325
protected static function isDoctrineDBALVersion3Installed(): bool
1426
{
15-
return !interface_exists(ResultStatement::class);
27+
return self::isDoctrineDBALInstalled()
28+
&& !self::isDoctrineDBALVersion2Installed();
1629
}
1730

1831
protected static function isDoctrineBundlePackageInstalled(): bool

‎tests/End2End/TracingEnd2EndTest.php

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
use Symfony\Component\HttpFoundation\Response;
1313

1414
if (!class_exists(KernelBrowser::class)) {
15-
/** @phpstan-ignore-next-line */
1615
class_alias(Client::class, KernelBrowser::class);
1716
}
1817

‎tests/Tracing/Doctrine/DBAL/TracingDriverMiddlewareTest.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ final class TracingDriverMiddlewareTest extends DoctrineTestCase
2525

2626
public static function setUpBeforeClass(): void
2727
{
28-
if (!self::isDoctrineBundlePackageInstalled()) {
28+
if (!self::isDoctrineDBALVersion3Installed()) {
2929
self::markTestSkipped();
3030
}
3131
}

‎tests/Tracing/Doctrine/DBAL/TracingDriverTest.php

+19-12
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
use Doctrine\DBAL\Driver\Connection as DriverConnectionInterface;
1111
use Doctrine\DBAL\Driver\DriverException as DriverExceptionInterface;
1212
use Doctrine\DBAL\Driver\ExceptionConverterDriver as ExceptionConverterDriverInterface;
13+
use Doctrine\DBAL\Exception;
1314
use Doctrine\DBAL\Exception\DriverException as DBALDriverException;
1415
use Doctrine\DBAL\Platforms\AbstractPlatform;
1516
use Doctrine\DBAL\Schema\AbstractSchemaManager;
@@ -217,8 +218,8 @@ public function testCreateDatabasePlatformForVersionWhenDriverDoesNotImplementIn
217218

218219
public function testConvertException(): void
219220
{
220-
if (self::isDoctrineDBALVersion3Installed()) {
221-
$this->markTestSkipped('This test requires the version of the "doctrine/dbal" Composer package to be <= 3.0.');
221+
if (!self::isDoctrineDBALVersion2Installed()) {
222+
$this->markTestSkipped('This test requires the version of the "doctrine/dbal" Composer package to be ^2.13.');
222223
}
223224

224225
$exception = $this->createMock(DriverExceptionInterface::class);
@@ -249,18 +250,24 @@ public function testConvertExceptionThrowsIfDoctrineDBALVersionIsAtLeast30(): vo
249250
}
250251
}
251252

252-
if (interface_exists(VersionAwarePlatformDriverInterface::class)) {
253-
interface StubVersionAwarePlatformDriverInterface extends DriverInterface, VersionAwarePlatformDriverInterface
254-
{
253+
if (interface_exists(DriverInterface::class)) {
254+
if (interface_exists(VersionAwarePlatformDriverInterface::class)) {
255+
interface StubVersionAwarePlatformDriverInterface extends DriverInterface, VersionAwarePlatformDriverInterface
256+
{
257+
}
255258
}
256-
}
257259

258-
if (interface_exists(ExceptionConverterDriverInterface::class)) {
259-
interface StubExceptionConverterDriverInterface extends ExceptionConverterDriverInterface, DriverInterface
260-
{
260+
if (interface_exists(ExceptionConverterDriverInterface::class)) {
261+
interface StubExceptionConverterDriverInterface extends ExceptionConverterDriverInterface, DriverInterface
262+
{
263+
}
264+
} else {
265+
interface StubExceptionConverterDriverInterface extends DriverInterface
266+
{
267+
}
261268
}
262-
} else {
263-
interface StubExceptionConverterDriverInterface extends DriverInterface
264-
{
269+
270+
if (!interface_exists(DriverExceptionInterface::class)) {
271+
class_alias(Exception::class, DriverExceptionInterface::class);
265272
}
266273
}

0 commit comments

Comments
 (0)