chore: add custom audit logger per entity ( SummitMemberSchedule )

Author: smarcet

app/Audit/AuditEventListener.php

@@ -26,15 +26,19 @@ class AuditEventListener
 
     public function onFlush(OnFlushEventArgs $eventArgs): void
     {
+        if (app()->environment('testing')){
+            return;
+        }
         $em = $eventArgs->getObjectManager();
         $uow = $em->getUnitOfWork();
         // Strategy selection based on environment configuration
         $strategy = $this->getAuditStrategy($em);
-        $ctx = $this->buildAuditContext();
         if (!$strategy) {
             return; // No audit strategy enabled
         }
 
+        $ctx = $this->buildAuditContext();
+
         try {
             foreach ($uow->getScheduledEntityInsertions() as $entity) {
                 $strategy->audit($entity, [], IAuditStrategy::EVENT_ENTITY_CREATION, $ctx);

app/Audit/AuditLogFormatterFactory.php

@@ -21,6 +21,21 @@
 class AuditLogFormatterFactory implements IAuditLogFormatterFactory
 {
 
+    private array $config;
+
+    public function __construct()
+    {
+        // cache the config so we don't hit config() repeatedly
+        $this->config = config('audit_log', []);
+    }
+
+    public function getStrategyClass(object $subject, string $event_type): ?IAuditLogFormatter
+    {
+        $class = get_class($subject);
+        $cls = $this->config['entities'][$class]['strategy'] ?? null;
+        return !is_null($cls) ? new $cls($event_type):null;
+    }
+
     public function make($subject, $eventType): ?IAuditLogFormatter
     {
         $formatter = null;
@@ -37,15 +52,24 @@ public function make($subject, $eventType): ?IAuditLogFormatter
                 $formatter = new EntityCollectionUpdateAuditLogFormatter($child_entity_formatter);
                 break;
             case IAuditStrategy::EVENT_ENTITY_CREATION:
-                $formatter = new EntityCreationAuditLogFormatter();
+                $formatter = $this->getStrategyClass($subject, $eventType);
+                if(is_null($formatter)) {
+                    $formatter = new EntityCreationAuditLogFormatter();
+                }
                 break;
             case IAuditStrategy::EVENT_ENTITY_DELETION:
-                $child_entity_formatter = ChildEntityFormatterFactory::build($subject);
-                $formatter = new EntityDeletionAuditLogFormatter($child_entity_formatter);
+                $formatter = $this->getStrategyClass($subject, $eventType);
+                if(is_null($formatter)) {
+                    $child_entity_formatter = ChildEntityFormatterFactory::build($subject);
+                    $formatter = new EntityDeletionAuditLogFormatter($child_entity_formatter);
+                }
                 break;
             case IAuditStrategy::EVENT_ENTITY_UPDATE:
-                $child_entity_formatter = ChildEntityFormatterFactory::build($subject);
-                $formatter = new EntityUpdateAuditLogFormatter($child_entity_formatter);
+                $formatter = $this->getStrategyClass($subject, $eventType);
+                if(is_null($formatter)) {
+                    $child_entity_formatter = ChildEntityFormatterFactory::build($subject);
+                    $formatter = new EntityUpdateAuditLogFormatter($child_entity_formatter);
+                }
                 break;
         }
         return $formatter;

app/Audit/ConcreteFormatters/SummitMemberScheduleAuditLogFormatter.php

@@ -0,0 +1,44 @@
+<?php namespace App\Audit\ConcreteFormatters;
+/**
+ * Copyright 2025 OpenStack Foundation
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+use App\Audit\IAuditLogFormatter;
+use App\Audit\Interfaces\IAuditStrategy;
+use models\main\SummitMemberSchedule;
+
+class SummitMemberScheduleAuditLogFormatter implements IAuditLogFormatter
+{
+
+    private string $event_type;
+    public function __construct(string $event_type)
+    {
+        $this->event_type = $event_type;
+    }
+
+    /**
+     * @param $subject
+     * @param array $change_set
+     * @return string|null
+     */
+    public function format($subject, array $change_set): ?string
+    {
+       if(!$subject instanceof SummitMemberSchedule) return null;
+       switch($this->event_type) {
+           case IAuditStrategy::EVENT_ENTITY_DELETION:{
+               return "Activity was removed from user custom schedule.";
+           }
+           case IAuditStrategy::EVENT_ENTITY_CREATION:{
+               return sprintf("Activity %s (%s) was inserted onto user custom schedule.", $subject->getEvent()->getTitle(), $subject->getEvent()->getId());
+           }
+       }
+    }
+}

config/audit_log.php

@@ -0,0 +1,10 @@
+<?php
+
+return [
+    'entities' => [
+        \models\main\SummitMemberSchedule::class => [
+            'enabled' => true,
+            'strategy' => \App\Audit\ConcreteFormatters\SummitMemberScheduleAuditLogFormatter::class,
+        ]
+    ]
+];