Skip to content

fix: reduces update logs that contain no actual changes #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrestejerina97 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix: reduces update logs that contain no actual changes #547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f961fbd
fix: reduces update logs that contain no actual changes
andrestejerina97 May 19, 2026
e7d22a9
fix: formatters now return a null description if there are no actual …
andrestejerina97 May 26, 2026
7636b49
fix: seal audit formatter update-suppression behind a private gateway
smarcet Aug 7, 2026
e2b6006
fix: remove unreachable microsecond fallback in DateTime equality check
smarcet Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 40 additions & 2 deletions app/Audit/AbstractAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ protected function formatChangeValue($value): string
}


protected function buildChangeDetails(array $change_set): string
private function buildChangeDetails(array $change_set): ?string
{
$changed_fields = [];
$ignored_fields = $this->getIgnoredFields();
Expand All @@ -178,21 +178,59 @@ protected function buildChangeDetails(array $change_set): string
}

if (empty($changed_fields)) {
return 'properties without changes registered';
return null;
}

$fields_summary = count($changed_fields) . ' field(s) modified: ';
return $fields_summary . implode(' | ', $changed_fields);
}

/**
* The only way to consume buildChangeDetails() for an EVENT_ENTITY_UPDATE message.
* Returns null (suppressing the audit entry) whenever nothing meaningful changed,
* otherwise hands the non-null details string to $messageBuilder to assemble the
* final message. buildChangeDetails() is private specifically so a formatter cannot
* bypass this null-check.
*/
final protected function formatUpdateMessage(array $change_set, \Closure $messageBuilder): ?string
{
$details = $this->buildChangeDetails($change_set);
if ($details === null) {
return null;
}
return $messageBuilder($details);
}


protected function formatFieldChange(string $prop_name, $old_value, $new_value): ?string
{
if ($this->valuesAreEffectivelyEqual($old_value, $new_value)) {
return null;
}

$old_display = $this->formatChangeValue($old_value);
$new_display = $this->formatChangeValue($new_value);

return sprintf("Property \"%s\" has changed from \"%s\" to \"%s\"", $prop_name, $old_display, $new_display);
}

protected function valuesAreEffectivelyEqual($old_value, $new_value): bool
{
if ($old_value === $new_value) {
return true;
}

if ($old_value instanceof \DateTimeInterface && $new_value instanceof \DateTimeInterface) {
return $old_value->getTimestamp() === $new_value->getTimestamp();
}

if ((is_scalar($old_value) || is_null($old_value)) && (is_scalar($new_value) || is_null($new_value))) {
return $this->formatChangeValue($old_value) === $this->formatChangeValue($new_value);
}

return false;
}

