AggregateAwareDBALEventStore - Code Metrics - Inspection of "III-1490 Merge the separate event stores." - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#255)

by Kristof

created 2018-11-29 07:13 UTC

AggregateAwareDBALEventStore A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	212
Duplicated Lines	10.85 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

Metric	Value
wmc	16
lcom	1
cbo	10
dl	23
loc	212
rs	10
c	0
b	0
f	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	13	13	1
A	load()	0	17	3
A	append()	0	18	3
A	insertMessage()	0	14	1
A	configureSchema()	0	8	2
A	configureTable()	0	24	1
A	prepareLoadStatement()	0	19	2
A	deserializeEvent()	10	10	1
A	guardStream()	0	7	2

How to fix Duplicated Code

<?php

namespace CultuurNet\UDB3\EventSourcing\DBAL;

use Broadway\Domain\DateTime;
use Broadway\Domain\DomainEventStream;
use Broadway\Domain\DomainEventStreamInterface;
use Broadway\Domain\DomainMessage;
use Broadway\EventStore\DBALEventStoreException;
use Broadway\EventStore\EventStoreInterface;
use Broadway\EventStore\EventStreamNotFoundException;
use Broadway\Serializer\SerializerInterface;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\DBALException;
use Doctrine\DBAL\Schema\Schema;
use Doctrine\DBAL\Schema\Table;

/**
 * Event store making use of Doctrine DBAL and aware of the aggregate type.
 *
 * Based on Broadways DBALEventStore.
 */
class AggregateAwareDBALEventStore implements EventStoreInterface
{
    /**
     * @var Connection
     */
    private $connection;

    /**
     * @var SerializerInterface
     */
    private $payloadSerializer;

    /**
     * @var SerializerInterface
     */
    private $metadataSerializer;

    /**
     * @var null
     */
    private $loadStatement = null;

    /**
     * @var string
     */
    private $tableName;

    /**
     * @var string
     */
    private $aggregateType;

    /**
     * @param Connection $connection
     * @param SerializerInterface $payloadSerializer
     * @param SerializerInterface $metadataSerializer
     * @param string $tableName
     * @param mixed $aggregateType
     */
    public function __construct(

        Connection $connection,
        SerializerInterface $payloadSerializer,
        SerializerInterface $metadataSerializer,
        $tableName,
        $aggregateType
    ) {
        $this->connection         = $connection;
        $this->payloadSerializer  = $payloadSerializer;
        $this->metadataSerializer = $metadataSerializer;
        $this->tableName          = $tableName;
        $this->aggregateType      = (string) $aggregateType;
    }

    /**
     * {@inheritDoc}
     */
    public function load($id)
    {
        $statement = $this->prepareLoadStatement();
        $statement->bindValue('uuid', $id);
        $statement->execute();

        $events = array();
        while ($row = $statement->fetch()) {
            $events[] = $this->deserializeEvent($row);
        }

        if (empty($events)) {
            throw new EventStreamNotFoundException(sprintf('EventStream not found for aggregate with id %s', $id));
        }

        return new DomainEventStream($events);
    }

    /**
     * {@inheritDoc}
     */
    public function append($id, DomainEventStreamInterface $eventStream)
    {
        // The original Broadway DBALEventStore implementation did only check
        // the type of $id. It is better to test all UUIDs inside the event
        // stream.
        $this->guardStream($eventStream);
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

        // Make the transaction more robust by using the transactional statement.
        $this->connection->transactional(function (Connection $connection) use ($eventStream) {
            try {
                foreach ($eventStream as $domainMessage) {
                    $this->insertMessage($connection, $domainMessage);
                }
            } catch (DBALException $exception) {
                throw DBALEventStoreException::create($exception);
            }
        });
    }

