@azure/storage-queue 12.20.0-alpha.20230615.1 → 12.20.0-alpha.20230616.2

package/dist/index.js

@@ -330,6 +330,8 @@ function ipRangeToString(ipRange) {
 }
 
 // Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const SDK_VERSION$1 = "12.20.0";
 const SERVICE_VERSION = "2021-10-04";
 const DevelopmentConnectionString = `DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;
   AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;
@@ -5040,8 +5042,9 @@ function getStorageClientContext(url, pipeline) {
  * Creates a span using the global tracer.
  * @internal
  */
-const createSpan = coreTracing.createSpanFunction({
-    packagePrefix: "Azure.Storage.Queue",
+const tracingClient = coreTracing.createTracingClient({
+    packageName: "@azure/storage-queue",
+    packageVersion: SDK_VERSION$1,
     namespace: "Microsoft.Storage",
 });
 
@@ -5280,20 +5283,9 @@ class QueueClient extends StorageClient {
      * ```
      */
     async create(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-create", options);
-        try {
+        return tracingClient.withSpan("QueueClient-create", options, async (updatedOptions) => {
             return assertResponse(await this.queueContext.create(updatedOptions));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Creates a new queue under the specified account if it doesn't already exist.
@@ -5303,35 +5295,25 @@ class QueueClient extends StorageClient {
      * @param options -
      */
     async createIfNotExists(options = {}) {
-        var _a, _b;
-        const { span, updatedOptions } = createSpan("QueueClient-createIfNotExists", options);
-        try {
-            const response = await this.create(updatedOptions);
-            // When a queue with the specified name already exists, the Queue service checks the metadata associated with the existing queue.
-            // If the existing metadata is identical to the metadata specified on the Create Queue request, status code 204 (No Content) is returned.
-            // If the existing metadata does not match, the operation fails and status code 409 (Conflict) is returned.
-            if (response._response.status === 204) {
-                return Object.assign({ succeeded: false }, response);
+        return tracingClient.withSpan("QueueClient-createIfNotExists", options, async (updatedOptions) => {
+            var _a, _b;
+            try {
+                const response = await this.create(updatedOptions);
+                // When a queue with the specified name already exists, the Queue service checks the metadata associated with the existing queue.
+                // If the existing metadata is identical to the metadata specified on the Create Queue request, status code 204 (No Content) is returned.
+                // If the existing metadata does not match, the operation fails and status code 409 (Conflict) is returned.
+                if (response._response.status === 204) {
+                    return Object.assign({ succeeded: false }, response);
+                }
+                return Object.assign({ succeeded: true }, response);
             }
-            return Object.assign({ succeeded: true }, response);
-        }
-        catch (e) {
-            if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "QueueAlreadyExists") {
-                span.setStatus({
-                    code: coreTracing.SpanStatusCode.ERROR,
-                    message: "Expected exception when creating a queue only if it does not already exist.",
-                });
-                return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+            catch (e) {
+                if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "QueueAlreadyExists") {
+                    return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+                }
+                throw e;
             }
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Deletes the specified queue permanently if it exists.
@@ -5340,29 +5322,19 @@ class QueueClient extends StorageClient {
      * @param options -
      */
     async deleteIfExists(options = {}) {
-        var _a, _b;
-        const { span, updatedOptions } = createSpan("QueueClient-deleteIfExists", options);
-        try {
-            const res = await this.delete(updatedOptions);
-            return Object.assign({ succeeded: true }, res);
-        }
-        catch (e) {
-            if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "QueueNotFound") {
-                span.setStatus({
-                    code: coreTracing.SpanStatusCode.ERROR,
-                    message: "Expected exception when deleting a queue only if it exists.",
-                });
-                return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+        return tracingClient.withSpan("QueueClient-deleteIfExists", options, async (updatedOptions) => {
+            var _a, _b;
+            try {
+                const res = await this.delete(updatedOptions);
+                return Object.assign({ succeeded: true }, res);
             }
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+            catch (e) {
+                if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "QueueNotFound") {
+                    return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+                }
+                throw e;
+            }
+        });
     }
     /**
      * Deletes the specified queue permanently.
@@ -5381,23 +5353,12 @@ class QueueClient extends StorageClient {
      * ```
      */
     async delete(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-delete", options);
-        try {
+        return tracingClient.withSpan("QueueClient-delete", options, async (updatedOptions) => {
             return assertResponse(await this.queueContext.delete({
                 abortSignal: options.abortSignal,
                 tracingOptions: updatedOptions.tracingOptions,
             }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Returns true if the specified queue exists; false otherwise.
@@ -5409,31 +5370,18 @@ class QueueClient extends StorageClient {
      * @param options - options to Exists operation.
      */
     async exists(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-exists", options);
-        try {
-            await this.getProperties({
-                abortSignal: options.abortSignal,
-                tracingOptions: updatedOptions.tracingOptions,
-            });
-            return true;
-        }
-        catch (e) {
-            if (e.statusCode === 404) {
-                span.setStatus({
-                    code: coreTracing.SpanStatusCode.ERROR,
-                    message: "Expected exception when checking queue existence",
-                });
-                return false;
+        return tracingClient.withSpan("QueueClient-exists", options, async (updatedOptions) => {
+            try {
+                await this.getProperties(updatedOptions);
+                return true;
             }
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+            catch (e) {
+                if (e.statusCode === 404) {
+                    return false;
+                }
+                throw e;
+            }
+        });
     }
     /**
      * Gets all user-defined metadata and system properties for the specified
@@ -5449,23 +5397,9 @@ class QueueClient extends StorageClient {
      * @returns Response data for the Queue get properties operation.
      */
     async getProperties(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-getProperties", options);
-        try {
-            return assertResponse(await this.queueContext.getProperties({
-                abortSignal: options.abortSignal,
-                tracingOptions: updatedOptions.tracingOptions,
-            }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueClient-getProperties", options, async (updatedOptions) => {
+            return assertResponse(await this.queueContext.getProperties(updatedOptions));
+        });
     }
     /**
      * Sets one or more user-defined name-value pairs for the specified queue.
@@ -5479,24 +5413,9 @@ class QueueClient extends StorageClient {
      * @returns Response data for the Queue set metadata operation.
      */
     async setMetadata(metadata, options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-setMetadata", options);
-        try {
-            return assertResponse(await this.queueContext.setMetadata({
-                abortSignal: options.abortSignal,
-                metadata,
-                tracingOptions: updatedOptions.tracingOptions,
-            }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueClient-setMetadata", options, async (updatedOptions) => {
+            return assertResponse(await this.queueContext.setMetadata(Object.assign(Object.assign({}, updatedOptions), { metadata })));
+        });
     }
     /**
      * Gets details about any stored access policies specified on the queue that may be used with Shared Access Signatures.
@@ -5510,8 +5429,7 @@ class QueueClient extends StorageClient {
      * @returns Response data for the Queue get access policy operation.
      */
     async getAccessPolicy(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-getAccessPolicy", options);
-        try {
+        return tracingClient.withSpan("QueueClient-getAccessPolicy", options, async (updatedOptions) => {
             const response = assertResponse(await this.queueContext.getAccessPolicy({
                 abortSignal: options.abortSignal,
                 tracingOptions: updatedOptions.tracingOptions,
@@ -5544,17 +5462,7 @@ class QueueClient extends StorageClient {
                 });
             }
             return res;
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Sets stored access policies for the queue that may be used with Shared Access Signatures.
@@ -5565,8 +5473,7 @@ class QueueClient extends StorageClient {
      * @returns Response data for the Queue set access policy operation.
      */
     async setAccessPolicy(queueAcl, options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-setAccessPolicy", options);
-        try {
+        return tracingClient.withSpan("QueueClient-setAccessPolicy", options, async (updatedOptions) => {
             const acl = [];
             for (const identifier of queueAcl || []) {
                 acl.push({
@@ -5582,22 +5489,8 @@ class QueueClient extends StorageClient {
                     id: identifier.id,
                 });
             }
-            return assertResponse(await this.queueContext.setAccessPolicy({
-                abortSignal: options.abortSignal,
-                queueAcl: acl,
-                tracingOptions: updatedOptions.tracingOptions,
-            }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+            return assertResponse(await this.queueContext.setAccessPolicy(Object.assign(Object.assign({}, updatedOptions), { queueAcl: acl })));
+        });
     }
     /**
      * Clear deletes all messages from a queue.
@@ -5607,23 +5500,9 @@ class QueueClient extends StorageClient {
      * @returns Response data for the clear messages operation.
      */
     async clearMessages(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-clearMessages", options);
-        try {
-            return assertResponse(await this.messagesContext.clear({
-                abortSignal: options.abortSignal,
-                tracingOptions: updatedOptions.tracingOptions,
-            }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueClient-clearMessages", options, async (updatedOptions) => {
+            return assertResponse(await this.messagesContext.clear(updatedOptions));
+        });
     }
     /**
      * sendMessage adds a new message to the back of a queue. The visibility timeout specifies how long
@@ -5647,8 +5526,7 @@ class QueueClient extends StorageClient {
      * ```
      */
     async sendMessage(messageText, options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-sendMessage", options);
-        try {
+        return tracingClient.withSpan("QueueClient-sendMessage", options, async (updatedOptions) => {
             const response = assertResponse(await this.messagesContext.enqueue({
                 messageText: messageText,
             }, updatedOptions));
@@ -5666,17 +5544,7 @@ class QueueClient extends StorageClient {
                 insertedOn: item.insertedOn,
                 expiresOn: item.expiresOn,
             };
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * receiveMessages retrieves one or more messages from the front of the queue.
@@ -5704,8 +5572,7 @@ class QueueClient extends StorageClient {
      * ```
      */
     async receiveMessages(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-receiveMessages", options);
-        try {
+        return tracingClient.withSpan("QueueClient-receiveMessages", options, async (updatedOptions) => {
             const response = assertResponse(await this.messagesContext.dequeue(updatedOptions));
             const res = {
                 _response: response._response,
@@ -5720,17 +5587,7 @@ class QueueClient extends StorageClient {
                 res.receivedMessageItems.push(item);
             }
             return res;
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * peekMessages retrieves one or more messages from the front of the queue but does not alter the visibility of the message.
@@ -5747,8 +5604,7 @@ class QueueClient extends StorageClient {
      * ```
      */
     async peekMessages(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-peekMessages", options);
-        try {
+        return tracingClient.withSpan("QueueClient-peekMessages", options, async (updatedOptions) => {
             const response = assertResponse(await this.messagesContext.peek(updatedOptions));
             const res = {
                 _response: response._response,
@@ -5763,17 +5619,7 @@ class QueueClient extends StorageClient {
                 res.peekedMessageItems.push(item);
             }
             return res;
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * deleteMessage permanently removes the specified message from its queue.
@@ -5785,23 +5631,9 @@ class QueueClient extends StorageClient {
      * @returns Response data for the delete message operation.
      */
     async deleteMessage(messageId, popReceipt, options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-deleteMessage", options);
-        try {
-            return assertResponse(await this.getMessageIdContext(messageId).delete(popReceipt, {
-                abortSignal: options.abortSignal,
-                tracingOptions: updatedOptions.tracingOptions,
-            }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueClient-deleteMessage", options, async (updatedOptions) => {
+            return assertResponse(await this.getMessageIdContext(messageId).delete(popReceipt, updatedOptions));
+        });
     }
     /**
      * Update changes a message's visibility timeout and contents.
@@ -5821,28 +5653,17 @@ class QueueClient extends StorageClient {
      * @returns Response data for the update message operation.
      */
     async updateMessage(messageId, popReceipt, message, visibilityTimeout, options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-updateMessage", options);
-        let queueMessage = undefined;
-        if (message !== undefined) {
-            queueMessage = { messageText: message };
-        }
-        try {
+        return tracingClient.withSpan("QueueClient-updateMessage", options, async (updatedOptions) => {
+            let queueMessage = undefined;
+            if (message !== undefined) {
+                queueMessage = { messageText: message };
+            }
             return assertResponse(await this.getMessageIdContext(messageId).update(popReceipt, visibilityTimeout || 0, {
                 abortSignal: options.abortSignal,
                 tracingOptions: updatedOptions.tracingOptions,
                 queueMessage,
             }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     getQueueNameFromUrl() {
         let queueName;
@@ -5994,30 +5815,12 @@ class QueueServiceClient extends StorageClient {
      * @returns Response data for the list queues segment operation.
      */
     async listQueuesSegment(marker, options = {}) {
-        const { span, updatedOptions } = createSpan("QueueServiceClient-listQueuesSegment", options);
         if (options.prefix === "") {
             options.prefix = undefined;
         }
-        try {
-            return assertResponse(await this.serviceContext.listQueuesSegment({
-                abortSignal: options.abortSignal,
-                marker: marker,
-                maxPageSize: options.maxPageSize,
-                prefix: options.prefix,
-                include: options.include === undefined ? undefined : [options.include],
-                tracingOptions: updatedOptions.tracingOptions,
-            }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueServiceClient-listQueuesSegment", options, async (updatedOptions) => {
+            return assertResponse(await this.serviceContext.listQueuesSegment(Object.assign(Object.assign({}, updatedOptions), { marker, include: options.include === undefined ? undefined : [options.include] })));
+        });
     }
     /**
      * Returns an AsyncIterableIterator for {@link ServiceListQueuesSegmentResponse} objects
@@ -6194,23 +5997,9 @@ class QueueServiceClient extends StorageClient {
      * @returns Response data including the queue service properties.
      */
     async getProperties(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueServiceClient-getProperties", options);
-        try {
-            return assertResponse(await this.serviceContext.getProperties({
-                abortSignal: options.abortSignal,
-                tracingOptions: updatedOptions.tracingOptions,
-            }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueServiceClient-getProperties", options, async (updatedOptions) => {
+            return assertResponse(await this.serviceContext.getProperties(updatedOptions));
+        });
     }
     /**
      * Sets properties for a storage account’s Queue service endpoint, including properties
@@ -6222,23 +6011,9 @@ class QueueServiceClient extends StorageClient {
      * @returns Response data for the Set Properties operation.
      */
     async setProperties(properties, options = {}) {
-        const { span, updatedOptions } = createSpan("QueueServiceClient-setProperties", options);
-        try {
-            return assertResponse(await this.serviceContext.setProperties(properties, {
-                abortSignal: options.abortSignal,
-                tracingOptions: updatedOptions.tracingOptions,
-            }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueServiceClient-setProperties", options, async (updatedOptions) => {
+            return assertResponse(await this.serviceContext.setProperties(properties, updatedOptions));
+        });
     }
     /**
      * Retrieves statistics related to replication for the Queue service. It is only
@@ -6250,23 +6025,9 @@ class QueueServiceClient extends StorageClient {
      * @returns Response data for get statistics the operation.
      */
     async getStatistics(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueServiceClient-getStatistics", options);
-        try {
-            return assertResponse(await this.serviceContext.getStatistics({
-                abortSignal: options.abortSignal,
-                tracingOptions: updatedOptions.tracingOptions,
-            }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueServiceClient-getStatistics", options, async (updatedOptions) => {
+            return assertResponse(await this.serviceContext.getStatistics(updatedOptions));
+        });
     }
     /**
      * Creates a new queue under the specified account.
@@ -6277,20 +6038,9 @@ class QueueServiceClient extends StorageClient {
      * @returns Response data for the Queue create operation.
      */
     async createQueue(queueName, options = {}) {
-        const { span, updatedOptions } = createSpan("QueueServiceClient-createQueue", options);
-        try {
-            return await this.getQueueClient(queueName).create(updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueServiceClient-createQueue", options, async (updatedOptions) => {
+            return this.getQueueClient(queueName).create(updatedOptions);
+        });
     }
     /**
      * Deletes the specified queue permanently.
@@ -6301,20 +6051,9 @@ class QueueServiceClient extends StorageClient {
      * @returns Response data for the Queue delete operation.
      */
     async deleteQueue(queueName, options = {}) {
-        const { span, updatedOptions } = createSpan("QueueServiceClient-deleteQueue", options);
-        try {
-            return await this.getQueueClient(queueName).delete(updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueServiceClient-deleteQueue", options, async (updatedOptions) => {
+            return this.getQueueClient(queueName).delete(updatedOptions);
+        });
     }
     /**
      * Only available for QueueServiceClient constructed with a shared key credential.