feat(monitoring+events): add connz filtering, event payloads, and message trace context (E12+E13+E14)
- Add ConnzHandler with sorting, filtering, pagination, CID lookup, and closed connection ring buffer - Add full Go events.go parity types (ConnectEventMsg, DisconnectEventMsg, ServerStatsMsg, etc.) - Add MessageTraceContext for per-message trace propagation with header parsing - 74 new tests (17 ConnzFilter + 16 EventPayload + 41 MessageTraceContext)
This commit is contained in:
Joseph Doherty
469
tests/NATS.Server.Tests/Events/EventPayloadTests.cs
Normal file
469
tests/NATS.Server.Tests/Events/EventPayloadTests.cs
Normal file
@@ -0,0 +1,469 @@
|
||||
using System.Text.Json;
|
||||
using NATS.Server.Events;
|
||||
|
||||
namespace NATS.Server.Tests.Events;
|
||||
|
||||
/// <summary>
|
||||
/// Tests that all event DTOs have complete JSON fields matching Go's output.
|
||||
/// Go reference: events.go:100-300 — TypedEvent, ServerInfo, ClientInfo,
|
||||
/// DataStats, ServerStats, ConnectEventMsg, DisconnectEventMsg, AccountNumConns.
|
||||
/// </summary>
|
||||
public class EventPayloadTests
|
||||
{
|
||||
// --- EventServerInfo ---
|
||||
|
||||
[Fact]
|
||||
public void EventServerInfo_serializes_all_fields_matching_Go()
|
||||
{
|
||||
var info = new EventServerInfo
|
||||
{
|
||||
Name = "test-server",
|
||||
Host = "127.0.0.1",
|
||||
Id = "ABCDEF123456",
|
||||
Cluster = "test-cluster",
|
||||
Domain = "test-domain",
|
||||
Version = "2.10.0",
|
||||
Tags = ["tag1", "tag2"],
|
||||
Metadata = new Dictionary<string, string> { ["env"] = "test" },
|
||||
JetStream = true,
|
||||
Flags = 1,
|
||||
Seq = 42,
|
||||
Time = new DateTime(2025, 1, 1, 0, 0, 0, DateTimeKind.Utc),
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(info);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.GetProperty("name").GetString().ShouldBe("test-server");
|
||||
root.GetProperty("host").GetString().ShouldBe("127.0.0.1");
|
||||
root.GetProperty("id").GetString().ShouldBe("ABCDEF123456");
|
||||
root.GetProperty("cluster").GetString().ShouldBe("test-cluster");
|
||||
root.GetProperty("domain").GetString().ShouldBe("test-domain");
|
||||
root.GetProperty("ver").GetString().ShouldBe("2.10.0");
|
||||
root.GetProperty("tags").GetArrayLength().ShouldBe(2);
|
||||
root.GetProperty("metadata").GetProperty("env").GetString().ShouldBe("test");
|
||||
root.GetProperty("jetstream").GetBoolean().ShouldBeTrue();
|
||||
root.GetProperty("flags").GetUInt64().ShouldBe(1UL);
|
||||
root.GetProperty("seq").GetUInt64().ShouldBe(42UL);
|
||||
root.GetProperty("time").GetDateTime().Year.ShouldBe(2025);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void EventServerInfo_omits_null_optional_fields()
|
||||
{
|
||||
var info = new EventServerInfo
|
||||
{
|
||||
Name = "s",
|
||||
Id = "ID",
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(info);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.TryGetProperty("cluster", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("domain", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("tags", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("metadata", out _).ShouldBeFalse();
|
||||
}
|
||||
|
||||
// --- EventClientInfo ---
|
||||
|
||||
[Fact]
|
||||
public void EventClientInfo_serializes_all_fields_matching_Go()
|
||||
{
|
||||
var ci = new EventClientInfo
|
||||
{
|
||||
Start = new DateTime(2025, 1, 1, 0, 0, 0, DateTimeKind.Utc),
|
||||
Stop = new DateTime(2025, 1, 1, 1, 0, 0, DateTimeKind.Utc),
|
||||
Host = "10.0.0.1",
|
||||
Id = 99,
|
||||
Account = "$G",
|
||||
Service = "orders",
|
||||
User = "admin",
|
||||
Name = "my-client",
|
||||
Lang = "go",
|
||||
Version = "1.30.0",
|
||||
RttNanos = 5_000_000, // 5ms
|
||||
Server = "srv-1",
|
||||
Cluster = "cluster-east",
|
||||
Alternates = ["alt1", "alt2"],
|
||||
Jwt = "eyJ...",
|
||||
IssuerKey = "OABC...",
|
||||
NameTag = "test-tag",
|
||||
Tags = ["dev"],
|
||||
Kind = "Client",
|
||||
ClientType = "nats",
|
||||
MqttClient = "mqtt-abc",
|
||||
Nonce = "nonce123",
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(ci);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.GetProperty("host").GetString().ShouldBe("10.0.0.1");
|
||||
root.GetProperty("id").GetUInt64().ShouldBe(99UL);
|
||||
root.GetProperty("acc").GetString().ShouldBe("$G");
|
||||
root.GetProperty("svc").GetString().ShouldBe("orders");
|
||||
root.GetProperty("user").GetString().ShouldBe("admin");
|
||||
root.GetProperty("name").GetString().ShouldBe("my-client");
|
||||
root.GetProperty("lang").GetString().ShouldBe("go");
|
||||
root.GetProperty("ver").GetString().ShouldBe("1.30.0");
|
||||
root.GetProperty("rtt").GetInt64().ShouldBe(5_000_000);
|
||||
root.GetProperty("server").GetString().ShouldBe("srv-1");
|
||||
root.GetProperty("cluster").GetString().ShouldBe("cluster-east");
|
||||
root.GetProperty("alts").GetArrayLength().ShouldBe(2);
|
||||
root.GetProperty("jwt").GetString().ShouldBe("eyJ...");
|
||||
root.GetProperty("issuer_key").GetString().ShouldBe("OABC...");
|
||||
root.GetProperty("name_tag").GetString().ShouldBe("test-tag");
|
||||
root.GetProperty("tags").GetArrayLength().ShouldBe(1);
|
||||
root.GetProperty("kind").GetString().ShouldBe("Client");
|
||||
root.GetProperty("client_type").GetString().ShouldBe("nats");
|
||||
root.GetProperty("client_id").GetString().ShouldBe("mqtt-abc");
|
||||
root.GetProperty("nonce").GetString().ShouldBe("nonce123");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void EventClientInfo_omits_null_optional_fields()
|
||||
{
|
||||
var ci = new EventClientInfo { Id = 1 };
|
||||
var json = JsonSerializer.Serialize(ci);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.TryGetProperty("svc", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("user", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("server", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("cluster", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("alts", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("jwt", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("issuer_key", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("nonce", out _).ShouldBeFalse();
|
||||
}
|
||||
|
||||
// --- DataStats ---
|
||||
|
||||
[Fact]
|
||||
public void DataStats_serializes_with_optional_sub_stats()
|
||||
{
|
||||
var ds = new DataStats
|
||||
{
|
||||
Msgs = 100,
|
||||
Bytes = 2048,
|
||||
Gateways = new MsgBytesStats { Msgs = 10, Bytes = 256 },
|
||||
Routes = new MsgBytesStats { Msgs = 50, Bytes = 1024 },
|
||||
Leafs = new MsgBytesStats { Msgs = 40, Bytes = 768 },
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(ds);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.GetProperty("msgs").GetInt64().ShouldBe(100);
|
||||
root.GetProperty("bytes").GetInt64().ShouldBe(2048);
|
||||
root.GetProperty("gateways").GetProperty("msgs").GetInt64().ShouldBe(10);
|
||||
root.GetProperty("routes").GetProperty("bytes").GetInt64().ShouldBe(1024);
|
||||
root.GetProperty("leafs").GetProperty("msgs").GetInt64().ShouldBe(40);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void DataStats_omits_null_sub_stats()
|
||||
{
|
||||
var ds = new DataStats { Msgs = 5, Bytes = 50 };
|
||||
var json = JsonSerializer.Serialize(ds);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.TryGetProperty("gateways", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("routes", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("leafs", out _).ShouldBeFalse();
|
||||
}
|
||||
|
||||
// --- ConnectEventMsg ---
|
||||
|
||||
[Fact]
|
||||
public void ConnectEventMsg_has_correct_type_and_required_fields()
|
||||
{
|
||||
var evt = new ConnectEventMsg
|
||||
{
|
||||
Id = "evt-1",
|
||||
Time = DateTime.UtcNow,
|
||||
Server = new EventServerInfo { Name = "s1", Id = "SRV1" },
|
||||
Client = new EventClientInfo { Id = 42, Name = "test-client" },
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(evt);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.GetProperty("type").GetString().ShouldBe("io.nats.server.advisory.v1.client_connect");
|
||||
root.GetProperty("id").GetString().ShouldBe("evt-1");
|
||||
root.GetProperty("server").GetProperty("name").GetString().ShouldBe("s1");
|
||||
root.GetProperty("client").GetProperty("id").GetUInt64().ShouldBe(42UL);
|
||||
}
|
||||
|
||||
// --- DisconnectEventMsg ---
|
||||
|
||||
[Fact]
|
||||
public void DisconnectEventMsg_has_correct_type_and_data_stats()
|
||||
{
|
||||
var evt = new DisconnectEventMsg
|
||||
{
|
||||
Id = "evt-2",
|
||||
Time = DateTime.UtcNow,
|
||||
Server = new EventServerInfo { Name = "s1", Id = "SRV1" },
|
||||
Client = new EventClientInfo { Id = 42 },
|
||||
Sent = new DataStats { Msgs = 100, Bytes = 2000 },
|
||||
Received = new DataStats { Msgs = 50, Bytes = 1000 },
|
||||
Reason = "Client Closed",
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(evt);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.GetProperty("type").GetString().ShouldBe("io.nats.server.advisory.v1.client_disconnect");
|
||||
root.GetProperty("sent").GetProperty("msgs").GetInt64().ShouldBe(100);
|
||||
root.GetProperty("received").GetProperty("bytes").GetInt64().ShouldBe(1000);
|
||||
root.GetProperty("reason").GetString().ShouldBe("Client Closed");
|
||||
}
|
||||
|
||||
// --- AccountNumConns ---
|
||||
|
||||
[Fact]
|
||||
public void AccountNumConns_serializes_all_Go_AccountStat_fields()
|
||||
{
|
||||
var evt = new AccountNumConns
|
||||
{
|
||||
Id = "evt-3",
|
||||
Time = DateTime.UtcNow,
|
||||
Server = new EventServerInfo { Name = "s1", Id = "SRV1" },
|
||||
AccountName = "$G",
|
||||
Name = "Global",
|
||||
Connections = 5,
|
||||
LeafNodes = 2,
|
||||
TotalConnections = 100,
|
||||
NumSubscriptions = 42,
|
||||
Sent = new DataStats { Msgs = 500, Bytes = 10_000 },
|
||||
Received = new DataStats { Msgs = 400, Bytes = 8_000 },
|
||||
SlowConsumers = 1,
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(evt);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.GetProperty("type").GetString().ShouldBe("io.nats.server.advisory.v1.account_connections");
|
||||
root.GetProperty("acc").GetString().ShouldBe("$G");
|
||||
root.GetProperty("name").GetString().ShouldBe("Global");
|
||||
root.GetProperty("conns").GetInt32().ShouldBe(5);
|
||||
root.GetProperty("leafnodes").GetInt32().ShouldBe(2);
|
||||
root.GetProperty("total_conns").GetInt32().ShouldBe(100);
|
||||
root.GetProperty("num_subscriptions").GetUInt32().ShouldBe(42u);
|
||||
root.GetProperty("sent").GetProperty("msgs").GetInt64().ShouldBe(500);
|
||||
root.GetProperty("received").GetProperty("bytes").GetInt64().ShouldBe(8_000);
|
||||
root.GetProperty("slow_consumers").GetInt64().ShouldBe(1);
|
||||
}
|
||||
|
||||
// --- ServerStatsMsg ---
|
||||
|
||||
[Fact]
|
||||
public void ServerStatsMsg_has_sent_received_and_breakdown_fields()
|
||||
{
|
||||
var msg = new ServerStatsMsg
|
||||
{
|
||||
Server = new EventServerInfo { Name = "s1", Id = "SRV1", Seq = 1 },
|
||||
Stats = new ServerStatsData
|
||||
{
|
||||
Start = new DateTime(2025, 1, 1, 0, 0, 0, DateTimeKind.Utc),
|
||||
Mem = 100_000_000,
|
||||
Cores = 8,
|
||||
Cpu = 12.5,
|
||||
Connections = 10,
|
||||
TotalConnections = 500,
|
||||
ActiveAccounts = 3,
|
||||
Subscriptions = 50,
|
||||
Sent = new DataStats { Msgs = 1000, Bytes = 50_000 },
|
||||
Received = new DataStats { Msgs = 800, Bytes = 40_000 },
|
||||
InMsgs = 800,
|
||||
OutMsgs = 1000,
|
||||
InBytes = 40_000,
|
||||
OutBytes = 50_000,
|
||||
SlowConsumers = 2,
|
||||
SlowConsumerStats = new SlowConsumersStats { Clients = 1, Routes = 1 },
|
||||
StaleConnections = 3,
|
||||
StaleConnectionStats = new StaleConnectionStats { Clients = 2, Leafs = 1 },
|
||||
ActiveServers = 3,
|
||||
Routes = [new RouteStat { Id = 1, Name = "r1", Sent = new DataStats { Msgs = 10 }, Received = new DataStats { Msgs = 5 }, Pending = 0 }],
|
||||
Gateways = [new GatewayStat { Id = 1, Name = "gw1", Sent = new DataStats { Msgs = 20 }, Received = new DataStats { Msgs = 15 }, InboundConnections = 2 }],
|
||||
},
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(msg);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
var stats = root.GetProperty("statsz");
|
||||
|
||||
stats.GetProperty("mem").GetInt64().ShouldBe(100_000_000);
|
||||
stats.GetProperty("cores").GetInt32().ShouldBe(8);
|
||||
stats.GetProperty("cpu").GetDouble().ShouldBe(12.5);
|
||||
stats.GetProperty("connections").GetInt32().ShouldBe(10);
|
||||
stats.GetProperty("total_connections").GetInt64().ShouldBe(500);
|
||||
stats.GetProperty("active_accounts").GetInt32().ShouldBe(3);
|
||||
stats.GetProperty("subscriptions").GetInt64().ShouldBe(50);
|
||||
stats.GetProperty("sent").GetProperty("msgs").GetInt64().ShouldBe(1000);
|
||||
stats.GetProperty("received").GetProperty("bytes").GetInt64().ShouldBe(40_000);
|
||||
stats.GetProperty("in_msgs").GetInt64().ShouldBe(800);
|
||||
stats.GetProperty("out_msgs").GetInt64().ShouldBe(1000);
|
||||
stats.GetProperty("slow_consumers").GetInt64().ShouldBe(2);
|
||||
stats.GetProperty("slow_consumer_stats").GetProperty("clients").GetInt64().ShouldBe(1);
|
||||
stats.GetProperty("stale_connections").GetInt64().ShouldBe(3);
|
||||
stats.GetProperty("stale_connection_stats").GetProperty("leafs").GetInt64().ShouldBe(1);
|
||||
stats.GetProperty("active_servers").GetInt32().ShouldBe(3);
|
||||
stats.GetProperty("routes").GetArrayLength().ShouldBe(1);
|
||||
stats.GetProperty("routes")[0].GetProperty("rid").GetUInt64().ShouldBe(1UL);
|
||||
stats.GetProperty("gateways").GetArrayLength().ShouldBe(1);
|
||||
stats.GetProperty("gateways")[0].GetProperty("name").GetString().ShouldBe("gw1");
|
||||
}
|
||||
|
||||
// --- AuthErrorEventMsg ---
|
||||
|
||||
[Fact]
|
||||
public void AuthErrorEventMsg_has_correct_type()
|
||||
{
|
||||
var evt = new AuthErrorEventMsg
|
||||
{
|
||||
Id = "evt-4",
|
||||
Time = DateTime.UtcNow,
|
||||
Server = new EventServerInfo { Name = "s1", Id = "SRV1" },
|
||||
Client = new EventClientInfo { Id = 99, Host = "10.0.0.1" },
|
||||
Reason = "Authorization Violation",
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(evt);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.GetProperty("type").GetString().ShouldBe("io.nats.server.advisory.v1.client_auth");
|
||||
root.GetProperty("reason").GetString().ShouldBe("Authorization Violation");
|
||||
root.GetProperty("client").GetProperty("host").GetString().ShouldBe("10.0.0.1");
|
||||
}
|
||||
|
||||
// --- OcspPeerRejectEventMsg ---
|
||||
|
||||
[Fact]
|
||||
public void OcspPeerRejectEventMsg_has_correct_type()
|
||||
{
|
||||
var evt = new OcspPeerRejectEventMsg
|
||||
{
|
||||
Id = "evt-5",
|
||||
Time = DateTime.UtcNow,
|
||||
Kind = "client",
|
||||
Server = new EventServerInfo { Name = "s1", Id = "SRV1" },
|
||||
Reason = "OCSP revoked",
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(evt);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.GetProperty("type").GetString().ShouldBe("io.nats.server.advisory.v1.ocsp_peer_reject");
|
||||
root.GetProperty("kind").GetString().ShouldBe("client");
|
||||
root.GetProperty("reason").GetString().ShouldBe("OCSP revoked");
|
||||
}
|
||||
|
||||
// --- ShutdownEventMsg ---
|
||||
|
||||
[Fact]
|
||||
public void ShutdownEventMsg_serializes_reason()
|
||||
{
|
||||
var evt = new ShutdownEventMsg
|
||||
{
|
||||
Server = new EventServerInfo { Name = "s1", Id = "SRV1" },
|
||||
Reason = "Server Shutdown",
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(evt);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
doc.RootElement.GetProperty("reason").GetString().ShouldBe("Server Shutdown");
|
||||
}
|
||||
|
||||
// --- AccNumConnsReq ---
|
||||
|
||||
[Fact]
|
||||
public void AccNumConnsReq_serializes_account()
|
||||
{
|
||||
var req = new AccNumConnsReq
|
||||
{
|
||||
Server = new EventServerInfo { Name = "s1", Id = "SRV1" },
|
||||
Account = "myAccount",
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(req);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
doc.RootElement.GetProperty("acc").GetString().ShouldBe("myAccount");
|
||||
}
|
||||
|
||||
// --- Round-trip deserialization ---
|
||||
|
||||
[Fact]
|
||||
public void ConnectEventMsg_roundtrips_through_json()
|
||||
{
|
||||
var original = new ConnectEventMsg
|
||||
{
|
||||
Id = "rt-1",
|
||||
Time = new DateTime(2025, 6, 15, 12, 0, 0, DateTimeKind.Utc),
|
||||
Server = new EventServerInfo { Name = "srv", Id = "SRV1", Version = "2.10.0", Seq = 5 },
|
||||
Client = new EventClientInfo
|
||||
{
|
||||
Id = 42,
|
||||
Host = "10.0.0.1",
|
||||
Account = "$G",
|
||||
Name = "test",
|
||||
Lang = "dotnet",
|
||||
Version = "1.0.0",
|
||||
RttNanos = 1_000_000,
|
||||
Kind = "Client",
|
||||
},
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(original);
|
||||
var deserialized = JsonSerializer.Deserialize<ConnectEventMsg>(json);
|
||||
|
||||
deserialized.ShouldNotBeNull();
|
||||
deserialized.Type.ShouldBe(ConnectEventMsg.EventType);
|
||||
deserialized.Id.ShouldBe("rt-1");
|
||||
deserialized.Server.Name.ShouldBe("srv");
|
||||
deserialized.Server.Seq.ShouldBe(5UL);
|
||||
deserialized.Client.Id.ShouldBe(42UL);
|
||||
deserialized.Client.Kind.ShouldBe("Client");
|
||||
deserialized.Client.RttNanos.ShouldBe(1_000_000);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ServerStatsMsg_roundtrips_through_json()
|
||||
{
|
||||
var original = new ServerStatsMsg
|
||||
{
|
||||
Server = new EventServerInfo { Name = "srv", Id = "SRV1" },
|
||||
Stats = new ServerStatsData
|
||||
{
|
||||
Connections = 10,
|
||||
Sent = new DataStats { Msgs = 100, Bytes = 5000 },
|
||||
Received = new DataStats { Msgs = 80, Bytes = 4000 },
|
||||
InMsgs = 80,
|
||||
OutMsgs = 100,
|
||||
},
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(original);
|
||||
var deserialized = JsonSerializer.Deserialize<ServerStatsMsg>(json);
|
||||
|
||||
deserialized.ShouldNotBeNull();
|
||||
deserialized.Stats.Connections.ShouldBe(10);
|
||||
deserialized.Stats.Sent.Msgs.ShouldBe(100);
|
||||
deserialized.Stats.Received.Bytes.ShouldBe(4000);
|
||||
}
|
||||
}
|
||||
628
tests/NATS.Server.Tests/Internal/MessageTraceContextTests.cs
Normal file
628
tests/NATS.Server.Tests/Internal/MessageTraceContextTests.cs
Normal file
@@ -0,0 +1,628 @@
|
||||
using System.Text;
|
||||
using System.Text.Json;
|
||||
using NATS.Server.Events;
|
||||
using NATS.Server.Internal;
|
||||
|
||||
namespace NATS.Server.Tests.Internal;
|
||||
|
||||
/// <summary>
|
||||
/// Tests for MsgTraceContext: header parsing, event collection, trace propagation,
|
||||
/// JetStream two-phase send, hop tracking, and JSON serialization.
|
||||
/// Go reference: msgtrace.go — initMsgTrace, sendEvent, addEgressEvent,
|
||||
/// addJetStreamEvent, genHeaderMapIfTraceHeadersPresent.
|
||||
/// </summary>
|
||||
public class MessageTraceContextTests
|
||||
{
|
||||
private static ReadOnlyMemory<byte> BuildHeaders(params (string key, string value)[] headers)
|
||||
{
|
||||
var sb = new StringBuilder("NATS/1.0\r\n");
|
||||
foreach (var (key, value) in headers)
|
||||
{
|
||||
sb.Append($"{key}: {value}\r\n");
|
||||
}
|
||||
sb.Append("\r\n");
|
||||
return Encoding.ASCII.GetBytes(sb.ToString());
|
||||
}
|
||||
|
||||
// --- Header parsing ---
|
||||
|
||||
[Fact]
|
||||
public void ParseTraceHeaders_returns_null_for_no_trace_headers()
|
||||
{
|
||||
var headers = BuildHeaders(("Content-Type", "text/plain"));
|
||||
var result = MsgTraceContext.ParseTraceHeaders(headers.Span);
|
||||
result.ShouldBeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ParseTraceHeaders_returns_map_when_trace_dest_present()
|
||||
{
|
||||
var headers = BuildHeaders(
|
||||
(MsgTraceHeaders.TraceDest, "trace.subject"),
|
||||
("Content-Type", "text/plain"));
|
||||
var result = MsgTraceContext.ParseTraceHeaders(headers.Span);
|
||||
result.ShouldNotBeNull();
|
||||
result.ShouldContainKey(MsgTraceHeaders.TraceDest);
|
||||
result[MsgTraceHeaders.TraceDest][0].ShouldBe("trace.subject");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ParseTraceHeaders_returns_null_when_trace_disabled()
|
||||
{
|
||||
var headers = BuildHeaders(
|
||||
(MsgTraceHeaders.TraceDest, MsgTraceHeaders.TraceDestDisabled));
|
||||
var result = MsgTraceContext.ParseTraceHeaders(headers.Span);
|
||||
result.ShouldBeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ParseTraceHeaders_detects_traceparent_with_sampled_flag()
|
||||
{
|
||||
// W3C trace context: version-traceid-parentid-flags (01 = sampled)
|
||||
var headers = BuildHeaders(
|
||||
("traceparent", "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"));
|
||||
var result = MsgTraceContext.ParseTraceHeaders(headers.Span);
|
||||
result.ShouldNotBeNull();
|
||||
result.ShouldContainKey("traceparent");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ParseTraceHeaders_ignores_traceparent_without_sampled_flag()
|
||||
{
|
||||
// flags=00 means not sampled
|
||||
var headers = BuildHeaders(
|
||||
("traceparent", "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-00"));
|
||||
var result = MsgTraceContext.ParseTraceHeaders(headers.Span);
|
||||
result.ShouldBeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ParseTraceHeaders_returns_null_for_empty_input()
|
||||
{
|
||||
var result = MsgTraceContext.ParseTraceHeaders(ReadOnlySpan<byte>.Empty);
|
||||
result.ShouldBeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ParseTraceHeaders_returns_null_for_non_nats_header()
|
||||
{
|
||||
var headers = Encoding.ASCII.GetBytes("HTTP/1.1 200 OK\r\nFoo: bar\r\n\r\n");
|
||||
var result = MsgTraceContext.ParseTraceHeaders(headers);
|
||||
result.ShouldBeNull();
|
||||
}
|
||||
|
||||
// --- Context creation ---
|
||||
|
||||
[Fact]
|
||||
public void Create_returns_null_for_empty_headers()
|
||||
{
|
||||
var ctx = MsgTraceContext.Create(
|
||||
ReadOnlyMemory<byte>.Empty,
|
||||
clientId: 1,
|
||||
clientName: "test",
|
||||
accountName: "$G",
|
||||
subject: "test.sub",
|
||||
msgSize: 10);
|
||||
ctx.ShouldBeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Create_returns_null_for_headers_without_trace()
|
||||
{
|
||||
var headers = BuildHeaders(("Content-Type", "text/plain"));
|
||||
var ctx = MsgTraceContext.Create(
|
||||
headers,
|
||||
clientId: 1,
|
||||
clientName: "test",
|
||||
accountName: "$G",
|
||||
subject: "test.sub",
|
||||
msgSize: 10);
|
||||
ctx.ShouldBeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Create_builds_context_with_ingress_event()
|
||||
{
|
||||
var headers = BuildHeaders(
|
||||
(MsgTraceHeaders.TraceDest, "trace.dest"));
|
||||
|
||||
var ctx = MsgTraceContext.Create(
|
||||
headers,
|
||||
clientId: 42,
|
||||
clientName: "my-publisher",
|
||||
accountName: "$G",
|
||||
subject: "orders.new",
|
||||
msgSize: 128);
|
||||
|
||||
ctx.ShouldNotBeNull();
|
||||
ctx.IsActive.ShouldBeTrue();
|
||||
ctx.Destination.ShouldBe("trace.dest");
|
||||
ctx.TraceOnly.ShouldBeFalse();
|
||||
ctx.AccountName.ShouldBe("$G");
|
||||
|
||||
// Check ingress event
|
||||
ctx.Event.Events.Count.ShouldBe(1);
|
||||
var ingress = ctx.Event.Events[0].ShouldBeOfType<MsgTraceIngress>();
|
||||
ingress.Type.ShouldBe(MsgTraceTypes.Ingress);
|
||||
ingress.Cid.ShouldBe(42UL);
|
||||
ingress.Name.ShouldBe("my-publisher");
|
||||
ingress.Account.ShouldBe("$G");
|
||||
ingress.Subject.ShouldBe("orders.new");
|
||||
ingress.Error.ShouldBeNull();
|
||||
|
||||
// Check request info
|
||||
ctx.Event.Request.MsgSize.ShouldBe(128);
|
||||
ctx.Event.Request.Header.ShouldNotBeNull();
|
||||
ctx.Event.Request.Header.ShouldContainKey(MsgTraceHeaders.TraceDest);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Create_with_trace_only_flag()
|
||||
{
|
||||
var headers = BuildHeaders(
|
||||
(MsgTraceHeaders.TraceDest, "trace.dest"),
|
||||
(MsgTraceHeaders.TraceOnly, "true"));
|
||||
|
||||
var ctx = MsgTraceContext.Create(
|
||||
headers,
|
||||
clientId: 1,
|
||||
clientName: "test",
|
||||
accountName: "$G",
|
||||
subject: "test",
|
||||
msgSize: 0);
|
||||
|
||||
ctx.ShouldNotBeNull();
|
||||
ctx.TraceOnly.ShouldBeTrue();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Create_with_trace_only_flag_numeric()
|
||||
{
|
||||
var headers = BuildHeaders(
|
||||
(MsgTraceHeaders.TraceDest, "trace.dest"),
|
||||
(MsgTraceHeaders.TraceOnly, "1"));
|
||||
|
||||
var ctx = MsgTraceContext.Create(
|
||||
headers,
|
||||
clientId: 1,
|
||||
clientName: "test",
|
||||
accountName: "$G",
|
||||
subject: "test",
|
||||
msgSize: 0);
|
||||
|
||||
ctx.ShouldNotBeNull();
|
||||
ctx.TraceOnly.ShouldBeTrue();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Create_without_trace_only_flag()
|
||||
{
|
||||
var headers = BuildHeaders(
|
||||
(MsgTraceHeaders.TraceDest, "trace.dest"),
|
||||
(MsgTraceHeaders.TraceOnly, "false"));
|
||||
|
||||
var ctx = MsgTraceContext.Create(
|
||||
headers,
|
||||
clientId: 1,
|
||||
clientName: "test",
|
||||
accountName: "$G",
|
||||
subject: "test",
|
||||
msgSize: 0);
|
||||
|
||||
ctx.ShouldNotBeNull();
|
||||
ctx.TraceOnly.ShouldBeFalse();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Create_captures_hop_from_non_client_kind()
|
||||
{
|
||||
var headers = BuildHeaders(
|
||||
(MsgTraceHeaders.TraceDest, "trace.dest"),
|
||||
(MsgTraceHeaders.TraceHop, "1.2"));
|
||||
|
||||
var ctx = MsgTraceContext.Create(
|
||||
headers,
|
||||
clientId: 1,
|
||||
clientName: "route-1",
|
||||
accountName: "$G",
|
||||
subject: "test",
|
||||
msgSize: 0,
|
||||
clientKind: MsgTraceContext.KindRouter);
|
||||
|
||||
ctx.ShouldNotBeNull();
|
||||
ctx.Hop.ShouldBe("1.2");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Create_ignores_hop_from_client_kind()
|
||||
{
|
||||
var headers = BuildHeaders(
|
||||
(MsgTraceHeaders.TraceDest, "trace.dest"),
|
||||
(MsgTraceHeaders.TraceHop, "1.2"));
|
||||
|
||||
var ctx = MsgTraceContext.Create(
|
||||
headers,
|
||||
clientId: 1,
|
||||
clientName: "test",
|
||||
accountName: "$G",
|
||||
subject: "test",
|
||||
msgSize: 0,
|
||||
clientKind: MsgTraceContext.KindClient);
|
||||
|
||||
ctx.ShouldNotBeNull();
|
||||
ctx.Hop.ShouldBe(""); // Client hop is ignored
|
||||
}
|
||||
|
||||
// --- Event recording ---
|
||||
|
||||
[Fact]
|
||||
public void SetIngressError_sets_error_on_first_event()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.SetIngressError("publish denied");
|
||||
|
||||
var ingress = ctx.Event.Events[0].ShouldBeOfType<MsgTraceIngress>();
|
||||
ingress.Error.ShouldBe("publish denied");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddSubjectMappingEvent_appends_mapping()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.AddSubjectMappingEvent("orders.mapped");
|
||||
|
||||
ctx.Event.Events.Count.ShouldBe(2);
|
||||
var mapping = ctx.Event.Events[1].ShouldBeOfType<MsgTraceSubjectMapping>();
|
||||
mapping.Type.ShouldBe(MsgTraceTypes.SubjectMapping);
|
||||
mapping.MappedTo.ShouldBe("orders.mapped");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddEgressEvent_appends_egress_with_subscription_and_queue()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.AddEgressEvent(
|
||||
clientId: 99,
|
||||
clientName: "subscriber",
|
||||
clientKind: MsgTraceContext.KindClient,
|
||||
subscriptionSubject: "orders.>",
|
||||
queue: "workers");
|
||||
|
||||
ctx.Event.Events.Count.ShouldBe(2);
|
||||
var egress = ctx.Event.Events[1].ShouldBeOfType<MsgTraceEgress>();
|
||||
egress.Type.ShouldBe(MsgTraceTypes.Egress);
|
||||
egress.Kind.ShouldBe(MsgTraceContext.KindClient);
|
||||
egress.Cid.ShouldBe(99UL);
|
||||
egress.Name.ShouldBe("subscriber");
|
||||
egress.Subscription.ShouldBe("orders.>");
|
||||
egress.Queue.ShouldBe("workers");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddEgressEvent_records_account_when_different_from_ingress()
|
||||
{
|
||||
var ctx = CreateSimpleContext(accountName: "acctA");
|
||||
ctx.AddEgressEvent(
|
||||
clientId: 99,
|
||||
clientName: "subscriber",
|
||||
clientKind: MsgTraceContext.KindClient,
|
||||
subscriptionSubject: "api.>",
|
||||
account: "acctB");
|
||||
|
||||
var egress = ctx.Event.Events[1].ShouldBeOfType<MsgTraceEgress>();
|
||||
egress.Account.ShouldBe("acctB");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddEgressEvent_omits_account_when_same_as_ingress()
|
||||
{
|
||||
var ctx = CreateSimpleContext(accountName: "$G");
|
||||
ctx.AddEgressEvent(
|
||||
clientId: 99,
|
||||
clientName: "subscriber",
|
||||
clientKind: MsgTraceContext.KindClient,
|
||||
subscriptionSubject: "test",
|
||||
account: "$G");
|
||||
|
||||
var egress = ctx.Event.Events[1].ShouldBeOfType<MsgTraceEgress>();
|
||||
egress.Account.ShouldBeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddEgressEvent_for_router_omits_subscription_and_queue()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.AddEgressEvent(
|
||||
clientId: 1,
|
||||
clientName: "route-1",
|
||||
clientKind: MsgTraceContext.KindRouter,
|
||||
subscriptionSubject: "should.not.appear",
|
||||
queue: "should.not.appear");
|
||||
|
||||
var egress = ctx.Event.Events[1].ShouldBeOfType<MsgTraceEgress>();
|
||||
egress.Subscription.ShouldBeNull();
|
||||
egress.Queue.ShouldBeNull();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddEgressEvent_with_error()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.AddEgressEvent(
|
||||
clientId: 50,
|
||||
clientName: "slow-client",
|
||||
clientKind: MsgTraceContext.KindClient,
|
||||
error: MsgTraceErrors.ClientClosed);
|
||||
|
||||
var egress = ctx.Event.Events[1].ShouldBeOfType<MsgTraceEgress>();
|
||||
egress.Error.ShouldBe(MsgTraceErrors.ClientClosed);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddStreamExportEvent_records_account_and_target()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.AddStreamExportEvent("exportAccount", "export.subject");
|
||||
|
||||
ctx.Event.Events.Count.ShouldBe(2);
|
||||
var se = ctx.Event.Events[1].ShouldBeOfType<MsgTraceStreamExport>();
|
||||
se.Type.ShouldBe(MsgTraceTypes.StreamExport);
|
||||
se.Account.ShouldBe("exportAccount");
|
||||
se.To.ShouldBe("export.subject");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddServiceImportEvent_records_from_and_to()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.AddServiceImportEvent("importAccount", "from.subject", "to.subject");
|
||||
|
||||
ctx.Event.Events.Count.ShouldBe(2);
|
||||
var si = ctx.Event.Events[1].ShouldBeOfType<MsgTraceServiceImport>();
|
||||
si.Type.ShouldBe(MsgTraceTypes.ServiceImport);
|
||||
si.Account.ShouldBe("importAccount");
|
||||
si.From.ShouldBe("from.subject");
|
||||
si.To.ShouldBe("to.subject");
|
||||
}
|
||||
|
||||
// --- JetStream events ---
|
||||
|
||||
[Fact]
|
||||
public void AddJetStreamEvent_records_stream_name()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.AddJetStreamEvent("ORDERS");
|
||||
|
||||
ctx.Event.Events.Count.ShouldBe(2);
|
||||
var js = ctx.Event.Events[1].ShouldBeOfType<MsgTraceJetStreamEntry>();
|
||||
js.Type.ShouldBe(MsgTraceTypes.JetStream);
|
||||
js.Stream.ShouldBe("ORDERS");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void UpdateJetStreamEvent_sets_subject_and_nointerest()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.AddJetStreamEvent("ORDERS");
|
||||
ctx.UpdateJetStreamEvent("orders.new", noInterest: true);
|
||||
|
||||
var js = ctx.Event.Events[1].ShouldBeOfType<MsgTraceJetStreamEntry>();
|
||||
js.Subject.ShouldBe("orders.new");
|
||||
js.NoInterest.ShouldBeTrue();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void SendEventFromJetStream_requires_both_phases()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.AddJetStreamEvent("ORDERS");
|
||||
|
||||
bool published = false;
|
||||
ctx.PublishCallback = (dest, reply, body) => { published = true; };
|
||||
|
||||
// Phase 1: message path calls SendEvent — should not publish yet
|
||||
ctx.SendEvent();
|
||||
published.ShouldBeFalse();
|
||||
|
||||
// Phase 2: JetStream path calls SendEventFromJetStream — now publishes
|
||||
ctx.SendEventFromJetStream();
|
||||
published.ShouldBeTrue();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void SendEventFromJetStream_with_error()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.AddJetStreamEvent("ORDERS");
|
||||
|
||||
object? publishedBody = null;
|
||||
ctx.PublishCallback = (dest, reply, body) => { publishedBody = body; };
|
||||
|
||||
ctx.SendEvent(); // Phase 1
|
||||
ctx.SendEventFromJetStream("stream full"); // Phase 2
|
||||
|
||||
publishedBody.ShouldNotBeNull();
|
||||
var js = ctx.Event.Events[1].ShouldBeOfType<MsgTraceJetStreamEntry>();
|
||||
js.Error.ShouldBe("stream full");
|
||||
}
|
||||
|
||||
// --- Hop tracking ---
|
||||
|
||||
[Fact]
|
||||
public void SetHopHeader_increments_and_builds_hop_id()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
|
||||
ctx.SetHopHeader();
|
||||
ctx.Event.Hops.ShouldBe(1);
|
||||
ctx.NextHop.ShouldBe("1");
|
||||
|
||||
ctx.SetHopHeader();
|
||||
ctx.Event.Hops.ShouldBe(2);
|
||||
ctx.NextHop.ShouldBe("2");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void SetHopHeader_chains_from_existing_hop()
|
||||
{
|
||||
var headers = BuildHeaders(
|
||||
(MsgTraceHeaders.TraceDest, "trace.dest"),
|
||||
(MsgTraceHeaders.TraceHop, "1"));
|
||||
|
||||
var ctx = MsgTraceContext.Create(
|
||||
headers,
|
||||
clientId: 1,
|
||||
clientName: "router",
|
||||
accountName: "$G",
|
||||
subject: "test",
|
||||
msgSize: 0,
|
||||
clientKind: MsgTraceContext.KindRouter);
|
||||
|
||||
ctx.ShouldNotBeNull();
|
||||
ctx.Hop.ShouldBe("1");
|
||||
|
||||
ctx.SetHopHeader();
|
||||
ctx.NextHop.ShouldBe("1.1");
|
||||
|
||||
ctx.SetHopHeader();
|
||||
ctx.NextHop.ShouldBe("1.2");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddEgressEvent_captures_and_clears_next_hop()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.SetHopHeader();
|
||||
ctx.NextHop.ShouldBe("1");
|
||||
|
||||
ctx.AddEgressEvent(1, "route-1", MsgTraceContext.KindRouter);
|
||||
|
||||
var egress = ctx.Event.Events[1].ShouldBeOfType<MsgTraceEgress>();
|
||||
egress.Hop.ShouldBe("1");
|
||||
|
||||
// NextHop should be cleared after adding egress
|
||||
ctx.NextHop.ShouldBe("");
|
||||
}
|
||||
|
||||
// --- SendEvent (non-JetStream) ---
|
||||
|
||||
[Fact]
|
||||
public void SendEvent_publishes_immediately_without_jetstream()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
string? publishedDest = null;
|
||||
ctx.PublishCallback = (dest, reply, body) => { publishedDest = dest; };
|
||||
|
||||
ctx.SendEvent();
|
||||
publishedDest.ShouldBe("trace.dest");
|
||||
}
|
||||
|
||||
// --- JSON serialization ---
|
||||
|
||||
[Fact]
|
||||
public void MsgTraceEvent_serializes_to_valid_json()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.Event.Server = new EventServerInfo { Name = "srv", Id = "SRV1" };
|
||||
ctx.AddSubjectMappingEvent("mapped.subject");
|
||||
ctx.AddEgressEvent(99, "subscriber", MsgTraceContext.KindClient, "test.>", "q1");
|
||||
ctx.AddStreamExportEvent("exportAcc", "export.subject");
|
||||
|
||||
var json = JsonSerializer.Serialize(ctx.Event);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.GetProperty("server").GetProperty("name").GetString().ShouldBe("srv");
|
||||
root.GetProperty("request").GetProperty("msgsize").GetInt32().ShouldBe(64);
|
||||
root.GetProperty("events").GetArrayLength().ShouldBe(4);
|
||||
|
||||
var events = root.GetProperty("events");
|
||||
events[0].GetProperty("type").GetString().ShouldBe(MsgTraceTypes.Ingress);
|
||||
events[1].GetProperty("type").GetString().ShouldBe(MsgTraceTypes.SubjectMapping);
|
||||
events[2].GetProperty("type").GetString().ShouldBe(MsgTraceTypes.Egress);
|
||||
events[3].GetProperty("type").GetString().ShouldBe(MsgTraceTypes.StreamExport);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void MsgTraceIngress_json_omits_null_error()
|
||||
{
|
||||
var ingress = new MsgTraceIngress
|
||||
{
|
||||
Type = MsgTraceTypes.Ingress,
|
||||
Cid = 1,
|
||||
Account = "$G",
|
||||
Subject = "test",
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize<MsgTraceEntry>(ingress);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
doc.RootElement.TryGetProperty("error", out _).ShouldBeFalse();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void MsgTraceEgress_json_omits_null_optional_fields()
|
||||
{
|
||||
var egress = new MsgTraceEgress
|
||||
{
|
||||
Type = MsgTraceTypes.Egress,
|
||||
Kind = MsgTraceContext.KindRouter,
|
||||
Cid = 5,
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize<MsgTraceEntry>(egress);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var root = doc.RootElement;
|
||||
|
||||
root.TryGetProperty("hop", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("acc", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("sub", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("queue", out _).ShouldBeFalse();
|
||||
root.TryGetProperty("error", out _).ShouldBeFalse();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Full_trace_event_with_all_event_types_serializes_correctly()
|
||||
{
|
||||
var ctx = CreateSimpleContext();
|
||||
ctx.Event.Server = new EventServerInfo { Name = "test-srv", Id = "ABC123" };
|
||||
ctx.AddSubjectMappingEvent("mapped");
|
||||
ctx.AddServiceImportEvent("importAcc", "from.sub", "to.sub");
|
||||
ctx.AddStreamExportEvent("exportAcc", "export.sub");
|
||||
ctx.AddJetStreamEvent("ORDERS");
|
||||
ctx.UpdateJetStreamEvent("orders.new", false);
|
||||
ctx.AddEgressEvent(100, "sub-1", MsgTraceContext.KindClient, "orders.>", "workers");
|
||||
ctx.AddEgressEvent(200, "route-east", MsgTraceContext.KindRouter, error: MsgTraceErrors.NoSupport);
|
||||
|
||||
var json = JsonSerializer.Serialize(ctx.Event);
|
||||
var doc = JsonDocument.Parse(json);
|
||||
var events = doc.RootElement.GetProperty("events");
|
||||
|
||||
events.GetArrayLength().ShouldBe(7);
|
||||
events[0].GetProperty("type").GetString().ShouldBe("in");
|
||||
events[1].GetProperty("type").GetString().ShouldBe("sm");
|
||||
events[2].GetProperty("type").GetString().ShouldBe("si");
|
||||
events[3].GetProperty("type").GetString().ShouldBe("se");
|
||||
events[4].GetProperty("type").GetString().ShouldBe("js");
|
||||
events[5].GetProperty("type").GetString().ShouldBe("eg");
|
||||
events[6].GetProperty("type").GetString().ShouldBe("eg");
|
||||
}
|
||||
|
||||
// --- Helper ---
|
||||
|
||||
private static MsgTraceContext CreateSimpleContext(string destination = "trace.dest", string accountName = "$G")
|
||||
{
|
||||
var headers = BuildHeaders(
|
||||
(MsgTraceHeaders.TraceDest, destination));
|
||||
|
||||
var ctx = MsgTraceContext.Create(
|
||||
headers,
|
||||
clientId: 1,
|
||||
clientName: "publisher",
|
||||
accountName: accountName,
|
||||
subject: "test.subject",
|
||||
msgSize: 64);
|
||||
|
||||
ctx.ShouldNotBeNull();
|
||||
return ctx;
|
||||
}
|
||||
}
|
||||
420
tests/NATS.Server.Tests/Monitoring/ConnzFilterTests.cs
Normal file
420
tests/NATS.Server.Tests/Monitoring/ConnzFilterTests.cs
Normal file
@@ -0,0 +1,420 @@
|
||||
using System.Net;
|
||||
using System.Net.Sockets;
|
||||
using System.Text;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.Logging.Abstractions;
|
||||
using NATS.Server;
|
||||
using NATS.Server.Auth;
|
||||
using NATS.Server.Monitoring;
|
||||
|
||||
namespace NATS.Server.Tests.Monitoring;
|
||||
|
||||
/// <summary>
|
||||
/// Tests for ConnzHandler filtering, sorting, pagination, and closed connection
|
||||
/// ring buffer behavior.
|
||||
/// Go reference: monitor_test.go — TestConnz, TestConnzSortedByCid, TestConnzSortedByBytesTo,
|
||||
/// TestConnzFilter, TestConnzWithCID, TestConnzOffsetAndLimit.
|
||||
/// </summary>
|
||||
public class ConnzFilterTests : IAsyncLifetime
|
||||
{
|
||||
private readonly NatsServer _server;
|
||||
private readonly NatsOptions _opts;
|
||||
private readonly CancellationTokenSource _cts = new();
|
||||
private readonly List<Socket> _sockets = [];
|
||||
|
||||
public ConnzFilterTests()
|
||||
{
|
||||
_opts = new NatsOptions
|
||||
{
|
||||
Port = GetFreePort(),
|
||||
MaxClosedClients = 100,
|
||||
Users =
|
||||
[
|
||||
new User { Username = "alice", Password = "pw", Account = "acctA" },
|
||||
new User { Username = "bob", Password = "pw", Account = "acctB" },
|
||||
],
|
||||
};
|
||||
_server = new NatsServer(_opts, NullLoggerFactory.Instance);
|
||||
}
|
||||
|
||||
public async Task InitializeAsync()
|
||||
{
|
||||
_ = _server.StartAsync(_cts.Token);
|
||||
await _server.WaitForReadyAsync();
|
||||
}
|
||||
|
||||
public async Task DisposeAsync()
|
||||
{
|
||||
foreach (var s in _sockets)
|
||||
{
|
||||
try { s.Shutdown(SocketShutdown.Both); } catch { }
|
||||
s.Dispose();
|
||||
}
|
||||
await _cts.CancelAsync();
|
||||
_server.Dispose();
|
||||
}
|
||||
|
||||
private static int GetFreePort()
|
||||
{
|
||||
using var sock = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
|
||||
sock.Bind(new IPEndPoint(IPAddress.Loopback, 0));
|
||||
return ((IPEndPoint)sock.LocalEndPoint!).Port;
|
||||
}
|
||||
|
||||
private async Task<Socket> ConnectAsync(string user, string? subjectToSubscribe = null)
|
||||
{
|
||||
var sock = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
|
||||
_sockets.Add(sock);
|
||||
await sock.ConnectAsync(IPAddress.Loopback, _opts.Port);
|
||||
|
||||
var buf = new byte[4096];
|
||||
await sock.ReceiveAsync(buf, SocketFlags.None); // INFO
|
||||
|
||||
var connect = $"CONNECT {{\"user\":\"{user}\",\"pass\":\"pw\"}}\r\n";
|
||||
await sock.SendAsync(Encoding.ASCII.GetBytes(connect));
|
||||
|
||||
if (subjectToSubscribe != null)
|
||||
{
|
||||
await sock.SendAsync(Encoding.ASCII.GetBytes($"SUB {subjectToSubscribe} sid1\r\n"));
|
||||
}
|
||||
|
||||
await sock.SendAsync("PING\r\n"u8.ToArray());
|
||||
await ReadUntilAsync(sock, "PONG");
|
||||
return sock;
|
||||
}
|
||||
|
||||
private Connz GetConnz(string queryString = "")
|
||||
{
|
||||
var ctx = new DefaultHttpContext();
|
||||
ctx.Request.QueryString = new QueryString(queryString);
|
||||
return new ConnzHandler(_server).HandleConnz(ctx);
|
||||
}
|
||||
|
||||
// --- Sort tests ---
|
||||
|
||||
[Fact]
|
||||
public async Task Sort_by_cid_returns_ascending_order()
|
||||
{
|
||||
await ConnectAsync("alice");
|
||||
await ConnectAsync("bob");
|
||||
await Task.Delay(50);
|
||||
|
||||
var connz = GetConnz("?sort=cid");
|
||||
connz.Conns.Length.ShouldBeGreaterThanOrEqualTo(2);
|
||||
|
||||
for (int i = 1; i < connz.Conns.Length; i++)
|
||||
{
|
||||
connz.Conns[i].Cid.ShouldBeGreaterThan(connz.Conns[i - 1].Cid);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Sort_by_bytes_to_returns_descending_order()
|
||||
{
|
||||
var sock1 = await ConnectAsync("alice");
|
||||
var sock2 = await ConnectAsync("bob");
|
||||
await Task.Delay(50);
|
||||
|
||||
// Publish some data through sock1 to accumulate bytes
|
||||
await sock1.SendAsync(Encoding.ASCII.GetBytes("SUB test 1\r\nPUB test 10\r\n1234567890\r\n"));
|
||||
await Task.Delay(100);
|
||||
|
||||
var connz = GetConnz("?sort=bytes_to");
|
||||
connz.Conns.Length.ShouldBeGreaterThanOrEqualTo(2);
|
||||
|
||||
for (int i = 1; i < connz.Conns.Length; i++)
|
||||
{
|
||||
connz.Conns[i].OutBytes.ShouldBeLessThanOrEqualTo(connz.Conns[i - 1].OutBytes);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Sort_by_msgs_from_returns_descending_order()
|
||||
{
|
||||
var sock1 = await ConnectAsync("alice");
|
||||
await Task.Delay(50);
|
||||
|
||||
// Send a PUB to increment InMsgs
|
||||
await sock1.SendAsync(Encoding.ASCII.GetBytes("PUB test 3\r\nabc\r\n"));
|
||||
await Task.Delay(100);
|
||||
|
||||
var connz = GetConnz("?sort=msgs_from");
|
||||
connz.Conns.Length.ShouldBeGreaterThanOrEqualTo(1);
|
||||
|
||||
for (int i = 1; i < connz.Conns.Length; i++)
|
||||
{
|
||||
connz.Conns[i].InMsgs.ShouldBeLessThanOrEqualTo(connz.Conns[i - 1].InMsgs);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Sort_by_subs_returns_descending_order()
|
||||
{
|
||||
// Alice has 2 subs, Bob has 1
|
||||
var sock1 = await ConnectAsync("alice", "test.a");
|
||||
await sock1.SendAsync(Encoding.ASCII.GetBytes("SUB test.b sid2\r\n"));
|
||||
var sock2 = await ConnectAsync("bob", "test.c");
|
||||
await Task.Delay(100);
|
||||
|
||||
var connz = GetConnz("?sort=subs");
|
||||
connz.Conns.Length.ShouldBeGreaterThanOrEqualTo(2);
|
||||
|
||||
for (int i = 1; i < connz.Conns.Length; i++)
|
||||
{
|
||||
connz.Conns[i].NumSubs.ShouldBeLessThanOrEqualTo(connz.Conns[i - 1].NumSubs);
|
||||
}
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Sort_by_start_returns_ascending_order()
|
||||
{
|
||||
await ConnectAsync("alice");
|
||||
await Task.Delay(20);
|
||||
await ConnectAsync("bob");
|
||||
await Task.Delay(50);
|
||||
|
||||
var connz = GetConnz("?sort=start");
|
||||
connz.Conns.Length.ShouldBeGreaterThanOrEqualTo(2);
|
||||
|
||||
for (int i = 1; i < connz.Conns.Length; i++)
|
||||
{
|
||||
connz.Conns[i].Start.ShouldBeGreaterThanOrEqualTo(connz.Conns[i - 1].Start);
|
||||
}
|
||||
}
|
||||
|
||||
// --- Filter tests ---
|
||||
|
||||
[Fact]
|
||||
public async Task Filter_by_account_returns_only_matching_connections()
|
||||
{
|
||||
await ConnectAsync("alice");
|
||||
await ConnectAsync("bob");
|
||||
await Task.Delay(50);
|
||||
|
||||
var connz = GetConnz("?acc=acctA");
|
||||
connz.Conns.ShouldAllBe(c => c.Account == "acctA");
|
||||
connz.Conns.ShouldNotBeEmpty();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Filter_by_user_returns_only_matching_connections()
|
||||
{
|
||||
await ConnectAsync("alice");
|
||||
await ConnectAsync("bob");
|
||||
await Task.Delay(50);
|
||||
|
||||
var connz = GetConnz("?user=bob");
|
||||
connz.Conns.ShouldAllBe(c => c.AuthorizedUser == "bob");
|
||||
connz.Conns.ShouldNotBeEmpty();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Filter_by_subject_returns_matching_subscribers()
|
||||
{
|
||||
await ConnectAsync("alice", "orders.>");
|
||||
await ConnectAsync("bob", "payments.>");
|
||||
await Task.Delay(50);
|
||||
|
||||
var connz = GetConnz("?filter_subject=orders.new&subs=1");
|
||||
connz.Conns.ShouldNotBeEmpty();
|
||||
connz.Conns.ShouldAllBe(c => c.Subs.Any(s => s.Contains("orders")));
|
||||
}
|
||||
|
||||
// --- Pagination tests ---
|
||||
|
||||
[Fact]
|
||||
public async Task Offset_and_limit_paginates_results()
|
||||
{
|
||||
await ConnectAsync("alice");
|
||||
await ConnectAsync("bob");
|
||||
await ConnectAsync("alice");
|
||||
await Task.Delay(50);
|
||||
|
||||
var page1 = GetConnz("?sort=cid&limit=2&offset=0");
|
||||
page1.Conns.Length.ShouldBe(2);
|
||||
page1.Total.ShouldBeGreaterThanOrEqualTo(3);
|
||||
page1.Offset.ShouldBe(0);
|
||||
page1.Limit.ShouldBe(2);
|
||||
|
||||
var page2 = GetConnz("?sort=cid&limit=2&offset=2");
|
||||
page2.Conns.Length.ShouldBeGreaterThanOrEqualTo(1);
|
||||
page2.Offset.ShouldBe(2);
|
||||
|
||||
// Ensure no overlap between pages
|
||||
var page1Cids = page1.Conns.Select(c => c.Cid).ToHashSet();
|
||||
var page2Cids = page2.Conns.Select(c => c.Cid).ToHashSet();
|
||||
page1Cids.Overlaps(page2Cids).ShouldBeFalse();
|
||||
}
|
||||
|
||||
// --- CID lookup test ---
|
||||
|
||||
[Fact]
|
||||
public async Task Cid_lookup_returns_single_connection()
|
||||
{
|
||||
await ConnectAsync("alice");
|
||||
await ConnectAsync("bob");
|
||||
await Task.Delay(50);
|
||||
|
||||
// Get all connections to find a known CID
|
||||
var all = GetConnz("?sort=cid");
|
||||
all.Conns.ShouldNotBeEmpty();
|
||||
var targetCid = all.Conns[0].Cid;
|
||||
|
||||
var single = GetConnz($"?cid={targetCid}");
|
||||
single.Conns.Length.ShouldBe(1);
|
||||
single.Conns[0].Cid.ShouldBe(targetCid);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Cid_lookup_nonexistent_returns_empty()
|
||||
{
|
||||
var result = GetConnz("?cid=99999999");
|
||||
result.Conns.Length.ShouldBe(0);
|
||||
result.Total.ShouldBe(0);
|
||||
}
|
||||
|
||||
// --- Closed connection tests ---
|
||||
|
||||
[Fact]
|
||||
public async Task Closed_state_shows_disconnected_clients()
|
||||
{
|
||||
var sock = await ConnectAsync("alice");
|
||||
await Task.Delay(50);
|
||||
|
||||
// Close the connection
|
||||
sock.Shutdown(SocketShutdown.Both);
|
||||
sock.Close();
|
||||
_sockets.Remove(sock);
|
||||
await Task.Delay(200);
|
||||
|
||||
var connz = GetConnz("?state=closed");
|
||||
connz.Conns.ShouldNotBeEmpty();
|
||||
connz.Conns.ShouldAllBe(c => c.Stop != null);
|
||||
connz.Conns.ShouldAllBe(c => !string.IsNullOrEmpty(c.Reason));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task All_state_shows_both_open_and_closed()
|
||||
{
|
||||
var sock1 = await ConnectAsync("alice");
|
||||
var sock2 = await ConnectAsync("bob");
|
||||
await Task.Delay(50);
|
||||
|
||||
// Close one connection
|
||||
sock1.Shutdown(SocketShutdown.Both);
|
||||
sock1.Close();
|
||||
_sockets.Remove(sock1);
|
||||
await Task.Delay(200);
|
||||
|
||||
var connz = GetConnz("?state=all");
|
||||
connz.Total.ShouldBeGreaterThanOrEqualTo(2);
|
||||
// Should have at least one open (bob) and one closed (alice)
|
||||
connz.Conns.Any(c => c.Stop == null).ShouldBeTrue("expected at least one open connection");
|
||||
connz.Conns.Any(c => c.Stop != null).ShouldBeTrue("expected at least one closed connection");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Closed_ring_buffer_caps_at_max()
|
||||
{
|
||||
// MaxClosedClients is 100, create and close 5 connections
|
||||
for (int i = 0; i < 5; i++)
|
||||
{
|
||||
var sock = await ConnectAsync("alice");
|
||||
await Task.Delay(20);
|
||||
sock.Shutdown(SocketShutdown.Both);
|
||||
sock.Close();
|
||||
_sockets.Remove(sock);
|
||||
await Task.Delay(100);
|
||||
}
|
||||
|
||||
var connz = GetConnz("?state=closed");
|
||||
connz.Total.ShouldBeLessThanOrEqualTo(_opts.MaxClosedClients);
|
||||
}
|
||||
|
||||
// --- Sort fallback tests ---
|
||||
|
||||
[Fact]
|
||||
public async Task Sort_by_stop_with_open_state_falls_back_to_cid()
|
||||
{
|
||||
await ConnectAsync("alice");
|
||||
await ConnectAsync("bob");
|
||||
await Task.Delay(50);
|
||||
|
||||
// sort=stop with state=open should fall back to cid sorting
|
||||
var connz = GetConnz("?sort=stop&state=open");
|
||||
connz.Conns.Length.ShouldBeGreaterThanOrEqualTo(2);
|
||||
|
||||
for (int i = 1; i < connz.Conns.Length; i++)
|
||||
{
|
||||
connz.Conns[i].Cid.ShouldBeGreaterThan(connz.Conns[i - 1].Cid);
|
||||
}
|
||||
}
|
||||
|
||||
// --- Combined filter + sort test ---
|
||||
|
||||
[Fact]
|
||||
public async Task Account_filter_with_bytes_sort_and_limit()
|
||||
{
|
||||
// Connect multiple alice clients
|
||||
for (int i = 0; i < 3; i++)
|
||||
{
|
||||
var sock = await ConnectAsync("alice");
|
||||
// Send varying amounts of data
|
||||
var data = new string('x', (i + 1) * 100);
|
||||
await sock.SendAsync(Encoding.ASCII.GetBytes($"SUB test 1\r\nPUB test {data.Length}\r\n{data}\r\n"));
|
||||
}
|
||||
await ConnectAsync("bob");
|
||||
await Task.Delay(100);
|
||||
|
||||
var connz = GetConnz("?acc=acctA&sort=bytes_to&limit=2");
|
||||
connz.Conns.Length.ShouldBeLessThanOrEqualTo(2);
|
||||
connz.Conns.ShouldAllBe(c => c.Account == "acctA");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Closed_cid_lookup_returns_from_ring_buffer()
|
||||
{
|
||||
var sock = await ConnectAsync("alice");
|
||||
await Task.Delay(50);
|
||||
|
||||
// Get the CID before closing
|
||||
var all = GetConnz("?sort=cid");
|
||||
all.Conns.ShouldNotBeEmpty();
|
||||
var targetCid = all.Conns.Last().Cid;
|
||||
|
||||
// Close the socket
|
||||
sock.Shutdown(SocketShutdown.Both);
|
||||
sock.Close();
|
||||
_sockets.Remove(sock);
|
||||
await Task.Delay(200);
|
||||
|
||||
// Look up closed connection by CID
|
||||
var single = GetConnz($"?cid={targetCid}");
|
||||
single.Conns.Length.ShouldBe(1);
|
||||
single.Conns[0].Cid.ShouldBe(targetCid);
|
||||
single.Conns[0].Stop.ShouldNotBeNull();
|
||||
}
|
||||
|
||||
private static async Task ReadUntilAsync(Socket sock, string expected)
|
||||
{
|
||||
var buf = new byte[4096];
|
||||
var all = new StringBuilder();
|
||||
var deadline = DateTime.UtcNow.AddSeconds(5);
|
||||
while (DateTime.UtcNow < deadline)
|
||||
{
|
||||
if (sock.Available > 0)
|
||||
{
|
||||
var n = await sock.ReceiveAsync(buf, SocketFlags.None);
|
||||
all.Append(Encoding.ASCII.GetString(buf, 0, n));
|
||||
if (all.ToString().Contains(expected))
|
||||
return;
|
||||
}
|
||||
else
|
||||
{
|
||||
await Task.Delay(10);
|
||||
}
|
||||
}
|
||||
|
||||
throw new TimeoutException($"Did not receive '{expected}' within 5 seconds. Got: {all}");
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user