Skip to content

Serialize sequence number as long #1806

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 11, 2025
Merged

Serialize sequence number as long #1806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 50 additions & 11 deletions projects/Applications/PublisherConfirms/PublisherConfirms.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@
//---------------------------------------------------------------------------

using System;
using System.Buffers.Binary;
using System.Collections.Generic;
using System.Diagnostics;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using RabbitMQ.Client;
using RabbitMQ.Client.Exceptions;

const ushort MAX_OUTSTANDING_CONFIRMS = 256;

Expand Down Expand Up @@ -124,11 +124,33 @@ async Task PublishMessagesInBatchAsync()
var sw = new Stopwatch();
sw.Start();

channel.BasicReturnAsync += (sender, ea) =>
{
ulong sequenceNumber = 0;

IReadOnlyBasicProperties props = ea.BasicProperties;
if (props.Headers is not null)
{
object? maybeSeqNum = props.Headers[Constants.PublishSequenceNumberHeader];
if (maybeSeqNum is long longSequenceNumber)
{
sequenceNumber = (ulong)longSequenceNumber;
}
}

return Console.Out.WriteLineAsync($"{DateTime.Now} [INFO] message sequence number '{sequenceNumber}' has been basic.return-ed");
};

var publishTasks = new List<ValueTask>();
for (int i = 0; i < MESSAGE_COUNT; i++)
{
string rk = queueName;
if (i % 1000 == 0)
{
rk = Guid.NewGuid().ToString();
}
byte[] body = Encoding.UTF8.GetBytes(i.ToString());
publishTasks.Add(channel.BasicPublishAsync(exchange: string.Empty, routingKey: queueName, body: body, mandatory: true, basicProperties: props));
publishTasks.Add(channel.BasicPublishAsync(exchange: string.Empty, routingKey: rk, body: body, mandatory: true, basicProperties: props));
outstandingMessageCount++;

if (outstandingMessageCount == batchSize)
Expand All @@ -139,9 +161,13 @@ async Task PublishMessagesInBatchAsync()
{
await pt;
}
catch (PublishException pex)
{
Console.Error.WriteLine($"{DateTime.Now} [ERROR] saw nack or return, pex.IsReturn: '{pex.IsReturn}', seq no: '{pex.PublishSequenceNumber}'");
}
catch (Exception ex)
{
Console.Error.WriteLine($"{DateTime.Now} [ERROR] saw nack or return, ex: '{ex}'");
Console.Error.WriteLine($"{DateTime.Now} [ERROR] saw exception, ex: '{ex}'");
}
}
publishTasks.Clear();
Expand All @@ -157,9 +183,13 @@ async Task PublishMessagesInBatchAsync()
{
await pt;
}
catch (PublishException pex)
{
Console.Error.WriteLine($"{DateTime.Now} [ERROR] saw nack or return, pex.IsReturn: '{pex.IsReturn}', seq no: '{pex.PublishSequenceNumber}'");
}
catch (Exception ex)
{
Console.Error.WriteLine($"{DateTime.Now} [ERROR] saw nack or return, ex: '{ex}'");
Console.Error.WriteLine($"{DateTime.Now} [ERROR] saw exception, ex: '{ex}'");
}
}
publishTasks.Clear();
Expand Down Expand Up @@ -236,22 +266,23 @@ async Task CleanOutstandingConfirms(ulong deliveryTag, bool multiple)
}
}

channel.BasicReturnAsync += (sender, ea) =>
channel.BasicReturnAsync += async (sender, ea) =>
{
ulong sequenceNumber = 0;

IReadOnlyBasicProperties props = ea.BasicProperties;
if (props.Headers is not null)
{
object? maybeSeqNum = props.Headers[Constants.PublishSequenceNumberHeader];
if (maybeSeqNum is not null)
if (maybeSeqNum is long longSequenceNumber)
{
sequenceNumber = BinaryPrimitives.ReadUInt64BigEndian((byte[])maybeSeqNum);
sequenceNumber = (ulong)longSequenceNumber;
}
}

Console.WriteLine($"{DateTime.Now} [WARNING] message sequence number {sequenceNumber} has been basic.return-ed");
return CleanOutstandingConfirms(sequenceNumber, false);
await Console.Out.WriteLineAsync($"{DateTime.Now} [INFO] message sequence number '{sequenceNumber}' has been basic.return-ed");

await CleanOutstandingConfirms(sequenceNumber, false);
};

