azure-sdk-for-net 🚀 - ServiceBusMessage Model

Historically, there was always some pain around BrokeredMessage/Message with regards to the broker set properties. Specifically, to be able to test certain scenarios w/o receiving a message but rather constructing it, an exception would be thrown. With some reflection, it could be worked around, but still wasn't straight forward. The idea of having two models could alleviate some of that.

SeanFeldman on 11 Feb 2020

Considering something like this:

public class Message
{

    public Message();
    public Message(ReadOnlyMemory<byte> body);
    public static string DeadLetterErrorDescriptionHeader;
    public static string DeadLetterReasonHeader;
    public ReadOnlyMemory<byte> Body { get; set; }
    public string ContentType { get; set; }
    public string CorrelationId { get; set; }
    public string Label { get; set; }
    public string MessageId { get; set; }
    public string PartitionKey { get; set; }
    public string ReplyTo { get; set; }
    public string ReplyToSessionId { get; set; }
    public DateTime ScheduledEnqueueTimeUtc { get; set; }
    public string SessionId { get; set; }
    public TimeSpan TimeToLive { get; set; }
    public string To { get; set; }
    public IDictionary<string, object> UserProperties { get; }
    public string ViaPartitionKey { get; set; }
    public Message Clone();
    public override string ToString();
}



public class ReceivedMessage : Message
{

    public ReceivedMessage();
    public ReceivedMessage(Memory<byte> body);
    public string DeadLetterSource { get; }
    public int DeliveryCount { get; }
    public long EnqueuedSequenceNumber { get; }
    public DateTime EnqueuedTimeUtc { get; }
    public DateTime ExpiresAtUtc { get; }
    public bool IsLockTokenSet { get; }
    public DateTime LockedUntilUtc { get; }
    public string LockToken { get; }
    public long SequenceNumber { get; }
}

JoshLove-msft on 13 Feb 2020

``c# // Wasn'tMessage` considered too generic? 😉
public class Message
{
public Message() {}
public Message(ReadOnlyMemory body) {}
// DeadLetterErrorDescriptionHeader and DeadLetterReasonHeader are only applicable to a received message
//public static string DeadLetterErrorDescriptionHeader;
//public static string DeadLetterReasonHeader;
public ReadOnlyMemory Body { get; set; }
public string ContentType { get; set; }
public string CorrelationId { get; set; }
public string Label { get; set; }
public string MessageId { get; set; }
public string PartitionKey { get; set; }
public string ReplyTo { get; set; }
public string ReplyToSessionId { get; set; }
public DateTime ScheduledEnqueueTimeUtc { get; set; }
public string SessionId { get; set; }
public TimeSpan TimeToLive { get; set; }
public string To { get; set; }
public IDictionary UserProperties { get; }
public string ViaPartitionKey { get; set; }
public Message Clone() { return new Message(); }
public override string ToString() { return this.GetType().ToString(); }

// missing
public DateTime ExpiresAtUtc { get; set; }
// this would be AMQP translated message size, currently shows the body byte count
public long Size { get; }
// I don't use it, but others might
public long ForcePersistence { get; set; }

}

public class ReceivedMessage : Message
{
public ReceivedMessage() {}
public ReceivedMessage(Memory body) {}
public static string DeadLetterErrorDescriptionHeader;
public static string DeadLetterReasonHeader;
public string DeadLetterSource { get; }
public int DeliveryCount { get; }
public DateTime EnqueuedTimeUtc { get; }
public DateTime ExpiresAtUtc { get; }
public DateTime LockedUntilUtc { get; }
public string LockToken { get; }
public long SequenceNumber { get; }
public long EnqueuedSequenceNumber { get; }

// IsLockTokenSet was necessary to distinguish between newly created Message vs received one.
// With two separate models, it seems unnecessary
//public bool IsLockTokenSet { get; }

// these properties also need to be on the received size as well
public long Size { get; }
public string ContentType { get; set; }
public string CorrelationId { get; set; }
public string Label { get; set; }
public string MessageId { get; set; }
public string PartitionKey { get; set; }
public string ReplyTo { get; set; }
public string ReplyToSessionId { get; set; }
public DateTime ScheduledEnqueueTimeUtc { get; set; }
public string SessionId { get; set; }
public TimeSpan TimeToLive { get; set; }
public string To { get; set; }

// missing
public MessageState State { get; set; }

}

public enum MessageState
{
Active = 0,
Deferred = 1,
Scheduled = 2
}
```

SeanFeldman on 13 Feb 2020

👍1

Thanks @SeanFeldman