See the history of a ticket about bileto HOT 4 CLOSED

I need to track activity of all Entities: insert, update and delete. This can be done pretty easily with a Doctrine Lifecycle Subscriber.

For updates, I have to track the changes. Changes can be retrieved via the unit of work:

public function postUpdate(LifecycleEventArgs $args): void
{
    $entity = $args->getObject();
    /** @var \Doctrine\ORM\EntityManager $entityManager */
    $entityManager = $args->getObjectManager();
    $unitOfWork = $entityManager->getUnitOfWork();
    $entityChanges = $unitOfWork->getEntityChangeSet($entity);

    // do something with $entityChanges
}

The activity can be saved in a table / entity EntityEvent with the following fields:

• id
• uid
• createdAt
• createdBy
• type (insert, update or delete)
• entity (polymorphic relation? entity_type, entity_id)
• changes (a JSON object with the list of old and new values per affected fields, e.g. {'title': ['Old title', 'New title']}, {} for insert and delete)

The $entityChanges needs to be processed before serializing it in JSON because of possible relations. For instance, ticket.organization cannot be serialized. In this case, we need to retrieve the relation id (ticket.organization.id). An exception should be raised for other unserializable changes.

from bileto.

Note that the changes should be visually grouped as much as possible. For instance, one single action could trigger multiple changes. Visually, it could be great to identify this action, and allow to open the details of what changed.

from bileto.

Remaining questions:

• should we clean the EntityEvent table? (e.g. after a certain time, or when the entity pointed by entity_id is deleted)
• what about personal data of users? (don't log events of the User entity?)

from bileto.

Fetching ticket events:

$events = $entityEventRepository->findBy([
    'entity_type' => $ticket::class,
    'entity_id' => $ticket->getId(),
]);

// merge messages and events in a unique array ordered by `createdAt`
$timeline = Timeline::build($messages, $events);

Display timeline:

{% for timelineItem in timeline %}
    {% if class(timelineItem) == 'Message' %}
        {% include('tickets/_show_message', { message: timelineItem }) %}
    {% elseif class(timelineItem) == 'EntityEvent' %}
        {% include('tickets/_show_event', { event: timelineItem }) %}
    {% endif %}
{% endfor %}

from bileto.