Merge pull request #144 from sumocoders/294-automatic-logging-audit-trail

Add catches for circular references

Author: Bjorn Van Acker

src/DoctrineListener/DoctrineAuditListener.php

@@ -17,6 +17,10 @@
 use SumoCoders\FrameworkCoreBundle\Attribute\AuditTrail\AuditTrailSensitiveData;
 use SumoCoders\FrameworkCoreBundle\Enum\EventAction;
 use SumoCoders\FrameworkCoreBundle\Logger\AuditLogger;
+use SumoCoders\FrameworkCoreBundle\Serializer\CircularReferenceHandler;
+use SumoCoders\FrameworkCoreBundle\Serializer\MaxDepthHandler;
+use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
+use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
 use Symfony\Component\Serializer\SerializerInterface;
 
 #[AsDoctrineListener(event: Events::postPersist, priority: 500)]
@@ -55,7 +59,7 @@ public function preRemove(PreRemoveEventArgs $args): void
     {
         $entity = $args->getObject();
         $properties = $this->getProperties($entity);
-        $data = $this->serializer->normalize($entity);
+        $data = $this->serialize($entity);
 
         // Hide sensitive data
         foreach ($properties as $property) {
@@ -118,7 +122,7 @@ private function log(object $entity, EventAction $action, EntityManagerInterface
 
                 break;
             case EventAction::CREATE:
-                $entityData = $this->serializer->normalize($entity);
+                $entityData = $this->serialize($entity);
                 $entityFields = array_keys($entityData);
 
                 if (!$this->showDataForEntity($entity) && !$this->showPropertyDataForEntity($entity)) {
@@ -172,11 +176,24 @@ private function log(object $entity, EventAction $action, EntityManagerInterface
         );
     }
 
+    private function serialize(object $object): array
+    {
+        return $this->serializer->normalize(
+            $object,
+            null,
+            [
+                AbstractObjectNormalizer::ENABLE_MAX_DEPTH => true,
+                AbstractObjectNormalizer::MAX_DEPTH_HANDLER => new MaxDepthHandler(),
+                AbstractNormalizer::CIRCULAR_REFERENCE_HANDLER => new CircularReferenceHandler(),
+            ]
+        );
+    }
+
     private function getIdForEntity(object $entity): ?string
     {
         $properties = $this->getProperties($entity);
         $methods = $this->getMethods($entity);
-        $serializedData = $this->serializer->normalize($entity);
+        $serializedData = $this->serialize($entity);
 
         foreach ($properties as $property) {
             if ($this->isPropertyPrimaryKey($entity, $property)) {
@@ -198,7 +215,7 @@ private function getIdentifierForEntity(object $entity): ?string
         // Check if the entity has a AuditTrailIdentifier::class attribute
         $properties = $this->getProperties($entity);
         $methods = $this->getMethods($entity);
-        $serializedData = $this->serializer->normalize($entity);
+        $serializedData = $this->serialize($entity);
 
         foreach ($properties as $property) {
             if ($this->isPropertyIdentifier($entity, $property)) {
@@ -238,7 +255,7 @@ private function getDataForDeletedEntity(object $entity): ?array
         }
 
         $idProperty = array_shift($properties);
-        $serializedEntity = $this->serializer->normalize($entity);
+        $serializedEntity = $this->serialize($entity);
 
         foreach ($removals as $rKey => $removal) {
             $isSameEntity = true;

src/Serializer/CircularReferenceHandler.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace SumoCoders\FrameworkCoreBundle\Serializer;
+
+use Doctrine\ORM\Mapping\Id;
+
+class CircularReferenceHandler
+{
+    public function __invoke($object)
+    {
+        return $this->getId($object);
+    }
+
+    private function getId(object $object): ?string
+    {
+        $reflectionClass = new \ReflectionClass($object);
+        $properties = $reflectionClass->getProperties();
+
+        foreach ($properties as $property) {
+            if ($property->getAttributes(Id::class)) {
+                $property->setAccessible(true);
+                return (string) $property->getValue($object);
+            }
+        }
+
+        return null;
+    }
+}

src/Serializer/MaxDepthHandler.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace SumoCoders\FrameworkCoreBundle\Serializer;
+
+use Doctrine\ORM\Mapping\Id;
+
+class MaxDepthHandler
+{
+    public function __invoke($innerObject, $outerObject, string $attributeName, string $format = null, array $context = [])
+    {
+        return $this->getId($innerObject);
+    }
+
+    private function getId(object $object): ?string
+    {
+        $reflectionClass = new \ReflectionClass($entity);
+        $properties = $reflectionClass->getProperties();
+
+        foreach ($properties as $property) {
+            if ($property->getAttributes(Id::class)) {
+                $property->setAccessible(true);
+                return (string) $property->getValue($entity);
+            }
+        }
+
+        return null;
+    }
+}