Joseph Doherty
a0203503a7
Re-reviewed every module/client against the 10-category checklist
(REVIEW-PROCESS.md) at commit 1cd51bb, filed 72 new findings, and
fixed them in three priority waves (3 High, 17 Medium, 52 Low).
Highs
- Server-017: enumerate AcknowledgeAlarm / QueryActiveAlarms in
GatewayGrpcScopeResolver so non-admin keys can use them; document
the mapping in docs/Authorization.md; add interceptor tests.
- Client.Java-013: add the five missing bulk-method stubs to the
CLI FakeSession so the test module compiles on a clean tree.
- Client.Rust-013: fix the clippy::doc_lazy_continuation regression
in generated tonic code by reformatting the ReadBulkCommand proto
comment and scoping a #![allow(...)] to the generated submodules.
Mediums (highlights)
- Server: unify GatewaySession state-lock discipline (-015) and
make DisposeAsync race-safe against in-flight CloseAsync (-016);
add constraint-enforcement test coverage for the bulk-plan path
(-021).
- Worker: introduce StaRuntimeShutdownException so RunAlarmPollLoop
can distinguish graceful shutdown from a real STA-affinity
violation (-016); have the watchdog skip StaHung while
CurrentCommandCorrelationId is non-empty so a legitimate slow
ReadBulk no longer self-faults (-017).
- Tests: add per-method round-trip + cancellation coverage for the
11 GatewaySession bulk methods (-013); replace the real TCP probe
in GalaxyHierarchyCacheTests with an IGalaxyRepository fake
(-016).
- IntegrationTests: drive the StreamEvents writer in the live Write
test and assert OnWriteComplete (-012); add live tests for
Unadvise/RemoveItem/Unregister ordering, WriteSecured, and
abnormal worker exit (-014).
- Worker.Tests: replace MxAccessSession reflection with an internal
CreateForTesting factory (-016); cover WorkerCancel and
unexpected-body envelope branches (-017).
- Client.Java: cancel MxEventStream when close() races
beforeStart() (-014); return a CancellingCompletableFuture that
actually forwards cancellation through .thenApply chains (-015).
- Client.Python: drop the silent localhost-plaintext downgrade in
the CLI; require explicit --plaintext (-013).
- Client.Rust: stop bench-read-bulk from polluting success-latency
histograms with failed-call durations (-015); add coverage for
the five MalformedReply paths, the bulk-write helpers, the
Error::Unavailable mapping, and the unary-fault path (-016).
- Contracts: extend docs/Contracts.md with the bulk read/write
command family (-009).
Lows (highlights)
- Server: cap GalaxyGlobMatcher.RegexCache; align
WorkerAlarmRpcDispatcher missing-session handling; drop the
duplicate dashboard @page routes; refresh IAlarmRpcDispatcher
XML doc.
- Worker: surface SetXmlAlarmQuery COM failures; remove dead
subscriptionExpression / ExecutingCommand arms; preserve
factory-supplied runtime sessions; split MxAlarmSnapshot.cs into
three files.
- Tests: dispose the WebApplication in seven test classes; rebuild
FakeWorkerProcess.WaitForExitAsync against a real TaskCompletion
source; switch the heartbeat-expires test to ManualTimeProvider;
add InvariantCulture to the remaining DateTimeOffset.Parse sites;
document GalaxyFilterInputSafetyTests in GatewayTesting.md.
- IntegrationTests: comment fixes, RecordingServerStreamWriter
IDisposable, class-level [Trait], single-source ZB default
connection string.
- Worker.Tests: replace silent-return gating with LiveMxAccessFact
so absent env vars SKIP not pass; PascalCase rename of probe
[Fact]s; deterministic deadline test; new frame-protocol error
tests; ComputeTransitions diff-coverage; relocate dev-rig probes
to Probes/.
- Contracts: add round-trip coverage and per-field redaction /
Galaxy-identifier comments to the protos.
- Client.Dotnet: introduce clients/dotnet/Directory.Build.props so
TreatWarningsAsErrors / analysers apply; document
DiscoverHierarchyOptions and IMxGatewayCliClient; require typed
bulk-read handles in CLI; surface AcknowledgeAlarm transport
faults through Translate().
- Client.Go: kill dead code in alarms_test / fakeGalaxyServer /
runWriteBulkVariant; document the six new subcommands in
writeUsage; drain galaxy-watch events on limit; switch io.EOF
comparisons to errors.Is.
- Client.Java: shared shutdown helpers + new shutdownTimeout
option; regex-based credential redaction; Long.toUnsignedString
for uint64 sequence; doc fixes.
- Client.Python: combine duplicate imports; add coverage for
_percentile / bench-read-bulk / MAX_AGGREGATE_EVENTS /
_api_key_from_env; populate pyproject metadata and ship py.typed.
- Client.Rust: expose next_correlation_id() so CLI ping/close
stop hard-coding correlation IDs; resync RustClientDesign.md
with the current Session / Error surface and CLI subcommand set.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
68 lines
2.5 KiB
C#
68 lines
2.5 KiB
C#
namespace MxGateway.Client;
|
|
|
|
/// <summary>
|
|
/// Server-side filters and shape options for
|
|
/// <see cref="GalaxyRepositoryClient.DiscoverHierarchyAsync(DiscoverHierarchyOptions, System.Threading.CancellationToken)"/>.
|
|
/// Each property maps directly to the corresponding field on the
|
|
/// <c>DiscoverHierarchyRequest</c> proto so the gateway can narrow the
|
|
/// hierarchy walk before serializing it back to the client.
|
|
/// </summary>
|
|
public sealed record DiscoverHierarchyOptions
|
|
{
|
|
/// <summary>
|
|
/// Root Galaxy object id to start the walk from. When set, takes
|
|
/// precedence over <see cref="RootTagName"/> and <see cref="RootContainedPath"/>.
|
|
/// </summary>
|
|
public int? RootGobjectId { get; init; }
|
|
|
|
/// <summary>
|
|
/// Root tag (assigned) name to start the walk from. Used when
|
|
/// <see cref="RootGobjectId"/> is null.
|
|
/// </summary>
|
|
public string? RootTagName { get; init; }
|
|
|
|
/// <summary>
|
|
/// Root contained-name dotted path to start the walk from. Used when
|
|
/// neither <see cref="RootGobjectId"/> nor <see cref="RootTagName"/> are set.
|
|
/// </summary>
|
|
public string? RootContainedPath { get; init; }
|
|
|
|
/// <summary>
|
|
/// Maximum traversal depth below the root, inclusive. Leave null for the
|
|
/// server default (unbounded).
|
|
/// </summary>
|
|
public int? MaxDepth { get; init; }
|
|
|
|
/// <summary>
|
|
/// Galaxy category ids to include. Empty means all categories.
|
|
/// </summary>
|
|
public IReadOnlyList<int> CategoryIds { get; init; } = Array.Empty<int>();
|
|
|
|
/// <summary>
|
|
/// Template tag names that must appear somewhere in each returned
|
|
/// object's template chain. Empty means no template filter.
|
|
/// </summary>
|
|
public IReadOnlyList<string> TemplateChainContains { get; init; } = Array.Empty<string>();
|
|
|
|
/// <summary>
|
|
/// Optional glob (e.g. <c>"Tank*"</c>) matched against each object's tag name.
|
|
/// </summary>
|
|
public string? TagNameGlob { get; init; }
|
|
|
|
/// <summary>
|
|
/// When set, overrides whether each returned <c>GalaxyObject</c> includes
|
|
/// its dynamic attribute list. Leave null to use the server default.
|
|
/// </summary>
|
|
public bool? IncludeAttributes { get; init; }
|
|
|
|
/// <summary>
|
|
/// When true, restrict results to objects that bear at least one configured alarm.
|
|
/// </summary>
|
|
public bool AlarmBearingOnly { get; init; }
|
|
|
|
/// <summary>
|
|
/// When true, restrict results to objects that have at least one historized attribute.
|
|
/// </summary>
|
|
public bool HistorizedOnly { get; init; }
|
|
}
|