DatabaseIntegrationTest.php

<?php

namespace Sentry\Features;

use Illuminate\Database\Events\QueryExecuted;
use Illuminate\Support\Facades\DB;
use Sentry\Laravel\Tests\TestCase;
use Sentry\Tracing\Span;

class DatabaseIntegrationTest extends TestCase
{
    protected function usesMySQL($app): void
    {
        $app['config']->set('database.default', 'mysql');
        $app['config']->set('database.connections.mysql', [
            'driver' => 'mysql',
            'host' => 'host-mysql',
            'port' => 3306,
            'username' => 'user-mysql',
            'password' => 'password',
            'database' => 'db-mysql',
        ]);
    }

    protected function usesMySQLFromUrl($app): void
    {
        $app['config']->set('database.default', 'mysqlurl');
        $app['config']->set('database.connections.mysqlurl', [
            'driver' => 'mysql',
            'url' => 'mysql://user-mysqlurl:password@host-mysqlurl:3307/db-mysqlurl',
        ]);
    }

    protected function usesInMemorySqlite($app): void
    {
        $app['config']->set('database.default', 'inmemory');
        $app['config']->set('database.connections.inmemory', [
            'driver' => 'sqlite',
            'database' => ':memory:',
        ]);
    }

    /**
     * @define-env usesMySQL
     */
    public function testSpanIsCreatedForMySQLConnectionQuery(): void
    {
        $span = $this->executeQueryAndRetrieveSpan(
            $query = 'SELECT "mysql"'
        );

        $this->assertEquals($query, $span->getDescription());
        $this->assertEquals('db.sql.query', $span->getOp());
        $this->assertEquals('host-mysql', $span->getData()['server.address']);
        $this->assertEquals(3306, $span->getData()['server.port']);
    }

    /**
     * @define-env usesMySQLFromUrl
     */
    public function testSpanIsCreatedForMySQLUrlConnectionQuery(): void
    {
        $span = $this->executeQueryAndRetrieveSpan(
            $query = 'SELECT "mysqlurl"'
        );

        $this->assertEquals($query, $span->getDescription());
        $this->assertEquals('db.sql.query', $span->getOp());
        $this->assertEquals('host-mysqlurl', $span->getData()['server.address']);
        $this->assertEquals(3307, $span->getData()['server.port']);
    }

    /**
     * @define-env usesInMemorySqlite
     */
    public function testSpanIsCreatedForSqliteConnectionQuery(): void
    {
        $span = $this->executeQueryAndRetrieveSpan(
            $query = 'SELECT "inmemory"'
        );

        $this->assertEquals($query, $span->getDescription());
        $this->assertEquals('db.sql.query', $span->getOp());
        $this->assertNull($span->getData()['server.address']);
        $this->assertNull($span->getData()['server.port']);
    }

    public function testSqlBindingsAreRecordedWhenEnabled(): void
    {
        $this->resetApplicationWithConfig([
            'sentry.tracing.sql_bindings' => true,
        ]);

        $span = $this->executeQueryAndRetrieveSpan(
            $query = 'SELECT %',
            $bindings = ['1']
        );

        $this->assertEquals($query, $span->getDescription());
        $this->assertEquals($bindings, $span->getData()['db.sql.bindings']);
    }

    public function testSqlBindingsAreRecordedWhenDisabled(): void
    {
        $this->resetApplicationWithConfig([
            'sentry.tracing.sql_bindings' => false,
        ]);

        $span = $this->executeQueryAndRetrieveSpan(
            $query = 'SELECT %',
            ['1']
        );

        $this->assertEquals($query, $span->getDescription());
        $this->assertFalse(isset($span->getData()['db.sql.bindings']));
    }

    private function executeQueryAndRetrieveSpan(string $query, array $bindings = []): Span
    {
        $transaction = $this->startTransaction();

        $this->dispatchLaravelEvent(new QueryExecuted($query, $bindings, 123, DB::connection()));

        $spans = $transaction->getSpanRecorder()->getSpans();

        $this->assertCount(2, $spans);

        return $spans[1];
    }
}