[azservicebus] Final API changes for beta.3

sdk/messaging/azservicebus/CHANGELOG.md

@@ -1,13 +1,27 @@
 # Release History
 
-## 0.2.1 (Unreleased)
+## 0.3.0 (Unreleased)
 
 ### Features Added
 
+- AbandonMessage and DeferMessage now take an additional `PropertiesToModify` option, allowing
+  the message properties to be modified when they are settled.
+
 ### Breaking Changes
 
+- ReceivedMessage.Body is now a function that returns a ([]byte, error), rather than being a field.
+  This protects against a potential data-loss scenario where a message is received with a payload 
+  encoded in the sequence or value sections of an AMQP message, which cannot be prpoerly represented
+  in the .Body. This will now return an error.
+- Functions that have options or might have options in the future have an additional *options parameter.
+  As usual, passing 'nil' ignores the options, and will cause the function to use defaults.
+- MessageBatch.Add() has been renamed to MessageBatch.AddMessage(). AddMessage() now returns only an `error`, 
+  with a sentinel error (ErrMessageTooLarge) signaling that the batch cannot fit a new message.
+- Sender.SendMessages() has been removed in favor of simplifications made in MessageBatch.
+
 ### Bugs Fixed
 
+
 ### Other Changes
 
 ## 0.2.0 (2021-11-02)

sdk/messaging/azservicebus/README.md

@@ -46,7 +46,7 @@ func main() {
   client, err := azservicebus.NewClientFromConnectionString("<Service Bus connection string>")
 
   if err != nil {
-    log.Fatalf("Failed to create Service Bus Client: %s", err.Error())
+    panic(err)
   }
 }
 ```
@@ -66,13 +66,13 @@ func main() {
   cred, err := azidentity.NewDefaultAzureCredential(nil)
 
   if err != nil {
-    log.Fatalf("Failed creating DefaultAzureCredential: %s", err.Error())
+    panic(err)
   }
 
   client, err := azservicebus.NewClient("<ex: my-service-bus.servicebus.windows.net>", cred)
 
   if err != nil {
-    log.Fatalf("Failed to create Service Bus Client: %s", err.Error())
+    panic(err)
   }
 }
 ```
