Audit log (История действий), лучший вариант?

Question

[tukreb]

Добрый день.

Хочу на некоторые действия в symfony сделать гибкую историю изменению.
Вопрос в том, как лучше это сделать.
1. В самой сущности "Entity" повесить event:

class Entity
{
    //поля сущности
    private array $events = [];
    protected function recordEvent(object $event): void
    {
        $this->events[] = $event;
    }

    public function someAction($blal): void
    {
        //что-то делаем
        $this->recordEvent(new Event\LogSomeMadeAction($args)); //эвент на сохранения записи в бд
    }
}

2. В сервисе где и происходит все основные вызовы методов сущностей:

class ServiceHandler
{
    public function handle($args): void
    {
        $entity->someAction($blal);
        //логируем в бд без всяких эвентов
       
    }
}

3. Всё это делать в самих контроллерах, вместе с Monolog.

Я думаю в сторону 1 варианта, он выглядит более гибким, но хорошее ли это решение?

Answer 1

[Максим]

Все события агрегата должны помещаться в самом корне агрегата, как в варианте 1, но при этом метод который будет применять эти события должен вызываться после того как данные будут сохранить.

Другими словами в $eventsвы складываете все события при работе с сущностью-агрегатом, а в Handler проходите по этому массиву и отправляете в EventDispatcher каждое событие. Ну а там уже делаете подписчиков событий лога, если нужно. Главное, чтобы все события попадали в диспетчер после того, как данные будут сохранены в базу. Иначе может получится так, что возникла ошибка и сработала роллбек транзакции, откатив все изменения, а события при этом уже ушли.

Comments

[tukreb]

Да, я подобное и имел ввиду в 1 варианте, меня же интересует, на сколько хорошо пихать в Entity события на логирования. Или лучше это выносить в сервис или даже в контроллер уже без всяких событий.

[Максим]

tukreb, сам вызов событий через new там допустимо и именно так нужно и делать. А вот уже подписчиков вешают через EventDispatcher. В подписчике уже идёт запись в лог.

[Максим Федоров]

важный момент, публиковаться то они должны ПОСЛЕ сохранения (флаша)
но ВО ВРЕМЯ флаша эти события должны быть сохранены в то же хранилище в рамках той же транзакции, границами которых сам агрегат и является... события терять нельзя, вдруг сразу после сохранения в БД что-то упало, например обработка первого события