class LoggingTest

class LoggingTest extends DatabaseTestBase {
    
    /**
     * Tests that we can log the existence of a query.
     *
     * This test is only marked as legacy to be able to test the deprecated
     * db_query function().
     *
     * @group legacy
     *
     * @expectedDeprecationMessage db_query() is deprecated in drupal:8.0.0. It will be removed before drupal:9.0.0. Instead, get a database connection injected into your service from the container and call query() on it. For example, $injected_database->query($query, $args, $options). See https://www.drupal.org/node/2993033
     */
    public function testEnableLogging() {
        Database::startLog('testing');
        $this->connection
            ->query('SELECT name FROM {test} WHERE age > :age', [
            ':age' => 25,
        ])
            ->fetchCol();
        $this->connection
            ->query('SELECT age FROM {test} WHERE name = :name', [
            ':name' => 'Ringo',
        ])
            ->fetchCol();
        // Trigger a call that does not have file in the backtrace.
        call_user_func_array([
            Database::getConnection(),
            'query',
        ], [
            'SELECT age FROM {test} WHERE name = :name',
            [
                ':name' => 'Ringo',
            ],
        ])->fetchCol();
        // Make sure that the caller is also detected correctly for the deprecated
        // db_query() function.
        db_query('SELECT name FROM {test} WHERE age > :age', [
            ':age' => 25,
        ])->fetchCol();
        $queries = Database::getLog('testing', 'default');
        $this->assertCount(4, $queries, 'Correct number of queries recorded.');
        foreach ($queries as $query) {
            $this->assertEqual($query['caller']['function'], __FUNCTION__, 'Correct function in query log.');
        }
    }
    
    /**
     * Tests that we can run two logs in parallel.
     */
    public function testEnableMultiLogging() {
        Database::startLog('testing1');
        $this->connection
            ->query('SELECT name FROM {test} WHERE age > :age', [
            ':age' => 25,
        ])
            ->fetchCol();
        Database::startLog('testing2');
        $this->connection
            ->query('SELECT age FROM {test} WHERE name = :name', [
            ':name' => 'Ringo',
        ])
            ->fetchCol();
        $queries1 = Database::getLog('testing1');
        $queries2 = Database::getLog('testing2');
        $this->assertCount(2, $queries1, 'Correct number of queries recorded for log 1.');
        $this->assertCount(1, $queries2, 'Correct number of queries recorded for log 2.');
    }
    
    /**
     * Tests logging queries against multiple targets on the same connection.
     */
    public function testEnableTargetLogging() {
        // Clone the primary credentials to a replica connection and to another fake
        // connection.
        $connection_info = Database::getConnectionInfo('default');
        Database::addConnectionInfo('default', 'replica', $connection_info['default']);
        Database::startLog('testing1');
        $this->connection
            ->query('SELECT name FROM {test} WHERE age > :age', [
            ':age' => 25,
        ])
            ->fetchCol();
        Database::getConnection('replica')->query('SELECT age FROM {test} WHERE name = :name', [
            ':name' => 'Ringo',
        ])
            ->fetchCol();
        $queries1 = Database::getLog('testing1');
        $this->assertCount(2, $queries1, 'Recorded queries from all targets.');
        $this->assertEqual($queries1[0]['target'], 'default', 'First query used default target.');
        $this->assertEqual($queries1[1]['target'], 'replica', 'Second query used replica target.');
    }
    
    /**
     * Tests that logs to separate targets use the same connection properly.
     *
     * This test is identical to the one above, except that it doesn't create
     * a fake target so the query should fall back to running on the default
     * target.
     */
    public function testEnableTargetLoggingNoTarget() {
        Database::startLog('testing1');
        $this->connection
            ->query('SELECT name FROM {test} WHERE age > :age', [
            ':age' => 25,
        ])
            ->fetchCol();
        // We use "fake" here as a target because any non-existent target will do.
        // However, because all of the tests in this class share a single page
        // request there is likely to be a target of "replica" from one of the other
        // unit tests, so we use a target here that we know with absolute certainty
        // does not exist.
        Database::getConnection('fake')->query('SELECT age FROM {test} WHERE name = :name', [
            ':name' => 'Ringo',
        ])
            ->fetchCol();
        $queries1 = Database::getLog('testing1');
        $this->assertCount(2, $queries1, 'Recorded queries from all targets.');
        $this->assertEqual($queries1[0]['target'], 'default', 'First query used default target.');
        $this->assertEqual($queries1[1]['target'], 'default', 'Second query used default target as fallback.');
    }
    
    /**
     * Tests that we can log queries separately on different connections.
     */
    public function testEnableMultiConnectionLogging() {
        // Clone the primary credentials to a fake connection.
        // That both connections point to the same physical database is irrelevant.
        $connection_info = Database::getConnectionInfo('default');
        Database::addConnectionInfo('test2', 'default', $connection_info['default']);
        Database::startLog('testing1');
        Database::startLog('testing1', 'test2');
        $this->connection
            ->query('SELECT name FROM {test} WHERE age > :age', [
            ':age' => 25,
        ])
            ->fetchCol();
        $old_key = Database::setActiveConnection('test2');
        Database::getConnection('replica')->query('SELECT age FROM {test} WHERE name = :name', [
            ':name' => 'Ringo',
        ])
            ->fetchCol();
        Database::setActiveConnection($old_key);
        $queries1 = Database::getLog('testing1');
        $queries2 = Database::getLog('testing1', 'test2');
        $this->assertCount(1, $queries1, 'Correct number of queries recorded for first connection.');
        $this->assertCount(1, $queries2, 'Correct number of queries recorded for second connection.');
    }
    
    /**
     * Tests that getLog with a wrong key return an empty array.
     */
    public function testGetLoggingWrongKey() {
        $result = Database::getLog('wrong');
        $this->assertEqual($result, [], 'The function getLog with a wrong key returns an empty array.');
    }

}