Files
mxaccessgw/src/ZB.MOM.WW.MxGateway.Worker.Tests/Ipc/WorkerPipeSessionOptionsTests.cs
T
Joseph Doherty 22964e192b
ci / nightly-windev (push) Has been skipped
ci / windows-x86 (push) Successful in 1m24s
ci / java (push) Successful in 2m15s
ci / portable (push) Failing after 4m17s
feat(gateway,worker): configurable worker watchdog grace; heartbeat settings in effective config and Settings page (mxaccessgw#224)
- New MxGateway:Worker:WorkerHeartbeatGraceSeconds (default 15), exported as
  MXGATEWAY_WORKER_HEARTBEAT_GRACE_MS and read by WorkerPipeSessionOptions.FromEnvironment
  (a grace the ceiling does not exceed falls back to the default so the worker
  still starts). Validation now checks WorkerHeartbeatStuckCeilingSeconds against
  the configured grace; the copied WorkerWatchdogGraceSeconds constant is gone.
- EffectiveWorkerConfiguration and the dashboard Settings page now show the worker
  heartbeat send interval, watchdog grace and stuck ceiling (render test added).
- Docs updated.

Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
2026-11-09 13:29:10 -05:00

98 lines
4.4 KiB
C#

using System;
using System.Collections.Generic;
using ZB.MOM.WW.MxGateway.Contracts;
using ZB.MOM.WW.MxGateway.Worker.Ipc;
namespace ZB.MOM.WW.MxGateway.Worker.Tests.Ipc;
/// <summary>
/// Covers <see cref="WorkerPipeSessionOptions.FromEnvironment"/>: the gateway conveys the
/// worker's heartbeat send interval and watchdog stuck ceiling through the launch environment
/// (mxaccessgw#218), and a bad value must fall back rather than keep the worker from starting.
/// </summary>
public sealed class WorkerPipeSessionOptionsTests
{
/// <summary>Verifies that launcher-provided values replace the compiled defaults.</summary>
[Fact]
public void FromEnvironment_WithLauncherValues_UsesThem()
{
WorkerPipeSessionOptions options = WorkerPipeSessionOptions.FromEnvironment(Lookup(
(WorkerLaunchEnvironment.HeartbeatSendIntervalMilliseconds, "3000"),
(WorkerLaunchEnvironment.HeartbeatStuckCeilingMilliseconds, "240000")));
Assert.Equal(TimeSpan.FromSeconds(3), options.HeartbeatInterval);
Assert.Equal(TimeSpan.FromSeconds(240), options.HeartbeatStuckCeiling);
Assert.Equal(WorkerPipeSessionOptions.DefaultHeartbeatGrace, options.HeartbeatGrace);
options.Validate();
}
/// <summary>Verifies that a launcher-provided grace replaces the compiled default (mxaccessgw#224).</summary>
[Fact]
public void FromEnvironment_WithGrace_UsesItAndStaysValid()
{
WorkerPipeSessionOptions options = WorkerPipeSessionOptions.FromEnvironment(Lookup(
(WorkerLaunchEnvironment.HeartbeatGraceMilliseconds, "30000"),
(WorkerLaunchEnvironment.HeartbeatStuckCeilingMilliseconds, "120000")));
Assert.Equal(TimeSpan.FromSeconds(30), options.HeartbeatGrace);
Assert.Equal(TimeSpan.FromSeconds(120), options.HeartbeatStuckCeiling);
options.Validate();
}
/// <summary>Verifies that a grace the ceiling does not exceed is dropped rather than failing the worker.</summary>
[Fact]
public void FromEnvironment_WithGraceAtOrAboveCeiling_FallsBackToDefaultGrace()
{
WorkerPipeSessionOptions options = WorkerPipeSessionOptions.FromEnvironment(Lookup(
(WorkerLaunchEnvironment.HeartbeatGraceMilliseconds, "80000")));
Assert.Equal(WorkerPipeSessionOptions.DefaultHeartbeatGrace, options.HeartbeatGrace);
Assert.Equal(WorkerPipeSessionOptions.DefaultHeartbeatStuckCeiling, options.HeartbeatStuckCeiling);
options.Validate();
}
/// <summary>Verifies that an absent environment yields the compiled defaults.</summary>
[Fact]
public void FromEnvironment_WithNothingSet_KeepsDefaults()
{
WorkerPipeSessionOptions options = WorkerPipeSessionOptions.FromEnvironment(Lookup());
Assert.Equal(WorkerPipeSessionOptions.DefaultHeartbeatInterval, options.HeartbeatInterval);
Assert.Equal(WorkerPipeSessionOptions.DefaultHeartbeatStuckCeiling, options.HeartbeatStuckCeiling);
}
/// <summary>
/// Verifies that unusable values fall back to the defaults, including a ceiling that would
/// fail <see cref="WorkerPipeSessionOptions.Validate"/> by not exceeding the grace.
/// </summary>
/// <param name="interval">Send-interval environment value.</param>
/// <param name="ceiling">Stuck-ceiling environment value.</param>
[Theory]
[InlineData("0", "0")]
[InlineData("-5", "-5")]
[InlineData("abc", "1.5")]
[InlineData("", "15000")]
[InlineData("99999999999", "99999999999")]
public void FromEnvironment_WithUnusableValues_FallsBackToDefaults(string interval, string ceiling)
{
WorkerPipeSessionOptions options = WorkerPipeSessionOptions.FromEnvironment(Lookup(
(WorkerLaunchEnvironment.HeartbeatSendIntervalMilliseconds, interval),
(WorkerLaunchEnvironment.HeartbeatStuckCeilingMilliseconds, ceiling)));
Assert.Equal(WorkerPipeSessionOptions.DefaultHeartbeatInterval, options.HeartbeatInterval);
Assert.Equal(WorkerPipeSessionOptions.DefaultHeartbeatStuckCeiling, options.HeartbeatStuckCeiling);
options.Validate();
}
private static Func<string, string?> Lookup(params (string Name, string Value)[] values)
{
Dictionary<string, string> map = new(StringComparer.Ordinal);
foreach ((string name, string value) in values)
{
map[name] = value;
}
return name => map.TryGetValue(name, out string? value) ? value : null;
}
}