Joseph Doherty
513fa1aa16
Comment/XML-doc changes only: - add summaries to ~10k test methods, fixtures, fakes and helpers (+ <param> on theories, <returns> on async Task methods, <inheritdoc/> on interface implementations the checker can resolve) - strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N, #NN, Component-0NN) from comments, keeping the explanatory text; reword false positives in comments only - real docs on fakes implementing BCL/library interfaces (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime) - reword the last 5 src/ false positives (CWE-1236, failures-1, year-0001, M365) Only non-comment edits: four one-line nested classes split across lines so members can carry docs. Build 0 errors / 0 warnings.
98 lines
4.2 KiB
C#
98 lines
4.2 KiB
C#
using Microsoft.Extensions.Caching.Memory;
|
|
using NSubstitute;
|
|
using ZB.MOM.WW.ScadaBridge.CentralUI.ScriptAnalysis;
|
|
using ZB.MOM.WW.ScadaBridge.TemplateEngine;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CentralUI.Tests.ScriptAnalysis;
|
|
|
|
/// <summary>
|
|
/// Regression tests for sync-over-async shared-script resolution. <c>ResolveCalledShape</c> resolved shared
|
|
/// script shapes with <c>_sharedScripts.GetShapesAsync().GetAwaiter().GetResult()</c>
|
|
/// — a sync-over-async block on a request thread that risks thread-pool
|
|
/// starvation and deadlock. <c>Hover</c> and <c>SignatureHelp</c> were synchronous
|
|
/// purely to accommodate that block. The fix makes both methods async and
|
|
/// <c>await</c>s the catalog.
|
|
/// </summary>
|
|
public class ScriptAnalysisAsyncResolveTests
|
|
{
|
|
private readonly ISharedScriptCatalog _catalog = Substitute.For<ISharedScriptCatalog>();
|
|
private readonly IMemoryCache _cache = new MemoryCache(new MemoryCacheOptions { SizeLimit = 100 });
|
|
private readonly IServiceProvider _services = Substitute.For<IServiceProvider>();
|
|
private readonly ScriptAnalysisService _svc;
|
|
|
|
/// <summary>Initializes the test class and its script analysis service.</summary>
|
|
public ScriptAnalysisAsyncResolveTests()
|
|
{
|
|
_catalog.GetShapesAsync().Returns(Array.Empty<ScriptShape>());
|
|
_svc = new ScriptAnalysisService(_catalog, _cache, _services);
|
|
}
|
|
|
|
private static ScriptShape Shape(string name, params ParameterShape[] ps) => new(name, ps, null);
|
|
private static ParameterShape Param(string name, string type) => new(name, type, true);
|
|
|
|
/// <summary>Verifies that hover on a shared-call name awaits the catalog and resolves the call shape.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task HoverAsync_OnSharedCallName_AwaitsCatalog_AndResolvesShape()
|
|
{
|
|
// The catalog only completes after yielding — a truly asynchronous
|
|
// source. The fixed Hover awaits it instead of blocking.
|
|
_catalog.GetShapesAsync().Returns(async _ =>
|
|
{
|
|
await Task.Yield();
|
|
return (IReadOnlyList<ScriptShape>)new[]
|
|
{
|
|
Shape("Aggregate", Param("window", "Integer")),
|
|
};
|
|
});
|
|
|
|
var resp = await _svc.Hover(new HoverRequest(
|
|
CodeText: "var r = Scripts.CallShared(\"Aggregate\");",
|
|
Line: 1,
|
|
Column: 30));
|
|
|
|
Assert.NotNull(resp.Markdown);
|
|
Assert.Contains("shared script", resp.Markdown);
|
|
Assert.Contains("Aggregate", resp.Markdown);
|
|
}
|
|
|
|
/// <summary>Verifies that signature help inside a shared call awaits the catalog and resolves the parameters.</summary>
|
|
/// <returns>A task that represents the asynchronous operation.</returns>
|
|
[Fact]
|
|
public async Task SignatureHelpAsync_InsideSharedCall_AwaitsCatalog_AndResolvesParameters()
|
|
{
|
|
_catalog.GetShapesAsync().Returns(async _ =>
|
|
{
|
|
await Task.Yield();
|
|
return (IReadOnlyList<ScriptShape>)new[]
|
|
{
|
|
Shape("Aggregate", Param("window", "Integer"), Param("mode", "String")),
|
|
};
|
|
});
|
|
|
|
var resp = await _svc.SignatureHelp(new SignatureHelpRequest(
|
|
CodeText: "var r = Scripts.CallShared(\"Aggregate\", ",
|
|
Line: 1,
|
|
Column: 41));
|
|
|
|
Assert.NotNull(resp.Label);
|
|
Assert.Contains("Aggregate", resp.Label!);
|
|
Assert.Equal(2, resp.Parameters!.Count);
|
|
}
|
|
|
|
/// <summary>Verifies that hover and signature help are asynchronous rather than sync-over-async.</summary>
|
|
[Fact]
|
|
public void HoverAndSignatureHelp_AreAsync_NotSyncOverAsync()
|
|
{
|
|
// Structural guard: the methods must return Task so the catalog can be
|
|
// awaited rather than blocked with .GetAwaiter().GetResult().
|
|
var hover = typeof(ScriptAnalysisService).GetMethod(nameof(ScriptAnalysisService.Hover));
|
|
var sigHelp = typeof(ScriptAnalysisService).GetMethod(nameof(ScriptAnalysisService.SignatureHelp));
|
|
|
|
Assert.NotNull(hover);
|
|
Assert.NotNull(sigHelp);
|
|
Assert.Equal(typeof(Task<HoverResponse>), hover!.ReturnType);
|
|
Assert.Equal(typeof(Task<SignatureHelpResponse>), sigHelp!.ReturnType);
|
|
}
|
|
}
|