    /**
     * @param Connection $connection
     * @param DomainMessage $domainMessage
     */
    private function insertMessage(Connection $connection, DomainMessage $domainMessage)
    {
        $data = array(
            'uuid'           => (string) $domainMessage->getId(),
            'playhead'       => $domainMessage->getPlayhead(),
            'metadata'       => json_encode($this->metadataSerializer->serialize($domainMessage->getMetadata())),
            'payload'        => json_encode($this->payloadSerializer->serialize($domainMessage->getPayload())),
            'recorded_on'    => $domainMessage->getRecordedOn()->toString(),
            'type'           => $domainMessage->getType(),
            'aggregate_type' => $this->aggregateType,
        );

        $connection->insert($this->tableName, $data);
    }

    /**
     * @param Schema $schema
     * @return Table|null
     */
    public function configureSchema(Schema $schema)
    {
        if ($schema->hasTable($this->tableName)) {
            return null;
        }

        return $this->configureTable();
    }

    /**
     * @return mixed
     */
    public function configureTable()
    {
        $schema = new Schema();

        $table = $schema->createTable($this->tableName);

        $table->addColumn('id', 'integer', array('autoincrement' => true));
        $table->addColumn('uuid', 'guid', array('length' => 36,));
        $table->addColumn('playhead', 'integer', array('unsigned' => true));
        $table->addColumn('payload', 'text');
        $table->addColumn('metadata', 'text');
        $table->addColumn('recorded_on', 'string', array('length' => 32));
        $table->addColumn('type', 'string', array('length' => 128));
        $table->addColumn('aggregate_type', 'string', array('length' => 128));

        $table->setPrimaryKey(array('id'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $table->addUniqueIndex(array('uuid', 'playhead'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $table->addIndex(['type']);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $table->addIndex(['aggregate_type']);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $table;
    }

    /**
     * @return \Doctrine\DBAL\Driver\Statement|null
     */
    private function prepareLoadStatement()
    {
        if (null === $this->loadStatement) {
            $queryBuilder = $this->connection->createQueryBuilder();

            $queryBuilder->select(
                ['uuid', 'playhead', 'metadata', 'payload', 'recorded_on']
            )
                ->from($this->tableName)
                ->where('uuid = :uuid')
                ->orderBy('playhead', 'ASC');

            $this->loadStatement = $this->connection->prepare(

                $queryBuilder->getSQL()
            );
        }

        return $this->loadStatement;
    }

    /**
     * @param $row
     * @return DomainMessage
     */
    private function deserializeEvent($row)

    {
        return new DomainMessage(
            $row['uuid'],
            $row['playhead'],
            $this->metadataSerializer->deserialize(json_decode($row['metadata'], true)),
            $this->payloadSerializer->deserialize(json_decode($row['payload'], true)),
            DateTime::fromString($row['recorded_on'])
        );
    }

    /**
     * Ensure that an error will be thrown if the ID in the domain messages is
     * not something that can be converted to a string.
     *
     * If we let this move on without doing this DBAL will eventually
     * give us a hard time but the true reason for the problem will be
     * obfuscated.
     *
     * @param DomainEventStreamInterface $eventStream
     */
    private function guardStream(DomainEventStreamInterface $eventStream)
    {
        foreach ($eventStream as $domainMessage) {
            /** @var DomainMessage $domainMessage */
            $id = (string) $domainMessage->getId();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        }
    }
}


1		<?php
2
3		namespace CultuurNet\UDB3\EventSourcing\DBAL;
4
5		use Broadway\Domain\DateTime;
6		use Broadway\Domain\DomainEventStream;
7		use Broadway\Domain\DomainEventStreamInterface;
8		use Broadway\Domain\DomainMessage;
9		use Broadway\EventStore\DBALEventStoreException;
10		use Broadway\EventStore\EventStoreInterface;
11		use Broadway\EventStore\EventStreamNotFoundException;
12		use Broadway\Serializer\SerializerInterface;
13		use Doctrine\DBAL\Connection;
14		use Doctrine\DBAL\DBALException;
15		use Doctrine\DBAL\Schema\Schema;
16		use Doctrine\DBAL\Schema\Table;
17
18		/**
19		* Event store making use of Doctrine DBAL and aware of the aggregate type.
20		*
21		* Based on Broadways DBALEventStore.
22		*/
23		class AggregateAwareDBALEventStore implements EventStoreInterface
24		{
25		/**
26		* @var Connection
27		*/
28		private $connection;
29
30		/**
31		* @var SerializerInterface
32		*/
33		private $payloadSerializer;
34
35		/**
36		* @var SerializerInterface
37		*/
38		private $metadataSerializer;
39
40		/**
41		* @var null
42		*/
43		private $loadStatement = null;
44
45		/**
46		* @var string
47		*/
48		private $tableName;
49
50		/**
51		* @var string
52		*/
53		private $aggregateType;
54
55		/**
56		* @param Connection $connection
57		* @param SerializerInterface $payloadSerializer
58		* @param SerializerInterface $metadataSerializer
59		* @param string $tableName
60		* @param mixed $aggregateType
61		*/
62	View Code Duplication	public function __construct(
		0 ignored issues – show Duplication introduced 2018-09-24 11:48 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
63		Connection $connection,
64		SerializerInterface $payloadSerializer,
65		SerializerInterface $metadataSerializer,
66		$tableName,
67		$aggregateType
68		) {
69		$this->connection = $connection;
70		$this->payloadSerializer = $payloadSerializer;
71		$this->metadataSerializer = $metadataSerializer;
72		$this->tableName = $tableName;
73		$this->aggregateType = (string) $aggregateType;
74		}
75
76		/**
77		* {@inheritDoc}
78		*/
79		public function load($id)
80		{
81		$statement = $this->prepareLoadStatement();
82		$statement->bindValue('uuid', $id);
83		$statement->execute();
84
85		$events = array();
86		while ($row = $statement->fetch()) {
87		$events[] = $this->deserializeEvent($row);
88		}
89
90		if (empty($events)) {
91		throw new EventStreamNotFoundException(sprintf('EventStream not found for aggregate with id %s', $id));
92		}
93
94		return new DomainEventStream($events);
95		}
96
97		/**
98		* {@inheritDoc}
99		*/
100		public function append($id, DomainEventStreamInterface $eventStream)
101		{
102		// The original Broadway DBALEventStore implementation did only check
103		// the type of $id. It is better to test all UUIDs inside the event
104		// stream.
105		$this->guardStream($eventStream);
		0 ignored issues – show Unused Code introduced 2016-12-15 16:01 UTC by Report Bug Copy Issue Report The call to the method `CultuurNet\UDB3\EventSou...entStore::guardStream()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
106
107		// Make the transaction more robust by using the transactional statement.
108		$this->connection->transactional(function (Connection $connection) use ($eventStream) {
109		try {
110		foreach ($eventStream as $domainMessage) {
111		$this->insertMessage($connection, $domainMessage);
112		}
113		} catch (DBALException $exception) {
114		throw DBALEventStoreException::create($exception);
115		}
116		});
117		}
118
119		/**
120		* @param Connection $connection
121		* @param DomainMessage $domainMessage
122		*/
123		private function insertMessage(Connection $connection, DomainMessage $domainMessage)
124		{
125		$data = array(
126		'uuid' => (string) $domainMessage->getId(),
127		'playhead' => $domainMessage->getPlayhead(),
128		'metadata' => json_encode($this->metadataSerializer->serialize($domainMessage->getMetadata())),
129		'payload' => json_encode($this->payloadSerializer->serialize($domainMessage->getPayload())),
130		'recorded_on' => $domainMessage->getRecordedOn()->toString(),
131		'type' => $domainMessage->getType(),
132		'aggregate_type' => $this->aggregateType,
133		);
134
135		$connection->insert($this->tableName, $data);
136		}
137
138		/**
139		* @param Schema $schema
140		* @return Table\|null
141		*/
142		public function configureSchema(Schema $schema)
143		{
144		if ($schema->hasTable($this->tableName)) {
145		return null;
146		}
147
148		return $this->configureTable();
149		}
150
151		/**
152		* @return mixed
153		*/
154		public function configureTable()
155		{
156		$schema = new Schema();
157
158		$table = $schema->createTable($this->tableName);
159
160		$table->addColumn('id', 'integer', array('autoincrement' => true));
161		$table->addColumn('uuid', 'guid', array('length' => 36,));
162		$table->addColumn('playhead', 'integer', array('unsigned' => true));
163		$table->addColumn('payload', 'text');
164		$table->addColumn('metadata', 'text');
165		$table->addColumn('recorded_on', 'string', array('length' => 32));
166		$table->addColumn('type', 'string', array('length' => 128));
167		$table->addColumn('aggregate_type', 'string', array('length' => 128));
168
169		$table->setPrimaryKey(array('id'));
		0 ignored issues – show Documentation introduced 2018-10-19 07:02 UTC by Report Bug Copy Issue Report `array('id')` is of type `array<integer,string,{"0":"string"}>`, but the function expects a `array<integer,array<integer,*>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
170
171		$table->addUniqueIndex(array('uuid', 'playhead'));
		0 ignored issues – show Documentation introduced 2018-10-19 07:02 UTC by Report Bug Copy Issue Report `array('uuid', 'playhead')` is of type `array<integer,string,{"0":"string","1":"string"}>`, but the function expects a `array<integer,array<integer,*>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
172
173		$table->addIndex(['type']);
		0 ignored issues – show Documentation introduced 2018-10-19 07:02 UTC by Report Bug Copy Issue Report `array('type')` is of type `array<integer,string,{"0":"string"}>`, but the function expects a `array<integer,array<integer,*>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
174		$table->addIndex(['aggregate_type']);
		0 ignored issues – show Documentation introduced 2018-10-19 07:02 UTC by Report Bug Copy Issue Report `array('aggregate_type')` is of type `array<integer,string,{"0":"string"}>`, but the function expects a `array<integer,array<integer,*>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
175
176		return $table;
177		}
178
179		/**
180		* @return \Doctrine\DBAL\Driver\Statement\|null
181		*/
182		private function prepareLoadStatement()
183		{
184		if (null === $this->loadStatement) {
185		$queryBuilder = $this->connection->createQueryBuilder();
186
187		$queryBuilder->select(
188		['uuid', 'playhead', 'metadata', 'payload', 'recorded_on']
189		)
190		->from($this->tableName)
191		->where('uuid = :uuid')
192		->orderBy('playhead', 'ASC');
193
194		$this->loadStatement = $this->connection->prepare(
		0 ignored issues – show Documentation Bug introduced 2016-12-15 09:21 UTC by Report Bug Copy Issue Report It seems like `$this->connection->prepa...queryBuilder->getSQL())` of type `object<Doctrine\DBAL\Driver\Statement>` is incompatible with the declared type `null` of property `$loadStatement`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
195		$queryBuilder->getSQL()
196		);
197		}
198
199		return $this->loadStatement;
200		}
201
202		/**
203		* @param $row
204		* @return DomainMessage
205		*/
206	View Code Duplication	private function deserializeEvent($row)
		0 ignored issues – show Duplication introduced 2018-09-24 11:48 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
207		{
208		return new DomainMessage(
209		$row['uuid'],
210		$row['playhead'],
211		$this->metadataSerializer->deserialize(json_decode($row['metadata'], true)),
212		$this->payloadSerializer->deserialize(json_decode($row['payload'], true)),
213		DateTime::fromString($row['recorded_on'])
214		);
215		}
216
217		/**
218		* Ensure that an error will be thrown if the ID in the domain messages is
219		* not something that can be converted to a string.
220		*
221		* If we let this move on without doing this DBAL will eventually
222		* give us a hard time but the true reason for the problem will be
223		* obfuscated.
224		*
225		* @param DomainEventStreamInterface $eventStream
226		*/
227		private function guardStream(DomainEventStreamInterface $eventStream)
228		{
229		foreach ($eventStream as $domainMessage) {
230		/** @var DomainMessage $domainMessage */
231		$id = (string) $domainMessage->getId();
		0 ignored issues – show Unused Code introduced 2016-12-15 16:01 UTC by Report Bug Copy Issue Report `$id` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
232		}
233		}
234		}
235

cultuurnet / udb3-php

Pull Request — master (#255)

AggregateAwareDBALEventStore A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like