fix: solve the abstraction problem and date format

andrestejerina97 · andrestejerina97 · commit 9831428b2837 · 2025-12-22T17:01:58.000-03:00
diff --git a/app/Audit/AbstractAuditLogFormatter.php b/app/Audit/AbstractAuditLogFormatter.php
@@ -2,6 +2,8 @@
 
 namespace App\Audit;
 
+use App\Audit\Utils\DateFormatter;
+
 /**
  * Copyright 2025 OpenStack Foundation
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,6 +20,12 @@
 abstract class AbstractAuditLogFormatter implements IAuditLogFormatter
 {
     protected AuditContext $ctx;
+    protected string $event_type;
+
+    public function __construct(string $event_type)
+    {
+        $this->event_type = $event_type;
+    }
 
     final public function setContext(AuditContext $ctx): void
     {
@@ -41,6 +49,10 @@ protected function getUserInfo(): string
         return sprintf("%s (%s)", $user_name, $user_id);
     }
 
+    protected function formatAuditDate($date, string $format = 'Y-m-d H:i:s'): string
+    {
+        return DateFormatter::format($date, $format);
+    }
 
     protected function getIgnoredFields(): array
     {
diff --git a/app/Audit/ConcreteFormatters/EntityUpdateAuditLogFormatter.php b/app/Audit/ConcreteFormatters/EntityUpdateAuditLogFormatter.php
@@ -140,8 +140,8 @@ public function format($subject, $change_set): ?string
             }
 
             if ($old_value instanceof DateTime || $new_value instanceof DateTime) {
-                $old_value = $old_value != null ? $old_value->format('Y-m-d H:i:s') : "";
-                $new_value = $new_value != null ? $new_value->format('Y-m-d H:i:s') : "";
+                $old_value = $old_value != null ? $this->formatAuditDate($old_value) : "";
+                $new_value = $new_value != null ? $this->formatAuditDate($new_value) : "";
             } else if (is_bool($old_value) || is_bool($new_value)) {
                 $old_value = $old_value ? 'true' : 'false';
                 $new_value = $new_value ? 'true' : 'false';
diff --git a/app/Audit/ConcreteFormatters/FeaturedSpeakerAuditLogFormatter.php b/app/Audit/ConcreteFormatters/FeaturedSpeakerAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class FeaturedSpeakerAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof FeaturedSpeaker) {
diff --git a/app/Audit/ConcreteFormatters/PresentationFormatters/PresentationSpeakerAuditLogFormatter.php b/app/Audit/ConcreteFormatters/PresentationFormatters/PresentationSpeakerAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class PresentationSpeakerAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof PresentationSpeaker) {
diff --git a/app/Audit/ConcreteFormatters/PresentationFormatters/PresentationTrackChairRatingTypeAuditLogFormatter.php b/app/Audit/ConcreteFormatters/PresentationFormatters/PresentationTrackChairRatingTypeAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class PresentationTrackChairRatingTypeAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof PresentationTrackChairRatingType) {
diff --git a/app/Audit/ConcreteFormatters/PresentationFormatters/PresentationTrackChairScoreTypeAuditLogFormatter.php b/app/Audit/ConcreteFormatters/PresentationFormatters/PresentationTrackChairScoreTypeAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class PresentationTrackChairScoreTypeAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof PresentationTrackChairScoreType) {
diff --git a/app/Audit/ConcreteFormatters/PresentationFormatters/PresentationUserSubmissionAuditLogFormatter.php b/app/Audit/ConcreteFormatters/PresentationFormatters/PresentationUserSubmissionAuditLogFormatter.php
@@ -9,13 +9,6 @@
 
 class PresentationUserSubmissionAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof Presentation) {
diff --git a/app/Audit/ConcreteFormatters/SelectionPlanAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SelectionPlanAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SelectionPlanAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof SelectionPlan) {
@@ -46,16 +39,16 @@ public function format($subject, array $change_set): ?string
                     $submission_dates = $subject->hasSubmissionPeriodDefined()
                         ? sprintf(
                             "[%s - %s]",
-                            $subject->getSubmissionBeginDate()?->format('Y-m-d H:i:s') ?? 'N/A',
-                            $subject->getSubmissionEndDate()?->format('Y-m-d H:i:s') ?? 'N/A'
+                            $this->formatAuditDate($subject->getSubmissionBeginDate()),
+                            $this->formatAuditDate($subject->getSubmissionEndDate())
                         )
                         : 'No dates set';
                     
                     $selection_dates = $subject->hasSelectionPeriodDefined()
                         ? sprintf(
                             "[%s - %s]",
-                            $subject->getSelectionBeginDate()?->format('Y-m-d H:i:s') ?? 'N/A',
-                            $subject->getSelectionEndDate()?->format('Y-m-d H:i:s') ?? 'N/A'
+                            $this->formatAuditDate($subject->getSelectionBeginDate()),
+                            $this->formatAuditDate($subject->getSelectionEndDate())
                         )
                         : 'No dates set';
                     
diff --git a/app/Audit/ConcreteFormatters/SpeakerAssistanceAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SpeakerAssistanceAuditLogFormatter.php
@@ -17,18 +17,11 @@
 
 use App\Audit\AbstractAuditLogFormatter;
 use App\Audit\Interfaces\IAuditStrategy;
-use models\summit\PresentationSpeakerSummitAssistanceConfirmationRequest;
+use models\summit\SpeakerAssistanceRequest;
 use Illuminate\Support\Facades\Log;
 
 class SpeakerAssistanceAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof PresentationSpeakerSummitAssistanceConfirmationRequest) {
diff --git a/app/Audit/ConcreteFormatters/SpeakerRegistrationRequestAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SpeakerRegistrationRequestAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SpeakerRegistrationRequestAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof SpeakerRegistrationRequest) {
diff --git a/app/Audit/ConcreteFormatters/SubmissionInvitationAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SubmissionInvitationAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SubmissionInvitationAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof SummitSubmissionInvitation) {
diff --git a/app/Audit/ConcreteFormatters/SummitAirportAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SummitAirportAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SummitAirportAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof SummitAirport) {
diff --git a/app/Audit/ConcreteFormatters/SummitAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SummitAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SummitAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof Summit) {
diff --git a/app/Audit/ConcreteFormatters/SummitEventAttendanceMetricAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SummitEventAttendanceMetricAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SummitEventAttendanceMetricAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof SummitEventAttendanceMetric) {
diff --git a/app/Audit/ConcreteFormatters/SummitExternalLocationAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SummitExternalLocationAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SummitExternalLocationAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof SummitExternalLocation) {
diff --git a/app/Audit/ConcreteFormatters/SummitGeoLocatedLocationAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SummitGeoLocatedLocationAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SummitGeoLocatedLocationAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof SummitGeoLocatedLocation) {
diff --git a/app/Audit/ConcreteFormatters/SummitHotelAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SummitHotelAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SummitHotelAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof SummitHotel) {
diff --git a/app/Audit/ConcreteFormatters/SummitMemberScheduleAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SummitMemberScheduleAuditLogFormatter.php
@@ -18,13 +18,6 @@
 
 class SummitMemberScheduleAuditLogFormatter extends AbstractAuditLogFormatter
 {
-
-    private string $event_type;
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     /**
      * @param $subject
      * @param array $change_set
diff --git a/app/Audit/ConcreteFormatters/SummitTrackChairAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SummitTrackChairAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SummitTrackChairAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof SummitTrackChair) {
diff --git a/app/Audit/ConcreteFormatters/SummitVenueAuditLogFormatter.php b/app/Audit/ConcreteFormatters/SummitVenueAuditLogFormatter.php
@@ -22,13 +22,6 @@
 
 class SummitVenueAuditLogFormatter extends AbstractAuditLogFormatter
 {
-    private string $event_type;
-
-    public function __construct(string $event_type)
-    {
-        $this->event_type = $event_type;
-    }
-
     public function format($subject, array $change_set): ?string
     {
         if (!$subject instanceof SummitVenue) {
diff --git a/app/Audit/Utils/DateFormatter.php b/app/Audit/Utils/DateFormatter.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Audit\Utils;
+
+/**
+ * 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.
+ **/
+
+class DateFormatter
+{
+
+    public static function format($date, string $format = 'Y-m-d H:i:s'): string
+    {
+        if ($date instanceof \DateTimeInterface) {
+            return $date->format($format);
+        }
+        if ($date instanceof \DateTime) {
+            return $date->format($format);
+        }
+        return 'N/A';
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -22,13 +22,6 @@`
`22`	`22`
`23`	`23`	`class FeaturedSpeakerAuditLogFormatter extends AbstractAuditLogFormatter`
`24`	`24`	`{`
`25`		`- private string $event_type;`
`26`		`-`
`27`		`- public function __construct(string $event_type)`
`28`		`- {`
`29`		`- $this->event_type = $event_type;`
`30`		`- }`
`31`		`-`
`32`	`25`	`public function format($subject, array $change_set): ?string`
`33`	`26`	`{`
`34`	`27`	`if (!$subject instanceof FeaturedSpeaker) {`
Original file line number	Diff line number	Diff line change
`@@ -9,13 +9,6 @@`
`9`	`9`
`10`	`10`	`class PresentationUserSubmissionAuditLogFormatter extends AbstractAuditLogFormatter`
`11`	`11`	`{`
`12`		`- private string $event_type;`
`13`		`-`
`14`		`- public function __construct(string $event_type)`
`15`		`- {`
`16`		`- $this->event_type = $event_type;`
`17`		`- }`
`18`		`-`
`19`	`12`	`public function format($subject, array $change_set): ?string`
`20`	`13`	`{`
`21`	`14`	`if (!$subject instanceof Presentation) {`