Skip to content
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

Support serializing received message to/from AMQP bytes #33682

Merged
merged 15 commits into from
Feb 2, 2023
Merged

Support serializing received message to/from AMQP bytes #33682

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
7fbf52a
Support serializing received message to/from AMQP bytes
JoshLove-msft Jan 25, 2023
709bc99
Use ToMemory to avoid extra allocation
JoshLove-msft Jan 26, 2023
5a1471a
PR fb
JoshLove-msft Jan 27, 2023
5c743fe
PR fb
JoshLove-msft Jan 27, 2023
3b48964
Update test
JoshLove-msft Jan 27, 2023
97a60fa
Add back TryRead
JoshLove-msft Jan 30, 2023
9519b32
Add endianness check
JoshLove-msft Jan 31, 2023
c63aee7
Fix comment
JoshLove-msft Jan 31, 2023
ae014e2
Update WebJobs version and remove nuget config change
JoshLove-msft Feb 2, 2023
d5252ac
Fix build break
JoshLove-msft Feb 2, 2023
4b7e79d
Merge branch 'main' of https://github.com/azure/azure-sdk-for-net int…
JoshLove-msft Feb 2, 2023
1cdb46d
build break fix
JoshLove-msft Feb 2, 2023
6a13572
Storage fix
JoshLove-msft Feb 2, 2023
b7566e0
revert to 3.0.35
JoshLove-msft Feb 2, 2023
ac51df1
revert
JoshLove-msft Feb 2, 2023
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
1 change: 1 addition & 0 deletions NuGet.Config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<!-- Do not add any additional feeds if new packages are needed they need to come from nuget.org or our azure-sdk-for-net DevOps feed -->
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
<add key="azure-sdk-for-net" value="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json" />
<add key="azure_app_service_staging" value="https://www.myget.org/F/azure-appservice-staging/api/v2" />
JoshLove-msft marked this conversation as resolved.
Show resolved Hide resolved

<!--
Used for azure-sdk-tools repo until issue https://github.com/Azure/azure-sdk-tools/issues/1329 is addressed
Expand Down
4 changes: 2 additions & 2 deletions eng/Packages.Data.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,8 @@
<PackageReference Update="Microsoft.Azure.SignalR.Management" Version="1.18.0" />
<PackageReference Update="Microsoft.Azure.SignalR.Protocols" Version="1.18.0" />
<PackageReference Update="Microsoft.Azure.SignalR.Serverless.Protocols" Version="1.9.0" />
<PackageReference Update="Microsoft.Azure.WebJobs" Version="3.0.33" />
<PackageReference Update="Microsoft.Azure.WebJobs.Sources" Version="3.0.30" />
<PackageReference Update="Microsoft.Azure.WebJobs" Version="3.0.35" />
<PackageReference Update="Microsoft.Azure.WebJobs.Sources" Version="3.0.35" />
<PackageReference Update="Microsoft.Spatial" Version="7.5.3" />
<PackageReference Update="Newtonsoft.Json" Version="10.0.3" />
</ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion sdk/core/Azure.Core.TestFramework/src/TestEnvironment.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ private async Task ExtendResourceGroupExpirationAsync()
string clientSecret = GetOptionalVariable("CLIENT_SECRET");
string authorityHost = GetOptionalVariable("AZURE_AUTHORITY_HOST");

if (tenantId == null || clientId == null || clientSecret == null || authorityHost == null)
if (tenantId == null || clientId == null || clientSecret == null || authorityHost == null || ResourceManagerUrl == null)
JoshLove-msft marked this conversation as resolved.
Show resolved Hide resolved
{
return;
}
Expand Down
8 changes: 8 additions & 0 deletions sdk/servicebus/Azure.Messaging.ServiceBus/api/Azure.Messaging.ServiceBus.netstandard2.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1005,6 +1005,14 @@ public TrueRuleFilter() : base (default(string)) { }
public override string ToString() { throw null; }
}
}
namespace Azure.Messaging.ServiceBus.Primitives
{
public static partial class ServiceBusAmqpExtensions
{
public static Azure.Messaging.ServiceBus.ServiceBusReceivedMessage FromAmqpBytes(System.BinaryData messageBytes, System.BinaryData lockTokenBytes) { throw null; }
public static System.BinaryData ToAmqpBytes(this Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message) { throw null; }
}
}
namespace Microsoft.Extensions.Azure
{
public static partial class ServiceBusClientBuilderExtensions
Expand Down
133 changes: 78 additions & 55 deletions sdk/servicebus/Azure.Messaging.ServiceBus/src/Amqp/AmqpMessageConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,26 +171,30 @@ private static ArraySegment<byte> ReadStreamToArraySegment(Stream stream)
}
}

