Skip to content

refactor: update env costants #24

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

Merged
frugan-dev merged 1 commit into from
Sep 7, 2025
Merged

refactor: update env costants #24

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
28 changes: 14 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ use WpSpaghetti\WpLogger\Logger;
// Configuration can come from environment variables via WP Env
$logger = new Logger([
'component_name' => 'my-plugin',
'log_retention_days' => 60, // Can be overridden by LOGGER_RETENTION_DAYS env var
'min_log_level' => 'info', // Can be overridden by LOGGER_MIN_LEVEL env var
'retention_days' => 60, // Can be overridden by LOGGER_RETENTION_DAYS env var
'min_level' => 'info', // Can be overridden by LOGGER_MIN_LEVEL env var
]);

// Logging behavior:
Expand All @@ -133,7 +133,7 @@ class MyPlugin
{
$this->logger = new Logger([
'component_name' => 'my-plugin',
'log_retention_days' => 30
'retention_days' => 30
]);

add_action('init', [$this, 'init']);
Expand Down Expand Up @@ -175,21 +175,21 @@ $config = [
'component_name' => 'my-plugin',

// Optional: Days to keep log files (default: 30)
'log_retention_days' => 60,
'retention_days' => 60,

// Optional: Minimum log level to record (default: 'debug')
'min_log_level' => 'info',
'min_level' => 'info',

// Optional: Wonolog namespace (default: 'Inpsyde\Wonolog')
'wonolog_namespace' => 'MyApp\Wonolog',

// Optional: WordPress constant to disable logging
// (default: auto-generated from component_name)
'disable_logging_constant' => 'MY_PLUGIN_DISABLE_LOGGING',
'disabled_constant' => 'MY_PLUGIN_LOGGER_DISABLED',

// Optional: WordPress constant for retention days
// (default: auto-generated from component_name)
'log_retention_constant' => 'MY_PLUGIN_LOG_RETENTION_DAYS'
'retention_days_constant' => 'MY_PLUGIN_LOGGER_RETENTION_DAYS'
];
```

Expand All @@ -204,17 +204,17 @@ LOGGER_DISABLED=false # Disable all logging
LOGGER_WONOLOG_NAMESPACE=Inpsyde\Wonolog

# Plugin-specific settings (higher priority)
MY_PLUGIN_LOG_RETENTION_DAYS=60
MY_PLUGIN_DISABLED=false
MY_PLUGIN_MIN_LEVEL=warning
MY_PLUGIN_LOGGER_RETENTION_DAYS=60
MY_PLUGIN_LOGGER_DISABLED=false
MY_PLUGIN_LOGGER_MIN_LEVEL=warning
```

### WordPress Constants (wp-config.php)

```php
// Control logging behavior per plugin
define('MY_PLUGIN_DISABLE_LOGGING', true); // Disable all logging
define('MY_PLUGIN_LOG_RETENTION_DAYS', 90); // Keep logs for 90 days
define('MY_PLUGIN_LOGGER_DISABLED', true); // Disable all logging
define('MY_PLUGIN_LOGGER_RETENTION_DAYS', 90); // Keep logs for 90 days

// Global WordPress debug (affects fallback behavior)
define('WP_DEBUG', true); // Forces error_log() usage in fallback mode
Expand Down Expand Up @@ -318,7 +318,7 @@ class MyAwesomePlugin
{
$this->logger = new Logger([
'component_name' => 'my-awesome-plugin',
'log_retention_days' => 30
'retention_days' => 30
]);

register_activation_hook(__FILE__, [$this, 'activate']);
Expand Down Expand Up @@ -360,7 +360,7 @@ use WpSpaghetti\WpLogger\Logger;

$theme_logger = new Logger([
'component_name' => get_template(),
'log_retention_days' => 14
'retention_days' => 14
]);

// Log theme setup
Expand Down
120 changes: 63 additions & 57 deletions src/Logger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ class Logger implements LoggerInterface
/**
* Default log retention days.
*/
private const DEFAULT_LOG_RETENTION_DAYS = 30;
private const DEFAULT_RETENTION_DAYS = 30;

/**
* Cleanup probability (1 in N chance).
Expand All @@ -58,11 +58,11 @@ class Logger implements LoggerInterface
*/
private const DEFAULT_CONFIG = [
'component_name' => null, // Required - can come from environment
'log_retention_days' => self::DEFAULT_LOG_RETENTION_DAYS,
'retention_days' => self::DEFAULT_RETENTION_DAYS,
'wonolog_namespace' => 'Inpsyde\Wonolog',
'min_log_level' => LogLevel::DEBUG,
'disable_logging_constant' => null, // Will be auto-generated if not provided
'log_retention_constant' => null, // Will be auto-generated if not provided
'min_level' => LogLevel::DEBUG,
'disabled_constant' => null, // Will be auto-generated if not provided
'retention_days_constant' => null, // Will be auto-generated if not provided
];

/**
Expand All @@ -88,6 +88,11 @@ class Logger implements LoggerInterface
*/
private array $config;

/**
* Component prefix for environment variables (cached for performance).
*/
private string $componentEnvPrefix;

/**
* Cache for Wonolog availability check.
*/
Expand All @@ -108,11 +113,11 @@ class Logger implements LoggerInterface
*
* @param array<string, mixed> $config Configuration array with the following options:
* - component_name: string - Unique identifier (can come from LOGGER_COMPONENT_NAME env var)
* - log_retention_days: int (default: 30) - Days to keep log files
* - retention_days: int (default: 30) - Days to keep log files
* - wonolog_namespace: string (default: 'Inpsyde\Wonolog') - Wonolog namespace
* - min_log_level: string (default: 'debug') - Minimum log level to record
* - disable_logging_constant: string - WordPress constant name to disable logging
* - log_retention_constant: string - WordPress constant name for retention days
* - min_level: string (default: 'debug') - Minimum log level to record
* - disabled_constant: string - WordPress constant name to disable logging
* - retention_days_constant: string - WordPress constant name for retention days
*
* @throws \InvalidArgumentException When component_name is missing from both config and environment
*/
Expand All @@ -125,6 +130,9 @@ public function __construct(array $config = [])
throw new \InvalidArgumentException('component_name is required in configuration or LOGGER_COMPONENT_NAME environment variable');
}

// Generate and cache component prefix
$this->componentEnvPrefix = $this->generateComponentEnvPrefix($componentName);

// Build configuration with priority: Plugin-specific env > Global env > Constants > Config array > Defaults
$this->config = $this->buildConfiguration($componentName, $config);
}
Expand Down Expand Up @@ -320,10 +328,10 @@ public function getDebugInfo(): array
return [
// Basic configuration
'component_name' => $this->config['component_name'],
'min_log_level' => $this->config['min_log_level'],
'log_retention_days' => $retentionDays,
'disable_constant' => $this->config['disable_logging_constant'],
'retention_constant' => $this->config['log_retention_constant'],
'min_level' => $this->config['min_level'],
'retention_days' => $retentionDays,
'disabled_constant' => $this->config['disabled_constant'],
'retention_days_constant' => $this->config['retention_days_constant'],

// Environment information
'environment_type' => Environment::getEnvironment(),
Expand All @@ -349,8 +357,8 @@ public function getDebugInfo(): array

// Constants status
'constants_defined' => [
$this->config['disable_logging_constant'] => \defined($this->config['disable_logging_constant']),
$this->config['log_retention_constant'] => \defined($this->config['log_retention_constant']),
$this->config['disabled_constant'] => \defined($this->config['disabled_constant']),
$this->config['retention_days_constant'] => \defined($this->config['retention_days_constant']),
],
];
}
Expand All @@ -372,10 +380,10 @@ private function buildConfiguration(string $componentName, array $config): array
$finalConfig = array_merge($finalConfig, $config);

// Apply environment-based overrides
$this->applyEnvironmentOverrides($finalConfig, $componentName);
$this->applyEnvironmentOverrides($finalConfig);

// Auto-generate constant names if not provided
$this->generateMissingConstants($finalConfig, $componentName);
$this->generateMissingConstants($finalConfig);

return $finalConfig;
}
Expand All @@ -385,26 +393,26 @@ private function buildConfiguration(string $componentName, array $config): array
*
* @param array<string, mixed> $config
*/
private function applyEnvironmentOverrides(array &$config, string $componentName): void
private function applyEnvironmentOverrides(array &$config): void
{
// WordPress constants
$retentionConstant = $this->generateConstantName($componentName, 'LOG_RETENTION_DAYS');
$retentionConstant = $this->buildConstantName('RETENTION_DAYS');
if (\defined($retentionConstant)) {
$days = \constant($retentionConstant);
if (\is_int($days) && $days > 0) {
$config['log_retention_days'] = $days;
$config['retention_days'] = $days;
}
}

// Global environment variables (higher priority)
$globalRetention = Environment::getInt('LOGGER_RETENTION_DAYS');
if ($globalRetention > 0) {
$config['log_retention_days'] = $globalRetention;
$config['retention_days'] = $globalRetention;
}

$globalMinLevel = Environment::get('LOGGER_MIN_LEVEL');
if ($globalMinLevel) {
$config['min_log_level'] = $globalMinLevel;
$config['min_level'] = $globalMinLevel;
}

$globalWonolog = Environment::get('LOGGER_WONOLOG_NAMESPACE');
Expand All @@ -413,14 +421,14 @@ private function applyEnvironmentOverrides(array &$config, string $componentName
}

// Plugin-specific environment variables (highest priority)
$componentRetention = Environment::getInt($this->generateEnvKey($componentName, 'LOG_RETENTION_DAYS'));
$componentRetention = Environment::getInt($this->buildConstantName('RETENTION_DAYS'));
if ($componentRetention > 0) {
$config['log_retention_days'] = $componentRetention;
$config['retention_days'] = $componentRetention;
}

$componentMinLevel = Environment::get($this->generateEnvKey($componentName, 'MIN_LEVEL'));
$componentMinLevel = Environment::get($this->buildConstantName('MIN_LEVEL'));
if ($componentMinLevel) {
$config['min_log_level'] = $componentMinLevel;
$config['min_level'] = $componentMinLevel;
}
}

Expand All @@ -429,14 +437,14 @@ private function applyEnvironmentOverrides(array &$config, string $componentName
*
* @param array<string, mixed> $config
*/
private function generateMissingConstants(array &$config, string $componentName): void
private function generateMissingConstants(array &$config): void
{
if (!$config['disable_logging_constant']) {
$config['disable_logging_constant'] = $this->generateConstantName($componentName, 'DISABLE_LOGGING');
if (!$config['disabled_constant']) {
$config['disabled_constant'] = $this->buildConstantName('DISABLED');
}

if (!$config['log_retention_constant']) {
$config['log_retention_constant'] = $this->generateConstantName($componentName, 'LOG_RETENTION_DAYS');
if (!$config['retention_days_constant']) {
$config['retention_days_constant'] = $this->buildConstantName('RETENTION_DAYS');
}
}

Expand All @@ -445,34 +453,33 @@ private function generateMissingConstants(array &$config, string $componentName)
*/
private function shouldLog(string $level): bool
{
$minPriority = self::LOG_LEVEL_PRIORITIES[$this->config['min_log_level']] ?? 0;
$minPriority = self::LOG_LEVEL_PRIORITIES[$this->config['min_level']] ?? 0;
$currentPriority = self::LOG_LEVEL_PRIORITIES[$level] ?? 0;

return $currentPriority >= $minPriority;
}

/**
* Generate component-specific environment variable key.
* Generate component prefix for environment variables.
*
* Transforms component name to uppercase with underscores, following wp-vite pattern.
* Examples: 'my-plugin' → 'MY_PLUGIN_LOGGER', 'camelCase' → 'CAMELCASE_LOGGER'
*/
private function generateEnvKey(string $componentName, string $key): string
private function generateComponentEnvPrefix(string $componentName): string
{
$componentPrefix = strtoupper(preg_replace('/[^a-zA-Z0-9]/', '_', $componentName) ?? $componentName);
$normalizedName = preg_replace('/[^a-zA-Z0-9]/', '_', $componentName) ?? $componentName;

return \sprintf('%s_%s', $componentPrefix, $key);
return strtoupper($normalizedName).'_LOGGER';
}

/**
* Generate properly formatted constant name from component name.
* Build component-specific environment variable name.
*
* Examples: 'LOGGER_DISABLED' → 'MY_PLUGIN_LOGGER_DISABLED'
*/
private function generateConstantName(string $componentName, string $suffix): string
private function buildConstantName(string $suffix): string
{
// Convert component name to uppercase and replace non-alphanumeric chars with underscores
$constantBase = preg_replace('/[^a-zA-Z0-9]/', '_', $componentName);
if (null === $constantBase) {
$constantBase = $componentName;
}

return strtoupper($constantBase).'_'.$suffix;
return \sprintf('%s_%s', $this->componentEnvPrefix, $suffix);
}

/**
Expand Down Expand Up @@ -597,13 +604,12 @@ private function isLoggingDisabled(): bool
}

// Check component-specific environment variable
$componentEnvKey = $this->generateEnvKey($this->config['component_name'], 'LOGGER_DISABLED');
if (Environment::getBool($componentEnvKey)) {
if (Environment::getBool($this->buildConstantName('DISABLED'))) {
return true;
}

// Fallback to WordPress constant
$constantName = $this->config['disable_logging_constant'];
$constantName = $this->config['disabled_constant'];

return \defined($constantName) && \constant($constantName);
}
Expand All @@ -613,7 +619,7 @@ private function isLoggingDisabled(): bool
*/
private function getLogRetentionDays(): int
{
return $this->config['log_retention_days'];
return $this->config['retention_days'];
}

/**
Expand Down Expand Up @@ -903,9 +909,8 @@ private function createProtectionFiles(string $componentDir, string $logDir): vo
private function generateReadme(string $componentFolder): string
{
$retentionDays = $this->getLogRetentionDays();
$disableConstant = $this->config['disable_logging_constant'];
$retentionConstant = $this->config['log_retention_constant'];
$componentEnvPrefix = $this->generateEnvKey($this->config['component_name'], '');
$disableConstant = $this->config['disabled_constant'];
$retentionConstant = $this->config['retention_days_constant'];

$config = "# LOG DIRECTORY PROTECTION CONFIGURATION\n";
$config .= "# ========================================\n\n";
Expand All @@ -931,9 +936,10 @@ private function generateReadme(string $componentFolder): string
$config .= \sprintf('LOGGER_RETENTION_DAYS=%d%s', $retentionDays, PHP_EOL);
$config .= "LOGGER_MIN_LEVEL=info\n\n";

$config .= "# Plugin-specific settings (higher priority):\n";
$config .= $componentEnvPrefix.'DISABLED=false'.PHP_EOL;
$config .= "{$componentEnvPrefix}LOG_RETENTION_DAYS={$retentionDays}\n\n";
$config .= "# Plugin/Theme-specific settings (higher priority):\n";
$config .= $this->buildConstantName('DISABLED')."=false\n";
$config .= $this->buildConstantName('RETENTION_DAYS').\sprintf('=%d%s', $retentionDays, PHP_EOL);
$config .= $this->buildConstantName('MIN_LEVEL')."=warning\n\n";

$config .= "# WordPress Constants (wp-config.php):\n";
$config .= "# Enable debug logging (uses error_log):\n";
Expand All @@ -945,11 +951,11 @@ private function generateReadme(string $componentFolder): string
$config .= "define('{$retentionConstant}', {$retentionDays});\n\n";

$config .= 'Generated: '.gmdate('Y-m-d H:i:s')." UTC\n";
$config .= 'Plugin: '.$this->config['component_name']."\n";
$config .= 'Plugin/Theme: '.$this->config['component_name']."\n";
$config .= 'Environment: '.Environment::getEnvironment()."\n";
$config .= "Log retention: {$retentionDays} days\n";

return $config.('Min log level: '.$this->config['min_log_level']."\n");
return $config.('Min log level: '.$this->config['min_level']."\n");
}

/**
Expand Down
Loading