pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-08-31 19:08:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix(logging): clamp stored log caps to minimums and reject extra applogfilecap args

Browse source 
Addresses Copilot review on #1473: clamp CDS-loaded fileSizeLimitBytes/retainedCount to the enforced floors (65536 bytes / 1 file) at startup so a stale small stored value cannot cause pathological rolling, and reject >2 console tokens to prevent silent misconfiguration.
This commit is contained in:
Jonathan Arndt 2026-08-29 11:59:59 -07:00
parent 66f7dc297f
commit c0c6a9fd65
1 changed files with 16 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

22
src/PepperDash.Core/Logging/Debug.cs
View file

@ -36,6 +36,10 @@ namespace PepperDash.Core
private const int DefaultApplianceRetainedFileCount = 7; private const int DefaultApplianceRetainedFileCount = 7;
private const int DefaultServerRetainedFileCount = 14; private const int DefaultServerRetainedFileCount = 14;
// Enforced floors so a stale/corrupt stored value can't cause pathological rolling.
private const int MinFileSizeLimitBytes = 65536;
private const int MinRetainedFileCount = 1;
/// <summary> /// <summary>
/// Per-file size (bytes) that triggers a roll of the debug log file. Read at /// Per-file size (bytes) that triggers a roll of the debug log file. Read at
/// startup from CrestronDataStore; override with the applogfilecap console command. /// startup from CrestronDataStore; override with the applogfilecap console command.
@ -179,10 +183,10 @@ namespace PepperDash.Core
: "[{@t:yyyy-MM-dd HH:mm:ss.fff}][{@l:u4}][{App}]{#if Key is not null}[{Key}]{#end} {@m}{#if @x is not null}\r\n{@x}{#end}"; : "[{@t:yyyy-MM-dd HH:mm:ss.fff}][{@l:u4}][{App}]{#if Key is not null}[{Key}]{#end} {@m}{#if @x is not null}\r\n{@x}{#end}";
var isAppliance = CrestronEnvironment.DevicePlatform == eDevicePlatform.Appliance; var isAppliance = CrestronEnvironment.DevicePlatform == eDevicePlatform.Appliance;
LogFileSizeLimitBytes = GetStoredIntValue(FileSizeLimitStoreKey, LogFileSizeLimitBytes = Math.Max(MinFileSizeLimitBytes, GetStoredIntValue(FileSizeLimitStoreKey,
(int)(isAppliance ? DefaultApplianceFileSizeLimitBytes : DefaultServerFileSizeLimitBytes)); (int)(isAppliance ? DefaultApplianceFileSizeLimitBytes : DefaultServerFileSizeLimitBytes)));
LogRetainedFileCountLimit = GetStoredIntValue(FileRetainedCountStoreKey, LogRetainedFileCountLimit = Math.Max(MinRetainedFileCount, GetStoredIntValue(FileRetainedCountStoreKey,
isAppliance ? DefaultApplianceRetainedFileCount : DefaultServerRetainedFileCount); isAppliance ? DefaultApplianceRetainedFileCount : DefaultServerRetainedFileCount));
_defaultLoggerConfiguration = new LoggerConfiguration() _defaultLoggerConfiguration = new LoggerConfiguration()
.MinimumLevel.Verbose() .MinimumLevel.Verbose()
@ -372,7 +376,13 @@ namespace PepperDash.Core
var tokens = trimmed.Split(new char[] { ' ', '\t' }, StringSplitOptions.RemoveEmptyEntries); var tokens = trimmed.Split(new char[] { ' ', '\t' }, StringSplitOptions.RemoveEmptyEntries);
if (!long.TryParse(tokens[0], out var sizeBytes) || sizeBytes < 65536) if (tokens.Length > 2)
{
CrestronConsole.ConsoleCommandResponse("Too many arguments. Usage: applogfilecap [sizeBytes] [retainedCount].\r\n");
return;
}
if (!long.TryParse(tokens[0], out var sizeBytes) || sizeBytes < MinFileSizeLimitBytes)
{ {
CrestronConsole.ConsoleCommandResponse("Invalid sizeBytes. Must be an integer >= 65536.\r\n"); CrestronConsole.ConsoleCommandResponse("Invalid sizeBytes. Must be an integer >= 65536.\r\n");
return; return;
@ -381,7 +391,7 @@ namespace PepperDash.Core
sizeBytes = Math.Min(sizeBytes, int.MaxValue); sizeBytes = Math.Min(sizeBytes, int.MaxValue);
var retained = LogRetainedFileCountLimit; var retained = LogRetainedFileCountLimit;
if (tokens.Length > 1 && (!int.TryParse(tokens[1], out retained) || retained < 1)) if (tokens.Length > 1 && (!int.TryParse(tokens[1], out retained) || retained < MinRetainedFileCount))
{ {
CrestronConsole.ConsoleCommandResponse("Invalid retainedCount. Must be an integer >= 1.\r\n"); CrestronConsole.ConsoleCommandResponse("Invalid retainedCount. Must be an integer >= 1.\r\n");
return; return;