fix(templateengine): audit projected template/script summaries instead of the tracked graph and script bodies (review 2026-10-21 08/G1)
This commit is contained in:
@@ -0,0 +1,78 @@
|
||||
using System.Security.Cryptography;
|
||||
using System.Text;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Scripts;
|
||||
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Templates;
|
||||
|
||||
namespace ZB.MOM.WW.ScadaBridge.TemplateEngine;
|
||||
|
||||
/// <summary>
|
||||
/// Compact after-state shapes for the configuration audit log (review 2026-10-21
|
||||
/// 08/G1). <c>IAuditService.LogAsync</c> serialises whatever it is handed into
|
||||
/// <c>AuditLogEntries.AfterStateJson</c> — an indefinitely-retained table — so
|
||||
/// handing it a tracked <see cref="Template"/> wrote the whole loaded graph,
|
||||
/// every attribute, alarm and script body included, on each create / rename / move.
|
||||
/// These shapes keep the identity, the scalar fields, per-collection member counts
|
||||
/// and the fields that changed. Script bodies are never written: a body is
|
||||
/// represented by its length and SHA-256, which still lets an auditor tell whether
|
||||
/// (and to what) a body changed without storing it again on every edit.
|
||||
/// </summary>
|
||||
internal static class TemplateAuditShapes
|
||||
{
|
||||
/// <summary>Summary of a template: identity, scalars and member counts — no member rows.</summary>
|
||||
/// <param name="template">The template.</param>
|
||||
/// <param name="changedFields">Names of the fields this operation changed, if known.</param>
|
||||
/// <returns>The audit after-state object.</returns>
|
||||
internal static object Template(Template template, IReadOnlyList<string>? changedFields = null) => new
|
||||
{
|
||||
template.Id,
|
||||
template.Name,
|
||||
template.Description,
|
||||
template.ParentTemplateId,
|
||||
template.FolderId,
|
||||
template.IsDerived,
|
||||
template.OwnerCompositionId,
|
||||
AttributeCount = template.Attributes.Count,
|
||||
AlarmCount = template.Alarms.Count,
|
||||
ScriptCount = template.Scripts.Count,
|
||||
CompositionCount = template.Compositions.Count,
|
||||
NativeAlarmSourceCount = template.NativeAlarmSources.Count,
|
||||
ChangedFields = changedFields,
|
||||
};
|
||||
|
||||
/// <summary>A template script without its body (length + SHA-256 instead).</summary>
|
||||
/// <param name="script">The script.</param>
|
||||
/// <returns>The audit after-state object.</returns>
|
||||
internal static object Script(TemplateScript script) => new
|
||||
{
|
||||
script.Id,
|
||||
script.TemplateId,
|
||||
script.Name,
|
||||
script.IsLocked,
|
||||
script.LockedInDerived,
|
||||
script.IsInherited,
|
||||
script.TriggerType,
|
||||
script.TriggerConfiguration,
|
||||
script.ParameterDefinitions,
|
||||
script.ReturnDefinition,
|
||||
script.MinTimeBetweenRuns,
|
||||
script.ExecutionTimeoutSeconds,
|
||||
CodeLength = script.Code?.Length ?? 0,
|
||||
CodeSha256 = HashCode(script.Code),
|
||||
};
|
||||
|
||||
/// <summary>A shared script without its body (length + SHA-256 instead).</summary>
|
||||
/// <param name="script">The shared script.</param>
|
||||
/// <returns>The audit after-state object.</returns>
|
||||
internal static object SharedScript(SharedScript script) => new
|
||||
{
|
||||
script.Id,
|
||||
script.Name,
|
||||
script.ParameterDefinitions,
|
||||
script.ReturnDefinition,
|
||||
CodeLength = script.Code?.Length ?? 0,
|
||||
CodeSha256 = HashCode(script.Code),
|
||||
};
|
||||
|
||||
private static string? HashCode(string? code) =>
|
||||
code == null ? null : Convert.ToHexString(SHA256.HashData(Encoding.UTF8.GetBytes(code)));
|
||||
}
|
||||
Reference in New Issue
Block a user