Documentation is too shallow, real life example should be added

[michaelklopf]

As someone who has no deep knowledge of event sourcing and having seen how it's done over at Spaties Laravel event sourcing package, I'd wish for one example to include how state and events are consumed by the application.

In Spaties package you create an aggregate, call that in the controller, it will create the event with the data

        SomeAggregate::retrieve($newUuid)
            ->createSome($request->type, auth()->user()->id)
            ->persist();

(uuid comes from a helper function in the model) and the aggregate records the event, i.e. writes the event to db

    public function createSome(string $type, string $userId)
    {
        $this->recordThat(new SomeCreated($type, $userId));

        return $this;
    }

the event

    // SomeCreated
    public function __construct(
        public string $type,
        public int $userId,
    ) {
    }

and a projector that writes it to database somewhere down the line

    public function onSomeCreated(SomeCreated $event)
    {
        Some::create([
            'uuid' => $event->aggregateRootUuid(),
            'type' => $event->type,
            'user_id' => $event->userId,
        ]);
    }

How does this package work now, I don't get it from the example code.

Fire the event in the controller?

SomeCreated::fire(type: 'with_a_type', user_id: auth()->user()->id);

The event may look something like this

    public string $type;

    #[StateId(SomeState::class)]
    public int $user_id;

    public function apply(SomeState $state)
    {
        $state->type = $this->type;
        $state->user_id = $this->user_id;
    }

    public function handle()
    {
        Some::create([
            'type' => $this->type,
            'user_id' => $this->user_id,
        ]);
    }

The state is bare bones

    public string $type = '';

    public int $user_id;

The unique id is set by the HasSnowflakes trait.

But nothing is happening when firing the event (I did it in Tinkerwell during these tests).

But when I change the line to as seen in the example here https://verbs.thunk.dev/docs/reference/events/#content-committing--immediately-accessing-results

SomeCreated::commit(type: 'with_a_type', user_id: auth()->user()->id);

Then it works.

Spaties package also goes into detail how to setup the queue. What is necessary to make fire work? Am I doing it wrong or configuring it wrong?

edit Just read the fire part of the docs again and propably mixed up console execution with tinkerwell. When I add Verbs::commit() to Tinkerwell it works.

I think an example which covers all bases would help to get a better understanding how "regular" event sourcing is applied in the package here.