fix: disable metric formatters

[andrestejerina97]

ref: https://app.clickup.com/t/86b9pvafe

Summary by CodeRabbit

Release Notes

• New Features

  • Audit logging can now be selectively disabled for specific entity types through configuration.
  • Audit logging is now disabled for SummitEventAttendanceMetric and SummitMetric entities.

• Tests

  • Added comprehensive test coverage for per-entity audit logging configuration and behavior.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6adade88-e2ee-41e1-a786-211012333e74

📥 Commits

Reviewing files that changed from the base of the PR and between 34e47f9 and 645f3f3.

📒 Files selected for processing (3)

• app/Audit/AuditLogFormatterFactory.php
• config/audit_log.php
• tests/OpenTelemetry/AuditLogFormatterFactoryTest.php

---

📝 Walkthrough

Walkthrough

This PR adds entity-level audit logging control to the summit API. The AuditLogFormatterFactory now checks a per-entity configuration flag and returns null when auditing is disabled, preventing audit logs from being generated for specific entity types. Two summit metric entities are configured to disable auditing, with comprehensive tests covering the new behavior.

Changes

Entity-Level Audit Disablement

Layer / File(s)	Summary
Audit disablement mechanism in factory app/Audit/AuditLogFormatterFactory.php	AuditLogFormatterFactory::make() now short-circuits early by checking if auditing is disabled for the subject via a new isAuditDisabledForSubject() helper that inspects the cached audit_log config and returns true only when the entity config explicitly sets enabled to false.
Entity-level audit configuration config/audit_log.php	Two summit metric entity types are disabled in the audit_log config by setting their enabled flag to false: SummitEventAttendanceMetric and SummitMetric.
Test coverage for disablement behavior tests/OpenTelemetry/AuditLogFormatterFactoryTest.php	New tests validate that isAuditDisabledForSubject correctly returns true/false based on entity config, that make() returns null for disabled entities, and support the tests with imports, a config injection helper, and test double classes (FakeAuditEntity and FakeAuditFormatter).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A audit log that bends the knee,
To config flags that set things free,
Some metrics rest, by design's decree,
While others log for all to see!
—The Summit Rabbit 🥕

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix: disable metric formatters' directly aligns with the main change: disabling audit logging for metric entities (SummitEventAttendanceMetric and SummitMetric) by adding configuration and logic to skip formatter creation.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/disable-metric-formatters

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

📘 OpenAPI / Swagger preview

➡️ https://OpenStackweb.github.io/summit-api/openapi/pr-542/

This page is automatically updated on each push to this PR.

[caseylocker]

LGTM. Nothing blocking. Follows the ticket direction.

[Copilot]

Pull request overview

This PR adds a configuration-driven way to disable audit logging for specific entity types, and uses it to disable audit logging for metric entities (notably SummitEventAttendanceMetric and SummitMetric) in the OpenTelemetry audit logging pipeline.

Changes:

• Add an entity “enabled/disabled” guard to AuditLogFormatterFactory::make() to skip formatter creation for disabled entities.
• Disable audit logging for SummitEventAttendanceMetric and SummitMetric via config/audit_log.php.
• Extend unit tests to cover per-entity audit-disable behavior and factory output when disabled.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
app/Audit/AuditLogFormatterFactory.php	Adds a config-based early return to skip audit formatter creation when an entity is disabled.
config/audit_log.php	Sets enabled => false for metric entities to disable their audit logging.
tests/OpenTelemetry/AuditLogFormatterFactoryTest.php	Adds test coverage for the new “audit disabled” logic and factory behavior.

Comments suppressed due to low confidence (1)

tests/OpenTelemetry/AuditLogFormatterFactoryTest.php:24

• The class-level docblock still says these tests are only for matchesStrategy() null-guard behavior, but this file now also tests audit-disable behavior (isAuditDisabledForSubject / make). Updating the docblock would keep the test intent accurate.

use App\Audit\Interfaces\IAuditStrategy;
use PHPUnit\Framework\TestCase;

/**
 * Class AuditLogFormatterFactoryTest

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.