refactor(worker): dedupe CreateEnvelope overloads and WorkerPipeClient constructors (mxaccessgw#185)

WorkerPipeSession had seven CreateEnvelope overloads that each forwarded to a
matching CreateBaseEnvelope overload; they are now one overload per body type
that stamps the header and sets the body. WorkerPipeClient's six chained
constructors collapse to one with optional arguments (null attempt timeout =
env/default, null session factory = production WorkerPipeSession). Adds
constructor-validation tests.

Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
This commit is contained in:
Joseph Doherty
2026-11-09 13:03:28 -05:00
parent 2a91e2b083
commit 7d44ecd62d
3 changed files with 66 additions and 129 deletions
@@ -33,93 +33,25 @@ public sealed class WorkerPipeClient : IWorkerPipeClient
private readonly IWorkerLogger? _logger;
/// <summary>
/// Initializes a worker pipe client with default timeouts.
/// </summary>
public WorkerPipeClient()
: this(null, DefaultConnectTimeoutMilliseconds)
{
}
/// <summary>
/// Initializes a worker pipe client with a logger and default timeouts.
/// </summary>
/// <param name="logger">Optional logger for diagnostic output.</param>
public WorkerPipeClient(IWorkerLogger? logger)
: this(logger, DefaultConnectTimeoutMilliseconds)
{
}
/// <summary>
/// Initializes a worker pipe client with a custom overall connect timeout.
/// </summary>
/// <param name="connectTimeoutMilliseconds">Overall connection timeout in milliseconds.</param>
public WorkerPipeClient(int connectTimeoutMilliseconds)
: this(null, connectTimeoutMilliseconds)
{
}
/// <summary>
/// Initializes a worker pipe client with custom timeouts and a session factory.
/// </summary>
/// <param name="connectTimeoutMilliseconds">Overall connection timeout in milliseconds.</param>
/// <param name="sessionFactory">Factory creating the worker pipe session.</param>
public WorkerPipeClient(
int connectTimeoutMilliseconds,
Func<Stream, WorkerFrameProtocolOptions, WorkerPipeSession> sessionFactory)
: this(
null,
connectTimeoutMilliseconds,
ResolveDefaultConnectAttemptTimeoutMilliseconds(),
(stream, frameOptions, _) => sessionFactory(stream, frameOptions))
{
}
/// <summary>
/// Initializes a worker pipe client with a logger and custom overall timeout.
/// Initializes a worker pipe client. Every argument is optional: production passes only a
/// logger, and tests override the timeouts and the session factory.
/// </summary>
/// <param name="logger">Optional logger for diagnostic output.</param>
/// <param name="connectTimeoutMilliseconds">Overall connection timeout in milliseconds.</param>
/// <param name="connectAttemptTimeoutMilliseconds">
/// Per-attempt connection timeout in milliseconds; <see langword="null"/> resolves
/// <see cref="WorkerLaunchEnvironment.PipeConnectAttemptTimeoutMilliseconds"/> from the
/// environment, falling back to <see cref="DefaultConnectAttemptTimeoutMilliseconds"/>.
/// </param>
/// <param name="sessionFactory">
/// Factory creating the worker pipe session; <see langword="null"/> constructs the production
/// <see cref="WorkerPipeSession"/>.
/// </param>
public WorkerPipeClient(
IWorkerLogger? logger,
int connectTimeoutMilliseconds)
: this(
logger,
connectTimeoutMilliseconds,
ResolveDefaultConnectAttemptTimeoutMilliseconds(),
(stream, frameOptions, workerLogger) => new WorkerPipeSession(stream, frameOptions, workerLogger))
{
}
/// <summary>
/// Initializes a worker pipe client with logger, timeouts, and a session factory.
/// </summary>
/// <param name="logger">Optional logger for diagnostic output.</param>
/// <param name="connectTimeoutMilliseconds">Overall connection timeout in milliseconds.</param>
/// <param name="sessionFactory">Factory creating the worker pipe session.</param>
public WorkerPipeClient(
IWorkerLogger? logger,
int connectTimeoutMilliseconds,
Func<Stream, WorkerFrameProtocolOptions, IWorkerLogger?, WorkerPipeSession> sessionFactory)
: this(
logger,
connectTimeoutMilliseconds,
ResolveDefaultConnectAttemptTimeoutMilliseconds(),
sessionFactory)
{
}
/// <summary>
/// Initializes a worker pipe client with full configuration.
/// </summary>
/// <param name="logger">Optional logger for diagnostic output.</param>
/// <param name="connectTimeoutMilliseconds">Overall connection timeout in milliseconds.</param>
/// <param name="connectAttemptTimeoutMilliseconds">Per-attempt connection timeout in milliseconds.</param>
/// <param name="sessionFactory">Factory creating the worker pipe session.</param>
public WorkerPipeClient(
IWorkerLogger? logger,
int connectTimeoutMilliseconds,
int connectAttemptTimeoutMilliseconds,
Func<Stream, WorkerFrameProtocolOptions, IWorkerLogger?, WorkerPipeSession> sessionFactory)
IWorkerLogger? logger = null,
int connectTimeoutMilliseconds = DefaultConnectTimeoutMilliseconds,
int? connectAttemptTimeoutMilliseconds = null,
Func<Stream, WorkerFrameProtocolOptions, IWorkerLogger?, WorkerPipeSession>? sessionFactory = null)
{
if (connectTimeoutMilliseconds <= 0)
{
@@ -128,7 +60,9 @@ public sealed class WorkerPipeClient : IWorkerPipeClient
"Worker pipe connect timeout must be greater than zero.");
}
if (connectAttemptTimeoutMilliseconds <= 0)
int attemptTimeoutMilliseconds =
connectAttemptTimeoutMilliseconds ?? ResolveDefaultConnectAttemptTimeoutMilliseconds();
if (attemptTimeoutMilliseconds <= 0)
{
throw new ArgumentOutOfRangeException(
nameof(connectAttemptTimeoutMilliseconds),
@@ -136,9 +70,10 @@ public sealed class WorkerPipeClient : IWorkerPipeClient
}
_logger = logger;
_sessionFactory = sessionFactory ?? throw new ArgumentNullException(nameof(sessionFactory));
_sessionFactory = sessionFactory
?? ((stream, frameOptions, workerLogger) => new WorkerPipeSession(stream, frameOptions, workerLogger));
_connectTimeoutMilliseconds = connectTimeoutMilliseconds;
_connectAttemptTimeoutMilliseconds = connectAttemptTimeoutMilliseconds;
_connectAttemptTimeoutMilliseconds = attemptTimeoutMilliseconds;
}
/// <inheritdoc />
@@ -1550,63 +1550,31 @@ public sealed class WorkerPipeSession
}
}
private WorkerEnvelope CreateEnvelope(WorkerHello hello)
{
return CreateBaseEnvelope(hello);
}
private WorkerEnvelope CreateEnvelope(WorkerReady ready)
{
return CreateBaseEnvelope(ready);
}
private WorkerEnvelope CreateEnvelope(WorkerFault fault)
{
return CreateBaseEnvelope(fault);
}
private WorkerEnvelope CreateEnvelope(WorkerCommandReply reply)
{
return CreateBaseEnvelope(reply);
}
private WorkerEnvelope CreateEnvelope(WorkerEvent workerEvent)
{
return CreateBaseEnvelope(workerEvent);
}
private WorkerEnvelope CreateEnvelope(WorkerShutdownAck shutdownAck)
{
return CreateBaseEnvelope(shutdownAck);
}
private WorkerEnvelope CreateEnvelope(WorkerHeartbeat heartbeat)
{
return CreateBaseEnvelope(heartbeat);
}
private WorkerEnvelope CreateBaseEnvelope(WorkerHello body)
// One overload per outbound body type: a protobuf oneof has a distinct setter per case, so the
// overloads cannot collapse further without reflection. Each stamps the shared header through
// CreateBaseEnvelope and assigns its body.
private WorkerEnvelope CreateEnvelope(WorkerHello body)
{
WorkerEnvelope envelope = CreateBaseEnvelope();
envelope.WorkerHello = body;
return envelope;
}
private WorkerEnvelope CreateBaseEnvelope(WorkerReady body)
private WorkerEnvelope CreateEnvelope(WorkerReady body)
{
WorkerEnvelope envelope = CreateBaseEnvelope();
envelope.WorkerReady = body;
return envelope;
}
private WorkerEnvelope CreateBaseEnvelope(WorkerFault body)
private WorkerEnvelope CreateEnvelope(WorkerFault body)
{
WorkerEnvelope envelope = CreateBaseEnvelope();
envelope.WorkerFault = body;
return envelope;
}
private WorkerEnvelope CreateBaseEnvelope(WorkerCommandReply body)
private WorkerEnvelope CreateEnvelope(WorkerCommandReply body)
{
WorkerEnvelope envelope = CreateBaseEnvelope();
envelope.CorrelationId = body.Reply?.CorrelationId ?? string.Empty;
@@ -1614,21 +1582,21 @@ public sealed class WorkerPipeSession
return envelope;
}
private WorkerEnvelope CreateBaseEnvelope(WorkerEvent body)
private WorkerEnvelope CreateEnvelope(WorkerEvent body)
{
WorkerEnvelope envelope = CreateBaseEnvelope();
envelope.WorkerEvent = body;
return envelope;
}
private WorkerEnvelope CreateBaseEnvelope(WorkerShutdownAck body)
private WorkerEnvelope CreateEnvelope(WorkerShutdownAck body)
{
WorkerEnvelope envelope = CreateBaseEnvelope();
envelope.WorkerShutdownAck = body;
return envelope;
}
private WorkerEnvelope CreateBaseEnvelope(WorkerHeartbeat body)
private WorkerEnvelope CreateEnvelope(WorkerHeartbeat body)
{
WorkerEnvelope envelope = CreateBaseEnvelope();
envelope.WorkerHeartbeat = body;