@@ -112,7 +112,7 @@ NOTE: Creating a `client` is covered in the ["Authenticate the client"](#authent
 sender, err := client.NewSender("<queue or topic>")
 
 if err != nil {
-  log.Fatalf("Failed to create Sender: %s", err.Error())
+  panic(err)
 }
 
 // send a single message
@@ -129,29 +129,23 @@ You can also send messages in batches, which can be more efficient than sending
 messageBatch, err := sender.NewMessageBatch(context.TODO())
 
 if err != nil {
-  log.Fatalf("Failed to create a message batch: %s", err.Error())
+  panic(err)
 }
 
-// Add a message using TryAdd.
-// This can be called multiple times, and will return (false, nil)
-// if the message cannot be added because the batch is full.
-added, err := messageBatch.TryAdd(&azservicebus.Message{
+// Add a message to our message batch. This can be called multiple times.
+err := messageBatch.Add(&azservicebus.Message{
     Body: []byte(fmt.Sprintf("hello world")),
 })
 
-if err != nil {
-  log.Fatalf("Failed to add message to batch because of an error: %s", err.Error())
-}
+if err == azservicebus.ErrMessageTooLarge {
+  fmt.Printf("Message batch is full. We should send it and create a new one.\n")
 
-if !added {
-  log.Printf("Message batch is full. We should send it and create a new one.")
+  // send what we have since the batch is full
   err := sender.SendMessageBatch(context.TODO(), messageBatch)
-
-  if err != nil {
-    log.Fatalf("Failed to send message batch: %s", err.Error())
-  }
-
-  // add the next message to a new batch and start again.
+
+  // Create a new batch, add this message and start again.
+} else if err != nil {
+  panic(err)
 }
 ```
 
@@ -172,7 +166,7 @@ receiver, err := client.NewReceiverForQueue(
 // client.NewReceiverForSubscription("<topic>", "<subscription>")
 
 if err != nil {
-  log.Fatalf("Failed to create the receiver: %s", err.Error())
+  panic(err)
 }
 
 // Receive a fixed set of messages. Note that the number of messages

sdk/messaging/azservicebus/admin/admin_client.go

@@ -0,0 +1,92 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package admin
+
+import (
+	"context"
+	"net/http"
+	"time"
+
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
+	"github.com/Azure/azure-sdk-for-go/sdk/messaging/azservicebus/internal"
+	"github.com/Azure/azure-sdk-for-go/sdk/messaging/azservicebus/internal/atom"
+)
+
+// Client allows you to administer resources in a Service Bus Namespace.
+// For example, you can create queues, enabling capabilities like partitioning, duplicate detection, etc..
+// NOTE: For sending and receiving messages you'll need to use the `Client` type instead.
+type Client struct {
+	em atom.EntityManager
+}
+
+type ClientOptions struct {
+	// for future expansion
+}
+
+// NewClientFromConnectionString creates an Client authenticating using a connection string.
+func NewClientFromConnectionString(connectionString string, options *ClientOptions) (*Client, error) {
+	em, err := atom.NewEntityManagerWithConnectionString(connectionString, internal.Version)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return &Client{em: em}, nil
+}
+
+// NewClient creates an Client authenticating using a TokenCredential.
+func NewClient(fullyQualifiedNamespace string, tokenCredential azcore.TokenCredential, options *ClientOptions) (*Client, error) {
+	em, err := atom.NewEntityManager(fullyQualifiedNamespace, tokenCredential, internal.Version)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return &Client{em: em}, nil
+}
+
+type NamespaceProperties struct {
+	CreatedTime  time.Time
+	ModifiedTime time.Time
+
+	SKU            string
+	MessagingUnits *int64
+	Name           string
+}
+
+type GetNamespacePropertiesResult struct {
+	NamespaceProperties
+}
+
+type GetNamespacePropertiesResponse struct {
+	GetNamespacePropertiesResult
+	RawResult *http.Response
+}
+
+type GetNamespacePropertiesOptions struct {
+	// For future expansion
+}
+
+// GetNamespaceProperties gets the properties for the namespace, includings properties like SKU and CreatedTime.
+func (ac *Client) GetNamespaceProperties(ctx context.Context, options *GetNamespacePropertiesOptions) (*GetNamespacePropertiesResponse, error) {
+	var body *atom.NamespaceEntry
+	resp, err := ac.em.Get(ctx, "/$namespaceinfo", &body)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return &GetNamespacePropertiesResponse{
+		RawResult: resp,
+		GetNamespacePropertiesResult: GetNamespacePropertiesResult{
+			NamespaceProperties: NamespaceProperties{
+				Name:           body.NamespaceInfo.Name,
+				CreatedTime:    body.NamespaceInfo.CreatedTime,
+				ModifiedTime:   body.NamespaceInfo.ModifiedTime,
+				SKU:            body.NamespaceInfo.MessagingSKU,
+				MessagingUnits: body.NamespaceInfo.MessagingUnits,
+			},
+		},
+	}, nil
+}

sdk/messaging/azservicebus/admin/admin_client_models.go

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package admin
+
+// EntityStatus represents the current status of the entity.
+type EntityStatus string
+
+const (
+	// EntityStatusActive indicates an entity can be used for sending and receiving.
+	EntityStatusActive EntityStatus = "Active"
+	// EntityStatusDisabled indicates an entity cannot be used for sending or receiving.
+	EntityStatusDisabled EntityStatus = "Disabled"
+	// EntityStatusSendDisabled indicates that an entity cannot be used for sending.
+	EntityStatusSendDisabled EntityStatus = "SendDisabled"
+	// EntityStatusReceiveDisabled indicates that an entity cannot be used for receiving.
+	EntityStatusReceiveDisabled EntityStatus = "ReceiveDisabled"
+)