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

package/dist-esm/{src → storage-queue/src}/QueueClient.js

@@ -1,19 +1,25 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-import { isTokenCredential, isNode, getDefaultProxySettings, URLBuilder, } from "@azure/core-http";
-import { SpanStatusCode } from "@azure/core-tracing";
-import { Messages, MessageId, Queue } from "./generated/src/operations";
-import { newPipeline, Pipeline } from "./Pipeline";
-import { StorageClient } from "./StorageClient";
-import { appendToURLPath, extractConnectionStringParts, isIpEndpointStyle, truncatedISO8061Date, getStorageClientContext, appendToURLQuery, } from "./utils/utils.common";
-import { StorageSharedKeyCredential } from "./credentials/StorageSharedKeyCredential";
-import { AnonymousCredential } from "./credentials/AnonymousCredential";
-import { createSpan } from "./utils/tracing";
+import { isTokenCredential } from "@azure/core-auth";
+import { isNode } from "@azure/core-util";
+import { newPipeline, Pipeline } from "../../storage-blob/src/Pipeline";
+import { StorageClient, getStorageClientContext } from "./StorageClient";
+import { appendToURLPath, extractConnectionStringParts, isIpEndpointStyle, truncatedISO8061Date, appendToURLQuery, assertResponse, } from "./utils/utils.common";
+import { StorageSharedKeyCredential } from "../../storage-blob/src/credentials/StorageSharedKeyCredential";
+import { AnonymousCredential } from "../../storage-blob/src/credentials/AnonymousCredential";
+import { tracingClient } from "./utils/tracing";
 import { generateQueueSASQueryParameters } from "./QueueSASSignatureValues";
