Prepare release 4.3.0

ste93cry · web-flow · commit 12d0f9674b8a · 2022-05-30T14:09:35.000+02:00
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -92,16 +92,20 @@ jobs:
   missing-optional-packages-tests:
     name: Tests without optional packages
     runs-on: ubuntu-latest
+    env:
+      SYMFONY_REQUIRE: ${{ matrix.symfony-version }}
     strategy:
       fail-fast: false
       matrix:
         include:
           - php: '7.2'
             dependencies: lowest
+            symfony-version: 3.4.*
           - php: '7.4'
             dependencies: highest
           - php: '8.0'
             dependencies: lowest
+            symfony-version: 4.4.*
           - php: '8.1'
             dependencies: highest
 
@@ -113,7 +117,8 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          coverage: xdebug
+          coverage: pcov
+          tools: flex
 
       - name: Setup Problem Matchers for PHPUnit
         run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,10 @@
 
 ## Unreleased
 
+## 4.3.0 (2022-05-30)
 - Fix compatibility issue with Symfony >= 6.1.0 (#635)
+- Add `TracingDriverConnectionInterface::getNativeConnection()` method to get the original driver connection (#597)
+- Add `options.http_timeout` and `options.http_connect_timeout` configuration options (#593)
 
 ## 4.2.10 (2022-05-17)
 
diff --git a/composer.json b/composer.json
@@ -26,7 +26,7 @@
         "php": "^7.2||^8.0",
         "jean85/pretty-package-versions": "^1.5 || ^2.0",
         "php-http/discovery": "^1.11",
-        "sentry/sdk": "^3.1",
+        "sentry/sdk": "^3.2",
         "symfony/cache-contracts": "^1.1||^2.4||^3.0",
         "symfony/config": "^3.4.44||^4.4.20||^5.0.11||^6.0",
         "symfony/console": "^3.4.44||^4.4.20||^5.0.11||^6.0",
@@ -97,7 +97,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "4.2.x-dev",
+            "dev-master": "4.3.x-dev",
             "releases/3.2.x": "3.2.x-dev",
             "releases/2.x": "2.x-dev",
             "releases/1.x": "1.x-dev"
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -436,7 +436,7 @@ parameters:
 			path: tests/Tracing/Doctrine/DBAL/TracingServerInfoAwareDriverConnectionTest.php
 
 		-
-			message: "#^Trying to mock an undefined method requiresQueryForServerVersion\\(\\) on class Sentry\\\\SentryBundle\\\\Tests\\\\Tracing\\\\Doctrine\\\\DBAL\\\\ServerInfoAwareConnectionStub\\.$#"
+			message: "#^Trying to mock an undefined method requiresQueryForServerVersion\\(\\) on class Sentry\\\\SentryBundle\\\\Tests\\\\Tracing\\\\Doctrine\\\\DBAL\\\\Fixture\\\\ServerInfoAwareConnectionStub\\.$#"
 			count: 1
 			path: tests/Tracing/Doctrine/DBAL/TracingServerInfoAwareDriverConnectionTest.php
 
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -116,6 +116,14 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->booleanNode('send_default_pii')->end()
                         ->integerNode('max_value_length')->min(0)->end()
                         ->scalarNode('http_proxy')->end()
+                        ->integerNode('http_connect_timeout')
+                            ->min(0)
+                            ->info('The maximum number of seconds to wait while trying to connect to a server. It works only when using the default transport.')
+                        ->end()
+                        ->integerNode('http_timeout')
+                            ->min(0)
+                            ->info('The maximum execution time for the request+response as a whole. It works only when using the default transport.')
+                        ->end()
                         ->booleanNode('capture_silenced_errors')->end()
                         ->enumNode('max_request_body_size')
                             ->values([
diff --git a/src/Resources/config/schema/sentry-1.0.xsd b/src/Resources/config/schema/sentry-1.0.xsd
@@ -49,6 +49,8 @@
         <xsd:attribute name="send-default-pii" type="xsd:boolean" />
         <xsd:attribute name="max-value-length" type="xsd:integer" />
         <xsd:attribute name="http-proxy" type="xsd:string" />
+        <xsd:attribute name="http-timeout" type="xsd:integer" />
+        <xsd:attribute name="http-connect-timeout" type="xsd:integer" />
         <xsd:attribute name="capture-silenced-errors" type="xsd:boolean" />
         <xsd:attribute name="max-request-body-size" type="max-request-body-size" />
     </xsd:complexType>
diff --git a/src/Tracing/Doctrine/DBAL/TracingDriverConnection.php b/src/Tracing/Doctrine/DBAL/TracingDriverConnection.php
@@ -168,6 +168,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}
      */
diff --git a/src/Tracing/Doctrine/DBAL/TracingDriverConnectionInterface.php b/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;
diff --git a/src/Tracing/Doctrine/DBAL/TracingServerInfoAwareDriverConnection.php b/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}
      */
diff --git a/tests/DependencyInjection/Fixtures/php/full.php b/tests/DependencyInjection/Fixtures/php/full.php
@@ -36,6 +36,8 @@
         'send_default_pii' => true,
         'max_value_length' => 255,
         'http_proxy' => 'proxy.example.com:8080',
+        'http_timeout' => 10,
+        'http_connect_timeout' => 15,
         'capture_silenced_errors' => true,
         'max_request_body_size' => 'none',
         'class_serializers' => ['App\\FooClass' => 'App\\Sentry\\Serializer\\FooClassSerializer'],
diff --git a/tests/DependencyInjection/Fixtures/xml/full.xml b/tests/DependencyInjection/Fixtures/xml/full.xml
@@ -30,6 +30,8 @@
                         send-default-pii="true"
                         max-value-length="255"
                         http-proxy="proxy.example.com:8080"
+                        http-timeout="10"
+                        http-connect-timeout="15"
                         capture-silenced-errors="true"
                         max-request-body-size="none"
         >
diff --git a/tests/DependencyInjection/Fixtures/yml/full.yml b/tests/DependencyInjection/Fixtures/yml/full.yml
@@ -32,6 +32,8 @@ sentry:
         send_default_pii: true
         max_value_length: 255
         http_proxy: proxy.example.com:8080
+        http_timeout: 10
+        http_connect_timeout: 15
         capture_silenced_errors: true
         max_request_body_size: 'none'
         class_serializers:
diff --git a/tests/DependencyInjection/SentryExtensionTest.php b/tests/DependencyInjection/SentryExtensionTest.php
@@ -219,6 +219,8 @@ public function testClientIsCreatedFromOptions(): void
             'send_default_pii' => true,
             'max_value_length' => 255,
             'http_proxy' => 'proxy.example.com:8080',
+            'http_timeout' => 10,
+            'http_connect_timeout' => 15,
             'capture_silenced_errors' => true,
             'max_request_body_size' => 'none',
             'class_serializers' => [
diff --git a/tests/End2End/App/config.yml b/tests/End2End/App/config.yml
@@ -2,7 +2,7 @@ sentry:
   tracing:
     enabled: true
   options:
-    capture_silenced_errors: true
+    capture_silenced_errors: false
     error_types: E_ALL & ~E_USER_DEPRECATED
     traces_sample_rate: 0
 
diff --git a/tests/End2End/End2EndTest.php b/tests/End2End/End2EndTest.php
@@ -162,6 +162,15 @@ public function testGetFatal(): void
     public function testNotice(): void
     {
         $client = static::createClient();
+
+        /** @var HubInterface $hub */
+        $hub = $client->getContainer()->get('test.hub');
+        $sentryClient = $hub->getClient();
+
+        $this->assertNotNull($sentryClient);
+
+        $sentryClient->getOptions()->setCaptureSilencedErrors(true);
+
         $client->request('GET', '/notice');
 
         $response = $client->getResponse();
diff --git a/tests/Tracing/Doctrine/DBAL/Fixture/NativeDriverConnectionInterfaceStub.php b/tests/Tracing/Doctrine/DBAL/Fixture/NativeDriverConnectionInterfaceStub.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 NativeDriverConnectionInterfaceStub extends TracingDriverConnectionInterface
+{
+    /**
+     * @return object|resource
+     */
+    public function getNativeConnection();
+}
diff --git a/tests/Tracing/Doctrine/DBAL/Fixture/ServerInfoAwareConnectionStub.php b/tests/Tracing/Doctrine/DBAL/Fixture/ServerInfoAwareConnectionStub.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Sentry\SentryBundle\Tests\Tracing\Doctrine\DBAL;
+namespace Sentry\SentryBundle\Tests\Tracing\Doctrine\DBAL\Fixture;
 
 use Doctrine\DBAL\Driver\Connection;
 use Doctrine\DBAL\Driver\ServerInfoAwareConnection;
diff --git a/tests/Tracing/Doctrine/DBAL/TracingDriverConnectionFactoryTest.php b/tests/Tracing/Doctrine/DBAL/TracingDriverConnectionFactoryTest.php
@@ -8,6 +8,7 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use PHPUnit\Framework\MockObject\MockObject;
 use Sentry\SentryBundle\Tests\DoctrineTestCase;
+use Sentry\SentryBundle\Tests\Tracing\Doctrine\DBAL\Fixture\ServerInfoAwareConnectionStub;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverConnection;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverConnectionFactory;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingServerInfoAwareDriverConnection;
diff --git a/tests/Tracing/Doctrine/DBAL/TracingDriverConnectionTest.php b/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\NativeDriverConnectionInterfaceStub;
 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;
@@ -417,6 +419,32 @@ public function testGetWrappedConnection(): void
         $this->assertSame($this->decoratedConnection, $connection->getWrappedConnection());
     }
 
+    public function testGetNativeConnection(): void
+    {
+        $nativeConnection = new class() {
+        };
+
+        $decoratedConnection = $this->createMock(NativeDriverConnectionInterfaceStub::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>
      */
diff --git a/tests/Tracing/Doctrine/DBAL/TracingServerInfoAwareDriverConnectionTest.php b/tests/Tracing/Doctrine/DBAL/TracingServerInfoAwareDriverConnectionTest.php
@@ -10,6 +10,8 @@
 use Doctrine\DBAL\ParameterType;
 use PHPUnit\Framework\MockObject\MockObject;
 use Sentry\SentryBundle\Tests\DoctrineTestCase;
+use Sentry\SentryBundle\Tests\Tracing\Doctrine\DBAL\Fixture\NativeDriverConnectionInterfaceStub;
+use Sentry\SentryBundle\Tests\Tracing\Doctrine\DBAL\Fixture\ServerInfoAwareConnectionStub;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverConnectionInterface;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingServerInfoAwareDriverConnection;
 
@@ -256,4 +258,30 @@ public function testGetWrappedConnection(): void
 
         $this->assertSame($wrappedConnection, $this->connection->getWrappedConnection());
     }
+
+    public function testGetNativeConnection(): void
+    {
+        $nativeConnection = new class() {
+        };
+
+        $decoratedConnection = $this->createMock(NativeDriverConnectionInterfaceStub::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();
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -436,7 +436,7 @@ parameters:`
`436`	`436`	`path: tests/Tracing/Doctrine/DBAL/TracingServerInfoAwareDriverConnectionTest.php`
`437`	`437`
`438`	`438`	`-`
`439`		`- message: "#^Trying to mock an undefined method requiresQueryForServerVersion\\(\\) on class Sentry\\\\SentryBundle\\\\Tests\\\\Tracing\\\\Doctrine\\\\DBAL\\\\ServerInfoAwareConnectionStub\\.$#"`
	`439`	`+ message: "#^Trying to mock an undefined method requiresQueryForServerVersion\\(\\) on class Sentry\\\\SentryBundle\\\\Tests\\\\Tracing\\\\Doctrine\\\\DBAL\\\\Fixture\\\\ServerInfoAwareConnectionStub\\.$#"`
`440`	`440`	`count: 1`
`441`	`441`	`path: tests/Tracing/Doctrine/DBAL/TracingServerInfoAwareDriverConnectionTest.php`
`442`	`442`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@`
`6`	`6`
`7`	`7`	`use Doctrine\DBAL\Driver\Connection;`
`8`	`8`
	`9`	`+/**`
	`10`	`+ * @method resource\|object getNativeConnection()`
	`11`	`+ */`
`9`	`12`	`interface TracingDriverConnectionInterface extends Connection`
`10`	`13`	`{`
`11`	`14`	`public function getWrappedConnection(): Connection;`