fix(correctness): close Theme 10 — 5 data-integrity / serialisation findings
Final themed batch. 5 well-localised correctness fixes. Serialisation precision: - ESG-020: DatabaseGateway.JsonElementToParameterValue probes TryGetInt64 → TryGetDecimal → GetDouble, so a script's high-precision decimal SQL parameter survives the cached-write retry round-trip without silent precision loss. 3 new regression tests. Template engine correctness: - TE-018: DiffService gains ComputeConnectionsDiff over FlattenedConfiguration.Connections, mirroring the existing entity-diff shape and pairing with the Theme 1 TE-017 hash-coverage fix. A ConfigurationDiff record extension in Commons is flagged as a follow-up. - TE-019: TemplateResolver.BuildInheritanceChain now walks via the int? ParentTemplateId directly — only null means "no parent". A real Id of 0 (the prior special-cased sentinel) now walks the chain like any other node, matching the TemplateEngine-013 CycleDetector fix. Regression of TE-013 closed. - TE-020: All 5 Create* paths in TemplateService + SharedScriptService re-ordered to save-first → log-with-real-Id → save-audit (matching the InstanceService pattern). Create* audit rows no longer carry a literal "0" EntityId. Doc deferral: - Transport-012: Component-Transport.md §Audit Trail now spells out that the BundleImportId repository filter IS wired (in CentralUiRepository), but the Audit-Log-Viewer UI dropdown + summary-row hyperlink are a deferred CentralUI follow-up. CLI workaround documented (audit query --bundle-import-id). 11+ new regression tests (3 ESG, 4 DiffService, 3 TemplateResolver, 4 TemplateService, 1 SharedScriptService). Build clean; ESG 72/72, TemplateEngine 324/324. README regenerated: 1 pending of 481 total. Session-to-date: 135 of 136 originally-open Theme findings closed across 10 themes in 10 commits.
This commit is contained in:
Joseph Doherty
@@ -34,7 +34,11 @@ public class TemplateServiceTests
|
||||
Assert.True(result.IsSuccess);
|
||||
Assert.Equal("Pump", result.Value.Name);
|
||||
_repoMock.Verify(r => r.AddTemplateAsync(It.IsAny<Template>(), It.IsAny<CancellationToken>()), Times.Once);
|
||||
_repoMock.Verify(r => r.SaveChangesAsync(It.IsAny<CancellationToken>()), Times.Once);
|
||||
// TemplateEngine-020: SaveChangesAsync runs twice — once after the
|
||||
// AddTemplateAsync to populate the auto-generated key (so the audit
|
||||
// row can carry the real Id), and once after LogAsync to persist the
|
||||
// audit row itself.
|
||||
_repoMock.Verify(r => r.SaveChangesAsync(It.IsAny<CancellationToken>()), Times.Exactly(2));
|
||||
_auditMock.Verify(a => a.LogAsync("admin", "Create", "Template", It.IsAny<string>(), "Pump", It.IsAny<object?>(), It.IsAny<CancellationToken>()), Times.Once);
|
||||
}
|
||||
|
||||
@@ -1195,4 +1199,177 @@ public class TemplateServiceTests
|
||||
Assert.Contains("locked-in-derived", result.Error);
|
||||
Assert.True(existing.LockedInDerived); // unchanged
|
||||
}
|
||||
|
||||
// ========================================================================
|
||||
// TemplateEngine-020: Create* audit rows must carry the real entity Id,
|
||||
// not the literal "0" that EF Core leaves on the entity until
|
||||
// SaveChangesAsync populates the auto-generated key.
|
||||
// ========================================================================
|
||||
|
||||
[Fact]
|
||||
public async Task CreateTemplate_AuditRowCarriesRealTemplateIdNotLiteralZero()
|
||||
{
|
||||
// Simulate EF Core's identity-key population: the repository's
|
||||
// AddTemplateAsync stamps Id during SaveChangesAsync. The pre-020
|
||||
// order (Add → LogAsync → Save) queued the audit row before the Id
|
||||
// existed, so every Create audit entry persisted with EntityId = "0"
|
||||
// and the audit trail lost its link back to the created template.
|
||||
// Post-020: save first, then log with the real Id, then save the
|
||||
// audit row.
|
||||
Template? added = null;
|
||||
_repoMock.Setup(r => r.AddTemplateAsync(It.IsAny<Template>(), It.IsAny<CancellationToken>()))
|
||||
.Callback<Template, CancellationToken>((t, _) => added = t)
|
||||
.Returns(Task.CompletedTask);
|
||||
_repoMock.Setup(r => r.SaveChangesAsync(It.IsAny<CancellationToken>()))
|
||||
.Callback<CancellationToken>(_ =>
|
||||
{
|
||||
// First SaveChangesAsync after Add: assign the identity key.
|
||||
if (added != null && added.Id == 0) added.Id = 42;
|
||||
})
|
||||
.ReturnsAsync(1);
|
||||
|
||||
string? auditedEntityId = null;
|
||||
_auditMock.Setup(a => a.LogAsync(
|
||||
It.IsAny<string>(),
|
||||
"Create",
|
||||
"Template",
|
||||
It.IsAny<string>(),
|
||||
It.IsAny<string>(),
|
||||
It.IsAny<object?>(),
|
||||
It.IsAny<CancellationToken>()))
|
||||
.Callback<string, string, string, string, string, object?, CancellationToken>(
|
||||
(_, _, _, entityId, _, _, _) => auditedEntityId = entityId)
|
||||
.Returns(Task.CompletedTask);
|
||||
|
||||
var result = await _service.CreateTemplateAsync("Pump", null, null, "admin");
|
||||
|
||||
Assert.True(result.IsSuccess);
|
||||
Assert.Equal("42", auditedEntityId);
|
||||
Assert.NotEqual("0", auditedEntityId);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AddAttribute_AuditRowCarriesRealAttributeIdNotLiteralZero()
|
||||
{
|
||||
var template = new Template("Pump") { Id = 1 };
|
||||
_repoMock.Setup(r => r.GetTemplateByIdAsync(1, It.IsAny<CancellationToken>())).ReturnsAsync(template);
|
||||
_repoMock.Setup(r => r.GetAllTemplatesAsync(It.IsAny<CancellationToken>()))
|
||||
.ReturnsAsync(new List<Template> { template });
|
||||
|
||||
TemplateAttribute? added = null;
|
||||
_repoMock.Setup(r => r.AddTemplateAttributeAsync(It.IsAny<TemplateAttribute>(), It.IsAny<CancellationToken>()))
|
||||
.Callback<TemplateAttribute, CancellationToken>((a, _) => added = a)
|
||||
.Returns(Task.CompletedTask);
|
||||
_repoMock.Setup(r => r.SaveChangesAsync(It.IsAny<CancellationToken>()))
|
||||
.Callback<CancellationToken>(_ =>
|
||||
{
|
||||
if (added != null && added.Id == 0) added.Id = 77;
|
||||
})
|
||||
.ReturnsAsync(1);
|
||||
|
||||
string? auditedEntityId = null;
|
||||
_auditMock.Setup(a => a.LogAsync(
|
||||
It.IsAny<string>(),
|
||||
"Create",
|
||||
"TemplateAttribute",
|
||||
It.IsAny<string>(),
|
||||
It.IsAny<string>(),
|
||||
It.IsAny<object?>(),
|
||||
It.IsAny<CancellationToken>()))
|
||||
.Callback<string, string, string, string, string, object?, CancellationToken>(
|
||||
(_, _, _, entityId, _, _, _) => auditedEntityId = entityId)
|
||||
.Returns(Task.CompletedTask);
|
||||
|
||||
var attr = new TemplateAttribute("Temperature") { DataType = DataType.Float, Value = "0.0" };
|
||||
var result = await _service.AddAttributeAsync(1, attr, "admin");
|
||||
|
||||
Assert.True(result.IsSuccess);
|
||||
Assert.Equal("77", auditedEntityId);
|
||||
Assert.NotEqual("0", auditedEntityId);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AddAlarm_AuditRowCarriesRealAlarmIdNotLiteralZero()
|
||||
{
|
||||
var template = new Template("Pump") { Id = 1 };
|
||||
_repoMock.Setup(r => r.GetTemplateByIdAsync(1, It.IsAny<CancellationToken>())).ReturnsAsync(template);
|
||||
_repoMock.Setup(r => r.GetAllTemplatesAsync(It.IsAny<CancellationToken>()))
|
||||
.ReturnsAsync(new List<Template> { template });
|
||||
|
||||
TemplateAlarm? added = null;
|
||||
_repoMock.Setup(r => r.AddTemplateAlarmAsync(It.IsAny<TemplateAlarm>(), It.IsAny<CancellationToken>()))
|
||||
.Callback<TemplateAlarm, CancellationToken>((a, _) => added = a)
|
||||
.Returns(Task.CompletedTask);
|
||||
_repoMock.Setup(r => r.SaveChangesAsync(It.IsAny<CancellationToken>()))
|
||||
.Callback<CancellationToken>(_ =>
|
||||
{
|
||||
if (added != null && added.Id == 0) added.Id = 99;
|
||||
})
|
||||
.ReturnsAsync(1);
|
||||
|
||||
string? auditedEntityId = null;
|
||||
_auditMock.Setup(a => a.LogAsync(
|
||||
It.IsAny<string>(),
|
||||
"Create",
|
||||
"TemplateAlarm",
|
||||
It.IsAny<string>(),
|
||||
It.IsAny<string>(),
|
||||
It.IsAny<object?>(),
|
||||
It.IsAny<CancellationToken>()))
|
||||
.Callback<string, string, string, string, string, object?, CancellationToken>(
|
||||
(_, _, _, entityId, _, _, _) => auditedEntityId = entityId)
|
||||
.Returns(Task.CompletedTask);
|
||||
|
||||
var alarm = new TemplateAlarm("HighTemp")
|
||||
{
|
||||
PriorityLevel = 500,
|
||||
TriggerType = AlarmTriggerType.RangeViolation,
|
||||
TriggerConfiguration = """{"Max": 100}"""
|
||||
};
|
||||
var result = await _service.AddAlarmAsync(1, alarm, "admin");
|
||||
|
||||
Assert.True(result.IsSuccess);
|
||||
Assert.Equal("99", auditedEntityId);
|
||||
Assert.NotEqual("0", auditedEntityId);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task AddScript_AuditRowCarriesRealScriptIdNotLiteralZero()
|
||||
{
|
||||
var template = new Template("Pump") { Id = 1 };
|
||||
_repoMock.Setup(r => r.GetTemplateByIdAsync(1, It.IsAny<CancellationToken>())).ReturnsAsync(template);
|
||||
_repoMock.Setup(r => r.GetAllTemplatesAsync(It.IsAny<CancellationToken>()))
|
||||
.ReturnsAsync(new List<Template> { template });
|
||||
|
||||
TemplateScript? added = null;
|
||||
_repoMock.Setup(r => r.AddTemplateScriptAsync(It.IsAny<TemplateScript>(), It.IsAny<CancellationToken>()))
|
||||
.Callback<TemplateScript, CancellationToken>((s, _) => added = s)
|
||||
.Returns(Task.CompletedTask);
|
||||
_repoMock.Setup(r => r.SaveChangesAsync(It.IsAny<CancellationToken>()))
|
||||
.Callback<CancellationToken>(_ =>
|
||||
{
|
||||
if (added != null && added.Id == 0) added.Id = 123;
|
||||
})
|
||||
.ReturnsAsync(1);
|
||||
|
||||
string? auditedEntityId = null;
|
||||
_auditMock.Setup(a => a.LogAsync(
|
||||
It.IsAny<string>(),
|
||||
"Create",
|
||||
"TemplateScript",
|
||||
It.IsAny<string>(),
|
||||
It.IsAny<string>(),
|
||||
It.IsAny<object?>(),
|
||||
It.IsAny<CancellationToken>()))
|
||||
.Callback<string, string, string, string, string, object?, CancellationToken>(
|
||||
(_, _, _, entityId, _, _, _) => auditedEntityId = entityId)
|
||||
.Returns(Task.CompletedTask);
|
||||
|
||||
var script = new TemplateScript("OnStart", "return true;") { TriggerType = "Startup" };
|
||||
var result = await _service.AddScriptAsync(1, script, "admin");
|
||||
|
||||
Assert.True(result.IsSuccess);
|
||||
Assert.Equal("123", auditedEntityId);
|
||||
Assert.NotEqual("0", auditedEntityId);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user