chore: refactor AuditLogFormatterFactory

Author: smarcet

app/Audit/AuditLogFormatterFactory.php

@@ -17,6 +17,8 @@
 use App\Audit\ConcreteFormatters\EntityDeletionAuditLogFormatter;
 use App\Audit\ConcreteFormatters\EntityUpdateAuditLogFormatter;
 use App\Audit\Interfaces\IAuditStrategy;
+use Doctrine\ORM\PersistentCollection;
+use Illuminate\Support\Facades\Log;
 
 class AuditLogFormatterFactory implements IAuditLogFormatterFactory
 {
@@ -34,14 +36,50 @@ public function make(AuditContext $ctx, $subject, $eventType): ?IAuditLogFormatt
         $formatter = null;
         switch ($eventType) {
             case IAuditStrategy::EVENT_COLLECTION_UPDATE:
-                $child_entity = null;
-                if (count($subject) > 0) {
-                    $child_entity = $subject[0];
-                }
-                if (is_null($child_entity) && isset($subject->getSnapshot()[0]) && count($subject->getSnapshot()) > 0) {
-                    $child_entity = $subject->getSnapshot()[0];
+                Log::debug("AuditLogFormatterFactory::make IAuditStrategy::EVENT_COLLECTION_UPDATE",
+                    ["subject" => get_class($subject)]);
+
+                $child_entity_formatter = null;
+
+                if ($subject instanceof PersistentCollection) {
+                    // KEY: do NOT initialize the collection.
+                    $targetEntity = null;
+
+                    // Doctrine variants:
+                    if (method_exists($subject, 'getTypeClass')) {
+                        $targetEntity = $subject->getTypeClass();
+                        Log::debug("AuditLogFormatterFactory::make getTypeClass {$targetEntity}");
+                    } elseif (method_exists($subject, 'getMapping')) {
+                        $mapping = $subject->getMapping();
+                        $targetEntity = $mapping['targetEntity'] ?? null;
+                        Log::debug("AuditLogFormatterFactory::make getMapping {$targetEntity}");
+                    } else {
+                        // last-resort: read private association metadata (still no hydration)
+                        $ref = new \ReflectionObject($subject);
+                        foreach (['association', 'mapping', 'associationMapping'] as $propName) {
+                            if ($ref->hasProperty($propName)) {
+                                $prop = $ref->getProperty($propName);
+                                $prop->setAccessible(true);
+                                $mapping = $prop->getValue($subject);
+                                $targetEntity = $mapping['targetEntity'] ?? null;
+                                if ($targetEntity) break;
+                            }
+                        }
+                    }
+
+                    if ($targetEntity) {
+                        $child_entity_formatter = ChildEntityFormatterFactory::build($targetEntity);
+                    }
+
+                } elseif (is_array($subject)) {
+                    $child_entity = $subject[0] ?? null;
+                    $child_entity_formatter = $child_entity ? ChildEntityFormatterFactory::build($child_entity) : null;
+                } elseif (is_object($subject) && method_exists($subject, 'getSnapshot')) {
+                    $snap = $subject->getSnapshot(); // only once
+                    $child_entity = $snap[0] ?? null;
+                    $child_entity_formatter = $child_entity ? ChildEntityFormatterFactory::build($child_entity) : null;
                 }
-                $child_entity_formatter = $child_entity != null ? ChildEntityFormatterFactory::build($child_entity) : null;
+
                 $formatter = new EntityCollectionUpdateAuditLogFormatter($child_entity_formatter);
                 break;
             case IAuditStrategy::EVENT_ENTITY_CREATION:
@@ -65,6 +103,7 @@ public function make(AuditContext $ctx, $subject, $eventType): ?IAuditLogFormatt
                 }
                 break;
         }
+        if ($formatter === null) return null;
         $formatter->setContext($ctx);
         return $formatter;
     }
@@ -73,7 +112,7 @@ private function getFormatterByContext(object $subject, string $event_type, Audi
     {
         $class = get_class($subject);
         $entity_config = $this->config['entities'][$class] ?? null;
-        
+
         if (!$entity_config) {
             return null;
         }

app/Audit/ConcreteFormatters/ChildEntityFormatters/ChildEntityFormatterFactory.php

@@ -16,25 +16,29 @@
  **/
 
 use Illuminate\Support\Facades\Log;
-use ReflectionClass;
+use Doctrine\Common\Util\ClassUtils;
 
 /**
  * Class ChildEntityFormatterFactory
  * @package App\Audit\ConcreteFormatters\ChildEntityFormatter
  */
 class ChildEntityFormatterFactory {
 
-    public static function build($entity): ?IChildEntityAuditLogFormatter {
+    public static function build(object|string $entityOrClass): ?IChildEntityAuditLogFormatter {
         try {
-            $class_name = (new ReflectionClass($entity))->getShortName();
-            $class_name = "App\\Audit\\ConcreteFormatters\\ChildEntityFormatters\\{$class_name}AuditLogFormatter";
-            if(class_exists($class_name)) {
-                return new $class_name();
-            }
-            return null;
-        } catch (\ReflectionException $e) {
+            $fqcn = is_string($entityOrClass)
+                ? ltrim($entityOrClass, '\\')
+                : (class_exists(ClassUtils::class) ? ClassUtils::getClass($entityOrClass) : get_class($entityOrClass));
+
+            $short = substr($fqcn, strrpos($fqcn, '\\') + 1);
+
+            Log::debug("Child Entity Formatter " . $short);
+            $class = "App\\Audit\\ConcreteFormatters\\ChildEntityFormatters\\{$short}AuditLogFormatter";
+
+            return class_exists($class) ? new $class() : null;
+        } catch (\Throwable $e) {
             Log::error($e);
             return null;
         }
     }
-}
+}