feat(sms): SMS configuration Central UI page + nav (S9)

This commit is contained in:
Joseph Doherty
2026-06-19 10:52:56 -04:00
parent 538117d114
commit 4860aeff62
3 changed files with 455 additions and 0 deletions
@@ -57,6 +57,7 @@
<AuthorizeView Policy="@AuthorizationPolicies.RequireAdmin"> <AuthorizeView Policy="@AuthorizationPolicies.RequireAdmin">
<Authorized Context="notifAdminContext"> <Authorized Context="notifAdminContext">
<NavRailItem Href="/notifications/smtp" Text="SMTP Configuration" /> <NavRailItem Href="/notifications/smtp" Text="SMTP Configuration" />
<NavRailItem Href="/notifications/sms" Text="SMS Configuration" />
</Authorized> </Authorized>
</AuthorizeView> </AuthorizeView>
<AuthorizeView Policy="@AuthorizationPolicies.RequireDesign"> <AuthorizeView Policy="@AuthorizationPolicies.RequireDesign">
@@ -0,0 +1,278 @@
@page "/notifications/sms"
@using ZB.MOM.WW.ScadaBridge.Security
@using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories
@using SmsConfigurationEntity = ZB.MOM.WW.ScadaBridge.Commons.Entities.Notifications.SmsConfiguration
@attribute [Authorize(Policy = AuthorizationPolicies.RequireAdmin)]
@inject INotificationRepository NotificationRepository
@inject NavigationManager NavigationManager
<div class="container-fluid mt-3">
<div class="d-flex justify-content-between align-items-center mb-3">
<h4 class="mb-0">SMS Configuration</h4>
</div>
<ToastNotification @ref="_toast" />
@if (_loading)
{
<LoadingSpinner IsLoading="true" />
}
else if (_errorMessage != null)
{
<div class="alert alert-danger">@_errorMessage</div>
}
else
{
@if (_smsConfigs.Count == 0 && !_showForm)
{
<div class="text-center py-5 text-muted">
<p class="mb-3">No SMS configuration set.</p>
<button class="btn btn-primary btn-sm" @onclick="ShowAddForm">
Add SMS configuration
</button>
</div>
}
else
{
@foreach (var sms in _smsConfigs)
{
<div class="card mb-3" @key="sms.Id">
<div class="card-header d-flex justify-content-between align-items-center">
<strong>@sms.AccountSid</strong>
@if (_editingSms?.Id != sms.Id || !_showForm)
{
<button class="btn btn-outline-primary btn-sm" @onclick="() => StartEdit(sms)">Edit</button>
}
</div>
<div class="card-body small">
<div class="row g-2">
<div class="col-md-4 text-muted">Account SID</div>
<div class="col-md-8">@sms.AccountSid</div>
<div class="col-md-4 text-muted">From Number</div>
<div class="col-md-8">@sms.FromNumber</div>
<div class="col-md-4 text-muted">Messaging Service SID</div>
<div class="col-md-8">@(string.IsNullOrWhiteSpace(sms.MessagingServiceSid) ? "(not set)" : sms.MessagingServiceSid)</div>
<div class="col-md-4 text-muted">API Base URL</div>
<div class="col-md-8">@(string.IsNullOrWhiteSpace(sms.ApiBaseUrl) ? "(provider default)" : sms.ApiBaseUrl)</div>
<div class="col-md-4 text-muted">Auth Token</div>
<div class="col-md-8">@(string.IsNullOrWhiteSpace(sms.AuthToken) ? "(not set)" : "(stored)")</div>
<div class="col-md-4 text-muted">Connection Timeout</div>
<div class="col-md-8">@sms.ConnectionTimeoutSeconds s</div>
<div class="col-md-4 text-muted">Max Retries</div>
<div class="col-md-8">@sms.MaxRetries</div>
<div class="col-md-4 text-muted">Retry Delay</div>
<div class="col-md-8">@sms.RetryDelay</div>
</div>
</div>
</div>
}
@if (_showForm)
{
<div class="card mb-3">
<div class="card-header">@(_editingSms != null ? "Edit SMS Configuration" : "Add SMS Configuration")</div>
<div class="card-body">
<div class="row g-3">
<div class="col-12">
<label class="form-label">Account SID</label>
<input type="text" class="form-control" @bind="_accountSid" placeholder="ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" />
</div>
<div class="col-12">
<label class="form-label">From Number</label>
<input type="text" class="form-control" @bind="_fromNumber" placeholder="+15551234567" />
</div>
<div class="col-12">
<label class="form-label">Messaging Service SID</label>
<input type="text" class="form-control" @bind="_messagingServiceSid"
placeholder="MGxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (optional)" />
<div class="form-text">Optional — used instead of the From number when set.</div>
</div>
<div class="col-12">
<label class="form-label">API Base URL</label>
<input type="text" class="form-control" @bind="_apiBaseUrl"
placeholder="Leave blank to use the provider default" />
</div>
<div class="col-12">
<label class="form-label">Auth Token</label>
<input type="password" class="form-control" @bind="_authToken"
placeholder="@(_editingSms != null ? "Leave blank to keep the stored token" : "Twilio Auth Token")" />
<div class="form-text">
Treat as sensitive — visible to admins only.
@if (_editingSms != null)
{
<span>Leave blank to keep the existing token.</span>
}
</div>
</div>
<div class="col-md-4">
<label class="form-label">Connection Timeout (s)</label>
<input type="number" class="form-control" @bind="_connectionTimeoutSeconds" min="1" />
</div>
<div class="col-md-4">
<label class="form-label">Max Retries</label>
<input type="number" class="form-control" @bind="_maxRetries" min="0" />
</div>
<div class="col-md-4">
<label class="form-label">Retry Delay (s)</label>
<input type="number" class="form-control" @bind="_retryDelaySeconds" min="0" />
</div>
@if (_formError != null)
{
<div class="col-12"><div class="text-danger small">@_formError</div></div>
}
<div class="col-12 text-end">
<button class="btn btn-outline-secondary me-1" @onclick="CancelForm">Cancel</button>
<button class="btn btn-success" @onclick="Save">Save</button>
</div>
</div>
</div>
</div>
}
else if (_smsConfigs.Count == 0)
{
<button class="btn btn-primary btn-sm" @onclick="ShowAddForm">Add SMS configuration</button>
}
}
}
</div>
@code {
private bool _loading = true;
private string? _errorMessage;
private List<SmsConfigurationEntity> _smsConfigs = new();
private bool _showForm;
private SmsConfigurationEntity? _editingSms;
private string _accountSid = string.Empty;
private string _fromNumber = string.Empty;
private string? _messagingServiceSid;
private string? _apiBaseUrl;
private string? _authToken;
private int _connectionTimeoutSeconds = 30;
private int _maxRetries = 10;
private int _retryDelaySeconds = 60;
private string? _formError;
private ToastNotification _toast = default!;
protected override async Task OnInitializedAsync()
{
await LoadAsync();
}
private async Task LoadAsync()
{
_loading = true;
_errorMessage = null;
try
{
_smsConfigs = (await NotificationRepository.GetAllSmsConfigurationsAsync()).ToList();
}
catch (Exception ex)
{
_errorMessage = ex.Message;
}
_loading = false;
}
private void ShowAddForm()
{
_editingSms = null;
_accountSid = string.Empty;
_fromNumber = string.Empty;
_messagingServiceSid = null;
_apiBaseUrl = null;
_authToken = null;
_connectionTimeoutSeconds = 30;
_maxRetries = 10;
_retryDelaySeconds = 60;
_formError = null;
_showForm = true;
}
private void StartEdit(SmsConfigurationEntity sms)
{
_editingSms = sms;
_accountSid = sms.AccountSid;
_fromNumber = sms.FromNumber;
_messagingServiceSid = sms.MessagingServiceSid;
_apiBaseUrl = sms.ApiBaseUrl;
// Never pre-fill the stored secret; blank means "keep existing".
_authToken = null;
_connectionTimeoutSeconds = sms.ConnectionTimeoutSeconds;
_maxRetries = sms.MaxRetries;
_retryDelaySeconds = (int)sms.RetryDelay.TotalSeconds;
_formError = null;
_showForm = true;
}
private void CancelForm()
{
_showForm = false;
_formError = null;
}
private async Task Save()
{
_formError = null;
if (string.IsNullOrWhiteSpace(_accountSid) || string.IsNullOrWhiteSpace(_fromNumber))
{
_formError = "Account SID and From Number are required.";
return;
}
var typedAuthToken = string.IsNullOrWhiteSpace(_authToken) ? null : _authToken.Trim();
try
{
if (_editingSms != null)
{
_editingSms.AccountSid = _accountSid.Trim();
_editingSms.FromNumber = _fromNumber.Trim();
_editingSms.MessagingServiceSid = string.IsNullOrWhiteSpace(_messagingServiceSid)
? null
: _messagingServiceSid.Trim();
_editingSms.ApiBaseUrl = string.IsNullOrWhiteSpace(_apiBaseUrl) ? null : _apiBaseUrl.Trim();
// Preserve-if-blank: only overwrite the stored token when a new value was typed.
if (typedAuthToken != null)
{
_editingSms.AuthToken = typedAuthToken;
}
_editingSms.ConnectionTimeoutSeconds = _connectionTimeoutSeconds;
_editingSms.MaxRetries = _maxRetries;
_editingSms.RetryDelay = TimeSpan.FromSeconds(_retryDelaySeconds);
await NotificationRepository.UpdateSmsConfigurationAsync(_editingSms);
}
else
{
if (typedAuthToken == null)
{
_formError = "Auth Token is required.";
return;
}
var sms = new SmsConfigurationEntity(_accountSid.Trim(), _fromNumber.Trim())
{
MessagingServiceSid = string.IsNullOrWhiteSpace(_messagingServiceSid)
? null
: _messagingServiceSid.Trim(),
ApiBaseUrl = string.IsNullOrWhiteSpace(_apiBaseUrl) ? null : _apiBaseUrl.Trim(),
AuthToken = typedAuthToken,
ConnectionTimeoutSeconds = _connectionTimeoutSeconds,
MaxRetries = _maxRetries,
RetryDelay = TimeSpan.FromSeconds(_retryDelaySeconds),
};
await NotificationRepository.AddSmsConfigurationAsync(sms);
}
await NotificationRepository.SaveChangesAsync();
_showForm = false;
_toast.ShowSuccess("SMS configuration saved.");
await LoadAsync();
}
catch (Exception ex)
{
_formError = ex.Message;
}
}
}
@@ -0,0 +1,176 @@
using System.Security.Claims;
using ZB.MOM.WW.ScadaBridge.Security;
using Bunit;
using Microsoft.AspNetCore.Components.Authorization;
using Microsoft.Extensions.DependencyInjection;
using NSubstitute;
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Notifications;
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
using SmsConfigurationPage = ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Notifications.SmsConfiguration;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.Pages;
/// <summary>
/// bUnit rendering tests for the SMS Configuration page — verifies the read-only list,
/// that the stored Auth Token value is never rendered (only a presence indicator),
/// repository-direct save on create/edit, and the preserve-if-blank secret handling.
/// </summary>
public class SmsConfigurationPageTests : BunitContext
{
private void WireAuth()
{
var claims = new[]
{
new Claim(JwtTokenService.UsernameClaimType, "tester"),
new Claim(JwtTokenService.RoleClaimType, "Administrator"),
};
var user = new ClaimsPrincipal(new ClaimsIdentity(claims, "TestAuth"));
Services.AddSingleton<AuthenticationStateProvider>(new TestAuthStateProvider(user));
Services.AddAuthorizationCore();
}
private const string SecretToken = "super-secret-auth-token";
private static SmsConfiguration Sample() =>
new("ACtest_account_sid", "+15551234567")
{
Id = 1,
MessagingServiceSid = "MGtest_messaging_service",
ApiBaseUrl = "https://api.example.com",
AuthToken = SecretToken,
ConnectionTimeoutSeconds = 30,
MaxRetries = 10,
RetryDelay = TimeSpan.FromMinutes(1),
};
private static INotificationRepository RepoWith(params SmsConfiguration[] configs)
{
var repo = Substitute.For<INotificationRepository>();
repo.GetAllSmsConfigurationsAsync()
.Returns(Task.FromResult<IReadOnlyList<SmsConfiguration>>(configs.ToList()));
return repo;
}
[Fact]
public void ReadOnlyView_ShowsConfigRow_ButNeverRendersAuthTokenValue()
{
var repo = RepoWith(Sample());
Services.AddSingleton(repo);
WireAuth();
var cut = Render<SmsConfigurationPage>();
cut.WaitForAssertion(() =>
{
// Config row fields render.
Assert.Contains("ACtest_account_sid", cut.Markup);
Assert.Contains("+15551234567", cut.Markup);
Assert.Contains("MGtest_messaging_service", cut.Markup);
// Auth Token shows a presence indicator only — never the value.
Assert.Contains("Auth Token", cut.Markup);
Assert.Contains("(stored)", cut.Markup);
Assert.DoesNotContain(SecretToken, cut.Markup);
});
}
[Fact]
public void EditForm_DoesNotPrefillAuthToken_ButPrefillsMessagingServiceSid()
{
var repo = RepoWith(Sample());
Services.AddSingleton(repo);
WireAuth();
var cut = Render<SmsConfigurationPage>();
cut.WaitForState(() => cut.Markup.Contains("ACtest_account_sid"));
cut.FindAll("button").First(b => b.TextContent.Contains("Edit")).Click();
cut.WaitForAssertion(() =>
{
// The secret is never placed into the form markup (no input pre-fill).
Assert.DoesNotContain(SecretToken, cut.Markup);
// Non-secret fields, including MessagingServiceSid, are pre-filled.
var inputs = cut.FindAll("input");
Assert.Contains(inputs, i => i.GetAttribute("value") == "MGtest_messaging_service");
});
}
[Fact]
public void SavingNewConfig_CallsAddAndSaveChanges()
{
var repo = RepoWith();
Services.AddSingleton(repo);
WireAuth();
var cut = Render<SmsConfigurationPage>();
cut.WaitForState(() => cut.Markup.Contains("No SMS configuration set."));
cut.FindAll("button").First(b => b.TextContent.Contains("Add SMS configuration")).Click();
// Re-query between each Change(): two-way binding re-renders the form and
// invalidates previously found element references.
cut.FindAll("input[type=text]")[0].Change("ACnew_account"); // Account SID
cut.FindAll("input[type=text]")[1].Change("+15559876543"); // From Number
cut.FindAll("input[type=password]").First().Change("new-token");
cut.FindAll("button").First(b => b.TextContent.Contains("Save")).Click();
cut.WaitForAssertion(() =>
{
repo.Received().AddSmsConfigurationAsync(
Arg.Is<SmsConfiguration>(c =>
c.AccountSid == "ACnew_account" &&
c.FromNumber == "+15559876543" &&
c.AuthToken == "new-token"));
repo.Received().SaveChangesAsync();
});
}
[Fact]
public void SavingEdit_WithBlankAuthToken_PreservesExistingToken()
{
var config = Sample();
var repo = RepoWith(config);
Services.AddSingleton(repo);
WireAuth();
var cut = Render<SmsConfigurationPage>();
cut.WaitForState(() => cut.Markup.Contains("ACtest_account_sid"));
cut.FindAll("button").First(b => b.TextContent.Contains("Edit")).Click();
// Leave the (blank) Auth Token input untouched, then save.
cut.FindAll("button").First(b => b.TextContent.Contains("Save")).Click();
cut.WaitForAssertion(() =>
{
repo.Received().UpdateSmsConfigurationAsync(
Arg.Is<SmsConfiguration>(c =>
c.AuthToken == SecretToken &&
c.MessagingServiceSid == "MGtest_messaging_service"));
repo.Received().SaveChangesAsync();
});
}
[Fact]
public void SavingEdit_WithNewAuthToken_OverwritesToken()
{
var config = Sample();
var repo = RepoWith(config);
Services.AddSingleton(repo);
WireAuth();
var cut = Render<SmsConfigurationPage>();
cut.WaitForState(() => cut.Markup.Contains("ACtest_account_sid"));
cut.FindAll("button").First(b => b.TextContent.Contains("Edit")).Click();
cut.FindAll("input[type=password]").First().Change("rotated-token");
cut.FindAll("button").First(b => b.TextContent.Contains("Save")).Click();
cut.WaitForAssertion(() =>
{
repo.Received().UpdateSmsConfigurationAsync(
Arg.Is<SmsConfiguration>(c => c.AuthToken == "rotated-token"));
repo.Received().SaveChangesAsync();
});
}
}