Add comprehensive validation system with runtime configuration
Implements a flexible validation framework for student rankings, team assignments, and team composition with administrator-configurable rules and thresholds. Validation System: - Reflection-based rule discovery eliminates manual registration - Base classes (RequiredEventTypeRuleBase, EventCountThresholdRuleBase) reduce code duplication by ~250 lines - 12 validation rules covering event requirements, counts, and team constraints - Configurable severity levels (Warning/Error) per rule type - ValidationService with caching for optimal performance - Rules apply contextually (StudentRanking, StudentAssignment, TeamComposition) Configuration & Admin UI: - ValidationSettings admin page for editing thresholds and severity levels - ChapterSettings admin page for editing chapter information - Settings stored in Data/appsettings.json for runtime configuration - JSON config works in both development and production environments - Auto-creates Data directory and config template on first run User Experience: - ValidationWarnings component displays inline warnings/errors - Integrated in Event Ranking, Registration, and Team Assignment pages - Color-coded severity indicators (warning yellow, error red) - Includes "Too Many Regional Events" rule (max 3 recommended) Technical Improvements: - Template Method pattern for rule base classes - Singleton rule instances with lazy initialization - Configuration loaded via IConfiguration with fallback to defaults - Safe JSON updates preserve other appsettings sections
This commit is contained in:
@@ -0,0 +1,186 @@
|
||||
@page "/settings/chapter"
|
||||
@attribute [Authorize(Roles = AuthRoles.Administrator)]
|
||||
@using WebApp.Authentication
|
||||
@using WebApp.Models
|
||||
@using System.Text.Json
|
||||
@inject IWebHostEnvironment Environment
|
||||
@inject IConfiguration Configuration
|
||||
|
||||
@rendermode InteractiveServer
|
||||
|
||||
<PageTitle>Chapter Settings</PageTitle>
|
||||
|
||||
<MudContainer MaxWidth="MaxWidth.Large" Class="mt-4">
|
||||
<MudText Typo="Typo.h3" Class="mb-4">Chapter Settings</MudText>
|
||||
<MudText Typo="Typo.body1" Class="mb-6">Configure chapter information. Changes take effect on next application restart.</MudText>
|
||||
|
||||
@if (_settings != null)
|
||||
{
|
||||
<MudPaper Class="pa-6 mb-4">
|
||||
<MudText Typo="Typo.h5" Class="mb-4">Basic Information</MudText>
|
||||
<MudGrid>
|
||||
<MudItem xs="12" md="8">
|
||||
<MudTextField @bind-Value="_settings.Name"
|
||||
Label="Chapter Name"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="Full chapter name"
|
||||
Required="true" />
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="4">
|
||||
<MudTextField @bind-Value="_settings.ShortName"
|
||||
Label="Short Name"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="Abbreviation (e.g., YCN)"
|
||||
MaxLength="10"
|
||||
Required="true" />
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudTextField @bind-Value="_settings.CompetitionYear"
|
||||
Label="Competition Year"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="Year of competition (e.g., 2026)"
|
||||
MaxLength="4"
|
||||
Required="true" />
|
||||
</MudItem>
|
||||
</MudGrid>
|
||||
</MudPaper>
|
||||
|
||||
<MudPaper Class="pa-6 mb-4">
|
||||
<MudText Typo="Typo.h5" Class="mb-4">Chapter IDs</MudText>
|
||||
<MudGrid>
|
||||
<MudItem xs="12" md="4">
|
||||
<MudTextField @bind-Value="_settings.NationalId"
|
||||
Label="National ID"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="4-digit national chapter ID"
|
||||
MaxLength="4" />
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="4">
|
||||
<MudTextField @bind-Value="_settings.StateId"
|
||||
Label="State ID"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="5-digit state chapter ID"
|
||||
MaxLength="5" />
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="4">
|
||||
<MudTextField @bind-Value="_settings.RegionalId"
|
||||
Label="Regional ID"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="5-digit regional chapter ID"
|
||||
MaxLength="5" />
|
||||
</MudItem>
|
||||
</MudGrid>
|
||||
</MudPaper>
|
||||
|
||||
<MudPaper Class="pa-6">
|
||||
<MudGrid>
|
||||
<MudItem xs="12">
|
||||
<MudButton Variant="Variant.Filled"
|
||||
Color="Color.Primary"
|
||||
StartIcon="@Icons.Material.Filled.Save"
|
||||
OnClick="SaveSettings"
|
||||
Disabled="_isSaving">
|
||||
@if (_isSaving)
|
||||
{
|
||||
<MudProgressCircular Class="mr-2" Size="Size.Small" Indeterminate="true" />
|
||||
<span>Saving...</span>
|
||||
}
|
||||
else
|
||||
{
|
||||
<span>Save Settings</span>
|
||||
}
|
||||
</MudButton>
|
||||
</MudItem>
|
||||
</MudGrid>
|
||||
</MudPaper>
|
||||
|
||||
@if (!string.IsNullOrEmpty(_statusMessage))
|
||||
{
|
||||
<MudAlert Severity="@_statusSeverity" Class="mt-4">@_statusMessage</MudAlert>
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
<MudProgressCircular Indeterminate="true" />
|
||||
}
|
||||
</MudContainer>
|
||||
|
||||
@code {
|
||||
private Models.ChapterSettings? _settings;
|
||||
private bool _isSaving;
|
||||
private string? _statusMessage;
|
||||
private Severity _statusSeverity = Severity.Success;
|
||||
|
||||
protected override void OnInitialized()
|
||||
{
|
||||
// Load from IConfiguration
|
||||
_settings = Configuration.GetSection("ChapterSettings").Get<Models.ChapterSettings>()
|
||||
?? new Models.ChapterSettings();
|
||||
}
|
||||
|
||||
private string GetAppSettingsPath()
|
||||
{
|
||||
return Path.Combine(
|
||||
Environment.ContentRootPath,
|
||||
"Data",
|
||||
"appsettings.json");
|
||||
}
|
||||
|
||||
private async Task SaveSettings()
|
||||
{
|
||||
if (_settings == null) return;
|
||||
|
||||
_isSaving = true;
|
||||
_statusMessage = null;
|
||||
|
||||
try
|
||||
{
|
||||
var appSettingsPath = GetAppSettingsPath();
|
||||
|
||||
// Ensure Data directory exists
|
||||
var dataDir = Path.GetDirectoryName(appSettingsPath);
|
||||
if (dataDir != null && !Directory.Exists(dataDir))
|
||||
{
|
||||
Directory.CreateDirectory(dataDir);
|
||||
}
|
||||
|
||||
// Read existing appsettings or create new
|
||||
JsonDocument? existingDoc = null;
|
||||
Dictionary<string, object?> settings;
|
||||
|
||||
if (File.Exists(appSettingsPath))
|
||||
{
|
||||
var existingJson = await File.ReadAllTextAsync(appSettingsPath);
|
||||
existingDoc = JsonDocument.Parse(existingJson);
|
||||
settings = JsonSerializer.Deserialize<Dictionary<string, object?>>(existingJson)
|
||||
?? new Dictionary<string, object?>();
|
||||
}
|
||||
else
|
||||
{
|
||||
settings = new Dictionary<string, object?>();
|
||||
}
|
||||
|
||||
// Update ChapterSettings section
|
||||
settings["ChapterSettings"] = _settings;
|
||||
|
||||
// Write back to file
|
||||
var options = new JsonSerializerOptions { WriteIndented = true };
|
||||
var json = JsonSerializer.Serialize(settings, options);
|
||||
await File.WriteAllTextAsync(appSettingsPath, json);
|
||||
|
||||
existingDoc?.Dispose();
|
||||
|
||||
_statusMessage = "Settings saved successfully! Changes will take effect on next application restart.";
|
||||
_statusSeverity = Severity.Success;
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_statusMessage = $"Error saving settings: {ex.Message}";
|
||||
_statusSeverity = Severity.Error;
|
||||
}
|
||||
finally
|
||||
{
|
||||
_isSaving = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -26,6 +26,9 @@
|
||||
</div>
|
||||
</MudPaper>
|
||||
|
||||
<MudPaper Elevation="0" Class="mb-6">
|
||||
<MudText Typo="Typo.h4" Class="mb-2">Data</MudText>
|
||||
</MudPaper>
|
||||
<MudGrid>
|
||||
<!-- Events Card -->
|
||||
<DashboardCard Icon="@AppIcons.Events"
|
||||
@@ -60,13 +63,19 @@
|
||||
Subtitle="Total Teams"
|
||||
Caption="@($"{_groupTeamsCount} Team | {_individualTeamsCount} Individual")"
|
||||
NavigateUrl="/teams" />
|
||||
|
||||
<!-- Meeting Schedule Card -->
|
||||
<DashboardCard Icon="@AppIcons.Scheduler"
|
||||
Title="Schedule"
|
||||
Caption="Optimize meeting times"
|
||||
NavigateUrl="/meeting-schedule" />
|
||||
</MudGrid>
|
||||
<MudPaper Elevation="0" Class="my-6">
|
||||
<MudText Typo="Typo.h4">Tools</MudText>
|
||||
</MudPaper>
|
||||
|
||||
<MudGrid>
|
||||
|
||||
<!-- Meeting Schedule Card -->
|
||||
<DashboardCard Icon="@AppIcons.Scheduler"
|
||||
Title="Schedule"
|
||||
Caption="Optimize meeting times"
|
||||
NavigateUrl="/meeting-schedule"/>
|
||||
</MudGrid>
|
||||
|
||||
@code {
|
||||
private int _eventCount;
|
||||
|
||||
@@ -0,0 +1,284 @@
|
||||
@page "/settings/validation"
|
||||
@attribute [Authorize(Roles = AuthRoles.Administrator)]
|
||||
@using Core.Validation
|
||||
@using WebApp.Authentication
|
||||
@using System.Text.Json
|
||||
@inject IWebHostEnvironment Environment
|
||||
@inject IConfiguration Configuration
|
||||
|
||||
@rendermode InteractiveServer
|
||||
|
||||
<PageTitle>Validation Settings</PageTitle>
|
||||
|
||||
<MudContainer MaxWidth="MaxWidth.Large" Class="mt-4">
|
||||
<MudText Typo="Typo.h3" Class="mb-4">Validation Settings</MudText>
|
||||
<MudText Typo="Typo.body1" Class="mb-6">Configure validation rules and thresholds. Changes take effect on next application restart.</MudText>
|
||||
|
||||
@if (_config != null)
|
||||
{
|
||||
<MudPaper Class="pa-6 mb-4">
|
||||
<MudText Typo="Typo.h5" Class="mb-4">Event Count Thresholds</MudText>
|
||||
<MudGrid>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudNumericField @bind-Value="_config.MinRecommendedEvents"
|
||||
Label="Minimum Recommended Events"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="Warning if student has fewer events"
|
||||
Min="0" Max="10" />
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudNumericField @bind-Value="_config.MaxRecommendedEvents"
|
||||
Label="Maximum Recommended Events"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="Warning if student has more events"
|
||||
Min="0" Max="10" />
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudNumericField @bind-Value="_config.MinCriticalEvents"
|
||||
Label="Minimum Critical Events"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="Error if student has fewer events"
|
||||
Min="0" Max="10" />
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudNumericField @bind-Value="_config.MaxCriticalEvents"
|
||||
Label="Maximum Critical Events"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="Error if student has more events"
|
||||
Min="0" Max="10" />
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudNumericField @bind-Value="_config.MaxRegionalEvents"
|
||||
Label="Maximum Regional Events"
|
||||
Variant="Variant.Outlined"
|
||||
HelperText="Warning if student has more regional events"
|
||||
Min="0" Max="10" />
|
||||
</MudItem>
|
||||
</MudGrid>
|
||||
</MudPaper>
|
||||
|
||||
<MudPaper Class="pa-6 mb-4">
|
||||
<MudText Typo="Typo.h5" Class="mb-4">Required Event Types</MudText>
|
||||
<MudGrid>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSwitch @bind-Value="_config.RequireRegionalEvent"
|
||||
Label="Require Regional Event"
|
||||
Color="Color.Primary" />
|
||||
<MudText Typo="Typo.body2" Class="mud-text-secondary ml-10">
|
||||
Students must have at least one regional event
|
||||
</MudText>
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSwitch @bind-Value="_config.RequireOnSiteActivity"
|
||||
Label="Require On-Site Activity"
|
||||
Color="Color.Primary" />
|
||||
<MudText Typo="Typo.body2" Class="mud-text-secondary ml-10">
|
||||
Students must have at least one on-site activity
|
||||
</MudText>
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSwitch @bind-Value="_config.RequireIndividualEvent"
|
||||
Label="Require Individual Event"
|
||||
Color="Color.Primary" />
|
||||
<MudText Typo="Typo.body2" Class="mud-text-secondary ml-10">
|
||||
Students must have at least one individual event
|
||||
</MudText>
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSwitch @bind-Value="_config.RequireTeamCaptain"
|
||||
Label="Require Team Captain"
|
||||
Color="Color.Primary" />
|
||||
<MudText Typo="Typo.body2" Class="mud-text-secondary ml-10">
|
||||
Team events must have an assigned captain
|
||||
</MudText>
|
||||
</MudItem>
|
||||
</MudGrid>
|
||||
</MudPaper>
|
||||
|
||||
<MudPaper Class="pa-6 mb-4">
|
||||
<MudText Typo="Typo.h5" Class="mb-4">Validation Severity Levels</MudText>
|
||||
<MudGrid>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSelect @bind-Value="_config.NoRegionalEventSeverity"
|
||||
Label="No Regional Event"
|
||||
Variant="Variant.Outlined">
|
||||
<MudSelectItem Value="ValidationSeverity.Warning">Warning</MudSelectItem>
|
||||
<MudSelectItem Value="ValidationSeverity.Error">Error</MudSelectItem>
|
||||
</MudSelect>
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSelect @bind-Value="_config.NoOnSiteActivitySeverity"
|
||||
Label="No On-Site Activity"
|
||||
Variant="Variant.Outlined">
|
||||
<MudSelectItem Value="ValidationSeverity.Warning">Warning</MudSelectItem>
|
||||
<MudSelectItem Value="ValidationSeverity.Error">Error</MudSelectItem>
|
||||
</MudSelect>
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSelect @bind-Value="_config.NoIndividualEventSeverity"
|
||||
Label="No Individual Event"
|
||||
Variant="Variant.Outlined">
|
||||
<MudSelectItem Value="ValidationSeverity.Warning">Warning</MudSelectItem>
|
||||
<MudSelectItem Value="ValidationSeverity.Error">Error</MudSelectItem>
|
||||
</MudSelect>
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSelect @bind-Value="_config.TeamSizeSeverity"
|
||||
Label="Team Size Issues"
|
||||
Variant="Variant.Outlined">
|
||||
<MudSelectItem Value="ValidationSeverity.Warning">Warning</MudSelectItem>
|
||||
<MudSelectItem Value="ValidationSeverity.Error">Error</MudSelectItem>
|
||||
</MudSelect>
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSelect @bind-Value="_config.EventCountSeverity"
|
||||
Label="Event Count Issues"
|
||||
Variant="Variant.Outlined">
|
||||
<MudSelectItem Value="ValidationSeverity.Warning">Warning</MudSelectItem>
|
||||
<MudSelectItem Value="ValidationSeverity.Error">Error</MudSelectItem>
|
||||
</MudSelect>
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSelect @bind-Value="_config.MissingCaptainSeverity"
|
||||
Label="Missing Team Captain"
|
||||
Variant="Variant.Outlined">
|
||||
<MudSelectItem Value="ValidationSeverity.Warning">Warning</MudSelectItem>
|
||||
<MudSelectItem Value="ValidationSeverity.Error">Error</MudSelectItem>
|
||||
</MudSelect>
|
||||
</MudItem>
|
||||
<MudItem xs="12" md="6">
|
||||
<MudSelect @bind-Value="_config.TooManyRegionalEventsSeverity"
|
||||
Label="Too Many Regional Events"
|
||||
Variant="Variant.Outlined">
|
||||
<MudSelectItem Value="ValidationSeverity.Warning">Warning</MudSelectItem>
|
||||
<MudSelectItem Value="ValidationSeverity.Error">Error</MudSelectItem>
|
||||
</MudSelect>
|
||||
</MudItem>
|
||||
</MudGrid>
|
||||
</MudPaper>
|
||||
|
||||
<MudPaper Class="pa-6">
|
||||
<MudGrid>
|
||||
<MudItem xs="12">
|
||||
<MudButton Variant="Variant.Filled"
|
||||
Color="Color.Primary"
|
||||
StartIcon="@Icons.Material.Filled.Save"
|
||||
OnClick="SaveConfiguration"
|
||||
Disabled="_isSaving">
|
||||
@if (_isSaving)
|
||||
{
|
||||
<MudProgressCircular Class="mr-2" Size="Size.Small" Indeterminate="true" />
|
||||
<span>Saving...</span>
|
||||
}
|
||||
else
|
||||
{
|
||||
<span>Save Configuration</span>
|
||||
}
|
||||
</MudButton>
|
||||
<MudButton Variant="Variant.Outlined"
|
||||
Class="ml-2"
|
||||
OnClick="ResetToDefaults"
|
||||
Disabled="_isSaving">
|
||||
Reset to Defaults
|
||||
</MudButton>
|
||||
</MudItem>
|
||||
</MudGrid>
|
||||
</MudPaper>
|
||||
|
||||
@if (!string.IsNullOrEmpty(_statusMessage))
|
||||
{
|
||||
<MudAlert Severity="@_statusSeverity" Class="mt-4">@_statusMessage</MudAlert>
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
<MudProgressCircular Indeterminate="true" />
|
||||
}
|
||||
</MudContainer>
|
||||
|
||||
@code {
|
||||
private ValidationConfiguration? _config;
|
||||
private bool _isSaving;
|
||||
private string? _statusMessage;
|
||||
private Severity _statusSeverity = Severity.Success;
|
||||
|
||||
protected override void OnInitialized()
|
||||
{
|
||||
// Load from IConfiguration
|
||||
_config = Configuration.GetSection("ValidationSettings").Get<ValidationConfiguration>()
|
||||
?? ValidationConfiguration.Default;
|
||||
}
|
||||
|
||||
private string GetAppSettingsPath()
|
||||
{
|
||||
return Path.Combine(
|
||||
Environment.ContentRootPath,
|
||||
"Data",
|
||||
"appsettings.json");
|
||||
}
|
||||
|
||||
private async Task SaveConfiguration()
|
||||
{
|
||||
if (_config == null) return;
|
||||
|
||||
_isSaving = true;
|
||||
_statusMessage = null;
|
||||
|
||||
try
|
||||
{
|
||||
var appSettingsPath = GetAppSettingsPath();
|
||||
|
||||
// Ensure Data directory exists
|
||||
var dataDir = Path.GetDirectoryName(appSettingsPath);
|
||||
if (dataDir != null && !Directory.Exists(dataDir))
|
||||
{
|
||||
Directory.CreateDirectory(dataDir);
|
||||
}
|
||||
|
||||
// Read existing appsettings or create new
|
||||
JsonDocument? existingDoc = null;
|
||||
Dictionary<string, object?> settings;
|
||||
|
||||
if (File.Exists(appSettingsPath))
|
||||
{
|
||||
var existingJson = await File.ReadAllTextAsync(appSettingsPath);
|
||||
existingDoc = JsonDocument.Parse(existingJson);
|
||||
settings = JsonSerializer.Deserialize<Dictionary<string, object?>>(existingJson)
|
||||
?? new Dictionary<string, object?>();
|
||||
}
|
||||
else
|
||||
{
|
||||
settings = new Dictionary<string, object?>();
|
||||
}
|
||||
|
||||
// Update ValidationSettings section
|
||||
settings["ValidationSettings"] = _config;
|
||||
|
||||
// Write back to file
|
||||
var options = new JsonSerializerOptions { WriteIndented = true };
|
||||
var json = JsonSerializer.Serialize(settings, options);
|
||||
await File.WriteAllTextAsync(appSettingsPath, json);
|
||||
|
||||
existingDoc?.Dispose();
|
||||
|
||||
_statusMessage = "Configuration saved successfully! Changes will take effect on next application restart.";
|
||||
_statusSeverity = Severity.Success;
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_statusMessage = $"Error saving configuration: {ex.Message}";
|
||||
_statusSeverity = Severity.Error;
|
||||
}
|
||||
finally
|
||||
{
|
||||
_isSaving = false;
|
||||
}
|
||||
}
|
||||
|
||||
private void ResetToDefaults()
|
||||
{
|
||||
_config = ValidationConfiguration.Default;
|
||||
_statusMessage = "Configuration reset to defaults. Click Save to apply.";
|
||||
_statusSeverity = Severity.Info;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user