channel.BasicAcksAsync += (sender, ea) => CleanOutstandingConfirms(ea.DeliveryTag, ea.Multiple);
Expand Down Expand Up @@ -290,13 +321,21 @@ async Task CleanOutstandingConfirms(ulong deliveryTag, bool multiple)
// This will cause a basic.return, for fun
rk = Guid.NewGuid().ToString();
}

var msgProps = new BasicProperties
{
Persistent = true,
Headers = new Dictionary<string, object?>()
};

msgProps.Headers.Add(Constants.PublishSequenceNumberHeader, (long)nextPublishSeqNo);

(ulong, ValueTask) data =
(nextPublishSeqNo, channel.BasicPublishAsync(exchange: string.Empty, routingKey: rk, body: body, mandatory: true, basicProperties: props));
(nextPublishSeqNo, channel.BasicPublishAsync(exchange: string.Empty, routingKey: rk, body: body, mandatory: true, basicProperties: msgProps));
publishTasks.Add(data);
}

using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
// await Task.WhenAll(publishTasks).WaitAsync(cts.Token);
foreach ((ulong SeqNo, ValueTask PublishTask) datum in publishTasks)
{
try
Expand Down
12 changes: 8 additions & 4 deletions projects/RabbitMQ.Client/Impl/Channel.BasicPublish.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
using System.Threading;
using System.Threading.Tasks;
using RabbitMQ.Client.Framing;
using RabbitMQ.Client.Util;

namespace RabbitMQ.Client.Impl
{
Expand Down Expand Up @@ -217,9 +216,14 @@ void MaybeAddPublishSequenceNumberToHeaders(IDictionary<string, object?> headers
{
if (_publisherConfirmationsEnabled && _publisherConfirmationTrackingEnabled)
{
byte[] publishSequenceNumberBytes = new byte[8];
NetworkOrderSerializer.WriteUInt64(ref publishSequenceNumberBytes.GetStart(), publishSequenceNumber);
headers[Constants.PublishSequenceNumberHeader] = publishSequenceNumberBytes;
if (publishSequenceNumber > long.MaxValue)
{
headers[Constants.PublishSequenceNumberHeader] = publishSequenceNumber.ToString();
}
else
{
headers[Constants.PublishSequenceNumberHeader] = (long)publishSequenceNumber;
}
}
}
}
Expand Down
18 changes: 14 additions & 4 deletions projects/RabbitMQ.Client/Impl/Channel.PublisherConfirms.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@
using System.Collections.Generic;
using System.Diagnostics;
using System.Runtime.CompilerServices;
using System.Text;
using System.Threading;
using System.Threading.RateLimiting;
using System.Threading.Tasks;
using RabbitMQ.Client.Events;
using RabbitMQ.Client.Exceptions;
using RabbitMQ.Client.Framing;
using RabbitMQ.Client.Util;

namespace RabbitMQ.Client.Impl
{
Expand Down Expand Up @@ -233,10 +233,20 @@ private void HandleReturn(BasicReturnEventArgs basicReturnEvent)
ulong publishSequenceNumber = 0;
IReadOnlyBasicProperties props = basicReturnEvent.BasicProperties;
object? maybeSeqNum = props.Headers?[Constants.PublishSequenceNumberHeader];
if (maybeSeqNum != null &&
maybeSeqNum is byte[] seqNumBytes)
if (maybeSeqNum != null)
{
publishSequenceNumber = NetworkOrderDeserializer.ReadUInt64(seqNumBytes);
switch (maybeSeqNum)
{
case long seqNumLong:
publishSequenceNumber = (ulong)seqNumLong;
break;
case string seqNumString:
publishSequenceNumber = ulong.Parse(seqNumString);
break;
case byte[] seqNumBytes:
publishSequenceNumber = ulong.Parse(Encoding.ASCII.GetString(seqNumBytes));
break;
}
}

HandleNack(publishSequenceNumber, multiple: false, isReturn: true);
Expand Down