Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 42 additions & 1 deletion app/Audit/AuditLogFormatterFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
use App\Audit\ConcreteFormatters\DefaultEntityManyToManyCollectionDeleteAuditLogFormatter;
use App\Audit\ConcreteFormatters\EntityUpdateAuditLogFormatter;
use App\Audit\Interfaces\IAuditStrategy;
use Doctrine\Common\Util\ClassUtils;
use Doctrine\ORM\PersistentCollection;
use Illuminate\Support\Facades\Log;
use Doctrine\ORM\Mapping\ClassMetadata;
Expand All @@ -42,6 +43,10 @@ public function __construct()

public function make(AuditContext $ctx, $subject, string $event_type): ?IAuditLogFormatter
{
if ($this->isAuditDisabledForSubject($subject)) {
return null;
}
Comment on lines +46 to +48

$formatter = null;
switch ($event_type) {
case IAuditStrategy::EVENT_COLLECTION_UPDATE:
Expand Down Expand Up @@ -144,9 +149,17 @@ public function make(AuditContext $ctx, $subject, string $event_type): ?IAuditLo
return $formatter;
}

public function isAuditDisabled(mixed $subject): bool
{
return $this->isAuditDisabledForSubject($subject);
}

private function getFormatterByContext(object $subject, string $event_type, AuditContext $ctx): ?IAuditLogFormatter
{
$class = get_class($subject);
$class = $this->getSubjectClass($subject);
if ($class === null) {
return null;
}
$entity_config = $this->config['entities'][$class] ?? null;

if (!$entity_config) {
Expand Down Expand Up @@ -190,4 +203,32 @@ private function routeMatches(string $route, string $actual_route): bool
{
return strcmp($actual_route, $route) === 0;
}

private function isAuditDisabledForSubject(mixed $subject): bool
{
$class = $this->getSubjectClass($subject);
if ($class === null) {
return false;
}

$entities = $this->config['entities'] ?? [];
$entity_config = $entities[$class] ?? null;

return is_array($entity_config)
&& array_key_exists('enabled', $entity_config)
&& $entity_config['enabled'] === false;
Comment on lines +214 to +219
}

private function getSubjectClass(mixed $subject): ?string
{
if (!is_object($subject)) {
return null;
}

if (class_exists(ClassUtils::class)) {
return ClassUtils::getClass($subject);
}

return get_class($subject);
}
}
3 changes: 3 additions & 0 deletions app/Audit/AuditLogOtlpStrategy.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ public function audit($subject, array $change_set, string $event_type, AuditCon
return;
}
Log::debug("AuditLogOtlpStrategy::audit current user", ["user_id" => $ctx->userId, "user_email" => $ctx->userEmail]);
if ($this->formatterFactory->isAuditDisabled($subject)) {
return;
}
$formatter = $this->formatterFactory->make($ctx, $subject, $event_type);
if(is_null($formatter)) {
Log::warning("AuditLogOtlpStrategy::audit formatter not found");
Expand Down
1 change: 1 addition & 0 deletions app/Audit/IAuditLogFormatterFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
interface IAuditLogFormatterFactory
{
public function make(AuditContext $ctx, $subject, string $event_type): ?IAuditLogFormatter;
public function isAuditDisabled(mixed $subject): bool;
}
4 changes: 2 additions & 2 deletions config/audit_log.php
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
'strategy' => \App\Audit\ConcreteFormatters\PresentationFormatters\PresentationActionTypeAuditLogFormatter::class,
],
\models\summit\SummitEventAttendanceMetric::class => [
'enabled' => true,
'enabled' => false,
'strategy' => \App\Audit\ConcreteFormatters\SummitEventAttendanceMetricAuditLogFormatter::class,
],
\models\summit\SummitMediaUploadType::class => [
Expand Down Expand Up @@ -149,7 +149,7 @@
'strategy' => \App\Audit\ConcreteFormatters\SummitVenueRoomAuditLogFormatter::class,
],
\models\summit\SummitMetric::class => [
'enabled' => true,
'enabled' => false,
'strategy' => \App\Audit\ConcreteFormatters\SummitMetricAuditLogFormatter::class,
],
\models\summit\SummitSponsorship::class => [
Expand Down
84 changes: 84 additions & 0 deletions tests/OpenTelemetry/AuditLogFormatterFactoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

use App\Audit\AuditContext;
use App\Audit\AuditLogFormatterFactory;
use App\Audit\AbstractAuditLogFormatter;
use App\Audit\Interfaces\IAuditStrategy;
use PHPUnit\Framework\TestCase;

/**
Expand Down Expand Up @@ -154,4 +156,86 @@ public function testMatchesStrategyReturnsFalseWhenRouteDoesNotMatch(): void
$result = $method->invoke($this->factory, $strategy, $ctx);
$this->assertFalse($result, 'matchesStrategy should return false when routes do not match');
}

public function testIsAuditDisabledForSubjectReturnsTrueWhenEntityIsDisabled(): void
{
$this->setFactoryConfig([
'entities' => [
FakeAuditEntity::class => [
'enabled' => false,
'strategy' => FakeAuditFormatter::class,
],
],
]);

$method = (new \ReflectionClass($this->factory))->getMethod('isAuditDisabledForSubject');
$method->setAccessible(true);

$this->assertTrue($method->invoke($this->factory, new FakeAuditEntity()));
}

public function testIsAuditDisabledForSubjectReturnsFalseWhenEntityIsEnabled(): void
{
$this->setFactoryConfig([
'entities' => [
FakeAuditEntity::class => [
'enabled' => true,
'strategy' => FakeAuditFormatter::class,
],
],
]);

$method = (new \ReflectionClass($this->factory))->getMethod('isAuditDisabledForSubject');
$method->setAccessible(true);

$this->assertFalse($method->invoke($this->factory, new FakeAuditEntity()));
}

public function testMakeReturnsNullWhenEntityIsDisabled(): void
{
$this->setFactoryConfig([
'entities' => [
FakeAuditEntity::class => [
'enabled' => false,
'strategy' => FakeAuditFormatter::class,
],
],
]);

$ctx = new AuditContext();
$formatter = $this->factory->make($ctx, new FakeAuditEntity(), IAuditStrategy::EVENT_ENTITY_CREATION);

$this->assertNull($formatter);
}

public function testIsAuditDisabledPublicMethodReturnsFalseForNonObjectSubject(): void
{
$this->setFactoryConfig([
'entities' => [
FakeAuditEntity::class => [
'enabled' => false,
'strategy' => FakeAuditFormatter::class,
],
],
]);

$this->assertFalse($this->factory->isAuditDisabled('not-an-object'));
}

private function setFactoryConfig(array $config): void
{
$prop = (new \ReflectionClass($this->factory))->getProperty('config');
$prop->setAccessible(true);
$prop->setValue($this->factory, $config);
}
}

class FakeAuditEntity {}

class FakeAuditFormatter extends AbstractAuditLogFormatter
{
public function format(mixed $subject, array $change_set): ?string
{
return 'ok';
}
}
37 changes: 37 additions & 0 deletions tests/OpenTelemetry/AuditLogOtlpStrategyDisabledAuditTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php

namespace Tests\OpenTelemetry;

use App\Audit\AuditContext;
use App\Audit\AuditLogOtlpStrategy;
use App\Audit\IAuditLogFormatterFactory;
use Illuminate\Support\Facades\Queue;

class AuditLogOtlpStrategyDisabledAuditTest extends OpenTelemetryTestCase
{
public function testAuditReturnsEarlyWhenSubjectAuditIsDisabled(): void
{
$factory = $this->createMock(IAuditLogFormatterFactory::class);
$factory->expects($this->once())
->method('isAuditDisabled')
->willReturn(true);
$factory->expects($this->never())
->method('make');

$strategy = new AuditLogOtlpStrategy($factory);
$enabledProperty = (new \ReflectionClass($strategy))->getProperty('enabled');
$enabledProperty->setAccessible(true);
$enabledProperty->setValue($strategy, true);

Queue::fake();

$strategy->audit(
new \stdClass(),
['name' => ['old', 'new']],
AuditLogOtlpStrategy::EVENT_ENTITY_UPDATE,
new AuditContext()
);

Queue::assertNothingPushed();
}
}
Loading