Adding a new error code so users can handle the "entity not found" error (Azure#24501)

Adding a new error code so users can handle the "entity not found" error.

Fixes Azure#24499

Author: richardpark-msft

sdk/messaging/azservicebus/CHANGELOG.md

@@ -1,14 +1,10 @@
 # Release History
 
-## 1.8.2-beta.1 (Unreleased)
+## 1.9.0 (2025-05-06)
 
 ### Features Added
 
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
+- Added a new azservicebus.Code value, `CodeNotFound`, which indicates the queue, topic or subscription doesn't exist. (PR#24501)
 
 ## 1.8.1 (2025-04-08)
 

sdk/messaging/azservicebus/client_test.go

@@ -6,6 +6,7 @@ package azservicebus
 import (
 	"context"
 	"io"
+
 	"net"
 	"net/http"
 	"strings"
@@ -159,7 +160,9 @@ func TestNewClientNewSenderNotFound(t *testing.T) {
 	defer cancel()
 
 	err = sender.SendMessage(ctx, &Message{Body: []byte("hello")}, nil)
-	assertRPCNotFound(t, err)
+	var sbErr *Error
+	require.ErrorAs(t, err, &sbErr)
+	require.Equal(t, CodeNotFound, sbErr.Code)
 }
 
 func TestNewClientNewReceiverNotFound(t *testing.T) {
@@ -175,7 +178,9 @@ func TestNewClientNewReceiverNotFound(t *testing.T) {
 
 	messages, err := receiver.ReceiveMessages(ctx, 1, nil)
 	require.Nil(t, messages)
-	assertRPCNotFound(t, err)
+	var sbErr *Error
+	require.ErrorAs(t, err, &sbErr)
+	require.Equal(t, CodeNotFound, sbErr.Code)
 
 	receiver, err = client.NewReceiverForSubscription("non-existent-topic", "non-existent-subscription", nil)
 	require.NoError(t, err)
@@ -185,7 +190,9 @@ func TestNewClientNewReceiverNotFound(t *testing.T) {
 
 	messages, err = receiver.PeekMessages(ctx, 1, nil)
 	require.Nil(t, messages)
-	assertRPCNotFound(t, err)
+	sbErr = nil
+	require.ErrorAs(t, err, &sbErr)
+	require.Equal(t, CodeNotFound, sbErr.Code)
 }
 
 func TestClientNewSessionReceiverNotFound(t *testing.T) {
@@ -198,14 +205,18 @@ func TestClientNewSessionReceiverNotFound(t *testing.T) {
 
 	receiver, err := client.AcceptSessionForQueue(ctx, "non-existent-queue", "session-id", nil)
 	require.Nil(t, receiver)
-	assertRPCNotFound(t, err)
+	var sbErr *Error
+	require.ErrorAs(t, err, &sbErr)
+	require.Equal(t, CodeNotFound, sbErr.Code)
 
 	ctx, cancel = context.WithTimeout(context.Background(), fastNotFoundDuration)
 	defer cancel()
 
 	receiver, err = client.AcceptNextSessionForQueue(ctx, "non-existent-queue", nil)
 	require.Nil(t, receiver)
-	assertRPCNotFound(t, err)
+	sbErr = nil
+	require.ErrorAs(t, err, &sbErr)
+	require.Equal(t, CodeNotFound, sbErr.Code)
 }
 
 func TestClientCloseVsClosePermanently(t *testing.T) {
@@ -555,18 +566,6 @@ func TestNewClientUnitTests(t *testing.T) {
 	})
 }
 
-func assertRPCNotFound(t *testing.T, err error) {
-	require.NotNil(t, err)
-
-	var rpcError interface {
-		RPCCode() int
-		error
-	}
-
-	require.ErrorAs(t, err, &rpcError)
-	require.Equal(t, http.StatusNotFound, rpcError.RPCCode())
-}
-
 func forceManagementSettlement(messages []*ReceivedMessage) {
 	for _, m := range messages {
 		m.settleOnMgmtLink = true

sdk/messaging/azservicebus/error.go

@@ -31,6 +31,9 @@ const (
 	// any available sessions it will eventually time out and return an *azservicebus.Error
 	// with this code.
 	CodeTimeout = exported.CodeTimeout
+
+	// CodeNotFound means the entity you're attempting to connect to doesn't exist.
+	CodeNotFound = exported.CodeNotFound
 )
 
 // Error represents a Service Bus specific error.

sdk/messaging/azservicebus/internal/constants.go

@@ -4,4 +4,4 @@
 package internal
 
 // Version is the semantic version number
-const Version = "v1.8.2-beta.1"
+const Version = "v1.9.0"

sdk/messaging/azservicebus/internal/errors.go

@@ -78,8 +78,13 @@ func TransformError(err error) error {
 
 	var rpcErr RPCError
 
-	if errors.As(err, &rpcErr) && rpcErr.Resp.Code == http.StatusUnauthorized {
-		return exported.NewError(exported.CodeUnauthorizedAccess, err)
+	if errors.As(err, &rpcErr) {
+		switch rpcErr.Resp.Code {
+		case http.StatusUnauthorized:
+			return exported.NewError(exported.CodeUnauthorizedAccess, err)
+		case http.StatusNotFound:
+			return exported.NewError(exported.CodeNotFound, err)
+		}
 	}
 
 	rk := GetRecoveryKind(err)

sdk/messaging/azservicebus/internal/errors_test.go

@@ -260,7 +260,8 @@ func Test_TransformError(t *testing.T) {
 
 	// sanity check, an RPCError but it's not a azservicebus.Code type error.
 	err = TransformError(RPCError{Resp: &amqpwrap.RPCResponse{Code: http.StatusNotFound}})
-	require.False(t, errors.As(err, &asExportedErr))
+	require.ErrorAs(t, err, &asExportedErr)
+	require.Equal(t, exported.CodeNotFound, asExportedErr.Code)
 
 	err = TransformError(&amqp.Error{Condition: amqp.ErrCond("com.microsoft:message-lock-lost")})
 	require.ErrorAs(t, err, &asExportedErr)

sdk/messaging/azservicebus/internal/exported/error.go

@@ -29,6 +29,9 @@ const (
 	// any available sessions it will eventually time out and return an *azservicebus.Error
 	// with this code.
 	CodeTimeout Code = "timeout"
+
+	// CodeNotFound means the entity you're attempting to connect to doesn't exist.
+	CodeNotFound Code = "notfound"
 )
 
 // Error represents a Service Bus specific error.