/**
* Format detailed message for many-to-many collection changes
*/
Expand Down
6 changes: 3 additions & 3 deletions app/Audit/AuditLogOtlpStrategy.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public function audit($subject, array $change_set, string $event_type, AuditCon
return;
}
Log::debug("AuditLogOtlpStrategy::audit", ['subject' => $subject, 'change_set' => $change_set, 'event_type' => $event_type]);
try {
try {
$entity = $this->resolveAuditableEntity($subject);
Comment on lines 52 to 54
if (is_null($entity)) {
Log::warning("AuditLogOtlpStrategy::audit subject not found");
Expand All @@ -67,7 +67,7 @@ public function audit($subject, array $change_set, string $event_type, AuditCon
}
$description = $formatter->format($subject, $change_set);
if(is_null($description)){
Log::warning("AuditLogOtlpStrategy::audit description is empty");
Log::debug("AuditLogOtlpStrategy::audit description is empty");
return;
}
$auditData = $this->buildAuditLogData($entity, $subject, $change_set, $event_type, $ctx);
Expand All @@ -79,7 +79,7 @@ public function audit($subject, array $change_set, string $event_type, AuditCon
job: $job,
);
Log::debug("AuditLogOtlpStrategy::audit entry sent to OTEL", ["user_id" => $ctx->userId, "user_email" => $ctx->userEmail]);

} catch (\Exception $ex) {
Log::error('OTEL audit logging error: ' . $ex->getMessage(), [
'exception' => $ex,
Expand Down
3 changes: 1 addition & 2 deletions app/Audit/ConcreteFormatters/AffiliationAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@ public function format($subject, array $change_set): ?string
return sprintf("Affiliation (%s) for '%s' (%s) created by user %s", $id, $owner_name, $job_title, $this->getUserInfo());

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$details = $this->buildChangeDetails($change_set);
return sprintf("Affiliation (%s) for '%s' (%s) updated: %s by user %s", $id, $owner_name, $job_title, $details, $this->getUserInfo());
return $this->formatUpdateMessage($change_set, fn($details) => sprintf("Affiliation (%s) for '%s' (%s) updated: %s by user %s", $id, $owner_name, $job_title, $details, $this->getUserInfo()));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf("Affiliation (%s) for '%s' (%s) deleted by user %s", $id, $owner_name, $job_title, $this->getUserInfo());
Expand Down
5 changes: 2 additions & 3 deletions app/Audit/ConcreteFormatters/AssignedSelectionPlanExtraQuestionTypeAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,13 @@ public function format($subject, array $change_set): ?string
case IAuditStrategy::EVENT_ENTITY_UPDATE:
$question_type = $subject->getQuestionType();
$question_label = $question_type ? ($question_type->getLabel() ?? 'Unknown Question') : 'Unknown Question';
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Assigned Selection Plan Extra Question (%s) '%s' updated: %s by user %s",
$id,
$question_label,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
$question_type = $subject->getQuestionType();
Expand Down
5 changes: 2 additions & 3 deletions app/Audit/ConcreteFormatters/CompanyAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,13 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Company '%s' (%d) updated: %s by user %s",
$name,
$id,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
3 changes: 1 addition & 2 deletions app/Audit/ConcreteFormatters/ExtraQuestionTypeValueAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ public function format($subject, array $change_set): ?string
case IAuditStrategy::EVENT_ENTITY_CREATION:
return sprintf("Extra Question Value '%s' (%s) for Question '%s' created by user %s", $label, $id, $question_label, $this->getUserInfo());
case IAuditStrategy::EVENT_ENTITY_UPDATE:
$details = $this->buildChangeDetails($change_set);
return sprintf("Extra Question Value '%s' (%s) for Question '%s' updated: %s by user %s", $label, $id, $question_label, $details, $this->getUserInfo());
return $this->formatUpdateMessage($change_set, fn($details) => sprintf("Extra Question Value '%s' (%s) for Question '%s' updated: %s by user %s", $label, $id, $question_label, $details, $this->getUserInfo()));
case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf("Extra Question Value '%s' (%s) for Question '%s' deleted by user %s", $label, $id, $question_label, $this->getUserInfo());
}
Expand Down
5 changes: 2 additions & 3 deletions app/Audit/ConcreteFormatters/FeaturedSpeakerAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,13 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Featured speaker '%s' (%s) updated: %s by user %s",
$speaker_name,
$speaker_id,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
5 changes: 2 additions & 3 deletions app/Audit/ConcreteFormatters/FileAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,14 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"File '%s' (%s) (%d) updated: %s by user %s",
$name,
$filename,
$id,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
5 changes: 2 additions & 3 deletions app/Audit/ConcreteFormatters/PrePaidSummitRegistrationDiscountCodeAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,16 +71,15 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Pre-Paid Discount Code '%s' (%d) for Summit '%s' updated: %s (current: %s) by user %s",
$code,
$id,
$summit_name,
$change_details,
$discount_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
3 changes: 1 addition & 2 deletions app/Audit/ConcreteFormatters/PresentationAttendeeVoteAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ public function format($subject, array $change_set): ?string
case IAuditStrategy::EVENT_ENTITY_CREATION:
return sprintf("Presentation Attendee Vote (%s) for '%s' created by user %s", $id, $title, $this->getUserInfo());
case IAuditStrategy::EVENT_ENTITY_UPDATE:
$details = $this->buildChangeDetails($change_set);
return sprintf("Presentation Attendee Vote (%s) for '%s' updated: %s by user %s", $id, $title, $details, $this->getUserInfo());
return $this->formatUpdateMessage($change_set, fn($details) => sprintf("Presentation Attendee Vote (%s) for '%s' updated: %s by user %s", $id, $title, $details, $this->getUserInfo()));
case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf("Presentation Attendee Vote (%s) for '%s' deleted by user %s", $id, $title, $this->getUserInfo());
}
Expand Down
5 changes: 2 additions & 3 deletions app/Audit/ConcreteFormatters/PresentationCategoryAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,15 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Presentation Category '%s' (%s) (%d) for Summit '%s' updated: %s by user %s",
$title,
$code,
$id,
$summit_name,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
5 changes: 2 additions & 3 deletions app/Audit/ConcreteFormatters/PresentationCategoryGroupAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,14 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Track Group (PresentationCategoryGroup) '%s' (%s) for Summit '%s' updated: %s by user %s",
$name,
$id,
$summit_name,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
2 changes: 1 addition & 1 deletion app/Audit/ConcreteFormatters/PresentationFormatters/BasePresentationAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public function format(mixed $subject, array $change_set): ?string

abstract protected function formatCreation(array $data): string;

abstract protected function formatUpdate(array $data, array $change_set): string;
abstract protected function formatUpdate(array $data, array $change_set): ?string;

abstract protected function formatDeletion(array $data): string;
}
5 changes: 2 additions & 3 deletions ...dit/ConcreteFormatters/PresentationFormatters/PresentationActionTypeAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,14 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Presentation Action Type '%s' (%d) for Summit '%s' updated: %s by user %s",
$label,
$id,
$summit_name,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
8 changes: 4 additions & 4 deletions ...Audit/ConcreteFormatters/PresentationFormatters/PresentationEventApiAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ protected function formatCreation(array $data): string
);
}

