dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'worktree-agent-a349413889618d94c' into fix/flow-debugger-arch-review

Browse Source
This commit is contained in:
Joseph Doherty
2026-09-06 14:13:56 -04:00
parent 17096d6fe2 f86eb61d1a
commit a7ed9d98ce
8 changed files with 266 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/FlowDebugger.razor
+40 -18
View File
@@ -3,7 +3,10 @@
@using ZB.MOM.WW.ScadaBridge.CentralUI.Components.Deployment
@using ZB.MOM.WW.ScadaBridge.CentralUI.Components.Shared
@using ZB.MOM.WW.ScadaBridge.Commons.Types.Debugging
@attribute [Authorize(Policy = AuthorizationPolicies.RequireDeployment)]
@* arch-review F3: opening the page is a Replay-capable read (Deployer + the OperationalAudit
roles) so the Audit Log / Execution Chain drill-ins work for an auditor. Every Live-run
affordance below is additionally gated on _canLive (the Deployer role). *@
@attribute [Authorize(Policy = AuthorizationPolicies.RequireFlowDebugger)]
<PageTitle>Flow Debugger</PageTitle>
@@ -13,15 +16,19 @@
@* ── Toolbar ─────────────────────────────────────────────────────────── *@
<div class="row g-2 align-items-end mb-2" data-test="flow-toolbar">
<div class="col-auto">
<label class="form-label form-label-sm">Entry point</label>
<div class="btn-group btn-group-sm d-block" role="group" aria-label="Entry point">
<button type="button" class="btn @(_entry == EntryKind.Method ? "btn-primary" : "btn-outline-secondary")"
data-test="flow-entry-method" disabled="@_running" @onclick="() => SetEntryAsync(EntryKind.Method)">Inbound API method</button>
<button type="button" class="btn @(_entry == EntryKind.ValueChange ? "btn-primary" : "btn-outline-secondary")"
data-test="flow-entry-value-change" disabled="@_running" @onclick="() => SetEntryAsync(EntryKind.ValueChange)">Value-change trigger</button>
@* The entry point only selects what a Live run starts from, so it is Deployer-only. *@
@if (_canLive)
{
<div class="col-auto">
<label class="form-label form-label-sm">Entry point</label>
<div class="btn-group btn-group-sm d-block" role="group" aria-label="Entry point">
<button type="button" class="btn @(_entry == EntryKind.Method ? "btn-primary" : "btn-outline-secondary")"
data-test="flow-entry-method" disabled="@_running" @onclick="() => SetEntryAsync(EntryKind.Method)">Inbound API method</button>
<button type="button" class="btn @(_entry == EntryKind.ValueChange ? "btn-primary" : "btn-outline-secondary")"
data-test="flow-entry-value-change" disabled="@_running" @onclick="() => SetEntryAsync(EntryKind.ValueChange)">Value-change trigger</button>
</div>
</div>
</div>
}
@if (_mode == FlowMode.Live)
{
@@ -85,15 +92,19 @@
</div>
}
<div class="col-auto">
<label class="form-label form-label-sm">Mode</label>
<div class="btn-group btn-group-sm d-block" role="group" aria-label="Mode">
<button type="button" class="btn @(_mode == FlowMode.Live ? "btn-primary" : "btn-outline-secondary")"
data-test="flow-mode-live" disabled="@_running" @onclick="() => SetMode(FlowMode.Live)">Live</button>
<button type="button" class="btn @(_mode == FlowMode.Replay ? "btn-primary" : "btn-outline-secondary")"
data-test="flow-mode-replay" disabled="@_running" @onclick="() => SetMode(FlowMode.Replay)">Replay</button>
@* Without Deployer there is only Replay, so the toggle would be a single dead button. *@
@if (_canLive)
{
<div class="col-auto">
<label class="form-label form-label-sm">Mode</label>
<div class="btn-group btn-group-sm d-block" role="group" aria-label="Mode">
<button type="button" class="btn @(_mode == FlowMode.Live ? "btn-primary" : "btn-outline-secondary")"
data-test="flow-mode-live" disabled="@_running" @onclick="() => SetMode(FlowMode.Live)">Live</button>
<button type="button" class="btn @(_mode == FlowMode.Replay ? "btn-primary" : "btn-outline-secondary")"
data-test="flow-mode-replay" disabled="@_running" @onclick="() => SetMode(FlowMode.Replay)">Replay</button>
</div>
</div>
</div>
}
<div class="col-auto ms-auto">
@if (_mode == FlowMode.Live)
@@ -115,6 +126,14 @@
</div>
</div>
@if (!_canLive)
{
<div class="text-muted small mb-2" data-test="flow-replay-only">
Replay only — rebuilding a past execution from the audit log. Starting a live run
requires the Deployer role.
</div>
}
@* ── Inline alerts ───────────────────────────────────────────────────── *@
@if (_error != null)
{
@@ -232,10 +251,13 @@
@* ── Detail panel ──────────────────────────────────────────────────── *@
<div class="col-12">
@* Retry / Discard relay a command to the site — only wired for a Deployer, so the
buttons never render for an auditor (arch-review F3). *@
<FlowStepDetail Step="_selected" Graph="_graph"
SiteDbId="@(_entry == EntryKind.ValueChange && _selectedSiteId > 0 ? _selectedSiteId : null)"
InstanceDbId="@(_entry == EntryKind.ValueChange && _selectedInstanceId > 0 ? _selectedInstanceId : null)"
OnRetry="OnRetryStepAsync" OnDiscard="OnDiscardStepAsync" ActionInProgress="_actionInProgress" />
OnRetry="RetryCallback" OnDiscard="DiscardCallback"
ActionInProgress="_actionInProgress" />
</div>
</div>
</div>
src/ZB.MOM.WW.ScadaBridge.CentralUI/Components/Pages/Deployment/FlowDebugger.razor.cs
+51 -2
View File
@@ -2,6 +2,7 @@ using System.Globalization;
using System.Text.Json;
using System.Text.Json.Nodes;
using Microsoft.AspNetCore.Components;
using Microsoft.AspNetCore.Components.Authorization;
using Microsoft.JSInterop;
using ZB.MOM.WW.Audit;
using ZB.MOM.WW.ScadaBridge.CentralUI.Auth;
@@ -15,6 +16,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Debugging;
using ZB.MOM.WW.ScadaBridge.Commons.Types.InboundApi;
using ZB.MOM.WW.ScadaBridge.ScriptAnalysis;
using ZB.MOM.WW.ScadaBridge.Security;
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Components.Pages.Deployment;
@@ -76,6 +78,7 @@ public partial class FlowDebugger : ComponentBase, IDisposable
[Inject] private SiteScopeService SiteScope { get; set; } = default!;
[Inject] private IJSRuntime JS { get; set; } = default!;
[Inject] private IDialogService Dialog { get; set; } = default!;
[Inject] private AuthenticationStateProvider Auth { get; set; } = default!;
/// <summary>Drill-in: pre-select an inbound method.</summary>
[SupplyParameterFromQuery] public int? MethodId { get; set; }
@@ -93,6 +96,16 @@ public partial class FlowDebugger : ComponentBase, IDisposable
private FlowMode _mode = FlowMode.Live;
private FlowState _state = FlowState.Idle;
/// <summary>
/// True when the principal holds <see cref="Roles.Deployer"/> and may therefore start a
/// Live run (and relay Retry/Discard on a parked node). The page itself opens to the
/// wider <see cref="AuthorizationPolicies.RequireFlowDebugger"/> set so an auditor can
/// follow the Audit Log / Execution Chain drill-in into Replay (arch-review F3); every
/// Live affordance is hidden when this is false, and the server enforces the same split
/// (the two run commands stay Deployer-only in the ManagementActor role matrix).
/// </summary>
private bool _canLive;
private List<ApiMethod> _methods = [];
private List<Site> _sites = [];
private List<Instance> _instances = [];
@@ -146,7 +159,7 @@ public partial class FlowDebugger : ComponentBase, IDisposable
private bool CanRefresh => !_running && _raw is not null;
private bool CanRun => !_running && _mode == FlowMode.Live && (
private bool CanRun => _canLive && !_running && _mode == FlowMode.Live && (
_entry == EntryKind.Method ? _selectedMethodId > 0
: _selectedInstanceId > 0 && !string.IsNullOrWhiteSpace(_selectedAttribute));
@@ -184,9 +197,29 @@ public partial class FlowDebugger : ComponentBase, IDisposable
/// <inheritdoc/>
protected override async Task OnInitializedAsync()
{
// arch-review F3: page access is the wider RequireFlowDebugger set; only a Deployer
// gets the Live half. Resolved before anything else so the Live-only drill-ins below
// are skipped and the mode starts on Replay for an auditor.
_canLive = (await Auth.GetAuthenticationStateAsync()).User
.HasClaim(JwtTokenService.RoleClaimType, Roles.Deployer);
if (!_canLive)
_mode = FlowMode.Replay;
_methods = (await InboundApi.GetAllApiMethodsAsync()).OrderBy(m => m.Name, StringComparer.OrdinalIgnoreCase).ToList();
_sites = await SiteScope.FilterSitesAsync(await SiteRepository.GetAllSitesAsync());
if (!_canLive)
{
// ?methodId= / ?instanceId= are Live-run drill-ins; ?executionId= is the audit
// drill-in and is the only one that means anything without Deployer.
if (ExecutionId is Guid auditExec && auditExec != Guid.Empty)
{
_replayExecutionIdText = auditExec.ToString();
await LoadReplayAsync();
}
return;
}
if (InstanceId is int iid && iid > 0)
{
_entry = EntryKind.ValueChange;
@@ -383,6 +416,8 @@ public partial class FlowDebugger : ComponentBase, IDisposable
private void SetMode(FlowMode mode)
{
if (_mode == mode) return;
// Without Deployer there is no Live half to switch to (arch-review F3).
if (mode == FlowMode.Live && !_canLive) return;
CancelPendingRefresh();
_mode = mode;
}
@@ -558,6 +593,17 @@ public partial class FlowDebugger : ComponentBase, IDisposable
private Task OnDiscardStepAsync(FlowStep step) => ActOnStepAsync(step, retry: false);
/// <summary>
/// The parked-node Retry callback, left unset (<c>default</c>) without the Deployer role so
/// <c>FlowStepDetail</c>'s <c>OnRetry.HasDelegate</c> check hides the button (arch-review F3).
/// </summary>
private EventCallback<FlowStep> RetryCallback
=> _canLive ? EventCallback.Factory.Create<FlowStep>(this, OnRetryStepAsync) : default;
/// <summary>The parked-node Discard callback; unset without Deployer, as <see cref="RetryCallback"/>.</summary>
private EventCallback<FlowStep> DiscardCallback
=> _canLive ? EventCallback.Factory.Create<FlowStep>(this, OnDiscardStepAsync) : default;
/// <summary>
/// Retry / Discard a Parked outbound node: site-scope re-check → confirm → relay through the
/// service → toast → re-poll Replay until the node leaves Parked. Mirrors the Site Calls /
@@ -565,7 +611,10 @@ public partial class FlowDebugger : ComponentBase, IDisposable
/// </summary>
private async Task ActOnStepAsync(FlowStep step, bool retry)
{
if (_actionInProgress || step.Outcome != FlowStepOutcome.Parked || step.CorrelationId is not { } corr)
// _canLive: relaying Retry/Discard to the site is a Deployer act. The buttons are not
// rendered without it (the callbacks are left unset), but the gate is repeated here so
// the split does not rest on markup alone (arch-review F3).
if (!_canLive || _actionInProgress || step.Outcome != FlowStepOutcome.Parked || step.CorrelationId is not { } corr)
return;
if (!await IsStepSiteAllowedAsync(step))