Neo4j\Neo4jBundle\Collector\QueryLogger

Complexity

Total Complexity

19

Size/Duplication

Total Lines	169
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getElapsedTime()	0	14	3
A	record()	0	29	3
A	finish()	0	29	4
A	reset()	0	6	1
A	logException()	0	10	3
A	count()	0	4	1
A	getStatements()	0	4	1
A	getStatementsHash()	0	4	1
A	statisticsToArray()	0	22	2

<?php

declare(strict_types=1);

namespace Neo4j\Neo4jBundle\Collector;

use GraphAware\Bolt\Result\Result;
use GraphAware\Common\Cypher\StatementInterface;
use GraphAware\Common\Result\StatementResult as StatementResultInterface;
use GraphAware\Common\Result\StatementStatisticsInterface;
use GraphAware\Neo4j\Client\Exception\Neo4jExceptionInterface;

/**
 * @author Xavier Coureau <xavier@pandawan-technology.com>
 */
class QueryLogger implements \Countable
{
    /**
     * @var int
     */
    private $nbQueries = 0;

    /**
     * @var array
     */
    private $statements = [];

    /**
     * @var array
     */
    private $statementsHash = [];

    /**
     * @param StatementInterface $statement
     */
    public function record(StatementInterface $statement)
    {
        $statementText = $statement->text();
        $statementParams = json_encode($statement->parameters());
        $tag = $statement->getTag() ?: -1;

        // Make sure we do not record the same statement twice
        if (isset($this->statementsHash[$statementText][$statementParams][$tag])) {
            return;
        }

        $idx = $this->nbQueries++;
        $this->statements[$idx] = [
            'start_time' => microtime(true) * 1000,
            'query' => $statementText,
            'parameters' => $statementParams,
            'tag' => $statement->getTag(),

            // Add dummy data in case we never run logException or finish
            'end_time' => microtime(true) * 1000, // same
            'nb_results' => 0,
            'statistics' => [],
            'scheme' => '',
            'success' => false,
            'exceptionCode' => 0,
            'exceptionMessage' => '',
        ];
        $this->statementsHash[$statementText][$statementParams][$tag] = $idx;
    }

    /**
     * @param StatementResultInterface $statementResult
     */
    public function finish(StatementResultInterface $statementResult)
    {
        $scheme = 'Http';
        if ($statementResult instanceof Result) {
            $scheme = 'Bolt';
        }

        $statement = $statementResult->statement();
        $statementText = $statement->text();
        $statementParams = $statement->parameters();
        $encodedParameters = json_encode($statementParams);
        $tag = $statement->getTag() ?: -1;

        if (!isset($this->statementsHash[$statementText][$encodedParameters][$tag])) {
            $idx = $this->nbQueries++;
            $this->statements[$idx]['start_time'] = null;
            $this->statementsHash[$idx] = $idx;
        } else {
            $idx = $this->statementsHash[$statementText][$encodedParameters][$tag];
        }

        $this->statements[$idx] = array_merge($this->statements[$idx], [
            'end_time' => microtime(true) * 1000,
            'nb_results' => $statementResult->size(),
            'statistics' => $this->statisticsToArray($statementResult->summarize()->updateStatistics()),
            'scheme' => $scheme,
            'success' => true,
        ]);
    }

    public function reset()
    {
        $this->nbQueries = 0;
        $this->statements = [];
        $this->statementsHash = [];
    }

    /**
     * @param Neo4jExceptionInterface $exception
     */
    public function logException(Neo4jExceptionInterface $exception)
    {
        $idx = $this->nbQueries - 1;
        $this->statements[$idx] = array_merge($this->statements[$idx], [
            'end_time' => microtime(true) * 1000,
            'exceptionCode' => method_exists($exception, 'classification') ? $exception->classification() : '',
            'exceptionMessage' => method_exists($exception, 'getMessage') ? $exception->getMessage() : '',
            'success' => false,
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public function count()
    {
        return $this->nbQueries;
    }

    /**
     * @return array[]
     */
    public function getStatements()
    {
        return $this->statements;
    }

    /**
     * @return array
     */
    public function getStatementsHash()
    {
        return $this->statementsHash;
    }

    /**
     * @return int
     */
    public function getElapsedTime()
    {
        $time = 0;

        foreach ($this->statements as $statement) {
            if (!isset($statement['start_time'], $statement['end_time'])) {
                continue;
            }

            $time += $statement['end_time'] - $statement['start_time'];
        }

        return $time;
    }

    private function statisticsToArray(?StatementStatisticsInterface $statementStatistics)
    {
        if (!$statementStatistics) {
            return [];
        }
        $data = [
            'contains_updates' => $statementStatistics->containsUpdates(),
            'nodes_created' => $statementStatistics->nodesCreated(),
            'nodes_deleted' => $statementStatistics->nodesDeleted(),
            'relationships_created' => $statementStatistics->relationshipsCreated(),
            'relationships_deleted' => $statementStatistics->relationshipsDeleted(),
            'properties_set' => $statementStatistics->propertiesSet(),
            'labels_added' => $statementStatistics->labelsAdded(),
            'labels_removed' => $statementStatistics->labelsRemoved(),
            'indexes_added' => $statementStatistics->indexesAdded(),
            'indexes_removed' => $statementStatistics->indexesRemoved(),
            'constraints_added' => $statementStatistics->constraintsAdded(),
            'constraints_removed' => $statementStatistics->constraintsRemoved(),
        ];

        return $data;
    }
}