protected function formatUpdate(array $data, array $change_set): string
protected function formatUpdate(array $data, array $change_set): ?string
{
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Presentation '%s' (%s) updated: %s by user %s",
$data['title'],
$data['id'],
$this->buildChangeDetails($change_set),
$change_details,
$this->getUserInfo()
);
));
}

protected function formatDeletion(array $data): string
Expand Down
5 changes: 2 additions & 3 deletions app/Audit/ConcreteFormatters/PresentationFormatters/PresentationLinkAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,14 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Presentation Link '%s' (%d) for presentation '%s' updated: %s by user %s",
$title,
$id,
$presentation_title,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
5 changes: 2 additions & 3 deletions ...it/ConcreteFormatters/PresentationFormatters/PresentationMediaUploadAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,14 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Presentation Media Upload '%s' (%d) for presentation '%s' updated: %s by user %s",
$title,
$id,
$presentation_title,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
5 changes: 2 additions & 3 deletions app/Audit/ConcreteFormatters/PresentationFormatters/PresentationSlideAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,14 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Presentation Slide '%s' (%d) for presentation '%s' updated: %s by user %s",
$title,
$id,
$presentation_title,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
5 changes: 2 additions & 3 deletions app/Audit/ConcreteFormatters/PresentationFormatters/PresentationSpeakerAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,13 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Speaker '%s' (%s) updated: %s by user %s",
$full_name,
$speaker_id,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
5 changes: 2 additions & 3 deletions ...esentationFormatters/PresentationSpeakerSummitAssistanceConfirmationAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,14 @@ public function format($subject, array $change_set): ?string
);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$change_details = $this->buildChangeDetails($change_set);
return sprintf(
return $this->formatUpdateMessage($change_set, fn($change_details) => sprintf(
"Speaker Assistance Confirmation (%d) for '%s' on Summit '%s' updated: %s by user %s",
$id,
$speaker_name,
$summit_name,
$change_details,
$this->getUserInfo()
);
));

case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf(
Expand Down
Loading
Loading