Add support for accessing dbal native connection

  Dbal V3 contains:

  ```php
  /**
   * Connection interface.
   * Driver connections must implement this interface.
   *
   * @method resource|object getNativeConnection()
   */
  interface Connection
  ```

Author: simPod

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Add `TracingDriverConnectionInterface::getNativeConnection()` method to get the original driver connection (#597)
+
 ## 4.2.6 (2022-01-10)
 
 - Add support for `symfony/cache-contracts` package version `3.x` (#588)

src/Tracing/Doctrine/DBAL/TracingDriverConnection.php

@@ -164,6 +164,20 @@ public function rollBack(): bool
         });
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return resource|object
+     */
+    public function getNativeConnection()
+    {
+        if (!method_exists($this->decoratedConnection, 'getNativeConnection')) {
+            throw new \BadMethodCallException(sprintf('The connection "%s" does not support accessing the native connection.', \get_class($this->decoratedConnection)));
+        }
+
+        return $this->decoratedConnection->getNativeConnection();
+    }
+
     /**
      * {@inheritdoc}
      */

src/Tracing/Doctrine/DBAL/TracingDriverConnectionInterface.php

@@ -6,6 +6,9 @@
 
 use Doctrine\DBAL\Driver\Connection;
 
+/**
+ * @method resource|object getNativeConnection()
+ */
 interface TracingDriverConnectionInterface extends Connection
 {
     public function getWrappedConnection(): Connection;

src/Tracing/Doctrine/DBAL/TracingServerInfoAwareDriverConnection.php

@@ -115,6 +115,20 @@ public function getServerVersion(): string
         return $wrappedConnection->getServerVersion();
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @return resource|object
+     */
+    public function getNativeConnection()
+    {
+        if (!method_exists($this->decoratedConnection, 'getNativeConnection')) {
+            throw new \BadMethodCallException(sprintf('The connection "%s" does not support accessing the native connection.', \get_class($this->decoratedConnection)));
+        }
+
+        return $this->decoratedConnection->getNativeConnection();
+    }
+
     /**
      * {@inheritdoc}
      */

tests/Tracing/Doctrine/DBAL/Fixture/NativeDriverConnectionInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\Tracing\Doctrine\DBAL\Fixture;
+
+use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverConnectionInterface;
+
+interface NativeDriverConnectionInterface extends TracingDriverConnectionInterface
+{
+    /**
+     * @return object|resource
+     */
+    public function getNativeConnection();
+}

tests/Tracing/Doctrine/DBAL/TracingDriverConnectionTest.php

@@ -10,7 +10,9 @@
 use Doctrine\DBAL\ParameterType;
 use PHPUnit\Framework\MockObject\MockObject;
 use Sentry\SentryBundle\Tests\DoctrineTestCase;
+use Sentry\SentryBundle\Tests\Tracing\Doctrine\DBAL\Fixture\NativeDriverConnectionInterface;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverConnection;
+use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverConnectionInterface;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingStatement;
 use Sentry\State\HubInterface;
 use Sentry\Tracing\Transaction;
@@ -396,6 +398,33 @@ public function testGetWrappedConnection(): void
         $this->assertSame($this->decoratedConnection, $connection->getWrappedConnection());
     }
 
+    public function testGetNativeConnection(): void
+    {
+        $nativeConnection = new class() {
+        };
+
+        $decoratedConnection = $this->createMock(NativeDriverConnectionInterface::class);
+        $decoratedConnection->expects($this->once())
+            ->method('getNativeConnection')
+            ->willReturn($nativeConnection);
+
+        $connection = new TracingDriverConnection($this->hub, $decoratedConnection, 'foo_platform', []);
+
+        $this->assertSame($nativeConnection, $connection->getNativeConnection());
+    }
+
+    public function testGetNativeConnectionThrowsExceptionIfDecoratedConnectionDoesNotImplementMethod(): void
+    {
+        $decoratedConnection = $this->createMock(TracingDriverConnectionInterface::class);
+
+        $connection = new TracingDriverConnection($this->hub, $decoratedConnection, 'foo_platform', []);
+
+        $this->expectException(\BadMethodCallException::class);
+        $this->expectExceptionMessageMatches('~The connection .+? does not support accessing the native connection~');
+
+        $connection->getNativeConnection();
+    }
+
     /**
      * @return \Generator<mixed>
      */

tests/Tracing/Doctrine/DBAL/TracingServerInfoAwareDriverConnectionTest.php

@@ -10,6 +10,7 @@
 use Doctrine\DBAL\ParameterType;
 use PHPUnit\Framework\MockObject\MockObject;
 use Sentry\SentryBundle\Tests\DoctrineTestCase;
+use Sentry\SentryBundle\Tests\Tracing\Doctrine\DBAL\Fixture\NativeDriverConnectionInterface;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverConnectionInterface;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingServerInfoAwareDriverConnection;
 
@@ -256,4 +257,31 @@ public function testGetWrappedConnection(): void
 
         $this->assertSame($wrappedConnection, $this->connection->getWrappedConnection());
     }
+
+    public function testGetNativeConnection(): void
+    {
+        $nativeConnection = new class() {
+        };
+
+        $decoratedConnection = $this->createMock(NativeDriverConnectionInterface::class);
+        $decoratedConnection->expects($this->once())
+            ->method('getNativeConnection')
+            ->willReturn($nativeConnection);
+
+        $connection = new TracingServerInfoAwareDriverConnection($decoratedConnection);
+
+        $this->assertSame($nativeConnection, $connection->getNativeConnection());
+    }
+
+    public function testGetNativeConnectionThrowsExceptionIfDecoratedConnectionDoesNotImplementMethod(): void
+    {
+        $decoratedConnection = $this->createMock(TracingDriverConnectionInterface::class);
+
+        $connection = new TracingServerInfoAwareDriverConnection($decoratedConnection);
+
+        $this->expectException(\BadMethodCallException::class);
+        $this->expectExceptionMessageMatches('~The connection .+? does not support accessing the native connection~');
+
+        $connection->getNativeConnection();
+    }
 }