EH/SB remove Message.LinkName (Azure#20520)

One more change from go-amqp to pick up.

Author: jhendrixMSFT

sdk/messaging/azeventhubs/internal/go-amqp/message.go

@@ -102,9 +102,8 @@ type Message struct {
 	// encryption details).
 	Footer Annotations
 
-	rcvr       *Receiver // the receiving link
-	deliveryID uint32    // used when sending disposition
-	settled    bool      // whether transfer was settled by sender
+	deliveryID uint32 // used when sending disposition
+	settled    bool   // whether transfer was settled by sender
 }
 
 // NewMessage returns a *Message with data as the payload.
@@ -127,14 +126,6 @@ func (m *Message) GetData() []byte {
 	return m.Data[0]
 }
 
-// LinkName returns the receiving link name or the empty string.
-func (m *Message) LinkName() string {
-	if m.rcvr != nil {
-		return m.rcvr.l.key.name
-	}
-	return ""
-}
-
 // MarshalBinary encodes the message into binary form.
 func (m *Message) MarshalBinary() ([]byte, error) {
 	buf := &buffer.Buffer{}

sdk/messaging/azeventhubs/internal/go-amqp/receiver.go

@@ -90,7 +90,6 @@ func (r *Receiver) Prefetched() *Message {
 	}
 
 	debug.Log(3, "RX (Receiver): prefetched delivery ID %d", msg.deliveryID)
-	msg.rcvr = r
 
 	if msg.settled {
 		r.onSettlement(1)
@@ -121,7 +120,6 @@ func (r *Receiver) Receive(ctx context.Context, opts *ReceiveOptions) (*Message,
 		msg := q.Dequeue()
 		debug.Assert(msg != nil)
 		debug.Log(3, "RX (Receiver): received delivery ID %d", msg.deliveryID)
-		msg.rcvr = r
 		r.messagesQ.Release(q)
 		if msg.settled {
 			r.onSettlement(1)

sdk/messaging/azservicebus/amqp_message.go

@@ -222,7 +222,7 @@ func copyAnnotations(src map[any]any) amqp.Annotations {
 	return dest
 }
 
-func newAMQPAnnotatedMessage(goAMQPMessage *amqp.Message) *AMQPAnnotatedMessage {
+func newAMQPAnnotatedMessage(goAMQPMessage *amqp.Message, receivingLinkName string) *AMQPAnnotatedMessage {
 	var header *AMQPAnnotatedMessageHeader
 
 	if goAMQPMessage.Header != nil {
@@ -273,7 +273,7 @@ func newAMQPAnnotatedMessage(goAMQPMessage *amqp.Message) *AMQPAnnotatedMessage
 		DeliveryTag:         goAMQPMessage.DeliveryTag,
 		Footer:              footer,
 		Header:              header,
-		linkName:            goAMQPMessage.LinkName(),
+		linkName:            receivingLinkName,
 		Properties:          properties,
 		inner:               goAMQPMessage,
 	}

sdk/messaging/azservicebus/internal/go-amqp/message.go

@@ -102,9 +102,8 @@ type Message struct {
 	// encryption details).
 	Footer Annotations
 
-	rcvr       *Receiver // the receiving link
-	deliveryID uint32    // used when sending disposition
-	settled    bool      // whether transfer was settled by sender
+	deliveryID uint32 // used when sending disposition
+	settled    bool   // whether transfer was settled by sender
 }
 
 // NewMessage returns a *Message with data as the payload.
@@ -127,14 +126,6 @@ func (m *Message) GetData() []byte {
 	return m.Data[0]
 }
 
-// LinkName returns the receiving link name or the empty string.
-func (m *Message) LinkName() string {
-	if m.rcvr != nil {
-		return m.rcvr.l.key.name
-	}
-	return ""
-}
-
 // MarshalBinary encodes the message into binary form.
 func (m *Message) MarshalBinary() ([]byte, error) {
 	buf := &buffer.Buffer{}

sdk/messaging/azservicebus/internal/go-amqp/receiver.go

@@ -90,7 +90,6 @@ func (r *Receiver) Prefetched() *Message {
 	}
 
 	debug.Log(3, "RX (Receiver): prefetched delivery ID %d", msg.deliveryID)
-	msg.rcvr = r
 
 	if msg.settled {
 		r.onSettlement(1)
@@ -121,7 +120,6 @@ func (r *Receiver) Receive(ctx context.Context, opts *ReceiveOptions) (*Message,
 		msg := q.Dequeue()
 		debug.Assert(msg != nil)
 		debug.Log(3, "RX (Receiver): received delivery ID %d", msg.deliveryID)
-		msg.rcvr = r
 		r.messagesQ.Release(q)
 		if msg.settled {
 			r.onSettlement(1)

sdk/messaging/azservicebus/message.go

@@ -312,9 +312,9 @@ func (m *Message) toAMQPMessage() *amqp.Message {
 // newReceivedMessage creates a received message from an AMQP message.
 // NOTE: this converter assumes that the Body of this message will be the first
 // serialized byte array in the Data section of the messsage.
-func newReceivedMessage(amqpMsg *amqp.Message) *ReceivedMessage {
+func newReceivedMessage(amqpMsg *amqp.Message, receivingLinkName string) *ReceivedMessage {
 	msg := &ReceivedMessage{
-		RawAMQPMessage: newAMQPAnnotatedMessage(amqpMsg),
+		RawAMQPMessage: newAMQPAnnotatedMessage(amqpMsg, receivingLinkName),
 		State:          MessageStateActive,
 	}
 

sdk/messaging/azservicebus/message_test.go

@@ -50,7 +50,7 @@ func TestMessageUnitTest(t *testing.T) {
 func TestAMQPMessageToReceivedMessage(t *testing.T) {
 	t.Run("empty_message", func(t *testing.T) {
 		// nothing should blow up.
-		rm := newReceivedMessage(&amqp.Message{})
+		rm := newReceivedMessage(&amqp.Message{}, "receiving_link")
 		require.NotNil(t, rm)
 	})
 
@@ -73,7 +73,7 @@ func TestAMQPMessageToReceivedMessage(t *testing.T) {
 			},
 		}
 
-		receivedMessage := newReceivedMessage(amqpMessage)
+		receivedMessage := newReceivedMessage(amqpMessage, "receiving_link")
 
 		require.Equal(t, []byte("hello"), receivedMessage.Body)
 		require.EqualValues(t, lockedUntil, *receivedMessage.LockedUntil)
@@ -134,7 +134,7 @@ func TestAMQPMessageToMessage(t *testing.T) {
 		Data: [][]byte{[]byte("foo")},
 	}
 
-	msg := newReceivedMessage(amqpMsg)
+	msg := newReceivedMessage(amqpMsg, "receiving_link")
 
 	require.EqualValues(t, msg.MessageID, amqpMsg.Properties.MessageID, "messageID")
 	require.EqualValues(t, msg.SessionID, amqpMsg.Properties.GroupID, "groupID")
@@ -179,40 +179,40 @@ func TestMessageState(t *testing.T) {
 				Annotations: amqp.Annotations{
 					messageStateAnnotation: td.PropValue,
 				},
-			})
+			}, "receiving_link")
 			require.EqualValues(t, td.Expected, m.State)
 		})
 	}
 
 	t.Run("NoAnnotations", func(t *testing.T) {
 		m := newReceivedMessage(&amqp.Message{
 			Annotations: nil,
-		})
+		}, "receiving_link")
 		require.EqualValues(t, MessageStateActive, m.State)
 	})
 }
 
 func TestMessageWithIncorrectBody(t *testing.T) {
 	// these are cases where the simple ReceivedMessage can't represent the AMQP message's
 	// payload.
-	message := newReceivedMessage(&amqp.Message{})
+	message := newReceivedMessage(&amqp.Message{}, "receiving_link")
 	require.Nil(t, message.Body)
 
 	message = newReceivedMessage(&amqp.Message{
 		Value: "hello",
-	})
+	}, "receiving_link")
 	require.Nil(t, message.Body)
 
 	message = newReceivedMessage(&amqp.Message{
 		Sequence: [][]any{},
-	})
+	}, "receiving_link")
 	require.Nil(t, message.Body)
 
 	message = newReceivedMessage(&amqp.Message{
 		Data: [][]byte{
 			[]byte("hello"),
 			[]byte("world"),
 		},
-	})
+	}, "receiving_link")
 	require.Nil(t, message.Body)
 }

