Skip to content

fix: disable metric formatters #542

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 1 commit into
base: main
Choose a base branch
from
+90 −2
Open

fix: disable metric formatters #542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions app/Audit/AuditLogFormatterFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ public function __construct()

public function make(AuditContext $ctx, $subject, string $event_type): ?IAuditLogFormatter
{
if ($this->isAuditDisabledForSubject($subject)) {
return null;
}

$formatter = null;
switch ($event_type) {
case IAuditStrategy::EVENT_COLLECTION_UPDATE:
Expand Down Expand Up @@ -190,4 +194,18 @@ private function routeMatches(string $route, string $actual_route): bool
{
return strcmp($actual_route, $route) === 0;
}

private function isAuditDisabledForSubject(mixed $subject): bool
{
if (!is_object($subject)) {
return false;
}

$entities = $this->config['entities'] ?? [];
$entity_config = $entities[get_class($subject)] ?? null;

return is_array($entity_config)
&& array_key_exists('enabled', $entity_config)
&& $entity_config['enabled'] === false;
}
}
4 changes: 2 additions & 2 deletions config/audit_log.php
View file
Open in desktop
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
70 changes: 70 additions & 0 deletions tests/OpenTelemetry/AuditLogFormatterFactoryTest.php
View file
Open in desktop
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,72 @@ 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);
}

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';
}
}
Loading