public virtual AmqpMessage SBMessageToAmqpMessage(ServiceBusMessage sbMessage)
public virtual AmqpMessage SBMessageToAmqpMessage(ServiceBusMessage sbMessage) => AmqpAnnotatedMessageToAmqpMessage(sbMessage.AmqpMessage);

public virtual AmqpMessage AmqpAnnotatedMessageToAmqpMessage(AmqpAnnotatedMessage annotatedMessage)
{
Argument.AssertNotNull(annotatedMessage, nameof(annotatedMessage));

// body
var amqpMessage = sbMessage.ToAmqpMessage();
AmqpMessage amqpMessage = annotatedMessage.ToAmqpMessage();

// properties
amqpMessage.Properties.MessageId = sbMessage.MessageId;
amqpMessage.Properties.CorrelationId = sbMessage.CorrelationId;
amqpMessage.Properties.ContentType = sbMessage.ContentType;
amqpMessage.Properties.ContentEncoding = sbMessage.AmqpMessage.Properties.ContentEncoding;
amqpMessage.Properties.Subject = sbMessage.Subject;
amqpMessage.Properties.To = sbMessage.To;
amqpMessage.Properties.ReplyTo = sbMessage.ReplyTo;
amqpMessage.Properties.GroupId = sbMessage.SessionId;
amqpMessage.Properties.ReplyToGroupId = sbMessage.ReplyToSessionId;
amqpMessage.Properties.GroupSequence = sbMessage.AmqpMessage.Properties.GroupSequence;

if (sbMessage.AmqpMessage.Properties.UserId.HasValue)
{
ReadOnlyMemory<byte> userId = sbMessage.AmqpMessage.Properties.UserId.Value;
amqpMessage.Properties.MessageId = annotatedMessage.Properties.MessageId?.ToString();
amqpMessage.Properties.CorrelationId = annotatedMessage.Properties.CorrelationId?.ToString();
amqpMessage.Properties.ContentType = annotatedMessage.Properties.ContentType;
amqpMessage.Properties.ContentEncoding = annotatedMessage.Properties.ContentEncoding;
amqpMessage.Properties.Subject = annotatedMessage.Properties.Subject;
amqpMessage.Properties.To = annotatedMessage.Properties.To?.ToString();
amqpMessage.Properties.ReplyTo = annotatedMessage.Properties.ReplyTo?.ToString();
amqpMessage.Properties.GroupId = annotatedMessage.Properties.GroupId;
amqpMessage.Properties.ReplyToGroupId = annotatedMessage.Properties.ReplyToGroupId;
amqpMessage.Properties.GroupSequence = annotatedMessage.Properties.GroupSequence;

if (annotatedMessage.Properties.UserId.HasValue)
{
ReadOnlyMemory<byte> userId = annotatedMessage.Properties.UserId.Value;
if (MemoryMarshal.TryGetArray(userId, out ArraySegment<byte> segment))
{
amqpMessage.Properties.UserId = segment;
Expand All @@ -202,14 +206,15 @@ public virtual AmqpMessage SBMessageToAmqpMessage(ServiceBusMessage sbMessage)
}

// If TTL is set, it is used to calculate AbsoluteExpiryTime and CreationTime
if (sbMessage.TimeToLive != TimeSpan.MaxValue)
TimeSpan ttl = annotatedMessage.GetTimeToLive();
if (ttl != TimeSpan.MaxValue)
{
amqpMessage.Header.Ttl = (uint)sbMessage.TimeToLive.TotalMilliseconds;
amqpMessage.Header.Ttl = (uint)ttl.TotalMilliseconds;
amqpMessage.Properties.CreationTime = DateTime.UtcNow;

if (AmqpConstants.MaxAbsoluteExpiryTime - amqpMessage.Properties.CreationTime.Value > sbMessage.TimeToLive)
if (AmqpConstants.MaxAbsoluteExpiryTime - amqpMessage.Properties.CreationTime.Value > ttl)
{
amqpMessage.Properties.AbsoluteExpiryTime = amqpMessage.Properties.CreationTime.Value + sbMessage.TimeToLive;
amqpMessage.Properties.AbsoluteExpiryTime = amqpMessage.Properties.CreationTime.Value + ttl;
}
else
{
Expand All @@ -218,38 +223,41 @@ public virtual AmqpMessage SBMessageToAmqpMessage(ServiceBusMessage sbMessage)
}
else
{
if (sbMessage.AmqpMessage.Properties.CreationTime.HasValue)
if (annotatedMessage.Properties.CreationTime.HasValue)
{
amqpMessage.Properties.CreationTime = sbMessage.AmqpMessage.Properties.CreationTime.Value.UtcDateTime;
amqpMessage.Properties.CreationTime = annotatedMessage.Properties.CreationTime.Value.UtcDateTime;
}
if (sbMessage.AmqpMessage.Properties.AbsoluteExpiryTime.HasValue)
if (annotatedMessage.Properties.AbsoluteExpiryTime.HasValue)
{
amqpMessage.Properties.AbsoluteExpiryTime = sbMessage.AmqpMessage.Properties.AbsoluteExpiryTime.Value.UtcDateTime;
amqpMessage.Properties.AbsoluteExpiryTime = annotatedMessage.Properties.AbsoluteExpiryTime.Value.UtcDateTime;
}
}

// message annotations

foreach (KeyValuePair<string, object> kvp in sbMessage.AmqpMessage.MessageAnnotations)
foreach (KeyValuePair<string, object> kvp in annotatedMessage.MessageAnnotations)
{
switch (kvp.Key)
{
case AmqpMessageConstants.ScheduledEnqueueTimeUtcName:
if ((sbMessage.ScheduledEnqueueTime != null) && sbMessage.ScheduledEnqueueTime > DateTimeOffset.MinValue)
DateTimeOffset scheduledEnqueueTime = annotatedMessage.GetScheduledEnqueueTime();
if (scheduledEnqueueTime != default)
{
amqpMessage.MessageAnnotations.Map.Add(AmqpMessageConstants.ScheduledEnqueueTimeUtcName, sbMessage.ScheduledEnqueueTime.UtcDateTime);
amqpMessage.MessageAnnotations.Map.Add(AmqpMessageConstants.ScheduledEnqueueTimeUtcName, scheduledEnqueueTime.UtcDateTime);
}
break;
case AmqpMessageConstants.PartitionKeyName:
if (sbMessage.PartitionKey != null)
string partitionKey = annotatedMessage.GetPartitionKey();
if (partitionKey != null)
{
amqpMessage.MessageAnnotations.Map.Add(AmqpMessageConstants.PartitionKeyName, sbMessage.PartitionKey);
amqpMessage.MessageAnnotations.Map.Add(AmqpMessageConstants.PartitionKeyName, partitionKey);
}
break;
case AmqpMessageConstants.ViaPartitionKeyName:
if (sbMessage.TransactionPartitionKey != null)
string viaPartitionKey = annotatedMessage.GetViaPartitionKey();
if (viaPartitionKey != null)
{
amqpMessage.MessageAnnotations.Map.Add(AmqpMessageConstants.ViaPartitionKeyName, sbMessage.TransactionPartitionKey);
amqpMessage.MessageAnnotations.Map.Add(AmqpMessageConstants.ViaPartitionKeyName, viaPartitionKey);
}
break;
default:
Expand All @@ -260,14 +268,14 @@ public virtual AmqpMessage SBMessageToAmqpMessage(ServiceBusMessage sbMessage)

// application properties

if (sbMessage.ApplicationProperties != null && sbMessage.ApplicationProperties.Count > 0)
if (annotatedMessage.ApplicationProperties.Count > 0)
{
if (amqpMessage.ApplicationProperties == null)
{
amqpMessage.ApplicationProperties = new ApplicationProperties();
}

foreach (KeyValuePair<string, object> pair in sbMessage.ApplicationProperties)
foreach (KeyValuePair<string, object> pair in annotatedMessage.ApplicationProperties)
{
if (TryGetAmqpObjectFromNetObject(pair.Value, MappingType.ApplicationProperty, out var amqpObject))
{
Expand All @@ -282,7 +290,7 @@ public virtual AmqpMessage SBMessageToAmqpMessage(ServiceBusMessage sbMessage)

// delivery annotations

foreach (KeyValuePair<string, object> kvp in sbMessage.AmqpMessage.DeliveryAnnotations)
foreach (KeyValuePair<string, object> kvp in annotatedMessage.DeliveryAnnotations)
{
if (TryGetAmqpObjectFromNetObject(kvp.Value, MappingType.ApplicationProperty, out var amqpObject))
{
Expand All @@ -292,38 +300,37 @@ public virtual AmqpMessage SBMessageToAmqpMessage(ServiceBusMessage sbMessage)

// header - except for ttl which is set above with the properties

if (sbMessage.AmqpMessage.Header.DeliveryCount != null)
if (annotatedMessage.Header.DeliveryCount != null)
{
amqpMessage.Header.DeliveryCount = sbMessage.AmqpMessage.Header.DeliveryCount;
amqpMessage.Header.DeliveryCount = annotatedMessage.Header.DeliveryCount;
}
if (sbMessage.AmqpMessage.Header.Durable != null)
if (annotatedMessage.Header.Durable != null)
{
amqpMessage.Header.Durable = sbMessage.AmqpMessage.Header.Durable;
amqpMessage.Header.Durable = annotatedMessage.Header.Durable;
}
if (sbMessage.AmqpMessage.Header.FirstAcquirer != null)
if (annotatedMessage.Header.FirstAcquirer != null)
{
amqpMessage.Header.FirstAcquirer = sbMessage.AmqpMessage.Header.FirstAcquirer;
amqpMessage.Header.FirstAcquirer = annotatedMessage.Header.FirstAcquirer;
}
if (sbMessage.AmqpMessage.Header.Priority != null)
if (annotatedMessage.Header.Priority != null)
{
amqpMessage.Header.Priority = sbMessage.AmqpMessage.Header.Priority;
amqpMessage.Header.Priority = annotatedMessage.Header.Priority;
}

// footer

foreach (KeyValuePair<string, object> kvp in sbMessage.AmqpMessage.Footer)
foreach (KeyValuePair<string, object> kvp in annotatedMessage.Footer)
{
amqpMessage.Footer.Map.Add(kvp.Key, kvp.Value);
}

return amqpMessage;
}

public virtual ServiceBusReceivedMessage AmqpMessageToSBMessage(AmqpMessage amqpMessage, bool isPeeked = false)
private static AmqpAnnotatedMessage AmqpMessageToAnnotatedMessage(AmqpMessage amqpMessage, bool isPeeked)
{
Argument.AssertNotNull(amqpMessage, nameof(amqpMessage));
AmqpAnnotatedMessage annotatedMessage;

// body

if ((amqpMessage.BodyType & SectionFlag.Data) != 0 && amqpMessage.DataBody != null)
Expand Down Expand Up @@ -351,7 +358,6 @@ public virtual ServiceBusReceivedMessage AmqpMessageToSBMessage(AmqpMessage amqp
{
annotatedMessage = new AmqpAnnotatedMessage(new AmqpMessageBody(Enumerable.Empty<ReadOnlyMemory<byte>>()));
}
ServiceBusReceivedMessage sbMessage = new ServiceBusReceivedMessage(annotatedMessage);

SectionFlag sections = amqpMessage.Sections;

Expand Down Expand Up @@ -540,22 +546,39 @@ public virtual ServiceBusReceivedMessage AmqpMessageToSBMessage(AmqpMessage amqp
}
}

return annotatedMessage;
}

public virtual ServiceBusReceivedMessage AmqpMessageToSBReceivedMessage(AmqpMessage amqpMessage, bool isPeeked = false)
{
AmqpAnnotatedMessage annotatedMessage = AmqpMessageToAnnotatedMessage(amqpMessage, isPeeked);

ServiceBusReceivedMessage sbMessage = new ServiceBusReceivedMessage(annotatedMessage);

// lock token

if (amqpMessage.DeliveryTag.Count == GuidSizeInBytes)
sbMessage.LockTokenGuid = ParseGuidBytes(amqpMessage.DeliveryTag);

amqpMessage.Dispose();

return sbMessage;
}

public virtual Guid ParseGuidBytes(ReadOnlyMemory<byte> bytes)
{
if (bytes.Length == GuidSizeInBytes)
{
Span<byte> guidBytes = stackalloc byte[GuidSizeInBytes];
amqpMessage.DeliveryTag.AsSpan().CopyTo(guidBytes);
if (!MemoryMarshal.TryRead<Guid>(guidBytes, out var lockTokenGuid))
// Use TryRead to avoid allocating an array
if (!MemoryMarshal.TryRead<Guid>(bytes.Span, out var lockTokenGuid))
JoshLove-msft marked this conversation as resolved.
Show resolved Hide resolved
{
lockTokenGuid = new Guid(guidBytes.ToArray());
// We expect the constructor to fail at this point, but we invoke it to leverage the Guid validation rather than
// throwing ourselves.
lockTokenGuid = new Guid(bytes.ToArray());
}
sbMessage.LockTokenGuid = lockTokenGuid;
return lockTokenGuid;
}

amqpMessage.Dispose();

return sbMessage;
return default;
}

internal static bool TryGetAmqpObjectFromNetObject(object netObject, MappingType mappingType, out object amqpObject)
Expand Down
12 changes: 7 additions & 5 deletions sdk/servicebus/Azure.Messaging.ServiceBus/src/Amqp/AmqpMessageExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ namespace Azure.Messaging.ServiceBus.Amqp
{
internal static class AmqpMessageExtensions
{
public static AmqpMessage ToAmqpMessage(this ServiceBusMessage message)
public static AmqpMessage ToAmqpMessage(this ServiceBusMessage message) => ToAmqpMessage(message.AmqpMessage);

public static AmqpMessage ToAmqpMessage(this AmqpAnnotatedMessage message)
{
if (message.AmqpMessage.Body.TryGetData(out IEnumerable<ReadOnlyMemory<byte>> dataBody))
if (message.Body.TryGetData(out IEnumerable<ReadOnlyMemory<byte>> dataBody))
{
return AmqpMessage.Create(dataBody.AsAmqpData());
}
if (message.AmqpMessage.Body.TryGetValue(out object value))
if (message.Body.TryGetValue(out object value))
{
if (AmqpMessageConverter.TryGetAmqpObjectFromNetObject(value, MappingType.MessageBody, out object amqpObject))
{
Expand All @@ -32,12 +34,12 @@ public static AmqpMessage ToAmqpMessage(this ServiceBusMessage message)
throw new NotSupportedException(Resources.InvalidAmqpMessageValueBody.FormatForUser(amqpObject?.GetType()));
}
}
if (message.AmqpMessage.Body.TryGetSequence(out IEnumerable<IList<object>> sequence))
if (message.Body.TryGetSequence(out IEnumerable<IList<object>> sequence))
{
return AmqpMessage.Create(sequence.Select(s => new AmqpSequence((IList)s)).ToList());
}

throw new NotSupportedException($"{message.AmqpMessage.Body.GetType()} is not a supported message body type.");
throw new NotSupportedException($"{message.Body.GetType()} is not a supported message body type.");
}

private static IEnumerable<Data> AsAmqpData(this IEnumerable<ReadOnlyMemory<byte>> binaryData)
Expand Down
6 changes: 3 additions & 3 deletions sdk/servicebus/Azure.Messaging.ServiceBus/src/Amqp/AmqpReceiver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ private async Task<IReadOnlyList<ServiceBusReceivedMessage>> ReceiveMessagesAsyn
link.DisposeDelivery(message, true, AmqpConstants.AcceptedOutcome);
}

receivedMessages.Add(_messageConverter.AmqpMessageToSBMessage(message));
receivedMessages.Add(_messageConverter.AmqpMessageToSBReceivedMessage(message));
message.Dispose();
}

Expand Down Expand Up @@ -984,7 +984,7 @@ private async Task<IReadOnlyList<ServiceBusReceivedMessage>> PeekMessagesInterna

var payload = (ArraySegment<byte>)entry[ManagementConstants.Properties.Message];
var amqpMessage = AmqpMessage.CreateAmqpStreamMessage(new BufferListStream(new[] { payload }), true);
message = _messageConverter.AmqpMessageToSBMessage(amqpMessage, true);
message = _messageConverter.AmqpMessageToSBReceivedMessage(amqpMessage, true);
messages.Add(message);
}

Expand Down Expand Up @@ -1294,7 +1294,7 @@ internal virtual async Task<IReadOnlyList<ServiceBusReceivedMessage>> ReceiveDef
var payload = (ArraySegment<byte>)entry[ManagementConstants.Properties.Message];
var amqpMessage =
AmqpMessage.CreateAmqpStreamMessage(new BufferListStream(new[] { payload }), true);
var message = _messageConverter.AmqpMessageToSBMessage(amqpMessage);
var message = _messageConverter.AmqpMessageToSBReceivedMessage(amqpMessage);
if (entry.TryGetValue<Guid>(ManagementConstants.Properties.LockToken, out var lockToken))
{
message.LockTokenGuid = lockToken;
Expand Down
Loading