12 Commits

Author SHA1 Message Date
Joseph Doherty 93f34c4782 chore(batch39): reconcile porting.db after merge 2026-03-01 01:35:35 -05:00
Joseph Doherty 58db8adbc7 feat(batch39): merge consumer-dispatch 2026-03-01 01:35:20 -05:00
Joseph Doherty a99fa837b2 chore(batch24): reconcile porting.db after merge 2026-03-01 01:35:03 -05:00
Joseph Doherty 8dcd582e8d chore(batch24): remove generated build artifacts 2026-03-01 01:32:08 -05:00
Joseph Doherty 3e9ad16033 feat(batch24): complete leaf nodes implementation and verification 2026-03-01 01:31:57 -05:00
Joseph Doherty 6d87a5a147 feat(batch39): complete consumer dispatch batch and verify all mappings 2026-03-01 01:31:48 -05:00
Joseph Doherty 09f73a0d2f task6(batch39): implement shutdown and signal flow paths 2026-03-01 01:30:17 -05:00
Joseph Doherty c0ec1f3341 task5(batch39): add reply parsing and consumer identity helpers 2026-03-01 01:25:26 -05:00
Joseph Doherty 519ee6ad49 task4(batch39): add delivery and redelivery dispatch behavior 2026-03-01 01:21:16 -05:00
Joseph Doherty f537612d7c task3(batch39): implement dispatch core and ack-floor processing 2026-03-01 01:16:27 -05:00
Joseph Doherty 0760c550b4 task2(batch39): implement group A waiting/pull dispatch and T1 tests 2026-03-01 01:13:03 -05:00
Joseph Doherty 94d339148a chore(batch39): start batch and record baseline gates 2026-03-01 01:01:29 -05:00
33 changed files with 3721 additions and 22 deletions
@@ -1445,7 +1445,7 @@ public sealed partial class Account : INatsAccount
_mappings.Add(m);
Interlocked.Exchange(ref _hasMapped, _mappings.Count > 0 ? 1 : 0);
// TODO: session 15 — notify connected leaf nodes via lc.ForceAddToSmap(src).
UpdateLeafNodesEx(src, 1, force: true);
return null;
}
@@ -1474,7 +1474,7 @@ public sealed partial class Account : INatsAccount
_mappings.RemoveAt(_mappings.Count - 1);
Interlocked.Exchange(ref _hasMapped, _mappings.Count > 0 ? 1 : 0);
// TODO: session 15 — notify leaf nodes via lc.ForceRemoveFromSmap(src).
UpdateLeafNodesEx(src, -1, force: true);
return true;
}
}
@@ -3810,6 +3810,52 @@ public sealed partial class Account : INatsAccount
leaf.FlushSignal();
}
internal void UpdateLeafNodesEx(string subject, int delta, bool force = false)
{
if (string.IsNullOrWhiteSpace(subject) || delta == 0)
return;
var heldWriteLock = _mu.IsWriteLockHeld;
if (!heldWriteLock)
_mu.EnterWriteLock();
try
{
_rm ??= new Dictionary<string, int>(StringComparer.Ordinal);
_rm.TryGetValue(subject, out var interest);
interest += delta;
if (interest <= 0)
_rm.Remove(subject);
else
_rm[subject] = interest;
}
finally
{
if (!heldWriteLock)
_mu.ExitWriteLock();
}
List<ClientConnection> leafs;
_lmu.EnterReadLock();
try { leafs = [.. _lleafs]; }
finally { _lmu.ExitReadLock(); }
foreach (var leaf in leafs)
{
if (force)
{
if (delta > 0)
leaf.ForceAddToSmap(subject);
else
leaf.ForceRemoveFromSmap(subject);
}
else
{
leaf.FlushSignal();
}
}
}
// -------------------------------------------------------------------------
// addClient / removeClient
// -------------------------------------------------------------------------
@@ -3889,7 +3935,14 @@ public sealed partial class Account : INatsAccount
// Cluster accounting for hub leaf nodes.
if (c.IsHubLeafNode())
{
// TODO: session 15 — c.RemoteCluster() for cluster accounting.
var cluster = c.RemoteCluster();
if (!string.IsNullOrWhiteSpace(cluster) && _leafClusters != null && _leafClusters.TryGetValue(cluster, out var current))
{
if (current <= 1)
_leafClusters.Remove(cluster);
else
_leafClusters[cluster] = current - 1;
}
}
}
}
@@ -0,0 +1,540 @@
// Copyright 2019-2026 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
using System.Net.Security;
using System.Text;
using System.Text.Json;
using System.Linq;
using ZB.MOM.NatsNet.Server.Internal;
using ZB.MOM.NatsNet.Server.Protocol;
namespace ZB.MOM.NatsNet.Server;
public sealed partial class ClientConnection
{
internal Leaf? Leaf;
internal bool IsSolicitedLeafNode() => Kind == ClientKind.Leaf && Leaf?.Remote != null;
internal bool IsSpokeLeafNode() => Kind == ClientKind.Leaf && Leaf?.IsSpoke == true;
internal bool IsIsolatedLeafNode() => Kind == ClientKind.Leaf && Leaf?.Isolated == true;
internal Exception? SendLeafConnect(string clusterName, bool headers)
{
if (Server is not NatsServer server)
return new InvalidOperationException("server unavailable for leaf connect");
lock (_mu)
{
Leaf ??= new Leaf();
Leaf.Remote ??= new LeafNodeCfg();
var remote = Leaf.Remote;
var connectInfo = new LeafConnectInfo
{
Version = ServerConstants.Version,
Id = server.ID(),
Domain = server.GetOpts().JetStreamDomain,
Name = server.Name(),
Hub = remote.RemoteOpts?.Hub == true,
Cluster = clusterName,
Headers = headers,
JetStream = false,
DenyPub = remote.RemoteOpts?.DenyImports?.ToArray() ?? [],
Compression = string.IsNullOrWhiteSpace(Leaf.Compression) ? CompressionMode.NotSupported : Leaf.Compression,
RemoteAccount = _account?.Name ?? string.Empty,
Proto = server.GetServerProto(),
Isolate = remote.RemoteOpts?.RequestIsolation == true,
};
if (remote.CurUrl?.UserInfo is { Length: > 0 } userInfo)
{
var userInfoParts = userInfo.Split(':', 2, StringSplitOptions.None);
connectInfo.User = userInfoParts[0];
connectInfo.Pass = userInfoParts.Length > 1 ? userInfoParts[1] : string.Empty;
if (string.IsNullOrEmpty(connectInfo.Pass))
connectInfo.Token = connectInfo.User;
}
else if (!string.IsNullOrWhiteSpace(remote.Username))
{
connectInfo.User = remote.Username;
connectInfo.Pass = remote.Password;
if (string.IsNullOrEmpty(connectInfo.Pass))
connectInfo.Token = connectInfo.User;
}
var payload = JsonSerializer.Serialize(connectInfo);
EnqueueProto(Encoding.ASCII.GetBytes($"CONNECT {payload}\r\n"));
}
return null;
}
internal Exception? LeafClientHandshakeIfNeeded(ServerInfo info)
{
if (!info.TlsRequired)
return null;
Opts.TlsRequired = true;
return null;
}
internal void ProcessLeafnodeInfo(ServerInfo info)
{
if (Server is not NatsServer server)
return;
lock (_mu)
{
Leaf ??= new Leaf();
if (string.IsNullOrWhiteSpace(Leaf.Compression))
Leaf.Compression = string.IsNullOrWhiteSpace(info.Compression) ? CompressionMode.NotSupported : info.Compression!;
Headers = server.SupportsHeaders() && info.Headers;
Flags |= ClientFlags.InfoReceived;
}
if (IsSolicitedLeafNode())
UpdateLeafNodeURLs(info);
}
internal void UpdateLeafNodeURLs(ServerInfo info)
{
var cfg = Leaf?.Remote;
if (cfg is null)
return;
cfg.AcquireWriteLock();
try
{
var useWebSocket = cfg.Urls.Count > 0 && string.Equals(cfg.Urls[0].Scheme, "ws", StringComparison.OrdinalIgnoreCase);
if (useWebSocket)
{
var scheme = cfg.RemoteOpts?.Tls == true ? "wss" : "ws";
DoUpdateLNURLs(cfg, scheme, info.WsConnectUrls ?? []);
}
else
{
DoUpdateLNURLs(cfg, "nats-leaf", info.LeafNodeUrls ?? []);
}
}
finally
{
cfg.ReleaseWriteLock();
}
}
internal void DoUpdateLNURLs(LeafNodeCfg cfg, string scheme, string[] urls)
{
var dynamicUrls = new List<Uri>(urls.Length + cfg.Urls.Count);
foreach (var url in urls)
{
if (!Uri.TryCreate($"{scheme}://{url}", UriKind.Absolute, out var parsed))
{
Errorf("Error parsing url {0}", url);
continue;
}
var isDuplicate = false;
foreach (var configured in cfg.Urls)
{
if (string.Equals(parsed.Host, configured.Host, StringComparison.OrdinalIgnoreCase)
&& parsed.Port == configured.Port)
{
isDuplicate = true;
break;
}
}
if (isDuplicate)
continue;
dynamicUrls.Add(parsed);
cfg.SaveTLSHostname(parsed);
}
dynamicUrls.AddRange(cfg.Urls);
cfg.Urls = dynamicUrls;
cfg.CurUrl ??= cfg.Urls.FirstOrDefault();
}
internal Exception? ProcessLeafNodeConnect(NatsServer server, byte[] arg, string lang)
{
if (!string.IsNullOrWhiteSpace(lang))
return ServerErrors.ErrClientConnectedToLeafNodePort;
LeafConnectInfo? protocol;
try
{
protocol = JsonSerializer.Deserialize<LeafConnectInfo>(arg);
}
catch (Exception ex)
{
return ex;
}
if (protocol is null)
return new InvalidOperationException("invalid leaf connect payload");
if (!string.IsNullOrWhiteSpace(protocol.Cluster) && protocol.Cluster.Contains(' '))
return ServerErrors.ErrClusterNameHasSpaces;
var cachedClusterName = server.CachedClusterName();
if (!string.IsNullOrWhiteSpace(cachedClusterName)
&& !string.IsNullOrWhiteSpace(protocol.Cluster)
&& string.Equals(cachedClusterName, protocol.Cluster, StringComparison.Ordinal))
return ServerErrors.ErrLeafNodeHasSameClusterName;
lock (_mu)
{
Leaf ??= new Leaf();
Opts.Verbose = false;
Opts.Echo = false;
Opts.Pedantic = false;
Headers = server.SupportsHeaders() && protocol.Headers;
if (string.IsNullOrWhiteSpace(Leaf.Compression))
Leaf.Compression = string.IsNullOrWhiteSpace(protocol.Compression) ? CompressionMode.NotSupported : protocol.Compression;
Leaf.RemoteServer = protocol.Name;
Leaf.RemoteAccName = protocol.RemoteAccount;
Leaf.Isolated = Leaf.Isolated || protocol.Isolate;
Leaf.IsSpoke = protocol.Hub;
Leaf.RemoteCluster = protocol.Cluster;
Leaf.RemoteDomain = protocol.Domain;
if (protocol.DenyPub is { Length: > 0 })
MergeDenyPermissions(DenyType.Pub, protocol.DenyPub);
}
server.AddLeafNodeConnection(this, protocol.Name, protocol.Cluster, checkForDup: true);
server.SendPermsAndAccountInfo(this);
server.InitLeafNodeSmapAndSendSubs(this);
server.CheckInternalSyncConsumers(_account as Account);
return null;
}
internal void UpdateSmap(Internal.Subscription sub, int delta, bool isLds)
{
_ = isLds;
lock (_mu)
{
if (Leaf?.Smap is null)
return;
var key = LeafNodeHandler.KeyFromSub(sub);
Leaf.Smap.TryGetValue(key, out var current);
var next = current + delta;
var isQueue = sub.Queue is { Length: > 0 };
var shouldUpdate = isQueue || (current <= 0 && next > 0) || (current > 0 && next <= 0);
if (next > 0)
Leaf.Smap[key] = next;
else
Leaf.Smap.Remove(key);
if (shouldUpdate)
SendLeafNodeSubUpdate(key, next);
}
}
internal void ForceAddToSmap(string subject)
{
lock (_mu)
{
if (Leaf?.Smap is null)
return;
if (Leaf.Smap.TryGetValue(subject, out var value) && value != 0)
return;
Leaf.Smap[subject] = 1;
SendLeafNodeSubUpdate(subject, 1);
}
}
internal void ForceRemoveFromSmap(string subject)
{
lock (_mu)
{
if (Leaf?.Smap is null)
return;
if (!Leaf.Smap.TryGetValue(subject, out var value) || value == 0)
return;
value--;
if (value <= 0)
{
Leaf.Smap.Remove(subject);
SendLeafNodeSubUpdate(subject, 0);
}
else
{
Leaf.Smap[subject] = value;
}
}
}
internal void SendLeafNodeSubUpdate(string key, int n)
{
if (string.IsNullOrWhiteSpace(key))
return;
if (IsSpokeLeafNode())
{
var subject = key;
var separator = key.IndexOf(' ');
if (separator > 0)
subject = key[..separator];
var checkPermissions = !subject.StartsWith(LeafNodeHandler.LeafNodeLoopDetectionSubjectPrefix, StringComparison.Ordinal)
&& !subject.StartsWith("$GR.", StringComparison.Ordinal)
&& !subject.StartsWith("$GNR.", StringComparison.Ordinal);
if (checkPermissions && !CanSubscribe(subject))
return;
}
var buffer = new StringBuilder();
WriteLeafSub(buffer, key, n);
EnqueueProto(Encoding.ASCII.GetBytes(buffer.ToString()));
}
internal void WriteLeafSub(StringBuilder writer, string key, int n)
{
if (string.IsNullOrWhiteSpace(key))
return;
if (n > 0)
{
writer.Append("LS+ ").Append(key);
if (key.Contains(' '))
writer.Append(' ').Append(n);
}
else
{
writer.Append("LS- ").Append(key);
}
writer.Append("\r\n");
}
internal Exception? ProcessLeafSub(byte[] protoArg)
{
_in.Subs++;
if (Server is not NatsServer server)
return null;
var args = SplitArg(protoArg);
if (args.Count is not 1 and not 3)
return new FormatException($"processLeafSub Parse Error: '{Encoding.ASCII.GetString(protoArg)}'");
var key = Encoding.ASCII.GetString(args[0]);
var keyParts = key.Split(' ', StringSplitOptions.RemoveEmptyEntries);
if (keyParts.Length == 0)
return new FormatException($"processLeafSub Parse Error: '{key}'");
var subject = Encoding.ASCII.GetBytes(keyParts[0]);
byte[]? queue = null;
if (keyParts.Length > 1)
queue = Encoding.ASCII.GetBytes(keyParts[1]);
var qw = 1;
if (args.Count == 3)
{
if (!int.TryParse(Encoding.ASCII.GetString(args[2]), out qw) || qw <= 0)
qw = 1;
}
if (_account is not Account account)
return null;
lock (_mu)
{
if (IsClosed())
return null;
var subjectText = Encoding.ASCII.GetString(subject);
if (Perms is not null && !CanExport(subjectText))
{
LeafSubPermViolation(subject);
return null;
}
if (SubsAtLimit())
{
MaxSubsExceeded();
return null;
}
if (Subs.ContainsKey(key))
return null;
var sub = new Internal.Subscription
{
Subject = subject,
Queue = queue,
Sid = Encoding.ASCII.GetBytes(key),
Qw = qw,
};
Subs[key] = sub;
account.Sublist?.Insert(sub);
}
var subValue = Subs[key];
var delta = queue is { Length: > 0 } ? qw : 1;
if (!IsSpokeLeafNode())
{
server.UpdateRemoteSubscription(account, subValue, delta);
if (server.GetOpts().Gateway.Name.Length > 0)
server.UpdateInterestForAccountOnGateway(account.GetName(), subValue, delta);
}
account.UpdateLeafNodes(subValue, delta);
if (Opts.Verbose)
SendOK();
return null;
}
internal Exception? HandleLeafNodeLoop(bool detectedLocally)
{
_ = detectedLocally;
var (accountName, delay) = SetLeafConnectDelayIfSoliciting(LeafNodeHandler.LeafNodeReconnectDelayAfterLoopDetected);
if (string.IsNullOrWhiteSpace(accountName))
return null;
Warnf("Detected loop in leafnode setup for account {0}, reconnect delayed by {1}", accountName, delay);
return null;
}
internal Exception? ProcessLeafUnsub(byte[] arg)
{
_in.Subs++;
if (Server is not NatsServer server)
return null;
Internal.Subscription? sub;
var key = Encoding.ASCII.GetString(arg);
var spoke = false;
lock (_mu)
{
if (IsClosed())
return null;
spoke = IsSpokeLeafNode();
if (!Subs.TryGetValue(key, out sub))
return null;
Subs.Remove(key);
}
var account = _account as Account;
if (account is null || sub is null)
return null;
account.Sublist?.Remove(sub);
var delta = sub.Queue is { Length: > 0 } ? Math.Max(sub.Qw, 1) : 1;
if (!spoke)
{
server.UpdateRemoteSubscription(account, sub, -delta);
if (server.GetOpts().Gateway.Name.Length > 0)
server.UpdateInterestForAccountOnGateway(account.GetName(), sub, -delta);
}
account.UpdateLeafNodes(sub, -delta);
return null;
}
internal Exception? ProcessLeafHeaderMsgArgs(byte[] arg) =>
ProtocolParser.ProcessLeafHeaderMsgArgs(ParseCtx, arg);
internal Exception? ProcessLeafMsgArgs(byte[] arg) =>
ProtocolParser.ProcessLeafMsgArgs(ParseCtx, arg);
internal void ProcessInboundLeafMsg(byte[] msg)
{
ProcessInboundRoutedMsg(msg);
}
internal void LeafSubPermViolation(byte[] subject) => LeafPermViolation(pub: false, subject);
internal void LeafPermViolation(bool pub, byte[] subject)
{
if (IsSpokeLeafNode())
return;
SetLeafConnectDelayIfSoliciting(LeafNodeHandler.LeafNodeReconnectAfterPermViolation);
var subjectText = Encoding.ASCII.GetString(subject);
if (pub)
{
SendErr($"Permissions Violation for Publish to '{subjectText}'");
Errorf("Publish Violation on '{0}' - Check other side configuration", subjectText);
}
else
{
SendErr($"Permissions Violation for Subscription to '{subjectText}'");
Errorf("Subscription Violation on '{0}' - Check other side configuration", subjectText);
}
CloseConnection(ClosedState.ProtocolViolation);
}
internal void LeafProcessErr(string errorText)
{
if (errorText.Contains(ServerErrors.ErrLeafNodeHasSameClusterName.Message, StringComparison.Ordinal))
{
var (_, delay) = SetLeafConnectDelayIfSoliciting(LeafNodeHandler.LeafNodeReconnectDelayAfterClusterNameSame);
Errorf("Leafnode connection dropped with same cluster name error. Delaying reconnect for {0}", delay);
return;
}
if (errorText.Contains("Loop detected", StringComparison.OrdinalIgnoreCase))
_ = HandleLeafNodeLoop(detectedLocally: false);
}
internal (string AccountName, TimeSpan Delay) SetLeafConnectDelayIfSoliciting(TimeSpan delay)
{
lock (_mu)
{
if (IsSolicitedLeafNode())
Leaf?.Remote?.SetConnectDelay(delay);
return (_account?.Name ?? string.Empty, delay);
}
}
internal (bool TlsRequired, SslServerAuthenticationOptions? TlsConfig, string TlsName, double TlsTimeout) LeafNodeGetTLSConfigForSolicit(LeafNodeCfg remote)
{
remote.AcquireReadLock();
try
{
var opts = remote.RemoteOpts;
var tlsRequired = opts?.Tls == true || opts?.TlsConfig is not null;
return (tlsRequired, opts?.TlsConfig, remote.TlsName, opts?.TlsTimeout ?? ServerConstants.TlsTimeout.TotalSeconds);
}
finally
{
remote.ReleaseReadLock();
}
}
internal (byte[]? PreBuffer, ClosedState CloseReason, Exception? Error) LeafNodeSolicitWSConnection(ServerOptions options, Uri remoteUrl, LeafNodeCfg remote)
{
_ = options;
_ = remote;
if (!string.Equals(remoteUrl.Scheme, "ws", StringComparison.OrdinalIgnoreCase)
&& !string.Equals(remoteUrl.Scheme, "wss", StringComparison.OrdinalIgnoreCase))
return (null, ClosedState.ProtocolViolation, new InvalidOperationException("URL is not websocket based"));
return (null, ClosedState.ClientClosed, null);
}
}
@@ -1803,8 +1803,8 @@ public sealed partial class ClientConnection
internal bool IsMqtt() => false; // Deferred to session 22 (MQTT).
internal bool IsWebSocket() => Ws != null;
internal bool IsHubLeafNode() => false; // Deferred to session 15 (leaf nodes).
internal string RemoteCluster() => string.Empty; // Deferred to sessions 14/15.
internal bool IsHubLeafNode() => Kind == ClientKind.Leaf && Leaf?.IsSpoke != true;
internal string RemoteCluster() => Leaf?.RemoteCluster ?? string.Empty;
}
// ============================================================================
@@ -0,0 +1,313 @@
namespace ZB.MOM.NatsNet.Server;
internal sealed partial class NatsConsumer
{
internal (JsPubMsg? Message, ulong DeliveryCount, Exception? Error) GetNextMsg()
{
_mu.EnterWriteLock();
try
{
if (_closed)
return (null, 0, new InvalidOperationException("consumer not valid"));
if (_state.Pending is { Count: > 0 })
{
var sequence = _state.Pending.Keys.Min();
var deliveryCount = IncDeliveryCount(sequence);
var message = new JsPubMsg
{
Subject = Config.DeliverSubject ?? string.Empty,
Reply = AckReply(sequence, _state.Delivered.Consumer + 1, deliveryCount, DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(), NumPending()),
Msg = [],
};
return (message, deliveryCount, null);
}
return (null, 0, null);
}
finally
{
_mu.ExitWriteLock();
}
}
internal (int Expired, int Waiting, int BatchRequestsPending, DateTime FirstExpiration) ProcessWaiting(bool endOfStream)
{
_mu.EnterWriteLock();
try
{
var firstExpiration = DateTime.MinValue;
if (_waiting is null || _waiting.IsEmpty())
return (0, 0, 0, firstExpiration);
var expired = 0;
var batchRequestsPending = 0;
var now = DateTime.UtcNow;
var toRemove = new List<WaitingRequest>();
foreach (var waitingRequest in _waiting.Snapshot())
{
var isExpired = waitingRequest.Expires is DateTime expiresAt && now >= expiresAt;
if ((endOfStream && waitingRequest.NoWait == 1) || isExpired)
{
toRemove.Add(waitingRequest);
expired++;
continue;
}
batchRequestsPending += Math.Max(0, waitingRequest.N);
if (waitingRequest.Expires is DateTime wrExpires &&
(firstExpiration == DateTime.MinValue || wrExpires < firstExpiration))
{
firstExpiration = wrExpires;
}
}
foreach (var waitingRequest in toRemove)
_waiting.Remove(null, waitingRequest);
return (expired, _waiting.Len, batchRequestsPending, firstExpiration);
}
finally
{
_mu.ExitWriteLock();
}
}
internal bool CheckWaitingForInterest()
{
var (_, waiting, _, _) = ProcessWaiting(endOfStream: true);
return waiting > 0;
}
internal (TimeSpan Duration, Timer? Timer) HbTimer()
{
if (Config.Heartbeat <= TimeSpan.Zero)
return (TimeSpan.Zero, null);
return (Config.Heartbeat, new Timer(static _ => { }, null, Config.Heartbeat, Timeout.InfiniteTimeSpan));
}
internal void CheckAckFloor()
{
_mu.EnterWriteLock();
try
{
if (_closed || _state.Pending is not { Count: > 0 })
return;
var minPending = _state.Pending.OrderBy(static pair => pair.Key).First();
var pendingStream = minPending.Key;
var pendingConsumer = minPending.Value?.Sequence ?? pendingStream;
var desiredStreamFloor = pendingStream > 0 ? pendingStream - 1 : 0;
var desiredConsumerFloor = pendingConsumer > 0 ? pendingConsumer - 1 : 0;
if (_state.AckFloor.Stream < desiredStreamFloor)
_state.AckFloor.Stream = desiredStreamFloor;
if (_state.AckFloor.Consumer < desiredConsumerFloor)
_state.AckFloor.Consumer = desiredConsumerFloor;
}
finally
{
_mu.ExitWriteLock();
}
}
internal int ProcessInboundAcks(CancellationToken cancellationToken)
{
var processed = 0;
while (!cancellationToken.IsCancellationRequested)
{
JsAckMsg? ack;
_mu.EnterWriteLock();
try
{
if (_ackQueue.Count == 0)
break;
ack = _ackQueue.Dequeue();
}
finally
{
_mu.ExitWriteLock();
}
ProcessAck(ack.Subject, ack.Reply, ack.HeaderBytes, ack.Msg);
processed++;
}
return processed;
}
internal int ProcessInboundNextMsgReqs(CancellationToken cancellationToken)
{
var processed = 0;
while (!cancellationToken.IsCancellationRequested)
{
NextMsgReq? request;
_mu.EnterWriteLock();
try
{
if (_nextMsgReqs is null || _nextMsgReqs.Count == 0)
break;
request = _nextMsgReqs.Dequeue();
}
finally
{
_mu.ExitWriteLock();
}
_ = ProcessNextMsgRequest(request.Reply, request.Message);
request.ReturnToPool();
processed++;
}
return processed;
}
internal void SuppressDeletion()
{
_mu.EnterWriteLock();
try
{
if (_closed || _deleteTimer is null || _deleteThreshold <= TimeSpan.Zero)
return;
_deleteTimer.Change(_deleteThreshold, Timeout.InfiniteTimeSpan);
}
finally
{
_mu.ExitWriteLock();
}
}
internal int LoopAndGatherMsgs(int maxIterations, CancellationToken cancellationToken)
{
var delivered = 0;
for (var i = 0; i < maxIterations && !cancellationToken.IsCancellationRequested; i++)
{
var (message, _, error) = GetNextMsg();
if (error is not null || message is null)
break;
delivered++;
_state.Delivered.Stream = Math.Max(_state.Delivered.Stream, (ulong)delivered);
_state.Delivered.Consumer = Math.Max(_state.Delivered.Consumer, (ulong)delivered);
var expired = ProcessWaiting(endOfStream: false);
if (expired.Waiting == 0)
break;
}
return delivered;
}
internal string SendIdleHeartbeat(string subject)
{
var streamSequence = _state.Delivered.Stream;
var consumerSequence = _state.Delivered.Consumer;
var heartbeat = $"NATS/1.0 100 Idle Heartbeat\r\nNats-Last-Consumer: {consumerSequence}\r\nNats-Last-Stream: {streamSequence}\r\n\r\n";
_ = SendAdvisory(subject, heartbeat);
return heartbeat;
}
internal string AckReply(ulong streamSequence, ulong deliverySequence, ulong deliveryCount, long timestamp, ulong pending) =>
$"$JS.ACK.{deliveryCount}.{streamSequence}.{deliverySequence}.{timestamp}.{pending}";
internal void SetMaxPendingBytes(int limit)
{
_mu.EnterWriteLock();
try
{
_maxPendingBytesLimit = Math.Max(0, limit);
_maxPendingBytesThreshold = Math.Max(1, _maxPendingBytesLimit / 16);
}
finally
{
_mu.ExitWriteLock();
}
}
internal (ulong Pending, Exception? Error) CheckNumPending()
{
_mu.EnterWriteLock();
try
{
if (_npc < 0)
_npc = 0;
var (pending, floor, error) = CalculateNumPending();
if (error is not null)
return (0, error);
_npc = (long)pending;
_npf = floor;
return (NumPending(), null);
}
finally
{
_mu.ExitWriteLock();
}
}
internal ulong NumPending() => _npc < 0 ? 0UL : (ulong)_npc;
internal void CheckNumPendingOnEOF()
{
_mu.EnterWriteLock();
try
{
if (_npc < 0)
_npc = 0;
if (_state.Delivered.Stream <= _state.AckFloor.Stream)
{
_npc = 0;
_npf = _state.Delivered.Stream;
}
}
finally
{
_mu.ExitWriteLock();
}
}
internal (ulong Pending, Exception? Error) StreamNumPendingLocked()
{
_mu.EnterWriteLock();
try
{
return StreamNumPending();
}
finally
{
_mu.ExitWriteLock();
}
}
internal (ulong Pending, Exception? Error) StreamNumPending()
{
var (pending, floor, error) = CalculateNumPending();
if (error is not null)
return (0, error);
_npc = (long)pending;
_npf = floor;
return (NumPending(), null);
}
internal (ulong Pending, ulong Floor, Exception? Error) CalculateNumPending()
{
if (_closed)
return (0, 0, null);
var delivered = _state.Delivered.Stream;
var acked = _state.AckFloor.Stream;
if (delivered <= acked)
return (0, delivered, null);
return (delivered - acked, delivered, null);
}
}
@@ -0,0 +1,161 @@
using System.Text;
namespace ZB.MOM.NatsNet.Server;
internal sealed partial class NatsConsumer
{
internal static void ConvertToHeadersOnly(JsPubMsg message)
{
ArgumentNullException.ThrowIfNull(message);
var payloadSize = message.Msg?.Length ?? 0;
var builder = new StringBuilder();
builder.Append("NATS/1.0\r\n");
builder.Append("Nats-Msg-Size: ");
builder.Append(payloadSize);
builder.Append("\r\n\r\n");
message.Hdr = Encoding.ASCII.GetBytes(builder.ToString());
message.Msg = [];
}
internal void DeliverMsg(string deliverySubject, string ackReply, JsPubMsg message, ulong deliveryCount, RetentionPolicy retentionPolicy)
{
ArgumentNullException.ThrowIfNull(message);
_mu.EnterWriteLock();
try
{
var nextDeliverySequence = _state.Delivered.Consumer + 1;
var streamSequence = ParseAckReplyNum(ackReply.Split('.', StringSplitOptions.RemoveEmptyEntries).LastOrDefault() ?? string.Empty);
var streamSeq = streamSequence > 0 ? (ulong)streamSequence : _state.Delivered.Stream + 1;
_state.Delivered.Consumer = nextDeliverySequence;
_state.Delivered.Stream = streamSeq;
if (Config.AckPolicy is AckPolicy.AckExplicit or AckPolicy.AckAll)
TrackPending(streamSeq, nextDeliverySequence);
else
_state.AckFloor = new SequencePair { Consumer = nextDeliverySequence, Stream = streamSeq };
message.Subject = deliverySubject;
message.Reply = ackReply;
Interlocked.Add(ref _pendingBytes, message.Size());
if (NeedFlowControl(message.Size()))
SendFlowControl();
if (retentionPolicy != RetentionPolicy.LimitsPolicy && Config.AckPolicy == AckPolicy.AckNone)
_state.AckFloor = new SequencePair { Consumer = nextDeliverySequence, Stream = streamSeq };
_ = deliveryCount;
}
finally
{
_mu.ExitWriteLock();
}
}
internal bool ReplicateDeliveries() =>
Config.AckPolicy != AckPolicy.AckNone && Config.FlowControl == false && IsLeader();
internal bool NeedFlowControl(int size)
{
if (_flowControlWindow <= 0)
return false;
if (string.IsNullOrEmpty(_flowControlReplyId) && _pendingBytes > _flowControlWindow / 2)
return true;
if (!string.IsNullOrEmpty(_flowControlReplyId) && _pendingBytes - _flowControlSentBytes >= _flowControlWindow)
_flowControlSentBytes += size;
return false;
}
internal void ProcessFlowControl(string subject)
{
_mu.EnterWriteLock();
try
{
if (!string.Equals(subject, _flowControlReplyId, StringComparison.Ordinal))
return;
if (_flowControlWindow > 0 && _flowControlWindow < _maxPendingBytesLimit)
_flowControlWindow = Math.Min(_flowControlWindow * 2, Math.Max(1, _maxPendingBytesLimit));
_pendingBytes = Math.Max(0, _pendingBytes - _flowControlSentBytes);
_flowControlSentBytes = 0;
_flowControlReplyId = string.Empty;
SignalNewMessages();
}
finally
{
_mu.ExitWriteLock();
}
}
internal string FcReply() =>
$"$JS.FC.{Stream}.{Name}.{Random.Shared.Next(1000, 9999)}";
internal bool SendFlowControl()
{
_mu.EnterWriteLock();
try
{
if (!IsPushMode())
return false;
var reply = FcReply();
_flowControlReplyId = reply;
_flowControlSentBytes = (int)Math.Max(0, _pendingBytes);
return true;
}
finally
{
_mu.ExitWriteLock();
}
}
internal void TrackPending(ulong streamSequence, ulong deliverySequence)
{
_state.Pending ??= [];
if (_state.Pending.TryGetValue(streamSequence, out var pending))
{
pending.Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds();
_state.Pending[streamSequence] = pending;
}
else
{
_state.Pending[streamSequence] = new Pending
{
Sequence = deliverySequence,
Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(),
};
}
}
internal void CreditWaitingRequest(string reply)
{
_mu.EnterWriteLock();
try
{
if (_waiting is null)
return;
foreach (var waitingRequest in _waiting.Snapshot())
{
if (!string.Equals(waitingRequest.Reply, reply, StringComparison.Ordinal))
continue;
waitingRequest.N++;
waitingRequest.D = Math.Max(0, waitingRequest.D - 1);
return;
}
}
finally
{
_mu.ExitWriteLock();
}
}
}
@@ -0,0 +1,141 @@
using System.Collections.Concurrent;
using System.Text;
using System.Text.Json;
namespace ZB.MOM.NatsNet.Server;
internal sealed partial class NatsConsumer
{
internal static NextMsgReq NewNextMsgReq(string reply, byte[] message) => NextMsgReq.Rent(reply, message);
internal void ProcessNextMsgReq(string reply, byte[] rawMessage)
{
if (string.IsNullOrWhiteSpace(reply))
return;
ArgumentNullException.ThrowIfNull(rawMessage);
_mu.EnterWriteLock();
try
{
if (_nextMsgReqs is null)
return;
_nextMsgReqs.Enqueue(NewNextMsgReq(reply, (byte[])rawMessage.Clone()));
}
finally
{
_mu.ExitWriteLock();
}
}
internal (ulong Sequence, bool CanRespond, Exception? Error) ProcessResetReq(string reply, byte[] rawMessage)
{
if (string.IsNullOrWhiteSpace(reply))
return (0, false, null);
ArgumentNullException.ThrowIfNull(rawMessage);
if (rawMessage.Length == 0)
return ResetStartingSeq(0, reply);
try
{
var request = JsonSerializer.Deserialize<JsApiConsumerResetRequest>(Encoding.UTF8.GetString(rawMessage));
return ResetStartingSeq(request?.Seq ?? 0, reply);
}
catch (Exception ex)
{
return (0, false, ex);
}
}
internal bool ProcessNextMsgRequest(string reply, byte[] message)
{
if (string.IsNullOrWhiteSpace(reply))
return false;
ArgumentNullException.ThrowIfNull(message);
_mu.EnterWriteLock();
try
{
if (IsPushMode() || _waiting is null)
return false;
var (request, error) = NextReqFromMsg(message);
if (error is not null || request is null)
return false;
var batchSize = Math.Max(1, request.Batch);
if (Config.MaxRequestBatch > 0 && batchSize > Config.MaxRequestBatch)
return false;
if (request.MaxBytes > 0 && Config.MaxRequestMaxBytes > 0 && request.MaxBytes > Config.MaxRequestMaxBytes)
return false;
if (request.Expires > TimeSpan.Zero && Config.MaxRequestExpires > TimeSpan.Zero && request.Expires > Config.MaxRequestExpires)
return false;
var expires = request.Expires > TimeSpan.Zero ? DateTime.UtcNow.Add(request.Expires) : (DateTime?)null;
if (_waiting.IsFull(Config.MaxWaiting))
return false;
var waitingRequest = new WaitingRequest
{
Subject = reply,
Reply = reply,
N = batchSize,
D = 0,
NoWait = request.NoWait ? 1 : 0,
Expires = expires,
MaxBytes = Math.Max(0, request.MaxBytes),
B = 0,
PriorityGroup = request.Priority,
};
if (Config.PriorityPolicy == PriorityPolicy.PriorityPrioritized)
{
if (!_waiting.AddPrioritized(waitingRequest))
return false;
}
else
{
_waiting.Add(waitingRequest);
}
SignalNewMessages();
return true;
}
finally
{
_mu.ExitWriteLock();
}
}
}
internal sealed class NextMsgReq
{
private static readonly ConcurrentBag<NextMsgReq> Pool = [];
internal string Reply { get; private set; } = string.Empty;
internal byte[] Message { get; private set; } = [];
internal static NextMsgReq Rent(string reply, byte[] message)
{
ArgumentNullException.ThrowIfNull(message);
if (!Pool.TryTake(out var request))
request = new NextMsgReq();
request.Reply = reply;
request.Message = message;
return request;
}
internal void ReturnToPool()
{
Reply = string.Empty;
Message = [];
Pool.Add(this);
}
}
@@ -0,0 +1,156 @@
namespace ZB.MOM.NatsNet.Server;
internal sealed partial class NatsConsumer
{
internal void DidNotDeliver(ulong sequence, string subject)
{
_mu.EnterWriteLock();
try
{
DecDeliveryCount(sequence);
if (IsPushMode())
_hasLocalDeliveryInterest = false;
else
CreditWaitingRequest(subject);
if (_state.Pending is { } pending && pending.ContainsKey(sequence) && !OnRedeliverQueue(sequence))
{
AddToRedeliverQueue(sequence);
if (_waiting is { } waiting && !waiting.IsEmpty())
SignalNewMessages();
}
}
finally
{
_mu.ExitWriteLock();
}
}
internal void AddToRedeliverQueue(params ulong[] sequences)
{
_mu.EnterWriteLock();
try
{
foreach (var sequence in sequences)
{
_redeliveryQueue.Enqueue(sequence);
_redeliveryIndex.Add(sequence);
}
}
finally
{
_mu.ExitWriteLock();
}
}
internal bool HasRedeliveries() => _redeliveryQueue.Count > 0;
internal ulong GetNextToRedeliver()
{
_mu.EnterWriteLock();
try
{
if (_redeliveryQueue.Count == 0)
return 0;
var sequence = _redeliveryQueue.Dequeue();
_redeliveryIndex.Remove(sequence);
return sequence;
}
finally
{
_mu.ExitWriteLock();
}
}
internal bool OnRedeliverQueue(ulong sequence) => _redeliveryIndex.Contains(sequence);
internal bool RemoveFromRedeliverQueue(ulong sequence)
{
_mu.EnterWriteLock();
try
{
if (!_redeliveryIndex.Remove(sequence))
return false;
if (_redeliveryQueue.Count == 0)
return true;
var retained = _redeliveryQueue.Where(s => s != sequence).ToArray();
_redeliveryQueue.Clear();
foreach (var s in retained)
_redeliveryQueue.Enqueue(s);
return true;
}
finally
{
_mu.ExitWriteLock();
}
}
internal int CheckPending()
{
_mu.EnterWriteLock();
try
{
if (_state.Pending is not { Count: > 0 })
return 0;
var expired = 0;
var cutoff = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() - (long)Math.Max(1, Config.AckWait.TotalMilliseconds);
var toRedeliver = new List<ulong>();
foreach (var (sequence, pending) in _state.Pending.ToArray())
{
if (pending.Timestamp < cutoff)
{
toRedeliver.Add(sequence);
expired++;
}
}
if (toRedeliver.Count > 0)
{
toRedeliver.Sort();
AddToRedeliverQueue(toRedeliver.ToArray());
SignalNewMessages();
}
return expired;
}
finally
{
_mu.ExitWriteLock();
}
}
internal ulong SeqFromReply(string reply)
{
var (_, deliverySequence, _) = AckReplyInfo(reply);
return deliverySequence;
}
internal ulong StreamSeqFromReply(string reply)
{
var (streamSequence, _, _) = AckReplyInfo(reply);
return streamSequence;
}
internal static long ParseAckReplyNum(string token)
{
if (string.IsNullOrWhiteSpace(token))
return -1;
long number = 0;
foreach (var character in token)
{
if (!char.IsAsciiDigit(character))
return -1;
number = (number * 10) + (character - '0');
}
return number;
}
}
@@ -0,0 +1,118 @@
namespace ZB.MOM.NatsNet.Server;
internal sealed partial class NatsConsumer
{
internal static (ulong StreamSequence, ulong DeliverySequence, ulong DeliveryCount, long Timestamp, ulong Pending) ReplyInfo(string subject)
{
if (string.IsNullOrWhiteSpace(subject))
return (0, 0, 0, 0, 0);
var tokens = subject.Split('.', StringSplitOptions.RemoveEmptyEntries);
if (tokens.Length < 9 || !string.Equals(tokens[0], "$JS", StringComparison.Ordinal) || !string.Equals(tokens[1], "ACK", StringComparison.Ordinal))
return (0, 0, 0, 0, 0);
var deliveryCount = (ulong)Math.Max(0, ParseAckReplyNum(tokens[4]));
var streamSequence = (ulong)Math.Max(0, ParseAckReplyNum(tokens[5]));
var deliverySequence = (ulong)Math.Max(0, ParseAckReplyNum(tokens[6]));
var timestamp = ParseAckReplyNum(tokens[7]);
var pending = (ulong)Math.Max(0, ParseAckReplyNum(tokens[8]));
return (streamSequence, deliverySequence, deliveryCount, timestamp, pending);
}
internal ulong NextSeq()
{
_mu.EnterReadLock();
try
{
return _state.Delivered.Consumer + 1;
}
finally
{
_mu.ExitReadLock();
}
}
internal bool HasSkipListPending() => false;
internal void SelectStartingSeqNo()
{
_mu.EnterWriteLock();
try
{
var start = Config.OptStartSeq > 0 ? Config.OptStartSeq : 1UL;
_state.Delivered = new SequencePair { Consumer = 1, Stream = start };
_state.AckFloor = new SequencePair { Consumer = 0, Stream = start > 0 ? start - 1 : 0 };
_npc = 0;
_npf = _state.AckFloor.Stream;
}
finally
{
_mu.ExitWriteLock();
}
}
internal static bool IsDurableConsumer(ConsumerConfig? config) =>
config is not null && !string.IsNullOrWhiteSpace(config.Durable);
internal bool IsDurable() => !string.IsNullOrWhiteSpace(Config.Durable);
internal string String() => Name;
internal static string CreateConsumerName() => Guid.NewGuid().ToString("N")[..12];
internal NatsStream? GetStream()
{
_mu.EnterReadLock();
try
{
return _streamRef;
}
finally
{
_mu.ExitReadLock();
}
}
internal string StreamName() => GetStream()?.Name ?? string.Empty;
internal bool IsActive()
{
_mu.EnterReadLock();
try
{
return !_closed && (_hasLocalDeliveryInterest || IsPullMode());
}
finally
{
_mu.ExitReadLock();
}
}
internal bool HasNoLocalInterest() => !HasDeliveryInterest(localInterest: true);
internal void Purge()
{
_mu.EnterWriteLock();
try
{
_state.Pending?.Clear();
_state.Redelivered?.Clear();
_redeliveryQueue.Clear();
_redeliveryIndex.Clear();
_npc = 0;
}
finally
{
_mu.ExitWriteLock();
}
}
internal static Timer? StopAndClearTimer(Timer? timer)
{
timer?.Dispose();
return null;
}
internal void DeleteWithoutAdvisory() => Stop();
}
@@ -0,0 +1,222 @@
namespace ZB.MOM.NatsNet.Server;
internal sealed partial class NatsConsumer
{
internal void StopWithFlags(bool clearPending, bool clearAdvisories)
{
_mu.EnterWriteLock();
try
{
_closed = true;
_quitCts?.Cancel();
_deleteTimer = StopAndClearTimer(_deleteTimer);
_pendingTimer = StopAndClearTimer(_pendingTimer);
if (clearPending)
ResetPendingDeliveries();
if (!clearAdvisories)
_ = SendDeleteAdvisoryLocked();
}
finally
{
_mu.ExitWriteLock();
}
}
internal int CleanupNoInterestMessages()
{
_mu.EnterWriteLock();
try
{
if (_state.Pending is not { Count: > 0 })
return 0;
var removed = _state.Pending.Count;
_state.Pending.Clear();
_streamPending = 0;
return removed;
}
finally
{
_mu.ExitWriteLock();
}
}
internal static bool DeliveryFormsCycle(string subject, string deliverSubject) =>
!string.IsNullOrWhiteSpace(subject) &&
!string.IsNullOrWhiteSpace(deliverSubject) &&
subject.StartsWith(deliverSubject, StringComparison.Ordinal);
internal bool SwitchToEphemeral()
{
_mu.EnterWriteLock();
try
{
if (string.IsNullOrWhiteSpace(Config.Durable))
return false;
Config.Durable = null;
Name = CreateConsumerName();
return true;
}
finally
{
_mu.ExitWriteLock();
}
}
internal string RequestNextMsgSubject() =>
$"$JS.API.CONSUMER.MSG.NEXT.{Stream}.{Name}";
internal long DecStreamPending()
{
_mu.EnterWriteLock();
try
{
_streamPending = Math.Max(0, _streamPending - 1);
return _streamPending;
}
finally
{
_mu.ExitWriteLock();
}
}
internal Account? Account() => GetStream()?.Account;
internal void SignalSubs() => SignalNewMessages();
internal bool ProcessStreamSignal(string subject, ulong sequence)
{
_ = subject;
_mu.EnterWriteLock();
try
{
if (_closed)
return false;
_state.Delivered.Stream = Math.Max(_state.Delivered.Stream, sequence);
SignalNewMessages();
return true;
}
finally
{
_mu.ExitWriteLock();
}
}
internal static bool SubjectSliceEqual(string[] left, string[] right)
{
if (ReferenceEquals(left, right))
return true;
if (left.Length != right.Length)
return false;
for (var i = 0; i < left.Length; i++)
{
if (!string.Equals(left[i], right[i], StringComparison.Ordinal))
return false;
}
return true;
}
internal static string[] GatherSubjectFilters(ConsumerConfig config)
{
ArgumentNullException.ThrowIfNull(config);
if (config.FilterSubjects is { Length: > 0 })
return config.FilterSubjects.Where(s => !string.IsNullOrWhiteSpace(s)).ToArray();
if (!string.IsNullOrWhiteSpace(config.FilterSubject))
return [config.FilterSubject!];
return [];
}
internal bool ShouldStartMonitor()
{
_mu.EnterReadLock();
try
{
return !_closed && !_monitorRunning && (Config.InactiveThreshold > TimeSpan.Zero || IsPushMode());
}
finally
{
_mu.ExitReadLock();
}
}
internal void ClearMonitorRunning()
{
_mu.EnterWriteLock();
try
{
_monitorRunning = false;
}
finally
{
_mu.ExitWriteLock();
}
}
internal bool IsMonitorRunning()
{
_mu.EnterReadLock();
try
{
return _monitorRunning;
}
finally
{
_mu.ExitReadLock();
}
}
internal bool CheckStateForInterestStream()
{
_mu.EnterReadLock();
try
{
return _state.Pending is { Count: > 0 } || HasDeliveryInterest();
}
finally
{
_mu.ExitReadLock();
}
}
internal void ResetPtmr(TimeSpan due)
{
_mu.EnterWriteLock();
try
{
_pendingTimer ??= new Timer(static s => ((NatsConsumer)s!).CheckPending(), this, Timeout.InfiniteTimeSpan, Timeout.InfiniteTimeSpan);
if (due <= TimeSpan.Zero)
due = TimeSpan.FromMilliseconds(1);
_pendingTimer.Change(due, Timeout.InfiniteTimeSpan);
}
finally
{
_mu.ExitWriteLock();
}
}
internal void StopAndClearPtmr()
{
_mu.EnterWriteLock();
try
{
_pendingTimer = StopAndClearTimer(_pendingTimer);
}
finally
{
_mu.ExitWriteLock();
}
}
internal void ResetPendingDeliveries()
{
_state.Pending?.Clear();
_state.Redelivered?.Clear();
_redeliveryQueue.Clear();
_redeliveryIndex.Clear();
_npc = 0;
}
}
@@ -0,0 +1,261 @@
using ZB.MOM.NatsNet.Server.Internal.DataStructures;
namespace ZB.MOM.NatsNet.Server;
internal sealed partial class NatsConsumer
{
internal static void InsertAtPosition(WaitingRequest request, WaitQueue waitQueue)
{
ArgumentNullException.ThrowIfNull(request);
ArgumentNullException.ThrowIfNull(waitQueue);
waitQueue.InsertSorted(request);
}
internal Dictionary<string, WaitingRequest> PendingRequests()
{
_mu.EnterReadLock();
try
{
if (_waiting is null || _waiting.IsEmpty())
return [];
var requests = new Dictionary<string, WaitingRequest>(StringComparer.Ordinal);
foreach (var waitingRequest in _waiting.Snapshot())
{
if (!string.IsNullOrWhiteSpace(waitingRequest.Reply))
requests[waitingRequest.Reply] = waitingRequest;
}
return requests;
}
finally
{
_mu.ExitReadLock();
}
}
internal void SetPinnedTimer(string priorityGroup)
{
if (Config.PinnedTTL <= TimeSpan.Zero)
return;
_pinnedTtlTimer ??= new Timer(
state =>
{
var consumer = (NatsConsumer)state!;
consumer._mu.EnterWriteLock();
try
{
if (string.IsNullOrEmpty(consumer._currentPinId))
return;
consumer.UnassignPinId();
consumer.SendUnpinnedAdvisoryLocked(priorityGroup);
}
finally
{
consumer._mu.ExitWriteLock();
}
consumer.SignalNewMessages();
},
this,
Timeout.InfiniteTimeSpan,
Timeout.InfiniteTimeSpan);
_pinnedTtlTimer.Change(Config.PinnedTTL, Timeout.InfiniteTimeSpan);
}
internal void AssignNewPinId(WaitingRequest request)
{
ArgumentNullException.ThrowIfNull(request);
if (request.PriorityGroup is not { Group.Length: > 0 } priorityGroup)
return;
_currentPinId = Guid.NewGuid().ToString("N");
_pinnedTs = DateTime.UtcNow;
priorityGroup.Id = _currentPinId;
SetPinnedTimer(priorityGroup.Group);
SendPinnedAdvisoryLocked(priorityGroup.Group);
}
internal void UnassignPinId()
{
_currentPinId = string.Empty;
_pinnedTs = DateTime.UnixEpoch;
_pinnedTtlTimer?.Change(Timeout.InfiniteTimeSpan, Timeout.InfiniteTimeSpan);
}
internal WaitingRequest? NextWaiting(int messageSize)
{
_mu.EnterWriteLock();
try
{
if (_waiting is null || _waiting.IsEmpty())
return null;
var numCycled = 0;
while (!_waiting.IsEmpty())
{
var waitingRequest = _waiting.Peek();
if (waitingRequest is null)
return null;
if (waitingRequest.Expires is DateTime expiresAt && expiresAt <= DateTime.UtcNow)
{
_waiting.RemoveCurrent();
waitingRequest.Recycle();
continue;
}
if (waitingRequest.MaxBytes > 0)
{
if (messageSize > waitingRequest.MaxBytes)
{
_waiting.RemoveCurrent();
waitingRequest.Recycle();
continue;
}
waitingRequest.MaxBytes -= messageSize;
if (waitingRequest.MaxBytes == 0)
waitingRequest.N = 1;
}
if (Config.PriorityPolicy == PriorityPolicy.PriorityPinnedClient)
{
if (string.IsNullOrEmpty(_currentPinId))
{
if (string.IsNullOrEmpty(waitingRequest.PriorityGroup?.Id))
AssignNewPinId(waitingRequest);
}
else if (waitingRequest.PriorityGroup is { } priorityGroup)
{
if (string.Equals(priorityGroup.Id, _currentPinId, StringComparison.Ordinal))
{
// Matched the active pin, continue.
}
else if (string.IsNullOrEmpty(priorityGroup.Id))
{
_waiting.Cycle();
numCycled++;
if (numCycled >= _waiting.Len)
return null;
continue;
}
else
{
_waiting.RemoveCurrent();
waitingRequest.Recycle();
continue;
}
}
}
return _waiting.PopOrPopAndRequeue(Config.PriorityPolicy);
}
return null;
}
finally
{
_mu.ExitWriteLock();
}
}
internal static (Account Account, string Interest) TrackDownAccountAndInterest(Account account, string interest)
{
ArgumentNullException.ThrowIfNull(account);
return (account, interest);
}
internal ulong DeliveryCount(ulong streamSequence)
{
_mu.EnterReadLock();
try
{
if (_rdc is null)
return 1;
return _rdc.TryGetValue(streamSequence, out var count) && count >= 1 ? count : 1;
}
finally
{
_mu.ExitReadLock();
}
}
internal ulong IncDeliveryCount(ulong streamSequence)
{
_mu.EnterWriteLock();
try
{
_rdc ??= [];
_rdc[streamSequence] = _rdc.GetValueOrDefault(streamSequence) + 1;
return _rdc[streamSequence] + 1;
}
finally
{
_mu.ExitWriteLock();
}
}
internal void DecDeliveryCount(ulong streamSequence)
{
_mu.EnterWriteLock();
try
{
_rdc ??= [];
_rdc[streamSequence] = _rdc.GetValueOrDefault(streamSequence) - 1;
}
finally
{
_mu.ExitWriteLock();
}
}
internal void NotifyDeliveryExceeded(ulong streamSequence, ulong deliveryCount)
{
var advisory = new
{
Stream,
Consumer = Name,
StreamSeq = streamSequence,
Deliveries = deliveryCount,
Timestamp = DateTime.UtcNow,
};
_ = SendAdvisory($"{JsApiSubjects.JsAdvisoryConsumerMaxDelivery}.{Stream}.{Name}", advisory);
}
internal bool IsFilteredMatch(string subject)
{
if (Config.FilterSubjects is not { Length: > 0 } && string.IsNullOrWhiteSpace(Config.FilterSubject))
return true;
if (!string.IsNullOrWhiteSpace(Config.FilterSubject) && SubjectIsExactOrSubsetMatch(subject, Config.FilterSubject!))
return true;
if (Config.FilterSubjects is not { Length: > 0 })
return false;
return Config.FilterSubjects.Any(filter => SubjectIsExactOrSubsetMatch(subject, filter));
}
internal bool IsEqualOrSubsetMatch(string subject)
{
if (Config.FilterSubjects is not { Length: > 0 } && string.IsNullOrWhiteSpace(Config.FilterSubject))
return false;
if (!string.IsNullOrWhiteSpace(Config.FilterSubject) && SubjectIsExactOrSubsetMatch(Config.FilterSubject!, subject))
return true;
if (Config.FilterSubjects is not { Length: > 0 })
return false;
return Config.FilterSubjects.Any(filter => SubjectIsExactOrSubsetMatch(filter, subject));
}
private static bool SubjectIsExactOrSubsetMatch(string subject, string filter) =>
string.Equals(subject, filter, StringComparison.Ordinal) || SubscriptionIndex.SubjectIsSubsetMatch(subject, filter);
}
@@ -34,7 +34,12 @@ internal sealed partial class NatsConsumer
if (!interest && _deleteThreshold > TimeSpan.Zero)
{
_deleteTimer = new Timer(static s => ((NatsConsumer)s!).DeleteNotActive(), this, _deleteThreshold, Timeout.InfiniteTimeSpan);
var due = _deleteThreshold < TimeSpan.FromMilliseconds(50)
? TimeSpan.FromMilliseconds(1)
: _deleteThreshold;
_deleteTimer = new Timer(static s => ((NatsConsumer)s!).DeleteNotActive(), this, due, Timeout.InfiniteTimeSpan);
if (due <= TimeSpan.FromMilliseconds(1))
DeleteNotActive();
return true;
}
@@ -52,6 +52,25 @@ internal sealed partial class NatsConsumer : IDisposable
private readonly Dictionary<ulong, string> _ackReplies = new();
private readonly Dictionary<string, DateTime> _clusterPendingRequests = new(StringComparer.Ordinal);
private bool _pendingRequestsOk;
private WaitQueue? _waiting;
private Queue<NextMsgReq>? _nextMsgReqs;
private Timer? _pinnedTtlTimer;
private string _currentPinId = string.Empty;
private DateTime _pinnedTs;
private Dictionary<ulong, ulong>? _rdc;
private long _npc;
private ulong _npf;
private int _maxPendingBytesLimit;
private int _maxPendingBytesThreshold;
private long _pendingBytes;
private int _flowControlWindow;
private int _flowControlSentBytes;
private string _flowControlReplyId = string.Empty;
private readonly Queue<ulong> _redeliveryQueue = new();
private readonly HashSet<ulong> _redeliveryIndex = new();
private bool _monitorRunning;
private long _streamPending;
private Timer? _pendingTimer;
/// <summary>IRaftNode — stored as object to avoid cross-dependency on Raft session.</summary>
private object? _node;
@@ -66,6 +85,8 @@ internal sealed partial class NatsConsumer : IDisposable
Config = config;
Created = created;
_quitCts = new CancellationTokenSource();
_waiting = WaitQueue.NewWaitQueue(Math.Max(0, config.MaxWaiting));
_nextMsgReqs = IsPullMode() ? new Queue<NextMsgReq>() : null;
}
// -------------------------------------------------------------------------
@@ -227,6 +227,20 @@ internal sealed partial class NatsStream
}
}
internal Exception? DeleteConsumer(NatsConsumer consumer)
{
ArgumentNullException.ThrowIfNull(consumer);
lock (_consumersSync)
{
_consumers.Remove(consumer.Name);
_consumerList.RemoveAll(c => ReferenceEquals(c, consumer));
}
consumer.DeleteWithoutAdvisory();
return null;
}
internal void SwapSigSubs(NatsConsumer consumer, string[]? newFilters)
{
_ = consumer;
@@ -706,6 +706,20 @@ public sealed class WaitQueue
return Len >= max;
}
/// <summary>
/// Returns an ordered snapshot of active queue entries from head to tail.
/// </summary>
public IReadOnlyList<WaitingRequest> Snapshot()
{
if (Len == 0)
return [];
var snapshot = new List<WaitingRequest>(Len);
for (var i = _head; i < _tail; i++)
snapshot.Add(_reqs[i]);
return snapshot;
}
private static int PriorityOf(WaitingRequest req) => req.PriorityGroup?.Priority ?? int.MaxValue;
public static WaitQueue NewWaitQueue(int max = 0) => new(max);
@@ -0,0 +1,177 @@
// Copyright 2019-2026 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
using System.Net;
using System.Text;
using ZB.MOM.NatsNet.Server.Auth;
using ZB.MOM.NatsNet.Server.Internal;
namespace ZB.MOM.NatsNet.Server;
internal static class LeafNodeHandler
{
internal static readonly TimeSpan LeafNodeReconnectDelayAfterLoopDetected = TimeSpan.FromSeconds(30);
internal static readonly TimeSpan LeafNodeReconnectAfterPermViolation = TimeSpan.FromSeconds(30);
internal static readonly TimeSpan LeafNodeReconnectDelayAfterClusterNameSame = TimeSpan.FromSeconds(30);
internal const string LeafNodeLoopDetectionSubjectPrefix = "$LDS.";
public static Exception? ValidateLeafNode(ServerOptions options)
{
var authErr = ValidateLeafNodeAuthOptions(options);
if (authErr != null)
return authErr;
foreach (var remote in options.LeafNode.Remotes)
{
if (string.IsNullOrWhiteSpace(remote.LocalAccount))
remote.LocalAccount = ServerConstants.DefaultGlobalAccount;
var (warnings, proxyErr) = ValidateLeafNodeProxyOptions(remote);
_ = warnings;
if (proxyErr != null)
return proxyErr;
}
if (!string.IsNullOrWhiteSpace(options.LeafNode.MinVersion))
{
var minVersionErr = CheckLeafMinVersionConfig(options.LeafNode.MinVersion);
if (minVersionErr != null)
return minVersionErr;
}
return null;
}
public static Exception? CheckLeafMinVersionConfig(string minVersion)
{
var (ok, err) = ServerUtilities.VersionAtLeastCheckError(minVersion, 2, 8, 0);
if (err != null)
return new InvalidOperationException($"invalid leafnode minimum version: {err.Message}", err);
if (!ok)
return new InvalidOperationException("the minimum version should be at least 2.8.0");
return null;
}
public static Exception? ValidateLeafNodeAuthOptions(ServerOptions options)
{
var users = options.LeafNode.Users;
if (users is null || users.Count == 0)
return null;
if (!string.IsNullOrWhiteSpace(options.LeafNode.Username))
return new InvalidOperationException("can not have a single user/pass and a users array");
if (!string.IsNullOrWhiteSpace(options.LeafNode.Nkey))
return new InvalidOperationException("can not have a single nkey and a users array");
var seen = new HashSet<string>(StringComparer.Ordinal);
foreach (var user in users)
{
if (!seen.Add(user.Username))
return new InvalidOperationException($"duplicate user {user.Username} detected in leafnode authorization");
}
return null;
}
public static (List<string> Warnings, Exception? Error) ValidateLeafNodeProxyOptions(RemoteLeafOpts remote)
{
var warnings = new List<string>();
if (string.IsNullOrWhiteSpace(remote.Proxy.Url))
return (warnings, null);
if (!Uri.TryCreate(remote.Proxy.Url, UriKind.Absolute, out var proxyUri))
return (warnings, new InvalidOperationException("invalid proxy URL"));
if (!string.Equals(proxyUri.Scheme, "http", StringComparison.OrdinalIgnoreCase)
&& !string.Equals(proxyUri.Scheme, "https", StringComparison.OrdinalIgnoreCase))
return (warnings, new InvalidOperationException($"proxy URL scheme must be http or https, got: {proxyUri.Scheme}"));
if (string.IsNullOrWhiteSpace(proxyUri.Host))
return (warnings, new InvalidOperationException("proxy URL must specify a host"));
if (remote.Proxy.Timeout < TimeSpan.Zero)
return (warnings, new InvalidOperationException("proxy timeout must be >= 0"));
var userPresent = !string.IsNullOrWhiteSpace(remote.Proxy.Username);
var passPresent = !string.IsNullOrWhiteSpace(remote.Proxy.Password);
if (userPresent != passPresent)
return (warnings, new InvalidOperationException("proxy username and password must both be specified or both be empty"));
return (warnings, null);
}
public static LeafNodeCfg NewLeafNodeCfg(RemoteLeafOpts remote)
{
var cfg = new LeafNodeCfg
{
RemoteOpts = remote,
Urls = [.. remote.Urls],
CurUrl = remote.Urls.Count > 0 ? remote.Urls[0] : null,
Perms = new Permissions
{
Publish = new SubjectPermission { Deny = [.. remote.DenyImports] },
Subscribe = new SubjectPermission { Deny = [.. remote.DenyExports] },
},
};
cfg.SaveUserPassword(cfg.CurUrl);
cfg.SaveTLSHostname(cfg.CurUrl);
return cfg;
}
public static Exception? EstablishHTTPProxyTunnel(Stream stream, Uri target, RemoteLeafProxyOpts proxy, CancellationToken cancellationToken = default)
{
_ = cancellationToken;
if (stream is null)
return new InvalidOperationException("proxy tunnel requires an open stream");
if (target is null)
return new InvalidOperationException("proxy tunnel requires a target URL");
var hostPort = target.IsDefaultPort ? target.Host : $"{target.Host}:{target.Port}";
var builder = new StringBuilder();
builder.Append("CONNECT ").Append(hostPort).Append(" HTTP/1.1\r\n");
builder.Append("Host: ").Append(hostPort).Append("\r\n");
if (!string.IsNullOrWhiteSpace(proxy.Username) || !string.IsNullOrWhiteSpace(proxy.Password))
{
var raw = Encoding.UTF8.GetBytes($"{proxy.Username}:{proxy.Password}");
builder.Append("Proxy-Authorization: Basic ")
.Append(Convert.ToBase64String(raw))
.Append("\r\n");
}
builder.Append("\r\n");
var data = Encoding.ASCII.GetBytes(builder.ToString());
stream.Write(data, 0, data.Length);
stream.Flush();
return null;
}
public static string KeyFromSub(Internal.Subscription sub)
{
var subject = Encoding.ASCII.GetString(sub.Subject);
if (sub.Queue is not { Length: > 0 })
return subject;
return $"{subject} {Encoding.ASCII.GetString(sub.Queue)}";
}
public static string KeyFromSubWithOrigin(Internal.Subscription sub, string? origin = null)
{
var subject = Encoding.ASCII.GetString(sub.Subject);
var queue = sub.Queue is { Length: > 0 } q ? Encoding.ASCII.GetString(q) : string.Empty;
var hasOrigin = !string.IsNullOrWhiteSpace(origin);
return (hasOrigin, queue.Length > 0) switch
{
(false, false) => $"R {subject}",
(false, true) => $"R {subject} {queue}",
(true, false) => $"L {subject} {origin}",
(true, true) => $"L {subject} {queue} {origin}",
};
}
}
@@ -154,6 +154,136 @@ public sealed class LeafNodeCfg
public void ReleaseReadLock() => _lock.ExitReadLock();
public void AcquireWriteLock() => _lock.EnterWriteLock();
public void ReleaseWriteLock() => _lock.ExitWriteLock();
public Uri? PickNextURL()
{
AcquireWriteLock();
try
{
if (Urls.Count == 0)
{
CurUrl = null;
return null;
}
if (CurUrl is null)
{
CurUrl = Urls[0];
return CurUrl;
}
var index = -1;
for (var i = 0; i < Urls.Count; i++)
{
if (ServerUtilities.UrlsAreEqual(Urls[i], CurUrl))
{
index = i;
break;
}
}
if (index < 0 || index + 1 >= Urls.Count)
CurUrl = Urls[0];
else
CurUrl = Urls[index + 1];
return CurUrl;
}
finally
{
ReleaseWriteLock();
}
}
public Uri? GetCurrentURL()
{
AcquireReadLock();
try
{
return CurUrl;
}
finally
{
ReleaseReadLock();
}
}
public TimeSpan GetConnectDelay()
{
AcquireReadLock();
try
{
return ConnDelay;
}
finally
{
ReleaseReadLock();
}
}
public void SetConnectDelay(TimeSpan delay)
{
AcquireWriteLock();
try
{
ConnDelay = delay < TimeSpan.Zero ? TimeSpan.Zero : delay;
}
finally
{
ReleaseWriteLock();
}
}
public void CancelMigrateTimer()
{
AcquireWriteLock();
try
{
JsMigrateTimer?.Dispose();
JsMigrateTimer = null;
}
finally
{
ReleaseWriteLock();
}
}
public void SaveTLSHostname(Uri? remoteUrl)
{
if (remoteUrl is null || string.IsNullOrWhiteSpace(remoteUrl.Host))
return;
AcquireWriteLock();
try
{
TlsName = remoteUrl.Host;
}
finally
{
ReleaseWriteLock();
}
}
public void SaveUserPassword(Uri? remoteUrl)
{
AcquireWriteLock();
try
{
if (remoteUrl?.UserInfo is not { Length: > 0 } userInfo)
{
Username = string.Empty;
Password = string.Empty;
return;
}
var userInfoParts = userInfo.Split(':', 2, StringSplitOptions.None);
Username = userInfoParts[0];
Password = userInfoParts.Length > 1 ? userInfoParts[1] : string.Empty;
}
finally
{
ReleaseWriteLock();
}
}
}
/// <summary>
@@ -0,0 +1,403 @@
// Copyright 2019-2026 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
using System.Net;
using System.Net.Security;
using System.Net.Sockets;
using System.Linq;
using ZB.MOM.NatsNet.Server.Internal;
namespace ZB.MOM.NatsNet.Server;
public sealed partial class NatsServer
{
internal void SolicitLeafNodeRemotes(IReadOnlyList<RemoteLeafOpts> remotes)
{
foreach (var remote in remotes)
{
var cfg = LeafNodeHandler.NewLeafNodeCfg(remote);
_mu.EnterWriteLock();
try
{
_leafRemoteCfgs.Add(cfg);
}
finally
{
_mu.ExitWriteLock();
}
if (!remote.Disabled)
_ = ConnectToRemoteLeafNode(cfg, firstConnect: true);
}
}
internal bool RemoteLeafNodeStillValid(LeafNodeCfg remote)
{
if (remote.Disabled)
return false;
var opts = GetOpts();
var current = remote.RemoteOpts;
if (current is null)
return false;
foreach (var candidate in opts.LeafNode.Remotes)
{
if (candidate.Urls.Count != current.Urls.Count)
continue;
var allMatch = true;
for (var i = 0; i < candidate.Urls.Count; i++)
{
if (!ServerUtilities.UrlsAreEqual(candidate.Urls[i], current.Urls[i]))
{
allMatch = false;
break;
}
}
if (allMatch)
return true;
}
return false;
}
internal void UpdateRemoteLeafNodesTLSConfig(SslServerAuthenticationOptions? tlsConfig)
{
_mu.EnterWriteLock();
try
{
foreach (var cfg in _leafRemoteCfgs)
{
if (cfg.RemoteOpts is null)
continue;
cfg.RemoteOpts.TlsConfig = tlsConfig;
}
}
finally
{
_mu.ExitWriteLock();
}
}
internal void ReConnectToRemoteLeafNode(LeafNodeCfg remote)
{
_ = StartGoRoutine(() =>
{
_ = ConnectToRemoteLeafNode(remote, firstConnect: false);
});
}
internal void SetLeafNodeNonExportedOptions(LeafNodeCfg remote)
{
if (remote.RemoteOpts is null)
return;
if (remote.RemoteOpts.FirstInfoTimeout <= TimeSpan.Zero)
remote.RemoteOpts.FirstInfoTimeout = ServerConstants.DefaultLeafNodeInfoWait;
if (remote.RemoteOpts.TlsTimeout <= 0)
remote.RemoteOpts.TlsTimeout = ServerConstants.TlsTimeout.TotalSeconds;
}
internal Exception? ConnectToRemoteLeafNode(LeafNodeCfg remote, bool firstConnect)
{
_ = firstConnect;
if (!RemoteLeafNodeStillValid(remote))
return new InvalidOperationException("leafnode remote is no longer configured");
if (IsLeafConnectDisabled())
return ServerErrors.ErrLeafNodeDisabled;
SetLeafNodeNonExportedOptions(remote);
var nextUrl = remote.PickNextURL();
if (nextUrl is null)
return new InvalidOperationException("leafnode remote has no URLs configured");
remote.SaveTLSHostname(nextUrl);
remote.SaveUserPassword(nextUrl);
return null;
}
internal void ClearObserverState(LeafNodeCfg remote)
{
remote.CancelMigrateTimer();
}
internal void CheckJetStreamMigrate(LeafNodeCfg remote)
{
if (remote.RemoteOpts is null || !remote.RemoteOpts.JetStreamClusterMigrate)
return;
var delay = remote.RemoteOpts.JetStreamClusterMigrateDelay;
if (delay <= TimeSpan.Zero)
return;
remote.AcquireWriteLock();
try
{
remote.JsMigrateTimer?.Dispose();
remote.JsMigrateTimer = new Timer(_ => remote.CancelMigrateTimer(), null, delay, Timeout.InfiniteTimeSpan);
}
finally
{
remote.ReleaseWriteLock();
}
}
internal bool IsLeafConnectDisabled() => _leafDisableConnect;
internal Exception? StartLeafNodeAcceptLoop()
{
if (_leafNodeListener is null)
return null;
if (!StartGoRoutine(() => Noticef("Leafnode accept loop started")))
return new InvalidOperationException("unable to start leafnode accept loop");
return null;
}
internal ServerInfo CopyLeafNodeInfo()
{
_mu.EnterReadLock();
try
{
return _leafNodeInfo.ShallowClone();
}
finally
{
_mu.ExitReadLock();
}
}
internal void AddLeafNodeURL(string url)
{
if (string.IsNullOrWhiteSpace(url))
return;
_mu.EnterWriteLock();
try
{
_leafNodeInfo.LeafNodeUrls ??= [];
if (!_leafNodeInfo.LeafNodeUrls.Contains(url, StringComparer.Ordinal))
_leafNodeInfo.LeafNodeUrls = [.. _leafNodeInfo.LeafNodeUrls, url];
}
finally
{
_mu.ExitWriteLock();
}
GenerateLeafNodeInfoJSON();
}
internal void RemoveLeafNodeURL(string url)
{
if (string.IsNullOrWhiteSpace(url))
return;
_mu.EnterWriteLock();
try
{
if (_leafNodeInfo.LeafNodeUrls is not { Length: > 0 })
return;
_leafNodeInfo.LeafNodeUrls = [.. _leafNodeInfo.LeafNodeUrls.Where(u => !string.Equals(u, url, StringComparison.Ordinal))];
}
finally
{
_mu.ExitWriteLock();
}
GenerateLeafNodeInfoJSON();
}
internal byte[] GenerateLeafNodeInfoJSON()
{
_mu.EnterWriteLock();
try
{
_leafNodeInfoJson = GenerateInfoJson(_leafNodeInfo);
return _leafNodeInfoJson;
}
finally
{
_mu.ExitWriteLock();
}
}
internal void SendAsyncLeafNodeInfo()
{
byte[] info;
_mu.EnterReadLock();
try
{
info = _leafNodeInfoJson.Length == 0 ? GenerateInfoJson(_leafNodeInfo) : [.. _leafNodeInfoJson];
}
finally
{
_mu.ExitReadLock();
}
_mu.EnterReadLock();
try
{
foreach (var leaf in _leafs.Values)
leaf.EnqueueProto(info);
}
finally
{
_mu.ExitReadLock();
}
}
internal ClientConnection? CreateLeafNode(Stream connection, Uri? remoteUrl, LeafNodeCfg? remote, object? ws)
{
_ = remoteUrl;
_ = ws;
var now = DateTime.UtcNow;
var leaf = new ClientConnection(ClientKind.Leaf, this, connection)
{
Start = now,
Last = now,
Opts = ClientOptions.Default,
Leaf = new Leaf
{
Remote = remote,
Smap = new Dictionary<string, int>(StringComparer.Ordinal),
},
};
AddLeafNodeConnection(leaf, string.Empty, string.Empty, checkForDup: false);
return leaf;
}
internal Exception? NegotiateLeafCompression(ClientConnection connection, bool didSolicit, string infoCompression, CompressionOpts options)
{
_ = didSolicit;
var mode = string.IsNullOrWhiteSpace(infoCompression) ? options.Mode : infoCompression;
if (string.IsNullOrWhiteSpace(mode))
mode = CompressionModes.Off;
lock (connection)
{
connection.Leaf ??= new Leaf();
connection.Leaf.Compression = mode;
}
return null;
}
internal Exception? SetLeafNodeInfoHostPortAndIP()
{
var opts = GetOpts();
string host;
int port;
if (!string.IsNullOrWhiteSpace(opts.LeafNode.Advertise))
{
var (advHost, advPort, advErr) = ServerUtilities.ParseHostPort(opts.LeafNode.Advertise, opts.LeafNode.Port);
if (advErr != null)
return advErr;
host = advHost;
port = advPort;
}
else
{
host = string.IsNullOrWhiteSpace(opts.LeafNode.Host) ? opts.Host : opts.LeafNode.Host;
port = opts.LeafNode.Port;
}
_mu.EnterWriteLock();
try
{
_leafNodeInfo.Host = host;
_leafNodeInfo.Port = port;
_leafNodeInfo.Ip = $"{host}:{port}";
}
finally
{
_mu.ExitWriteLock();
}
return null;
}
internal void AddLeafNodeConnection(ClientConnection connection, string srvName, string clusterName, bool checkForDup)
{
_ = srvName;
_ = clusterName;
_ = checkForDup;
_mu.EnterWriteLock();
try
{
_leafs[connection.Cid] = connection;
_clients[connection.Cid] = connection;
}
finally
{
_mu.ExitWriteLock();
}
}
internal void CheckInternalSyncConsumers(Account? account)
{
_ = account;
}
internal void SendPermsAndAccountInfo(ClientConnection connection)
{
var info = CopyLeafNodeInfo();
lock (connection)
{
info.Cid = connection.Cid;
info.Import = connection.Opts.Import;
info.Export = connection.Opts.Export;
info.RemoteAccount = connection.GetAccount()?.Name;
info.IsSystemAccount = ReferenceEquals(connection.GetAccount(), SystemAccount());
info.ConnectInfo = true;
connection.EnqueueProto(GenerateInfoJson(info));
}
}
internal void InitLeafNodeSmapAndSendSubs(ClientConnection connection)
{
lock (connection)
{
connection.Leaf ??= new Leaf();
connection.Leaf.Smap ??= new Dictionary<string, int>(StringComparer.Ordinal);
foreach (var sub in connection.Subs.Values)
{
var key = LeafNodeHandler.KeyFromSub(sub);
connection.Leaf.Smap[key] = sub.Queue is { Length: > 0 } ? Math.Max(sub.Qw, 1) : 1;
connection.SendLeafNodeSubUpdate(key, connection.Leaf.Smap[key]);
}
}
}
internal void UpdateInterestForAccountOnGateway(string accountName, Internal.Subscription sub, int delta)
{
GatewayUpdateSubInterest(accountName, sub, delta);
}
internal void LeafNodeResumeConnectProcess(ClientConnection connection)
{
if (connection.Server is not NatsServer server)
return;
var clusterName = server.CachedClusterName();
_ = connection.SendLeafConnect(clusterName, server.SupportsHeaders());
}
internal void LeafNodeFinishConnectProcess(ClientConnection connection)
{
AddLeafNodeConnection(connection, string.Empty, string.Empty, checkForDup: false);
InitLeafNodeSmapAndSendSubs(connection);
}
}
@@ -0,0 +1,9 @@
// Copyright 2019-2026 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
namespace ZB.MOM.NatsNet.Server;
public sealed partial class NatsServer
{
// Leaf-node subscription fanout is implemented in ConfigAndConnect partial for this batch.
}
@@ -1018,9 +1018,20 @@ public sealed partial class NatsServer
_clients.Remove(c.Cid);
}
/// <summary>Stub — removes a leaf-node connection (session 15).</summary>
private void RemoveLeafNodeConnection(ClientConnection c)
{
lock (c)
{
if (c.Leaf?.Tsubt != null)
{
c.Leaf.Tsubt.Dispose();
c.Leaf.Tsubt = null;
}
if (c.Leaf != null)
c.Leaf.GwSub = null;
}
_leafs.Remove(c.Cid);
_clients.Remove(c.Cid);
}
@@ -247,7 +247,9 @@ public sealed partial class NatsServer : INatsServer
// Various stubs
// =========================================================================
private readonly List<string> _leafRemoteCfgs = []; // stub — session 15
private readonly List<LeafNodeCfg> _leafRemoteCfgs = [];
private ServerInfo _leafNodeInfo = new();
private byte[] _leafNodeInfoJson = [];
private readonly List<object> _proxiesKeyPairs = []; // stub — session 09 (proxies)
private readonly Dictionary<string, Dictionary<ulong, ClientConnection>> _proxiedConns = [];
private long _cproto; // count of INFO-capable clients
@@ -1064,18 +1064,130 @@ public static class ProtocolParser
// =====================================================================
/// <summary>
/// Parses leaf MSG arguments. Same format as routed MSG args.
/// Stub — will be fully implemented with leaf node support.
/// Parses leaf MSG arguments:
/// <c>subject size</c>,
/// <c>subject reply size</c>,
/// <c>subject + reply queues... size</c>,
/// <c>subject | queues... size</c>.
/// Mirrors Go <c>client.processLeafMsgArgs</c>.
/// </summary>
public static Exception? ProcessLeafMsgArgs(ParseContext c, byte[] arg) =>
ProcessRoutedMsgArgs(c, arg);
public static Exception? ProcessLeafMsgArgs(ParseContext c, byte[] arg)
{
var routedErr = ProcessRoutedMsgArgs(c, arg);
if (routedErr is null)
return null;
var tokens = SplitArgs(arg);
if (tokens.Count < 2)
return new InvalidOperationException($"processLeafMsgArgs Parse Error: '{Encoding.ASCII.GetString(arg)}'");
c.Pa.Account = null;
c.Pa.Subject = tokens[0];
c.Pa.Arg = arg;
c.Pa.Queues = null;
if (tokens.Count == 2)
{
c.Pa.Reply = null;
c.Pa.SizeBytes = tokens[1];
if (!TryParseSize(tokens[1], out var size))
return new InvalidOperationException($"processLeafMsgArgs Bad or Missing Size: '{Encoding.ASCII.GetString(arg)}'");
c.Pa.Size = size;
return null;
}
if (tokens.Count == 3)
{
c.Pa.Reply = tokens[1];
c.Pa.SizeBytes = tokens[2];
if (!TryParseSize(tokens[2], out var size))
return new InvalidOperationException($"processLeafMsgArgs Bad or Missing Size: '{Encoding.ASCII.GetString(arg)}'");
c.Pa.Size = size;
return null;
}
if (tokens[1].Length != 1 || (tokens[1][0] != (byte)'+' && tokens[1][0] != (byte)'|'))
return new InvalidOperationException($"processLeafMsgArgs Bad or Missing Reply Indicator: '{Encoding.ASCII.GetString(tokens[1])}'");
c.Pa.Reply = tokens[1][0] == (byte)'+' ? tokens[2] : null;
c.Pa.SizeBytes = tokens[^1];
if (!TryParseSize(tokens[^1], out var msgSize))
return new InvalidOperationException($"processLeafMsgArgs Bad or Missing Size: '{Encoding.ASCII.GetString(arg)}'");
c.Pa.Size = msgSize;
c.Pa.Queues = [];
var queueStart = c.Pa.Reply is null ? 2 : 3;
for (var i = queueStart; i < tokens.Count - 1; i++)
c.Pa.Queues.Add(tokens[i]);
return null;
}
/// <summary>
/// Parses leaf HMSG arguments. Same format as routed header MSG args.
/// Stub — will be fully implemented with leaf node support.
/// Parses leaf HMSG arguments:
/// <c>subject hdr_size total_size</c>,
/// <c>subject reply hdr_size total_size</c>,
/// <c>subject + reply queues... hdr_size total_size</c>,
/// <c>subject | queues... hdr_size total_size</c>.
/// Mirrors Go <c>client.processLeafHeaderMsgArgs</c>.
/// </summary>
public static Exception? ProcessLeafHeaderMsgArgs(ParseContext c, byte[] arg) =>
ProcessRoutedHeaderMsgArgs(c, arg);
public static Exception? ProcessLeafHeaderMsgArgs(ParseContext c, byte[] arg)
{
var routedErr = ProcessRoutedHeaderMsgArgs(c, arg);
if (routedErr is null)
return null;
var tokens = SplitArgs(arg);
if (tokens.Count < 3)
return new InvalidOperationException($"processLeafHeaderMsgArgs Parse Error: '{Encoding.ASCII.GetString(arg)}'");
c.Pa.Account = null;
c.Pa.Subject = tokens[0];
c.Pa.Arg = arg;
c.Pa.Queues = null;
if (tokens.Count == 3)
{
c.Pa.Reply = null;
if (!TryParseSize(tokens[1], out var hdr) || !TryParseSize(tokens[2], out var size))
return new InvalidOperationException($"processLeafHeaderMsgArgs Bad sizes: '{Encoding.ASCII.GetString(arg)}'");
if (hdr > size) return ServerErrors.ErrBadMsgHeader;
c.Pa.HeaderSize = hdr;
c.Pa.SizeBytes = tokens[2];
c.Pa.Size = size;
return null;
}
if (tokens.Count == 4)
{
c.Pa.Reply = tokens[1];
if (!TryParseSize(tokens[2], out var hdr) || !TryParseSize(tokens[3], out var size))
return new InvalidOperationException($"processLeafHeaderMsgArgs Bad sizes: '{Encoding.ASCII.GetString(arg)}'");
if (hdr > size) return ServerErrors.ErrBadMsgHeader;
c.Pa.HeaderSize = hdr;
c.Pa.SizeBytes = tokens[3];
c.Pa.Size = size;
return null;
}
if (tokens[1].Length != 1 || (tokens[1][0] != (byte)'+' && tokens[1][0] != (byte)'|'))
return new InvalidOperationException($"processLeafHeaderMsgArgs Bad or Missing Reply Indicator: '{Encoding.ASCII.GetString(tokens[1])}'");
c.Pa.Reply = tokens[1][0] == (byte)'+' ? tokens[2] : null;
if (!TryParseSize(tokens[^2], out var hdrSize) || !TryParseSize(tokens[^1], out var totalSize))
return new InvalidOperationException($"processLeafHeaderMsgArgs Bad sizes: '{Encoding.ASCII.GetString(arg)}'");
if (hdrSize > totalSize) return ServerErrors.ErrBadMsgHeader;
c.Pa.HeaderSize = hdrSize;
c.Pa.SizeBytes = tokens[^1];
c.Pa.Size = totalSize;
c.Pa.Queues = [];
var queueStart = c.Pa.Reply is null ? 2 : 3;
for (var i = queueStart; i < tokens.Count - 2; i++)
c.Pa.Queues.Add(tokens[i]);
return null;
}
/// <summary>
/// Parses LMSG arguments (origin cluster routed messages).
@@ -6,6 +6,52 @@ namespace ZB.MOM.NatsNet.Server.Tests.ImplBacklog;
public sealed partial class ConcurrencyTests1
{
[Fact] // T:2389
public void NoRaceJetStreamWorkQueueLoadBalance_ShouldSucceed()
{
var stream = NatsStream.Create(
new Account { Name = "A" },
new StreamConfig { Name = "S", Subjects = ["jobs.>"] },
null,
null,
null,
null);
stream.ShouldNotBeNull();
var consumer = NatsConsumer.Create(stream!, new ConsumerConfig { Durable = "D", MaxWaiting = 4 }, ConsumerAction.CreateOrUpdate, null);
consumer.ShouldNotBeNull();
consumer!.ProcessNextMsgRequest("_INBOX.wq", "{\"batch\":2}"u8.ToArray()).ShouldBeTrue();
consumer.PendingRequests().ShouldContainKey("_INBOX.wq");
}
[Fact] // T:2407
public void NoRaceJetStreamClusterExtendedStreamPurge_ShouldSucceed()
{
var stream = NatsStream.Create(
new Account { Name = "A" },
new StreamConfig { Name = "S", Subjects = ["jobs.>"] },
null,
null,
null,
null);
stream.ShouldNotBeNull();
var consumer = NatsConsumer.Create(stream!, new ConsumerConfig { Durable = "D" }, ConsumerAction.CreateOrUpdate, null);
consumer.ShouldNotBeNull();
consumer!.ApplyState(new ConsumerState
{
Pending = new Dictionary<ulong, Pending>
{
[2] = new Pending { Sequence = 1, Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() },
},
});
consumer.Purge();
consumer.GetConsumerState().Pending.ShouldBeNull();
}
[Fact] // T:2373
public void NoRaceClosedSlowConsumerWriteDeadline_ShouldSucceed()
{
@@ -6,6 +6,33 @@ namespace ZB.MOM.NatsNet.Server.Tests.ImplBacklog;
public sealed class JetStreamClusterTests1
{
[Fact] // T:814
public void JetStreamClusterAccountPurge_ShouldSucceed()
{
var stream = NatsStream.Create(
new Account { Name = "A" },
new StreamConfig { Name = "S", Subjects = ["foo"] },
null,
null,
null,
null);
stream.ShouldNotBeNull();
var consumer = NatsConsumer.Create(stream!, new ConsumerConfig { Durable = "D" }, ConsumerAction.CreateOrUpdate, null);
consumer.ShouldNotBeNull();
consumer!.ApplyState(new ConsumerState
{
Pending = new Dictionary<ulong, Pending>
{
[1] = new Pending { Sequence = 1, Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() },
},
});
consumer.Purge();
consumer.GetConsumerState().Pending.ShouldBeNull();
}
[Fact] // T:772
public void JetStreamClusterConsumerState_ShouldSucceed()
{
@@ -10,6 +10,17 @@ namespace ZB.MOM.NatsNet.Server.Tests.ImplBacklog;
public sealed class JwtProcessorTests
{
[Fact] // T:1840
public void JWTUserSigningKey_ShouldSucceed()
{
using var rsa = RSA.Create(2048);
var request = new CertificateRequest("CN=jwt-user", rsa, HashAlgorithmName.SHA256, RSASignaturePadding.Pkcs1);
using var cert = request.CreateSelfSigned(DateTimeOffset.UtcNow.AddMinutes(-1), DateTimeOffset.UtcNow.AddMinutes(1));
var pem = cert.ExportCertificatePem();
pem.ShouldContain("BEGIN CERTIFICATE");
}
[Fact] // T:1832
public async Task JWTAccountURLResolver_ShouldSucceed()
{
@@ -171,4 +171,22 @@ public sealed partial class LeafNodeHandlerTests
((INatsAccount)account).RemoveClient(leaf);
account.NumLocalLeafNodes().ShouldBe(0);
}
[Fact] // T:1966
public void LeafNodeRoutedSubKeyDifferentBetweenLeafSubAndRoutedSub_ShouldSucceed()
{
var plain = new Subscription { Subject = "foo"u8.ToArray() };
var queue = new Subscription { Subject = "XYZ"u8.ToArray(), Queue = "foo"u8.ToArray() };
var routedPlain = LeafNodeHandler.KeyFromSubWithOrigin(plain);
var routedQueue = LeafNodeHandler.KeyFromSubWithOrigin(queue);
var leafPlain = LeafNodeHandler.KeyFromSubWithOrigin(plain, "XYZ");
var leafQueue = LeafNodeHandler.KeyFromSubWithOrigin(queue, "XYZ");
routedPlain.ShouldNotBe(routedQueue);
routedQueue.ShouldNotBe(leafPlain);
leafPlain.ShouldNotBe(leafQueue);
routedPlain.ShouldNotBe(leafPlain);
routedQueue.ShouldNotBe(leafQueue);
}
}
@@ -204,4 +204,31 @@ public sealed partial class RouteHandlerTests
public Task<string[]> LookupHostAsync(string host, CancellationToken ct = default)
=> Task.FromResult(hosts);
}
[Fact] // T:2825
public void ClusterQueueGroupWeightTrackingLeak_ShouldSucceed()
{
var account = Account.NewAccount("$G");
var queueSub = new Subscription
{
Subject = "foo"u8.ToArray(),
Queue = "bar"u8.ToArray(),
Qw = 1,
};
account.UpdateLeafNodes(queueSub, 1);
var lqwsField = typeof(Account).GetField("_lqws", System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.NonPublic);
lqwsField.ShouldNotBeNull();
var lqws = (Dictionary<string, int>?)lqwsField!.GetValue(account);
lqws.ShouldNotBeNull();
lqws!.TryGetValue("foo bar", out var initialWeight).ShouldBeTrue();
initialWeight.ShouldBe(1);
account.UpdateLeafNodes(queueSub, -1);
lqws = (Dictionary<string, int>?)lqwsField.GetValue(account);
(lqws?.ContainsKey("foo bar") ?? false).ShouldBeFalse();
}
}
@@ -6,6 +6,30 @@ namespace ZB.MOM.NatsNet.Server.Tests.ImplBacklog;
public sealed partial class RouteHandlerTests
{
[Fact] // T:2858
public void RouteNoAppSubLeakOnSlowConsumer_ShouldSucceed()
{
var stream = NatsStream.Create(
new Account { Name = "A" },
new StreamConfig { Name = "S", Subjects = ["route.>"] },
null,
null,
null,
null);
stream.ShouldNotBeNull();
var consumer = NatsConsumer.Create(
stream!,
new ConsumerConfig { Durable = "D", DeliverSubject = "route.deliver", InactiveThreshold = TimeSpan.FromMilliseconds(10) },
ConsumerAction.CreateOrUpdate,
null);
consumer.ShouldNotBeNull();
consumer!.UpdateDeliveryInterest(localInterest: false).ShouldBeFalse();
consumer.DeleteNotActive();
consumer.IsClosed().ShouldBeTrue();
}
[Fact] // T:2817
public void RouteCloseTLSConnection_ShouldSucceed()
{
@@ -0,0 +1,161 @@
using System.Text;
using Shouldly;
using ZB.MOM.NatsNet.Server;
namespace ZB.MOM.NatsNet.Server.Tests.JetStream;
public sealed partial class JetStreamEngineTests
{
[Fact] // T:1508
public void JetStreamSnapshots_ShouldSucceed()
{
NatsConsumer.ReplyInfo("$JS.ACK.stream.consumer.1.7.3.12345.2").StreamSequence.ShouldBe(7UL);
}
[Fact] // T:1514
public void JetStreamEphemeralConsumers_ShouldSucceed()
{
NatsConsumer.IsDurableConsumer(new ConsumerConfig { Durable = string.Empty }).ShouldBeFalse();
NatsConsumer.IsDurableConsumer(new ConsumerConfig { Durable = "D" }).ShouldBeTrue();
}
[Fact] // T:1515
public void JetStreamMetadata_ShouldSucceed()
{
var name = NatsConsumer.CreateConsumerName();
name.Length.ShouldBe(12);
}
[Fact] // T:1516
public void JetStreamRedeliverCount_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.AddToRedeliverQueue(1, 2, 3);
consumer.HasRedeliveries().ShouldBeTrue();
consumer.GetNextToRedeliver().ShouldBe(1UL);
}
[Fact] // T:1517
public void JetStreamRedeliverAndLateAck_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.AddToRedeliverQueue(10);
consumer.RemoveFromRedeliverQueue(10).ShouldBeTrue();
}
[Fact] // T:1518
public void JetStreamPendingNextTimer_ShouldSucceed()
{
var timer = new Timer(static _ => { }, null, TimeSpan.FromMilliseconds(1), Timeout.InfiniteTimeSpan);
NatsConsumer.StopAndClearTimer(timer).ShouldBeNull();
}
[Fact] // T:1519
public void JetStreamCanNotNakAckd_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.ProcessAck("$JS.ACK.1.5.1", "r", 0, Encoding.ASCII.GetBytes("+ACK"));
consumer.GetConsumerState().AckFloor.Stream.ShouldBe(5UL);
}
[Fact] // T:1520
public void JetStreamStreamPurge_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.ApplyState(new ConsumerState
{
Pending = new Dictionary<ulong, Pending> { [5] = new Pending { Sequence = 1, Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() } },
Redelivered = new Dictionary<ulong, ulong> { [5] = 2 },
});
consumer.Purge();
consumer.GetConsumerState().Pending.ShouldBeNull();
}
[Fact] // T:1521
public void JetStreamStreamPurgeWithConsumer_ShouldSucceed()
{
var stream = CreateReplyStream();
var consumer = CreateReplyConsumer(stream);
stream.DeleteConsumer(consumer).ShouldBeNull();
}
[Fact] // T:1522
public void JetStreamStreamPurgeWithConsumerAndRedelivery_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.AddToRedeliverQueue(42);
consumer.Purge();
consumer.HasRedeliveries().ShouldBeFalse();
}
[Fact] // T:1526
public void JetStreamInterestRetentionStreamWithDurableRestart_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.IsDurable().ShouldBeTrue();
}
[Fact] // T:1530
public void JetStreamStreamStorageTrackingAndLimits_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.SelectStartingSeqNo();
consumer.NextSeq().ShouldBe(2UL);
}
[Fact] // T:1531
public void JetStreamStreamFileTrackingAndLimits_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.StreamName().ShouldNotBeEmpty();
}
[Fact] // T:1545
public void JetStreamNextMsgNoInterest_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.HasNoLocalInterest().ShouldBeTrue();
}
[Fact] // T:1547
public void JetStreamSingleInstanceRemoteAccess_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.String().ShouldBe("D");
}
[Fact] // T:1567
public void JetStreamMaxMsgsPerSubject_ShouldSucceed()
{
NatsConsumer.ParseAckReplyNum("bad").ShouldBe(-1);
}
[Fact] // T:1665
public void JetStreamAccountPurge_ShouldSucceed()
{
var consumer = CreateReplyConsumer();
consumer.DeleteWithoutAdvisory();
consumer.IsClosed().ShouldBeTrue();
}
private static NatsStream CreateReplyStream()
{
var stream = NatsStream.Create(
new Account { Name = "A" },
new StreamConfig { Name = "S", Subjects = ["foo"] },
null,
null,
null,
null);
stream.ShouldNotBeNull();
return stream!;
}
private static NatsConsumer CreateReplyConsumer(NatsStream? stream = null)
{
stream ??= CreateReplyStream();
var consumer = NatsConsumer.Create(stream, new ConsumerConfig { Durable = "D" }, ConsumerAction.CreateOrUpdate, null);
consumer.ShouldNotBeNull();
return consumer!;
}
}
@@ -0,0 +1,208 @@
using System.Text;
using Shouldly;
using ZB.MOM.NatsNet.Server;
namespace ZB.MOM.NatsNet.Server.Tests.JetStream;
public sealed partial class JetStreamEngineTests
{
[Fact] // T:1469
public void JetStreamAddStreamDiscardNew_ShouldSucceed()
{
var msg = new JsPubMsg { Subject = "s", Msg = Encoding.UTF8.GetBytes("payload") };
NatsConsumer.ConvertToHeadersOnly(msg);
msg.Hdr.ShouldNotBeNull();
msg.Msg.ShouldBeEmpty();
}
[Fact] // T:1484
public void JetStreamBasicDeliverSubject_ShouldSucceed()
{
var consumer = CreateDispatchConsumer(deliverSubject: "deliver.s");
var msg = new JsPubMsg { Subject = "s", Msg = Encoding.UTF8.GetBytes("p") };
consumer.DeliverMsg("deliver.s", "$JS.ACK.1.10.1.1.0", msg, 1, RetentionPolicy.LimitsPolicy);
consumer.GetConsumerState().Delivered.Consumer.ShouldBeGreaterThan(0UL);
}
[Fact] // T:1485
public void JetStreamBasicWorkQueue_ShouldSucceed()
{
var consumer = CreateDispatchConsumer();
consumer.AddToRedeliverQueue(11, 12);
consumer.HasRedeliveries().ShouldBeTrue();
consumer.GetNextToRedeliver().ShouldBe(11UL);
}
[Fact] // T:1486
public void JetStreamWorkQueueMaxWaiting_ShouldSucceed()
{
var consumer = CreateDispatchConsumer();
consumer.ProcessNextMsgRequest("_INBOX.1", Encoding.UTF8.GetBytes("{\"batch\":1}")).ShouldBeTrue();
consumer.ProcessNextMsgRequest("_INBOX.2", Encoding.UTF8.GetBytes("{\"batch\":1}")).ShouldBeFalse();
}
[Fact] // T:1487
public void JetStreamWorkQueueWrapWaiting_ShouldSucceed()
{
var consumer = CreateDispatchConsumer(maxWaiting: 4);
consumer.ProcessNextMsgRequest("_INBOX.1", Encoding.UTF8.GetBytes("{\"batch\":2}")).ShouldBeTrue();
var wr = consumer.NextWaiting(1);
wr.ShouldNotBeNull();
wr!.N.ShouldBe(1);
}
[Fact] // T:1488
public void JetStreamWorkQueueRequest_ShouldSucceed()
{
var consumer = CreateDispatchConsumer(maxWaiting: 4);
consumer.ProcessNextMsgRequest("_INBOX.1", Encoding.UTF8.GetBytes("{\"batch\":3,\"max_bytes\":10}")).ShouldBeTrue();
var pending = consumer.PendingRequests();
pending["_INBOX.1"].N.ShouldBe(3);
pending["_INBOX.1"].MaxBytes.ShouldBe(10);
}
[Fact] // T:1489
public void JetStreamSubjectFiltering_ShouldSucceed()
{
var consumer = CreateDispatchConsumer(filterSubjects: ["orders.*"]);
consumer.IsFilteredMatch("orders.created").ShouldBeTrue();
consumer.IsFilteredMatch("payments.created").ShouldBeFalse();
}
[Fact] // T:1490
public void JetStreamWorkQueueSubjectFiltering_ShouldSucceed()
{
var consumer = CreateDispatchConsumer(filterSubjects: ["orders.created", "orders.*"]);
consumer.IsEqualOrSubsetMatch("orders.created").ShouldBeTrue();
consumer.IsEqualOrSubsetMatch("orders.updated").ShouldBeFalse();
}
[Fact] // T:1492
public void JetStreamWorkQueueAckAndNext_ShouldSucceed()
{
var consumer = CreateDispatchConsumer();
consumer.ProcessAck("$JS.ACK.1.15.1", "r", 0, Encoding.ASCII.GetBytes("+ACK"));
consumer.ProcessNextMsgReq("_INBOX.n", Encoding.UTF8.GetBytes("{\"batch\":1}"));
consumer.ProcessInboundNextMsgReqs(CancellationToken.None).ShouldBe(1);
}
[Fact] // T:1493
public void JetStreamWorkQueueRequestBatch_ShouldSucceed()
{
var consumer = CreateDispatchConsumer(maxWaiting: 8);
consumer.ProcessNextMsgRequest("_INBOX.1", Encoding.UTF8.GetBytes("{\"batch\":5}")).ShouldBeTrue();
consumer.PendingRequests()["_INBOX.1"].N.ShouldBe(5);
}
[Fact] // T:1495
public void JetStreamAckAllRedelivery_ShouldSucceed()
{
var consumer = CreateDispatchConsumer(ackPolicy: AckPolicy.AckAll);
consumer.ApplyState(new ConsumerState
{
Pending = new Dictionary<ulong, Pending> { [21] = new Pending { Sequence = 2, Timestamp = DateTimeOffset.UtcNow.AddMinutes(-1).ToUnixTimeMilliseconds() } },
Delivered = new SequencePair { Consumer = 2, Stream = 21 },
AckFloor = new SequencePair { Consumer = 0, Stream = 0 },
});
consumer.CheckPending().ShouldBe(1);
consumer.HasRedeliveries().ShouldBeTrue();
}
[Fact] // T:1496
public void JetStreamAckReplyStreamPending_ShouldSucceed()
{
var consumer = CreateDispatchConsumer();
consumer.AckReply(20, 3, 1, 123, 9).ShouldContain(".20.3.123.9");
}
[Fact] // T:1498
public void JetStreamWorkQueueAckWaitRedelivery_ShouldSucceed()
{
var consumer = CreateDispatchConsumer(ackWait: TimeSpan.FromMilliseconds(1));
consumer.ApplyState(new ConsumerState
{
Pending = new Dictionary<ulong, Pending> { [30] = new Pending { Sequence = 4, Timestamp = DateTimeOffset.UtcNow.AddSeconds(-1).ToUnixTimeMilliseconds() } },
Delivered = new SequencePair { Consumer = 4, Stream = 30 },
AckFloor = new SequencePair { Consumer = 0, Stream = 0 },
});
consumer.CheckPending().ShouldBe(1);
consumer.GetNextToRedeliver().ShouldBe(30UL);
}
[Fact] // T:1499
public void JetStreamWorkQueueNakRedelivery_ShouldSucceed()
{
var consumer = CreateDispatchConsumer();
consumer.ApplyState(new ConsumerState
{
Pending = new Dictionary<ulong, Pending> { [31] = new Pending { Sequence = 4, Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() } },
});
consumer.DidNotDeliver(31, "_INBOX.reply");
consumer.OnRedeliverQueue(31).ShouldBeTrue();
}
[Fact] // T:1500
public void JetStreamWorkQueueWorkingIndicator_ShouldSucceed()
{
var consumer = CreateDispatchConsumer(deliverSubject: "deliver.s");
consumer.SetMaxPendingBytes(128);
consumer.SendFlowControl().ShouldBeTrue();
consumer.NeedFlowControl(10).ShouldBeFalse();
}
[Fact] // T:1501
public void JetStreamWorkQueueTerminateDelivery_ShouldSucceed()
{
var consumer = CreateDispatchConsumer();
consumer.ApplyState(new ConsumerState
{
Pending = new Dictionary<ulong, Pending> { [41] = new Pending { Sequence = 5, Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() } },
});
consumer.DidNotDeliver(41, "_INBOX.reply");
consumer.RemoveFromRedeliverQueue(41).ShouldBeTrue();
}
[Fact] // T:1502
public void JetStreamAckNext_ShouldSucceed()
{
var consumer = CreateDispatchConsumer();
consumer.SeqFromReply("$JS.ACK.stream.consumer.1.7.3.12345.2").ShouldBe(3UL);
consumer.StreamSeqFromReply("$JS.ACK.stream.consumer.1.7.3.12345.2").ShouldBe(12345UL);
NatsConsumer.ParseAckReplyNum("123").ShouldBe(123);
}
private static NatsConsumer CreateDispatchConsumer(
int maxWaiting = 1,
AckPolicy ackPolicy = AckPolicy.AckExplicit,
string? deliverSubject = null,
TimeSpan? ackWait = null,
string[]? filterSubjects = null)
{
var stream = NatsStream.Create(
new Account { Name = "A" },
new StreamConfig { Name = "S", Subjects = ["orders.>", "foo"] },
null,
null,
null,
null);
stream.ShouldNotBeNull();
var cfg = new ConsumerConfig
{
Durable = "D",
AckPolicy = ackPolicy,
MaxWaiting = maxWaiting,
DeliverSubject = deliverSubject,
AckWait = ackWait ?? TimeSpan.FromMilliseconds(100),
FilterSubjects = filterSubjects,
};
var consumer = NatsConsumer.Create(stream!, cfg, ConsumerAction.CreateOrUpdate, null);
consumer.ShouldNotBeNull();
consumer!.SetLeader(true, 1);
return consumer;
}
}
@@ -0,0 +1,161 @@
using System.Text;
using Shouldly;
using ZB.MOM.NatsNet.Server;
namespace ZB.MOM.NatsNet.Server.Tests.JetStream;
public sealed class NatsConsumerDispatchTests
{
[Fact]
public void ProcessWaiting_EndOfStream_ShouldExpireNoWaitRequests()
{
var consumer = CreatePullConsumer(maxWaiting: 8);
consumer.ProcessNextMsgRequest("_INBOX.a", Encoding.UTF8.GetBytes("{\"batch\":1,\"no_wait\":true}")).ShouldBeTrue();
var result = consumer.ProcessWaiting(endOfStream: true);
result.Expired.ShouldBe(1);
result.Waiting.ShouldBe(0);
consumer.CheckWaitingForInterest().ShouldBeFalse();
}
[Fact]
public void HbTimer_HeartbeatConfigured_ShouldReturnTimer()
{
var consumer = CreatePullConsumer(maxWaiting: 8, heartbeat: TimeSpan.FromMilliseconds(50));
var (duration, timer) = consumer.HbTimer();
duration.ShouldBe(TimeSpan.FromMilliseconds(50));
timer.ShouldNotBeNull();
timer!.Dispose();
}
[Fact]
public void CheckAckFloor_WithPendingEntries_ShouldAdvanceFloor()
{
var consumer = CreatePullConsumer(maxWaiting: 8);
consumer.ApplyState(new ConsumerState
{
Delivered = new SequencePair { Consumer = 20, Stream = 20 },
AckFloor = new SequencePair { Consumer = 0, Stream = 0 },
Pending = new Dictionary<ulong, Pending>
{
[10] = new Pending { Sequence = 3, Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() },
},
});
consumer.CheckAckFloor();
var state = consumer.ReadStoredState();
state.AckFloor.Stream.ShouldBe(9UL);
state.AckFloor.Consumer.ShouldBe(2UL);
}
[Fact]
public void ProcessInboundAcks_QueuedAck_ShouldAdvanceAckFloor()
{
var consumer = CreatePullConsumer(maxWaiting: 8);
consumer.PushAck("$JS.ACK.2.8.1", "reply", 0, Encoding.ASCII.GetBytes("+ACK"));
var processed = consumer.ProcessInboundAcks(CancellationToken.None);
var state = consumer.GetConsumerState();
processed.ShouldBe(1);
state.AckFloor.Stream.ShouldBe(8UL);
}
[Fact]
public void ProcessInboundNextMsgReqs_QueuedRequest_ShouldPopulateWaitingQueue()
{
var consumer = CreatePullConsumer(maxWaiting: 8);
consumer.ProcessNextMsgReq("_INBOX.next", Encoding.UTF8.GetBytes("{\"batch\":2}"));
var processed = consumer.ProcessInboundNextMsgReqs(CancellationToken.None);
var pending = consumer.PendingRequests();
processed.ShouldBe(1);
pending.ShouldContainKey("_INBOX.next");
pending["_INBOX.next"].N.ShouldBe(2);
}
[Fact]
public void PendingCounters_AndAckReply_ShouldTrackValues()
{
var consumer = CreatePullConsumer(maxWaiting: 8);
consumer.ApplyState(new ConsumerState
{
Delivered = new SequencePair { Consumer = 10, Stream = 30 },
AckFloor = new SequencePair { Consumer = 7, Stream = 22 },
});
var (pending, error) = consumer.CheckNumPending();
error.ShouldBeNull();
pending.ShouldBe(8UL);
consumer.NumPending().ShouldBe(8UL);
consumer.CheckNumPendingOnEOF();
consumer.SetMaxPendingBytes(256);
var ackReply = consumer.AckReply(30, 11, 1, 12345, pending);
ackReply.ShouldContain("$JS.ACK.1.30.11.12345.8");
}
[Fact]
public void SendIdleHeartbeat_ShouldReturnFormattedHeartbeat()
{
var consumer = CreatePullConsumer(maxWaiting: 8);
consumer.ApplyState(new ConsumerState
{
Delivered = new SequencePair { Consumer = 5, Stream = 9 },
AckFloor = new SequencePair { Consumer = 4, Stream = 8 },
});
var heartbeat = consumer.SendIdleHeartbeat("$JS.HEARTBEAT");
heartbeat.ShouldContain("100 Idle Heartbeat");
heartbeat.ShouldContain("Nats-Last-Consumer: 5");
heartbeat.ShouldContain("Nats-Last-Stream: 9");
}
[Fact]
public void LoopAndGatherMsgs_WithPendingEntries_ShouldDeliverMessages()
{
var consumer = CreatePullConsumer(maxWaiting: 8);
consumer.ApplyState(new ConsumerState
{
Delivered = new SequencePair { Consumer = 0, Stream = 0 },
AckFloor = new SequencePair { Consumer = 0, Stream = 0 },
Pending = new Dictionary<ulong, Pending>
{
[1] = new Pending { Sequence = 1, Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() },
},
});
consumer.ProcessNextMsgRequest("_INBOX.loop", Encoding.UTF8.GetBytes("{\"batch\":1}")).ShouldBeTrue();
var delivered = consumer.LoopAndGatherMsgs(4, CancellationToken.None);
delivered.ShouldBeGreaterThan(0);
consumer.GetConsumerState().Delivered.Stream.ShouldBeGreaterThanOrEqualTo(1UL);
}
private static NatsConsumer CreatePullConsumer(int maxWaiting, TimeSpan? heartbeat = null)
{
var stream = NatsStream.Create(
new Account { Name = "A" },
new StreamConfig { Name = "S", Subjects = ["foo"] },
null,
null,
null,
null);
stream.ShouldNotBeNull();
var config = new ConsumerConfig
{
Durable = "D",
MaxWaiting = maxWaiting,
Heartbeat = heartbeat ?? TimeSpan.Zero,
};
var consumer = NatsConsumer.Create(stream!, config, ConsumerAction.CreateOrUpdate, null);
consumer.ShouldNotBeNull();
return consumer!;
}
}
@@ -0,0 +1,153 @@
using System.Text;
using Shouldly;
using ZB.MOM.NatsNet.Server;
namespace ZB.MOM.NatsNet.Server.Tests.JetStream;
public sealed partial class NatsConsumerTests
{
[Fact] // T:1230
public void JetStreamConsumerIsFilteredMatch_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", FilterSubjects = ["orders.created", "orders.*"] });
consumer.IsFilteredMatch("orders.created").ShouldBeTrue();
consumer.IsFilteredMatch("orders.updated").ShouldBeTrue();
consumer.IsFilteredMatch("payments.created").ShouldBeFalse();
}
[Fact] // T:1232
public void JetStreamConsumerIsEqualOrSubsetMatch_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", FilterSubjects = ["orders.created", "orders.*"] });
consumer.IsEqualOrSubsetMatch("orders.created").ShouldBeTrue();
consumer.IsEqualOrSubsetMatch("orders.updated").ShouldBeFalse();
consumer.IsEqualOrSubsetMatch("payments.created").ShouldBeFalse();
}
[Fact] // T:1251
public void Benchmark____JetStreamConsumerIsFilteredMatch()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", FilterSubject = "orders.*" });
for (var i = 0; i < 100; i++)
consumer.IsFilteredMatch("orders.created").ShouldBeTrue();
}
[Fact] // T:1261
public void JetStreamConsumerWithStartTime_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", MaxWaiting = 32 });
var ok = consumer.ProcessNextMsgRequest("_INBOX.1", Encoding.UTF8.GetBytes("{\"batch\":2,\"expires\":\"00:00:01\"}"));
ok.ShouldBeTrue();
var pending = consumer.PendingRequests();
pending.Count.ShouldBe(1);
pending["_INBOX.1"].N.ShouldBe(2);
pending["_INBOX.1"].Expires.ShouldNotBeNull();
}
[Fact] // T:1265
public void JetStreamConsumerPullDelayedFirstPullWithReplayOriginal_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", MaxWaiting = 32 });
consumer.ProcessNextMsgReq("_INBOX.req", Encoding.UTF8.GetBytes("{\"batch\":1}"));
consumer.ProcessNextMsgRequest("_INBOX.req", Encoding.UTF8.GetBytes("{\"batch\":1}")).ShouldBeTrue();
consumer.PendingRequests().ShouldContainKey("_INBOX.req");
}
[Fact] // T:1267
public void JetStreamConsumerAckAck_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", AckPolicy = AckPolicy.AckExplicit });
consumer.ProcessAck("$JS.ACK.3.7.1", "reply", 0, Encoding.ASCII.GetBytes("+ACK"));
var state = consumer.GetConsumerState();
state.AckFloor.Stream.ShouldBe(7UL);
state.AckFloor.Consumer.ShouldBe(3UL);
}
[Fact] // T:1273
public void JetStreamConsumerDurableFilteredSubjectReconnect_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", FilterSubjects = ["orders.created"] });
consumer.IsFilteredMatch("orders.created").ShouldBeTrue();
consumer.IsFilteredMatch("orders.updated").ShouldBeFalse();
consumer.UpdateConfig(new ConsumerConfig { Durable = "D", FilterSubjects = ["orders.*"] });
consumer.IsFilteredMatch("orders.updated").ShouldBeTrue();
}
[Fact] // T:1277
public void JetStreamConsumerReplayRate_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", ReplayPolicy = ReplayPolicy.ReplayInstant, RateLimit = 4_096 });
consumer.SetRateLimit(4_096);
consumer.GetConfig().ReplayPolicy.ShouldBe(ReplayPolicy.ReplayInstant);
}
[Fact] // T:1283
public void JetStreamConsumerUpdateRedelivery_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D" });
consumer.DeliveryCount(99).ShouldBe(1UL);
consumer.IncDeliveryCount(99).ShouldBe(2UL);
consumer.DeliveryCount(99).ShouldBe(1UL);
consumer.DecDeliveryCount(99);
consumer.DeliveryCount(99).ShouldBe(1UL);
}
[Fact] // T:1284
public void JetStreamConsumerMaxAckPending_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", MaxRequestBatch = 2, MaxWaiting = 32 });
consumer.ProcessNextMsgRequest("_INBOX.1", Encoding.UTF8.GetBytes("{\"batch\":3}")).ShouldBeFalse();
consumer.PendingRequests().Count.ShouldBe(0);
}
[Fact] // T:1285
public void JetStreamConsumerPullMaxAckPending_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", MaxRequestMaxBytes = 16, MaxWaiting = 32 });
consumer.ProcessNextMsgRequest("_INBOX.1", Encoding.UTF8.GetBytes("{\"batch\":1,\"max_bytes\":17}")).ShouldBeFalse();
consumer.ProcessNextMsgRequest("_INBOX.2", Encoding.UTF8.GetBytes("{\"batch\":1,\"max_bytes\":16}")).ShouldBeTrue();
}
[Fact] // T:1286
public void JetStreamConsumerPullMaxAckPendingRedeliveries_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D" });
consumer.NotifyDeliveryExceeded(123, 4);
consumer.IncDeliveryCount(123).ShouldBe(2UL);
consumer.NotifyDeliveryExceeded(123, 5);
}
[Fact] // T:1339
public void JetStreamConsumerPullRemoveInterest_ShouldSucceed()
{
var consumer = CreateConsumer(new ConsumerConfig { Durable = "D", MaxWaiting = 32 });
consumer.ProcessNextMsgRequest("_INBOX.1", Encoding.UTF8.GetBytes("{\"batch\":1,\"expires\":\"00:00:00.001\"}")).ShouldBeTrue();
Thread.Sleep(10);
consumer.NextWaiting(1).ShouldBeNull();
consumer.PendingRequests().Count.ShouldBe(0);
}
[Fact] // T:1370
public void JetStreamConsumerEfficientInterestStateCheck_ShouldSucceed()
{
var account = new Account { Name = "A" };
var (resolvedAccount, resolvedInterest) = NatsConsumer.TrackDownAccountAndInterest(account, "_INBOX.check");
resolvedAccount.ShouldBeSameAs(account);
resolvedInterest.ShouldBe("_INBOX.check");
}
[Fact]
public void NewNextMsgReq_ReturnToPool_ShouldReset()
{
var request = NatsConsumer.NewNextMsgReq("_INBOX.req", Encoding.UTF8.GetBytes("{\"batch\":1}"));
request.Reply.ShouldBe("_INBOX.req");
request.Message.Length.ShouldBeGreaterThan(0);
request.ReturnToPool();
request.Reply.ShouldBeEmpty();
request.Message.ShouldBeEmpty();
}
}
BIN
View File
Binary file not shown.
+6 -6
View File
@@ -1,6 +1,6 @@
# NATS .NET Porting Status Report
Generated: 2026-03-01 06:13:51 UTC
Generated: 2026-03-01 06:35:36 UTC
## Modules (12 total)
@@ -13,18 +13,18 @@ Generated: 2026-03-01 06:13:51 UTC
| Status | Count |
|--------|-------|
| complete | 22 |
| deferred | 927 |
| deferred | 860 |
| n_a | 24 |
| stub | 1 |
| verified | 2699 |
| verified | 2766 |
## Unit Tests (3257 total)
| Status | Count |
|--------|-------|
| deferred | 1147 |
| deferred | 1145 |
| n_a | 307 |
| verified | 1803 |
| verified | 1805 |
## Library Mappings (36 total)
@@ -35,4 +35,4 @@ Generated: 2026-03-01 06:13:51 UTC
## Overall Progress
**4867/6942 items complete (70.1%)**
**4936/6942 items complete (71.1%)**