Added tests to test the DbalListener and make sure dbal is installed

Author: rjd22

.github/workflows/static-analysis.yaml

@@ -23,6 +23,9 @@ jobs:
       - name: Install dependencies
         run: composer update --no-progress --no-interaction --prefer-dist
 
+      - name: Install suggested packages
+        run: composer suggests sentry/sentry-symfony --list | xargs -i composer require {}
+
       - name: Run script
         run: composer phpcs
 
@@ -39,6 +42,9 @@ jobs:
       - name: Install dependencies
         run: composer update --no-progress --no-interaction --prefer-dist
 
+      - name: Install suggested packages
+        run: composer suggests sentry/sentry-symfony --list | xargs -i composer require {}
+
       - name: Run script
         run: composer phpstan
 
@@ -55,5 +61,8 @@ jobs:
       - name: Install dependencies
         run: composer update --no-progress --no-interaction --prefer-dist
 
+      - name: Install suggested packages
+        run: composer suggests sentry/sentry-symfony --list | xargs -i composer require {}
+
       - name: Run script
         run: composer psalm

.github/workflows/tests.yaml

@@ -58,6 +58,7 @@ jobs:
       - run: composer remove --dev symfony/messenger --no-update
         if: matrix.symfony_constraint == '3.4.*' || matrix.composer_option == '--prefer-lowest'
       - run: composer update --no-progress --ansi ${{ matrix.composer_option }}
+      - run: composer suggests sentry/sentry-symfony --list | xargs -i composer require {}
       - run: composer require sentry/sentry dev-develop
         if: matrix.sentry_constraint == 'dev-develop'
       - run: vendor/bin/phpunit --coverage-clover=coverage.xml

src/EventListener/Tracing/DbalListener.php

@@ -8,6 +8,7 @@
 use Sentry\State\HubInterface;
 use Sentry\Tracing\Span;
 use Sentry\Tracing\SpanContext;
+use Sentry\Tracing\Transaction;
 
 /**
  * Getting the logger, tied into dbal seems extremely hard. Cheating the system a bit by putting it in between the
@@ -40,7 +41,7 @@ public function startQuery($sql, ?array $params = null, ?array $types = null)
     {
         $transaction = $this->hub->getTransaction();
 
-        if (!$transaction) {
+        if (!$transaction instanceof Transaction) {
             return;
         }
 

tests/EventListener/Tracing/DbalListenerTest.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\EventListener\Tracing;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Sentry\SentryBundle\EventListener\Tracing\DbalListener;
+use Sentry\State\HubInterface;
+use Sentry\Tracing\Transaction;
+use Sentry\Tracing\TransactionContext;
+
+final class DbalListenerTest extends TestCase
+{
+    /**
+     * @var MockObject&HubInterface
+     */
+    private $hub;
+
+    /**
+     * @var DbalListener
+     */
+    private $listener;
+
+    protected function setUp(): void
+    {
+        $this->hub = $this->createMock(HubInterface::class);
+        $this->listener = new DbalListener($this->hub);
+    }
+
+    public function testThatDbalStartQueryIgnoresTracingWhenTransactionIsNotStarted(): void
+    {
+        $this->hub->expects($this->once())
+            ->method('getTransaction')
+            ->willReturn(null);
+
+        $this->listener->startQuery('');
+    }
+
+    public function testThatDbalStopQueryIgnoresTracingWhenChildSpanWasNotStarted(): void
+    {
+        $this->hub->expects($this->once())
+            ->method('getTransaction')
+            ->willReturn(null);
+
+        $this->listener->startQuery('');
+        $this->listener->stopQuery();
+    }
+
+    public function testThatDbalStartQueryAttachesAChildSpanWhenTransactionStarted(): void
+    {
+        $transaction = new Transaction(new TransactionContext());
+        $transaction->initSpanRecorder();
+
+        $this->hub->expects($this->once())
+            ->method('getTransaction')
+            ->willReturn($transaction);
+
+        $this->listener->startQuery('');
+
+        $spans = $transaction->getSpanRecorder()->getSpans();
+
+        $this->assertCount(2, $spans);
+        $this->assertNull($spans['1']->getEndTimestamp());
+    }
+
+    public function testThatDbalStopQueryFinishesTheChildSpanWhenChildSpanStarted(): void
+    {
+        $transaction = new Transaction(new TransactionContext());
+        $transaction->initSpanRecorder();
+
+        $this->hub->expects($this->once())
+            ->method('getTransaction')
+            ->willReturn($transaction);
+
+        $this->listener->startQuery('');
+        $this->listener->stopQuery();
+
+        $spans = $transaction->getSpanRecorder()->getSpans();
+
+        $this->assertCount(2, $spans);
+        $this->assertNotNull($spans['1']->getEndTimestamp());
+    }
+}