+import { getDefaultProxySettings } from "@azure/core-rest-pipeline";
 /**
  * A QueueClient represents a URL to an Azure Storage Queue's messages allowing you to manipulate its messages.
  */
 export class QueueClient extends StorageClient {
+    /**
+     * The name of the queue.
+     */
+    get name() {
+        return this._name;
+    }
     constructor(urlOrConnectionString, credentialOrPipelineOrQueueName, 
     // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
     /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
@@ -36,7 +42,7 @@ export class QueueClient extends StorageClient {
         else if (!credentialOrPipelineOrQueueName &&
             typeof credentialOrPipelineOrQueueName !== "string") {
             // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
-            // The second paramter is undefined. Use anonymous credential.
+            // The second parameter is undefined. Use anonymous credential.
             url = urlOrConnectionString;
             pipeline = newPipeline(new AnonymousCredential(), options);
         }
@@ -72,20 +78,14 @@ export class QueueClient extends StorageClient {
         }
         super(url, pipeline);
         this._name = this.getQueueNameFromUrl();
-        this.queueContext = new Queue(this.storageClientContext);
+        this.queueContext = this.storageClientContext.queue;
         // MessagesContext
         // Build the url with "messages"
         const partsOfUrl = this.url.split("?");
         this._messagesUrl = partsOfUrl[1]
             ? appendToURLPath(partsOfUrl[0], "messages") + "?" + partsOfUrl[1]
             : appendToURLPath(partsOfUrl[0], "messages");
-        this.messagesContext = new Messages(getStorageClientContext(this._messagesUrl, this.pipeline));
-    }
-    /**
-     * The name of the queue.
-     */
-    get name() {
-        return this._name;
+        this.messagesContext = getStorageClientContext(this._messagesUrl, this.pipeline).messages;
     }
     getMessageIdContext(messageId) {
         // Build the url with messageId
@@ -93,7 +93,7 @@ export class QueueClient extends StorageClient {
         const urlWithMessageId = partsOfUrl[1]
             ? appendToURLPath(partsOfUrl[0], messageId) + "?" + partsOfUrl[1]
             : appendToURLPath(partsOfUrl[0], messageId);
-        return new MessageId(getStorageClientContext(urlWithMessageId, this.pipeline));
+        return getStorageClientContext(urlWithMessageId, this.pipeline).messageId;
     }
     /**
      * Creates a new queue under the specified account.
@@ -110,20 +110,9 @@ export class QueueClient extends StorageClient {
      * ```
      */
     async create(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-create", options);
-        try {
-            return await this.queueContext.create(Object.assign(Object.assign({}, updatedOptions), { abortSignal: options.abortSignal }));
-        }
-        catch (e) {
-            span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("QueueClient-create", options, async (updatedOptions) => {
+            return assertResponse(await this.queueContext.create(updatedOptions));
+        });
     }
     /**
      * Creates a new queue under the specified account if it doesn't already exist.
@@ -133,35 +122,25 @@ export 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: 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: SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Deletes the specified queue permanently if it exists.
@@ -170,29 +149,19 @@ export 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: 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: 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.
@@ -211,23 +180,12 @@ export class QueueClient extends StorageClient {
      * ```
      */
     async delete(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-delete", options);
-        try {
-            return await this.queueContext.delete({
+        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: SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+            }));
+        });
     }
     /**
      * Returns true if the specified queue exists; false otherwise.
@@ -239,31 +197,18 @@ export 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: 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: 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
@@ -279,23 +224,9 @@ export 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 await this.queueContext.getProperties({
-                abortSignal: options.abortSignal,
-                tracingOptions: updatedOptions.tracingOptions,
-            });
-        }
-        catch (e) {
-            span.setStatus({
-                code: 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.
@@ -309,24 +240,9 @@ export 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 await this.queueContext.setMetadata({
-                abortSignal: options.abortSignal,
-                metadata,
-                tracingOptions: updatedOptions.tracingOptions,
-            });
-        }
-        catch (e) {
-            span.setStatus({
-                code: 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.
@@ -340,12 +256,11 @@ export 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 {
-            const response = await this.queueContext.getAccessPolicy({
+        return tracingClient.withSpan("QueueClient-getAccessPolicy", options, async (updatedOptions) => {
+            const response = assertResponse(await this.queueContext.getAccessPolicy({
                 abortSignal: options.abortSignal,
                 tracingOptions: updatedOptions.tracingOptions,
-            });
+            }));
             const res = {
                 _response: response._response,
                 date: response.date,
@@ -374,17 +289,7 @@ export class QueueClient extends StorageClient {
                 });
             }
             return res;
-        }
-        catch (e) {
-            span.setStatus({
-                code: 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.
@@ -395,8 +300,7 @@ export 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({
@@ -412,22 +316,8 @@ export class QueueClient extends StorageClient {
                     id: identifier.id,
                 });
             }
-            return await this.queueContext.setAccessPolicy({
-                abortSignal: options.abortSignal,
-                queueAcl: acl,
-                tracingOptions: updatedOptions.tracingOptions,
-            });
-        }
-        catch (e) {
-            span.setStatus({
-                code: 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.
@@ -437,23 +327,9 @@ export class QueueClient extends StorageClient {
      * @returns Response data for the clear messages operation.
      */
     async clearMessages(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-clearMessages", options);
-        try {
-            return await this.messagesContext.clear({
-                abortSignal: options.abortSignal,
-                tracingOptions: updatedOptions.tracingOptions,
-            });
-        }
-        catch (e) {
-            span.setStatus({
-                code: 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
@@ -477,11 +353,10 @@ export class QueueClient extends StorageClient {
      * ```
      */
     async sendMessage(messageText, options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-sendMessage", options);
-        try {
-            const response = await this.messagesContext.enqueue({
+        return tracingClient.withSpan("QueueClient-sendMessage", options, async (updatedOptions) => {
+            const response = assertResponse(await this.messagesContext.enqueue({
                 messageText: messageText,
-            }, updatedOptions);
+            }, updatedOptions));
             const item = response[0];
             return {
                 _response: response._response,
@@ -496,17 +371,7 @@ export class QueueClient extends StorageClient {
                 insertedOn: item.insertedOn,
                 expiresOn: item.expiresOn,
             };
-        }
-        catch (e) {
-            span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * receiveMessages retrieves one or more messages from the front of the queue.
@@ -534,9 +399,8 @@ export class QueueClient extends StorageClient {
      * ```
      */
     async receiveMessages(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-receiveMessages", options);
-        try {
-            const response = await this.messagesContext.dequeue(updatedOptions);
+        return tracingClient.withSpan("QueueClient-receiveMessages", options, async (updatedOptions) => {
+            const response = assertResponse(await this.messagesContext.dequeue(updatedOptions));
             const res = {
                 _response: response._response,
                 date: response.date,
@@ -550,17 +414,7 @@ export class QueueClient extends StorageClient {
                 res.receivedMessageItems.push(item);
             }
             return res;
-        }
-        catch (e) {
-            span.setStatus({
-                code: 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.
@@ -577,9 +431,8 @@ export class QueueClient extends StorageClient {
      * ```
      */
     async peekMessages(options = {}) {
-        const { span, updatedOptions } = createSpan("QueueClient-peekMessages", options);
-        try {
-            const response = await this.messagesContext.peek(updatedOptions);
+        return tracingClient.withSpan("QueueClient-peekMessages", options, async (updatedOptions) => {
+            const response = assertResponse(await this.messagesContext.peek(updatedOptions));
             const res = {
                 _response: response._response,
                 date: response.date,
@@ -593,17 +446,7 @@ export class QueueClient extends StorageClient {
                 res.peekedMessageItems.push(item);
             }
             return res;
-        }
-        catch (e) {
-            span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * deleteMessage permanently removes the specified message from its queue.
@@ -615,23 +458,9 @@ export 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 await this.getMessageIdContext(messageId).delete(popReceipt, {
-                abortSignal: options.abortSignal,
-                tracingOptions: updatedOptions.tracingOptions,
-            });
-        }
-        catch (e) {
-            span.setStatus({
-                code: 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.
@@ -651,28 +480,17 @@ export 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 await this.getMessageIdContext(messageId).update(popReceipt, visibilityTimeout || 0, {
+        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: SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+            }));
+        });
     }
     getQueueNameFromUrl() {
         let queueName;
@@ -682,22 +500,22 @@ export class QueueClient extends StorageClient {
             // "https://myaccount.queue.core.windows.net/myqueue".
             // IPv4/IPv6 address hosts, Endpoints - `http://127.0.0.1:10001/devstoreaccount1/myqueue`
             // http://localhost:10001/devstoreaccount1/queuename
-            const parsedUrl = URLBuilder.parse(this.url);
-            if (parsedUrl.getHost().split(".")[1] === "queue") {
+            const parsedUrl = new URL(this.url);
+            if (parsedUrl.hostname.split(".")[1] === "queue") {
                 // "https://myaccount.queue.core.windows.net/queuename".
                 // .getPath() -> /queuename
-                queueName = parsedUrl.getPath().split("/")[1];
+                queueName = parsedUrl.pathname.split("/")[1];
             }
             else if (isIpEndpointStyle(parsedUrl)) {
                 // IPv4/IPv6 address hosts... Example - http://192.0.0.10:10001/devstoreaccount1/queuename
                 // Single word domain without a [dot] in the endpoint... Example - http://localhost:10001/devstoreaccount1/queuename
                 // .getPath() -> /devstoreaccount1/queuename
-                queueName = parsedUrl.getPath().split("/")[2];
+                queueName = parsedUrl.pathname.split("/")[2];
             }
             else {
                 // "https://customdomain.com/queuename".
                 // .getPath() -> /queuename
-                queueName = parsedUrl.getPath().split("/")[1];
+                queueName = parsedUrl.pathname.split("/")[1];
             }
             if (!queueName) {
                 throw new Error("Provided queueName is invalid.");