Spatie\EventProjector\Projectors\ProjectsEvents

Complexity

Total Complexity

31

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	5

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	8	2
B	rememberReceivedEvent()	0	46	6
A	hasAlreadyReceivedEvent()	0	15	3
B	hasReceivedAllPriorEvents()	0	47	5
A	hasReceivedAllEvents()	0	4	1
A	markAsNotUpToDate()	0	8	2
A	getLastProcessedEventId()	0	4	1
A	lastEventProcessedAt()	0	4	1
A	reset()	0	10	2
A	shouldBeCalledImmediately()	0	4	1
A	getEventStreams()	0	17	3
A	getEventStreamFullNames()	0	14	2
A	getStatus()	0	4	1
A	getAllStatuses()	0	4	1

<?php

namespace Spatie\EventProjector\Projectors;

use Carbon\Carbon;
use Illuminate\Support\Collection;
use Spatie\EventProjector\Models\StoredEvent;
use Spatie\EventProjector\Models\ProjectorStatus;
use Spatie\EventProjector\EventHandlers\HandlesEvents;
use Spatie\EventProjector\Exceptions\CouldNotResetProjector;

trait ProjectsEvents
{
    use HandlesEvents;

    public function getName(): string
    {
        if (isset($this->name)) {
            return $this->name;

The property name does not exist. Did you maybe forget to declare it?

        }

        return get_class($this);
    }

    public function rememberReceivedEvent(StoredEvent $storedEvent)
    {
        foreach ($this->getEventStreamFullNames($storedEvent) as $streamName) {
            $status = $this->getStatus($streamName);

            $status->rememberLastProcessedEvent($storedEvent, $this);

            $streams = $this->getEventStreams($storedEvent);

            if ($streams->isEmpty()) {
                $lastStoredEvent = StoredEvent::query()
                    ->whereIn('event_class', $this->handlesEventClassNames())
                    ->orderBy('id', 'desc')
                    ->first();

                $lastStoredEventId = (int) optional($lastStoredEvent)->id ?? 0;

                $status = $this->getStatus();

                $status->last_processed_event_id === $lastStoredEventId
                    ? $status->markAsReceivedAllEvents()
                    : $status->markasAsNotReceivedAllEvents();

                return;
            }

            foreach ($streams as $streamName => $streamValue) {
                $streamFullName = "{$streamName}-{$streamValue}";
                $whereJsonClause = str_replace('.', '->', $streamName);

                $lastStoredEvent = StoredEvent::query()
                    ->whereIn('event_class', $this->handlesEventClassNames())
                    ->where("event_properties->{$whereJsonClause}", $streamValue)
                    ->orderBy('id', 'desc')
                    ->first();

                $lastStoredEventId = (int)optional($lastStoredEvent)->id ?? 0;

                $status = $this->getStatus($streamFullName);

                $status->last_processed_event_id === $lastStoredEventId
                    ? $status->markAsReceivedAllEvents()
                    : $status->markasAsNotReceivedAllEvents();
            }
        }
    }

    public function hasAlreadyReceivedEvent(StoredEvent $storedEvent): bool
    {
        foreach($this->getEventStreamFullNames($storedEvent) as $streamFullName)
        {
            $status = $this->getStatus($streamFullName);

            $lastProcessedEventId = (int) optional($status)->last_processed_event_id ?? 0;

            if ($storedEvent->id <= $lastProcessedEventId) {
                return true;
            }
        }

        return false;
    }

    public function hasReceivedAllPriorEvents(StoredEvent $storedEvent): bool
    {
        $streams = $this->getEventStreams($storedEvent);

        if ($streams->isEmpty()) {
            $lastStoredEvent = StoredEvent::query()
                ->whereIn('event_class', $this->handlesEventClassNames())
                ->where('id', '<', $storedEvent->id)
                ->orderBy('id', 'desc')
                ->first();

            $lastStoredEventId = (int) optional($lastStoredEvent)->id ?? 0;

            $status = $this->getStatus();

            $lastProcessedEventId = (int) $status->last_processed_event_id ?? 0;

            if ($lastStoredEventId !== $lastProcessedEventId) {
                return false;

            }
            return true;
        }

        foreach ($streams as $streamName => $streamValue) {
            $streamFullName = "{$streamName}-{$streamValue}";
            $whereJsonClause = str_replace('.', '->', $streamName);

            $lastStoredEvent = StoredEvent::query()
                ->whereIn('event_class', $this->handlesEventClassNames())
                ->where('id', '<', $storedEvent->id)
                ->where("event_properties->{$whereJsonClause}", $streamValue)
                ->orderBy('id', 'desc')
                ->first();

            $lastStoredEventId = (int) optional($lastStoredEvent)->id ?? 0;

            $status = $this->getStatus($streamFullName);
            $lastProcessedEventId = (int) $status->last_processed_event_id ?? 0;

            if ($lastStoredEventId !== $lastProcessedEventId) {
                return false;
            }
        }

        return true;
    }

    public function hasReceivedAllEvents(): bool
    {
        return ProjectorStatus::hasReceivedAllEvents($this);
    }

    public function markAsNotUpToDate(StoredEvent $storedEvent)
    {
        foreach($this->getEventStreamFullNames($storedEvent) as $streamName) {
            $status = $this->getStatus($streamName);

            $status->markasAsNotReceivedAllEvents();
        }
    }

    public function getLastProcessedEventId(): int
    {
        return $this->getStatus()->last_processed_event_id ?? 0;
    }

    public function lastEventProcessedAt(): Carbon
    {
        return $this->getStatus()->updated_at;
    }

    public function reset()
    {
        if (! method_exists($this, 'resetState')) {
            throw CouldNotResetProjector::doesNotHaveResetStateMethod($this);
        }

        $this->resetState();

It seems like resetState() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->getAllStatuses()->each->delete();
    }

    public function shouldBeCalledImmediately(): bool
    {
        return ! $this instanceof QueuedProjector;
    }

    protected function getEventStreams(StoredEvent $storedEvent): Collection
    {
        $streams = method_exists($this, 'streamEventsBy')
            ? $this->streamEventsBy($storedEvent)

It seems like streamEventsBy() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            : [];

        return collect(array_wrap($streams))
            ->mapWithKeys(function ($streamValue, $streamName) use ($storedEvent) {
                if (is_numeric($streamName)) {
                    $streamName = $streamValue;

                    $streamValue = array_get($storedEvent->event_properties, $streamName);
                }

                return [$streamName => $streamValue];
            });
    }

    protected function getEventStreamFullNames(StoredEvent $storedEvent): array
    {
        $streamFullNames = $this->getEventStreams($storedEvent)
            ->map(function ($streamValue, $streamName) {
                return "{$streamName}-{$streamValue}";
            })
            ->toArray();

        if (count($streamFullNames) === 0) {
            $streamFullNames = ['main'];
        }

        return $streamFullNames;
    }

    protected function getStatus(string $stream = 'main'): ProjectorStatus
    {
        return ProjectorStatus::getForProjector($this, $stream);
    }

    protected function getAllStatuses(): Collection
    {
        return ProjectorStatus::getAllForProjector($this);
    }
}