Files
ScadaBridge/src/ZB.MOM.WW.ScadaBridge.SiteRuntime/Deployment/DeployCompileValidator.cs
T

121 lines
5.6 KiB
C#

using System.Text.Json;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Flattening;
using ZB.MOM.WW.ScadaBridge.SiteRuntime.Scripts;
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Deployment;
/// <summary>
/// Pure, thread-safe deploy-time gate: given a flattened-configuration JSON, it
/// compiles every script, every alarm on-trigger script, and every Expression
/// trigger just as <see cref="Actors.InstanceActor.CreateChildActors"/> does at
/// runtime — but WITHOUT touching any actor state. It returns the collected
/// compile errors so the Deployment Manager can reject a deployment whose scripts
/// do not compile on the site (design spec: site-side compile failure rejects the
/// deployment; no partial state is applied).
///
/// Because it holds no actor state and only calls the (stateless)
/// <see cref="ScriptCompilationService"/>, it is pure and thread-safe; the Deployment
/// Manager nevertheless invokes it <em>synchronously on the singleton's actor thread</em>
/// as a pure prefix step, preserving mailbox-FIFO deploy ordering (see
/// <see cref="Actors.DeploymentManagerActor.HandleDeploy"/>). Compiles of unchanged
/// script bodies are deduped by the process-wide compile cache.
/// </summary>
public sealed class DeployCompileValidator
{
private readonly ScriptCompilationService _compilationService;
/// <summary>Initializes a new instance of the <see cref="DeployCompileValidator"/>.</summary>
/// <param name="compilationService">The same compilation service the Instance Actor uses at runtime.</param>
public DeployCompileValidator(ScriptCompilationService compilationService)
=> _compilationService = compilationService;
/// <summary>
/// Validates every compilable artifact in the flattened configuration.
/// Returns an empty list when the whole configuration compiles; otherwise
/// one human-readable error per failing artifact. Malformed JSON is itself a
/// single error (this also fronts the poison-config case for startup load).
/// </summary>
/// <param name="configJson">The flattened-configuration JSON to validate.</param>
/// <returns>A list of compile-error messages; empty if the configuration is clean.</returns>
public IReadOnlyList<string> Validate(string configJson)
{
FlattenedConfiguration? config;
try
{
config = JsonSerializer.Deserialize<FlattenedConfiguration>(configJson);
}
catch (JsonException ex)
{
return [$"Configuration JSON failed to deserialize: {ex.Message}"];
}
if (config == null)
return ["Configuration JSON failed to deserialize: result was null."];
var errors = new List<string>();
// Scripts: full execution-path compile against ScriptGlobals.
foreach (var script in config.Scripts)
{
var result = _compilationService.Compile(script.CanonicalName, script.Code);
if (!result.IsSuccess)
errors.Add($"Script '{script.CanonicalName}': {string.Join("; ", result.Errors)}");
// Expression-triggered scripts also compile their trigger expression.
AddTriggerExpressionError(errors, script.TriggerType, script.TriggerConfiguration,
$"script-trigger-{script.CanonicalName}");
}
// Alarms: on-trigger script reference must resolve + compile, and any
// Expression trigger must compile — mirrors InstanceActor.CreateChildActors.
foreach (var alarm in config.Alarms)
{
if (!string.IsNullOrEmpty(alarm.OnTriggerScriptCanonicalName))
{
var triggerScriptDef = config.Scripts
.FirstOrDefault(s => s.CanonicalName == alarm.OnTriggerScriptCanonicalName);
if (triggerScriptDef == null)
{
errors.Add($"Alarm '{alarm.CanonicalName}': on-trigger script " +
$"'{alarm.OnTriggerScriptCanonicalName}' is not defined.");
}
else
{
var result = _compilationService.Compile(
$"alarm-trigger-{alarm.CanonicalName}", triggerScriptDef.Code);
if (!result.IsSuccess)
errors.Add($"Alarm '{alarm.CanonicalName}' on-trigger script " +
$"'{alarm.OnTriggerScriptCanonicalName}': {string.Join("; ", result.Errors)}");
}
}
AddTriggerExpressionError(errors, alarm.TriggerType, alarm.TriggerConfiguration,
$"alarm-trigger-expr-{alarm.CanonicalName}");
}
return errors;
}
/// <summary>
/// Compiles the boolean trigger expression for an Expression-triggered script
/// or alarm and records any failure. No-op for non-Expression triggers or a
/// blank/malformed expression config — mirroring
/// <c>InstanceActor.CompileTriggerExpression</c>, where those cases yield an
/// inert trigger rather than a deployment error.
/// </summary>
private void AddTriggerExpressionError(
List<string> errors, string? triggerType, string? triggerConfigJson, string compileName)
{
if (!string.Equals(triggerType, "Expression", StringComparison.OrdinalIgnoreCase))
return;
var expression = TriggerExpressionGlobals.ExtractExpression(triggerConfigJson);
if (expression == null)
return;
var result = _compilationService.CompileTriggerExpression(compileName, expression);
if (!result.IsSuccess)
errors.Add($"Trigger expression '{compileName}': {string.Join("; ", result.Errors)}");
}
}