michaelschiemer/src/Framework/ExceptionHandling/RateLimit/ExceptionRateLimitConfig.php

<?php

declare(strict_types=1);

namespace App\Framework\ExceptionHandling\RateLimit;

use App\Framework\Core\ValueObjects\Duration;

/**
 * Exception Rate Limit Configuration
 *
 * Immutable configuration for exception rate limiting.
 */
final readonly class ExceptionRateLimitConfig
{
    /**
     * @param int $maxExceptions Maximum number of exceptions allowed per time window
     * @param Duration $timeWindow Time window for rate limiting
     * @param bool $enabled Whether rate limiting is enabled
     * @param bool $skipLoggingOnLimit Whether to skip logging when rate limit is reached
     * @param bool $skipAuditOnLimit Whether to skip audit logging when rate limit is reached
     * @param bool $trackMetricsOnLimit Whether to track metrics even when rate limit is reached
     */
    public function __construct(
        public int $maxExceptions = 10,
        public Duration $timeWindow = new Duration(60), // 1 minute default
        public bool $enabled = true,
        public bool $skipLoggingOnLimit = true,
        public bool $skipAuditOnLimit = true,
        public bool $trackMetricsOnLimit = true
    ) {
        if ($this->maxExceptions < 1) {
            throw new \InvalidArgumentException('maxExceptions must be at least 1');
        }
    }

    /**
     * Create default configuration
     */
    public static function default(): self
    {
        return new self();
    }

    /**
     * Create configuration with custom limits
     */
    public static function withLimits(int $maxExceptions, Duration $timeWindow): self
    {
        return new self(
            maxExceptions: $maxExceptions,
            timeWindow: $timeWindow
        );
    }

    /**
     * Create disabled configuration
     */
    public static function disabled(): self
    {
        return new self(enabled: false);
    }

    /**
     * Create new instance with different max exceptions
     */
    public function withMaxExceptions(int $maxExceptions): self
    {
        return new self(
            maxExceptions: $maxExceptions,
            timeWindow: $this->timeWindow,
            enabled: $this->enabled,
            skipLoggingOnLimit: $this->skipLoggingOnLimit,
            skipAuditOnLimit: $this->skipAuditOnLimit,
            trackMetricsOnLimit: $this->trackMetricsOnLimit
        );
    }

    /**
     * Create new instance with different time window
     */
    public function withTimeWindow(Duration $timeWindow): self
    {
        return new self(
            maxExceptions: $this->maxExceptions,
            timeWindow: $timeWindow,
            enabled: $this->enabled,
            skipLoggingOnLimit: $this->skipLoggingOnLimit,
            skipAuditOnLimit: $this->skipAuditOnLimit,
            trackMetricsOnLimit: $this->trackMetricsOnLimit
        );
    }

    /**
     * Create new instance with enabled/disabled state
     */
    public function withEnabled(bool $enabled): self
    {
        return new self(
            maxExceptions: $this->maxExceptions,
            timeWindow: $this->timeWindow,
            enabled: $enabled,
            skipLoggingOnLimit: $this->skipLoggingOnLimit,
            skipAuditOnLimit: $this->skipAuditOnLimit,
            trackMetricsOnLimit: $this->trackMetricsOnLimit
        );
    }
}