sdk/messaging/azservicebus/receiver.go

@@ -229,7 +229,7 @@ func (r *Receiver) ReceiveDeferredMessages(ctx context.Context, sequenceNumbers
 		}
 
 		for _, amqpMsg := range amqpMessages {
-			receivedMsg := newReceivedMessage(amqpMsg)
+			receivedMsg := newReceivedMessage(amqpMsg, lwid.Receiver.LinkName())
 			receivedMsg.deferred = true
 
 			receivedMessages = append(receivedMessages, receivedMsg)
@@ -279,7 +279,7 @@ func (r *Receiver) PeekMessages(ctx context.Context, maxMessageCount int, option
 		receivedMessages = make([]*ReceivedMessage, len(messages))
 
 		for i := 0; i < len(messages); i++ {
-			receivedMessages[i] = newReceivedMessage(messages[i])
+			receivedMessages[i] = newReceivedMessage(messages[i], links.Receiver.LinkName())
 		}
 
 		if len(receivedMessages) > 0 && updateInternalSequenceNumber {
@@ -440,7 +440,7 @@ func (r *Receiver) receiveMessagesImpl(ctx context.Context, maxMessages int, opt
 	var receivedMessages []*ReceivedMessage
 
 	for _, msg := range result.Messages {
-		receivedMessages = append(receivedMessages, newReceivedMessage(msg))
+		receivedMessages = append(receivedMessages, newReceivedMessage(msg, linksWithID.Receiver.LinkName()))
 	}
 
 	return receivedMessages, nil