Joseph Doherty
dc9c0c950c
Apply the ZB.MOM.WW. prefix to all gateway-side projects, folders,
.csproj/.sln contents, C# namespaces, using directives, generated proto
C# (csharp_namespace + checked-in generated files), InternalsVisibleTo
attributes, project-name string literals (LoadProject, .sln lookups,
worker exe paths, staticwebassets manifest), and the install/script/doc
references that point at any of the above. Migrate the solution from
.sln to .slnx via `dotnet sln migrate` and delete the old file.
External-runtime identifiers are intentionally NOT prefixed so external
configuration keeps working:
- GatewayMetrics.cs MeterName ("MxGateway.Server")
- DashboardAuthenticationDefaults Scheme/Policy ("MxGateway.Dashboard")
- GatewayRequestLoggingMiddleware logger category ("MxGateway.Request")
- StaRuntime thread name ("MxGateway.Worker.STA")
- appsettings.json root section "MxGateway" + env-var prefix
MxGateway__... and secret-name MxGateway:ApiKeyPepper
- C:\ProgramData\MxGateway\ data dir paths
Also fixes two tests that were not rename-related but became visible
while validating the rename:
- WorkerLiveMxAccessSmokeTests.ShutDownAsync: cancellation that the
gateway service correctly maps to RpcException(Cancelled) per gRPC
convention was being misclassified as a stream fault. Added a sibling
catch on RpcException with StatusCode.Cancelled.
- IntegrationTestEnvironment.ResolveRepositoryRoot: extracted IsRepositoryRoot
and made it accept either a .git marker OR a .sln/.slnx next to src/
so the worker-exe walker works in non-git working copies.
clients/proto/proto-inputs.json's protoRoot updated to point at
src/ZB.MOM.WW.MxGateway.Contracts/Protos.
Verified by `dotnet build` and a full `dotnet test` of the .slnx with
MXGATEWAY_RUN_LIVE_{MXACCESS,LDAP,GALAXY}_TESTS=1:
Tests: 472/472 pass
Worker.Tests: 280/280 pass (4 dev-rig [Fact(Skip=...)] skipped)
IntegrationTests: 18/18 pass
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
73 lines
2.8 KiB
C#
73 lines
2.8 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
using ZB.MOM.WW.MxGateway.Worker.Sta;
|
|
|
|
namespace ZB.MOM.WW.MxGateway.Worker.MxAccess;
|
|
|
|
/// <summary>
|
|
/// Manages the runtime session between the worker and the MXAccess COM instance on an STA thread.
|
|
/// </summary>
|
|
public interface IWorkerRuntimeSession : IDisposable
|
|
{
|
|
/// <summary>
|
|
/// Starts the session, creates the MXAccess COM object, and returns ready metadata.
|
|
/// </summary>
|
|
/// <param name="sessionId">Identifier of the session.</param>
|
|
/// <param name="workerProcessId">ID of the worker process.</param>
|
|
/// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
|
|
/// <returns>Asynchronous task returning worker readiness metadata.</returns>
|
|
Task<WorkerReady> StartAsync(
|
|
string sessionId,
|
|
int workerProcessId,
|
|
CancellationToken cancellationToken = default);
|
|
|
|
/// <summary>
|
|
/// Dispatches an STA command to the MXAccess runtime and returns the reply.
|
|
/// </summary>
|
|
/// <param name="command">STA command to execute on the STA thread.</param>
|
|
/// <returns>Asynchronous task returning the command reply.</returns>
|
|
Task<MxCommandReply> DispatchAsync(StaCommand command);
|
|
|
|
/// <summary>
|
|
/// Captures a heartbeat snapshot of the runtime state.
|
|
/// </summary>
|
|
WorkerRuntimeHeartbeatSnapshot CaptureHeartbeat();
|
|
|
|
/// <summary>
|
|
/// Drains up to the specified number of pending events from the queue.
|
|
/// </summary>
|
|
/// <param name="maxEvents">Maximum number of events to drain.</param>
|
|
/// <returns>List of drained events.</returns>
|
|
IReadOnlyList<WorkerEvent> DrainEvents(uint maxEvents);
|
|
|
|
/// <summary>
|
|
/// Drains a pending fault from the queue, if any.
|
|
/// </summary>
|
|
WorkerFault? DrainFault();
|
|
|
|
/// <summary>
|
|
/// Cancels a pending command by correlation ID.
|
|
/// </summary>
|
|
/// <param name="correlationId">Correlation ID of the command to cancel.</param>
|
|
/// <returns>True if the command was found and cancelled; otherwise, false.</returns>
|
|
bool CancelCommand(string correlationId);
|
|
|
|
/// <summary>
|
|
/// Requests a graceful shutdown of the session.
|
|
/// </summary>
|
|
void RequestShutdown();
|
|
|
|
/// <summary>
|
|
/// Shuts down the session gracefully within the specified timeout.
|
|
/// </summary>
|
|
/// <param name="timeout">Maximum time to allow for graceful shutdown.</param>
|
|
/// <param name="cancellationToken">Token to cancel the asynchronous operation.</param>
|
|
/// <returns>Asynchronous task returning the shutdown result.</returns>
|
|
Task<MxAccessShutdownResult> ShutdownGracefullyAsync(
|
|
TimeSpan timeout,
|
|
CancellationToken cancellationToken = default);
|
|
}
|