@azure/service-bus 7.10.0-beta.1 → 7.10.0-beta.3

package/dist/commonjs/core/linkEntity.d.ts

@@ -0,0 +1,192 @@
+import type { RequestResponseLink } from "@azure/core-amqp";
+import type { ConnectionContext } from "../connectionContext.js";
+import type { AwaitableSender, AwaitableSenderOptions, Receiver, ReceiverOptions, SenderOptions } from "rhea-promise";
+import type { AbortSignalLike } from "@azure/abort-controller";
+import type { ServiceBusLogger } from "../log.js";
+/**
+ * @internal
+ * Options passed to the constructor of LinkEntity
+ */
+export interface LinkEntityOptions {
+    /**
+     * The client entity address in one of the following forms:
+     */
+    address?: string;
+    /**
+     * The client entity token audience in one of the following forms:
+     */
+    audience?: string;
+}
+/**
+ * A simple grouping of the sender and receiver options. Only used
+ * with the ManagementClient today.
+ *
+ * @internal
+ */
+export interface RequestResponseLinkOptions {
+    senderOptions: SenderOptions;
+    receiverOptions: ReceiverOptions;
+    name?: string;
+}
+/**
+ * @internal
+ */
+export type NonSessionReceiverType = "batching" | "streaming";
+/**
+ * @internal
+ */
+export type ReceiverType = NonSessionReceiverType | "session";
+/**
+ * @internal
+ */
+type LinkOptionsT<LinkT extends Receiver | AwaitableSender | RequestResponseLink> = LinkT extends Receiver ? ReceiverOptions : LinkT extends AwaitableSender ? AwaitableSenderOptions : LinkT extends RequestResponseLink ? RequestResponseLinkOptions : never;
+/**
+ * @internal
+ */
+type LinkTypeT<LinkT extends Receiver | AwaitableSender | RequestResponseLink> = LinkT extends Receiver ? ReceiverType : LinkT extends AwaitableSender ? "sender" : LinkT extends RequestResponseLink ? "mgmt" : never;
+/**
+ * @internal
+ * Describes the base class for entities like MessageSender, MessageReceiver and Management client.
+ */
+export declare abstract class LinkEntity<LinkT extends Receiver | AwaitableSender | RequestResponseLink> {
+    readonly baseName: string;
+    readonly entityPath: string;
+    private _linkType;
+    private _logger;
+    /**
+     * The unique name for the entity in the format:
+     * `${name of the entity}-${guid}`.
+     */
+    name: string;
+    /**
+     * The client entity address in one of the following forms:
+     *
+     * **Sender**
+     * - `"<queue-name>"`.
+     * - `"<topic-name>"`.
+     *
+     * **Receiver**
+     * - `"<queue-name>"`.
+     * - `"<topic-name>"`.
+     *
+     * **ManagementClient**
+     * -`"$management"`.
+     */
+    address: string;
+    /**
+     * The client entity token audience in one of the following forms:
+     *
+     * **Sender**
+     * - `"sb://<yournamespace>.servicebus.windows.net/<queue-name>"`
+     * - `"sb://<yournamespace>.servicebus.windows.net/<topic-name>"`
+     *
+     * **Receiver**
+     * - `"sb://<yournamespace>.servicebus.windows.net/<queue-name>"`
+     * - `"sb://<yournamespace>.servicebus.windows.net/<topic-name>"`
+     *
+     * **ManagementClient**
+     * - `"sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management"`.
+     * - `"sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management"`.
+     */
+    audience: string;
+    /**
+     * Provides relevant information about the amqp connection,
+     * cbs and $management sessions, token provider, sender and receivers.
+     */
+    protected _context: ConnectionContext;
+    /**
+     * The token renewal timer that keeps track of when
+     * the Client Entity is due for token renewal.
+     */
+    private _tokenRenewalTimer?;
+    /**
+     * Indicates token timeout
+     */
+    protected _tokenTimeout?: number;
+    /**
+     * The actual rhea link (of type Receiver or AwaitableSender) or RequestResponseLink
+     */
+    private _link?;
+    /**
+     * The log prefix for any log messages.
+     */
+    private _logPrefix;
+    get logPrefix(): string;
+    /**
+     * Indicates that close() has been called on this link and
+     * that it should not be allowed to reopen.
+     */
+    private _wasClosedPermanently;
+    /**
+     * A lock that ensures that opening and closing this
+     * link properly cooperate.
+     */
+    private _openLock;
+    /**
+     * Creates a new ClientEntity instance.
+     * @param baseName - The base name to use for the link. A unique ID will be appended to this.
+     * @param entityPath - The entity path (ex: 'your-queue')
+     * @param context - The connection context.
+     * @param options - Options that can be provided while creating the LinkEntity.
+     */
+    constructor(baseName: string, entityPath: string, context: ConnectionContext, _linkType: LinkTypeT<LinkT>, _logger: ServiceBusLogger, options?: LinkEntityOptions);
+    /**
+     * Determines whether the AMQP link is open. If open then returns true else returns false.
+     */
+    isOpen(): boolean;
+    /**
+     * Initializes this LinkEntity, setting this._link with the result of  `createRheaLink`, which
+     * is implemented by child classes.
+     *
+     * @returns A Promise that resolves when the link has been properly initialized
+     * @throws `AbortError` if the link has been closed via 'close'
+     */
+    initLink(options: LinkOptionsT<LinkT>, abortSignal?: AbortSignalLike): Promise<void>;
+    private _initLinkImpl;
+    /**
+     * Clears token renewal for current link, removes current LinkEntity instance from cache,
+     * and closes the underlying AMQP link.
+     * Once closed, this instance of LinkEntity is not meant to be re-used.
+     */
+    close(): Promise<void>;
+    /**
+     * NOTE: This method should be implemented by any child classes to actually create the underlying
+     * Rhea link (AwaitableSender or Receiver or RequestResponseLink)
+     *
+     */
+    protected abstract createRheaLink(_options: LinkOptionsT<LinkT>): Promise<LinkT>;
+    /**
+     * Clears this link from context's link cache.
+     */
+    protected abstract removeLinkFromContext(): void;
+    /**
+     * Closes the internally held rhea link, stops the token renewal timer and sets
+     * the this._link field to undefined.
+     */
+    protected closeLink(): Promise<void>;
+    private closeLinkImpl;
+    /**
+     * Provides the current type of the ClientEntity.
+     * @returns The entity type.
+     */
+    private get _type();
+    protected get wasClosedPermanently(): boolean;
+    protected get link(): LinkT | undefined;
+    /**
+     * Negotiates the cbs claim for the ClientEntity.
+     * @param setTokenRenewal - Set the token renewal timer. Default false.
+     */
+    private _negotiateClaim;
+    /**
+     * Checks to see if the connection is in a "reopening" state. If it is
+     * we need to _not_ use it otherwise we'll trigger some race conditions
+     * within rhea (for instance, errors about _process not being defined).
+     */
+    private checkIfConnectionReady;
+    /**
+     * Ensures that the token is renewed within the predefined renewal margin.
+     */
+    private _ensureTokenRenewal;
+}
+export {};
+//# sourceMappingURL=linkEntity.d.ts.map

package/dist/commonjs/core/linkEntity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"linkEntity.d.ts","sourceRoot":"","sources":["../../../src/core/linkEntity.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAS5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EACV,eAAe,EACf,sBAAsB,EACtB,QAAQ,EACR,eAAe,EACf,aAAa,EACd,MAAM,cAAc,CAAC;AAGtB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAGlD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC,aAAa,EAAE,aAAa,CAAC;IAC7B,eAAe,EAAE,eAAe,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,UAAU,GACV,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,sBAAsB,GAAG,SAAS,CAAC;AAE9D;;GAEG;AACH,KAAK,YAAY,CAAC,KAAK,SAAS,QAAQ,GAAG,eAAe,GAAG,mBAAmB,IAC9E,KAAK,SAAS,QAAQ,GAClB,eAAe,GACf,KAAK,SAAS,eAAe,GAC3B,sBAAsB,GACtB,KAAK,SAAS,mBAAmB,GAC/B,0BAA0B,GAC1B,KAAK,CAAC;AAEhB;;GAEG;AACH,KAAK,SAAS,CAAC,KAAK,SAAS,QAAQ,GAAG,eAAe,GAAG,mBAAmB,IAC3E,KAAK,SAAS,QAAQ,GAClB,YAAY,GACZ,KAAK,SAAS,eAAe,GAC3B,QAAQ,GACR,KAAK,SAAS,mBAAmB,GAC/B,MAAM,GACN,KAAK,CAAC;AAEhB;;;GAGG;AACH,8BAAsB,UAAU,CAAC,KAAK,SAAS,QAAQ,GAAG,eAAe,GAAG,mBAAmB;aAsF3E,QAAQ,EAAE,MAAM;aAChB,UAAU,EAAE,MAAM;IAElC,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,OAAO;IAzFjB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;OAaG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;;;;;;;;;OAcG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,QAAQ,EAAE,iBAAiB,CAAC;IACtC;;;OAGG;IACH,OAAO,CAAC,kBAAkB,CAAC,CAAiB;IAC5C;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,KAAK,CAAC,CAAQ;IAEtB;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;;OAGG;IACH,OAAO,CAAC,qBAAqB,CAAkB;IAE/C;;;OAGG;IACH,OAAO,CAAC,SAAS,CAA2C;IAE5D;;;;;;OAMG;gBAEe,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClC,OAAO,EAAE,iBAAiB,EAClB,SAAS,EAAE,SAAS,CAAC,KAAK,CAAC,EAC3B,OAAO,EAAE,gBAAgB,EACjC,OAAO,CAAC,EAAE,iBAAiB;IAU7B;;OAEG;IACH,MAAM,IAAI,OAAO;IAMjB;;;;;;OAMG;IACG,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;YAsB5E,aAAa;IAyD3B;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;IAEhF;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,qBAAqB,IAAI,IAAI;IAEhD;;;OAGG;IACH,SAAS,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;YActB,aAAa;IAqB3B;;;OAGG;IACH,OAAO,KAAK,KAAK,GAMhB;IAED,SAAS,KAAK,oBAAoB,IAAI,OAAO,CAE5C;IAED,SAAS,KAAK,IAAI,IAAI,KAAK,GAAG,SAAS,CAEtC;IAED;;;OAGG;YACW,eAAe;IA6G7B;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAgB9B;;OAEG;IACH,OAAO,CAAC,mBAAmB;CAsC5B"}

package/dist/commonjs/core/linkEntity.js

@@ -0,0 +1,344 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinkEntity = void 0;
+const core_amqp_1 = require("@azure/core-amqp");
+const rhea_promise_1 = require("rhea-promise");
+const utils_js_1 = require("../util/utils.js");
+const abort_controller_1 = require("@azure/abort-controller");
+const serviceBusError_js_1 = require("../serviceBusError.js");
+/**
+ * @internal
+ * Describes the base class for entities like MessageSender, MessageReceiver and Management client.
+ */
+class LinkEntity {
+    baseName;
+    entityPath;
+    _linkType;
+    _logger;
+    /**
+     * The unique name for the entity in the format:
+     * `${name of the entity}-${guid}`.
+     */
+    name;
+    /**
+     * The client entity address in one of the following forms:
+     *
+     * **Sender**
+     * - `"<queue-name>"`.
+     * - `"<topic-name>"`.
+     *
+     * **Receiver**
+     * - `"<queue-name>"`.
+     * - `"<topic-name>"`.
+     *
+     * **ManagementClient**
+     * -`"$management"`.
+     */
+    address;
+    /**
+     * The client entity token audience in one of the following forms:
+     *
+     * **Sender**
+     * - `"sb://<yournamespace>.servicebus.windows.net/<queue-name>"`
+     * - `"sb://<yournamespace>.servicebus.windows.net/<topic-name>"`
+     *
+     * **Receiver**
+     * - `"sb://<yournamespace>.servicebus.windows.net/<queue-name>"`
+     * - `"sb://<yournamespace>.servicebus.windows.net/<topic-name>"`
+     *
+     * **ManagementClient**
+     * - `"sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management"`.
+     * - `"sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management"`.
+     */
+    audience;
+    /**
+     * Provides relevant information about the amqp connection,
+     * cbs and $management sessions, token provider, sender and receivers.
+     */
+    _context;
+    /**
+     * The token renewal timer that keeps track of when
+     * the Client Entity is due for token renewal.
+     */
+    _tokenRenewalTimer;
+    /**
+     * Indicates token timeout
+     */
+    _tokenTimeout;
+    /**
+     * The actual rhea link (of type Receiver or AwaitableSender) or RequestResponseLink
+     */
+    _link;
+    /**
+     * The log prefix for any log messages.
+     */
+    _logPrefix;
+    get logPrefix() {
+        return this._logPrefix;
+    }
+    /**
+     * Indicates that close() has been called on this link and
+     * that it should not be allowed to reopen.
+     */
+    _wasClosedPermanently = false;
+    /**
+     * A lock that ensures that opening and closing this
+     * link properly cooperate.
+     */
+    _openLock = `linkEntity-${(0, rhea_promise_1.generate_uuid)()}`;
+    /**
+     * Creates a new ClientEntity instance.
+     * @param baseName - The base name to use for the link. A unique ID will be appended to this.
+     * @param entityPath - The entity path (ex: 'your-queue')
+     * @param context - The connection context.
+     * @param options - Options that can be provided while creating the LinkEntity.
+     */
+    constructor(baseName, entityPath, context, _linkType, _logger, options) {
+        this.baseName = baseName;
+        this.entityPath = entityPath;
+        this._linkType = _linkType;
+        this._logger = _logger;
+        if (!options)
+            options = {};
+        this._context = context;
+        this.address = options.address || "";
+        this.audience = options.audience || "";
+        this.name = (0, utils_js_1.getUniqueName)(baseName);
+        this._logPrefix = `[${context.connectionId}|${this._linkType}:${this.name}]`;
+    }
+    /**
+     * Determines whether the AMQP link is open. If open then returns true else returns false.
+     */
+    isOpen() {
+        const result = this._link ? this._link.isOpen() : false;
+        this._logger.verbose(`${this._logPrefix} is open? ${result}`);
+        return result;
+    }
+    /**
+     * Initializes this LinkEntity, setting this._link with the result of  `createRheaLink`, which
+     * is implemented by child classes.
+     *
+     * @returns A Promise that resolves when the link has been properly initialized
+     * @throws `AbortError` if the link has been closed via 'close'
+     */
+    async initLink(options, abortSignal) {
+        // we'll check that the connection isn't in the process of recycling (and if so, wait for it to complete)
+        await this._context.readyToOpenLink();
+        this._logger.verbose(`${this._logPrefix} Attempting to acquire lock token ${this._openLock} for initializing link`);
+        return core_amqp_1.defaultCancellableLock.acquire(this._openLock, () => {
+            this._logger.verbose(`${this._logPrefix} Lock ${this._openLock} acquired for initializing link`);
+            return this._initLinkImpl(options, abortSignal);
+        }, {
+            abortSignal: abortSignal,
+            timeoutInMs: core_amqp_1.Constants.defaultOperationTimeoutInMs,
+        });
+    }
+    async _initLinkImpl(options, abortSignal) {
+        const checkAborted = () => {
+            if (abortSignal?.aborted) {
+                this._link?.close();
+                throw new abort_controller_1.AbortError(core_amqp_1.StandardAbortMessage);
+            }
+        };
+        const connectionId = this._context.connectionId;
+        checkAborted();
+        if (options.name) {
+            this.name = options.name;
+            this._logPrefix = `[${connectionId}|${this._linkType}:${this.name}]`;
+        }
+        if (this._wasClosedPermanently) {
+            this._logger.verbose(`${this._logPrefix} Link has been permanently closed. Not reopening.`);
+            throw new abort_controller_1.AbortError(`Link has been permanently closed. Not reopening.`);
+        }
+        if (this.isOpen()) {
+            this._logger.verbose(`${this._logPrefix} Link is already open. Returning.`);
+            return;
+        }
+        this._logger.verbose(`${this._logPrefix} Is not open and is not currently connecting. Opening.`);
+        try {
+            await this._negotiateClaim({
+                abortSignal,
+                setTokenRenewal: false,
+                timeoutInMs: core_amqp_1.Constants.defaultOperationTimeoutInMs,
+            });
+            checkAborted();
+            this.checkIfConnectionReady();
+            this._logger.verbose(`${this._logPrefix} Creating with options %O`, options);
+            this._link = await this.createRheaLink(options);
+            checkAborted();
+            this._ensureTokenRenewal();
+            this._logger.verbose(`${this._logPrefix} Link has been created.`);
+        }
+        catch (err) {
+            this._logger.logError(err, `${this._logPrefix} Error thrown when creating the link`);
+            await this.closeLinkImpl();
+            throw err;
+        }
+    }
+    /**
+     * Clears token renewal for current link, removes current LinkEntity instance from cache,
+     * and closes the underlying AMQP link.
+     * Once closed, this instance of LinkEntity is not meant to be re-used.
+     */
+    async close() {
+        // Set the flag to indicate that this instance of LinkEntity is not meant to be re-used.
+        this._wasClosedPermanently = true;
+        this._logger.verbose(`${this.logPrefix} permanently closing this link.`);
+        this.removeLinkFromContext();
+        await this.closeLink();
+        this._logger.verbose(`${this.logPrefix} permanently closed this link.`);
+    }
+    /**
+     * Closes the internally held rhea link, stops the token renewal timer and sets
+     * the this._link field to undefined.
+     */
+    closeLink() {
+        this._logger.verbose(`${this._logPrefix} Attempting to acquire lock token ${this._openLock} for closing link`);
+        return core_amqp_1.defaultCancellableLock.acquire(this._openLock, () => {
+            this._logger.verbose(`${this._logPrefix} Lock ${this._openLock} acquired for closing link`);
+            return this.closeLinkImpl();
+        }, { abortSignal: undefined, timeoutInMs: undefined });
+    }
+    async closeLinkImpl() {
+        this._logger.verbose(`${this._logPrefix} closeLinkImpl() called`);
+        clearTimeout(this._tokenRenewalTimer);
+        this._tokenRenewalTimer = undefined;
+        if (this._link) {
+            try {
+                const link = this._link;
+                this._link = undefined;
+                // This should take care of closing the link and it's underlying session. This should also
+                // remove them from the internal map.
+                await link.close();
+                this._logger.verbose(`${this._logPrefix} closed.`);
+            }
+            catch (err) {
+                this._logger.logError(err, `${this._logPrefix} An error occurred while closing the link`);
+            }
+        }
+    }
+    /**
+     * Provides the current type of the ClientEntity.
+     * @returns The entity type.
+     */
+    get _type() {
+        let result = "LinkEntity";
+        if (this.constructor && this.constructor.name) {
+            result = this.constructor.name;
+        }
+        return result;
+    }
+    get wasClosedPermanently() {
+        return this._wasClosedPermanently;
+    }
+    get link() {
+        return this._link;
+    }
+    /**
+     * Negotiates the cbs claim for the ClientEntity.
+     * @param setTokenRenewal - Set the token renewal timer. Default false.
+     */
+    async _negotiateClaim({ abortSignal, setTokenRenewal, timeoutInMs, }) {
+        this._logger.verbose(`${this._logPrefix} negotiateclaim() has been called`);
+        // Wait for the connectionContext to be ready to open the link.
+        this.checkIfConnectionReady();
+        // Acquire the lock and establish a cbs session if it does not exist on the connection.
+        // Although node.js is single threaded, we need a locking mechanism to ensure that a
+        // race condition does not happen while creating a shared resource (in this case the
+        // cbs session, since we want to have exactly 1 cbs session per connection).
+        this._logger.verbose("%s Acquiring cbs lock: '%s' for creating the cbs session while creating the %s: " +
+            "'%s' with address: '%s'.", this.logPrefix, this._context.cbsSession.cbsLock, this._type, this.name, this.address);
+        const startTime = Date.now();
+        if (!this._context.cbsSession.isOpen()) {
+            await core_amqp_1.defaultCancellableLock.acquire(this._context.cbsSession.cbsLock, () => {
+                this.checkIfConnectionReady();
+                return this._context.cbsSession.init({ abortSignal, timeoutInMs });
+            }, {
+                abortSignal,
+                timeoutInMs: timeoutInMs - (Date.now() - startTime),
+            });
+        }
+        let tokenObject;
+        let tokenType;
+        if ((0, core_amqp_1.isSasTokenProvider)(this._context.tokenCredential)) {
+            tokenObject = await this._context.tokenCredential.getToken(this.audience);
+            tokenType = core_amqp_1.TokenType.CbsTokenTypeSas;
+            // renew sas token in every 45 minutes
+            this._tokenTimeout = (3600 - 900) * 1000;
+        }
+        else {
+            const aadToken = await this._context.tokenCredential.getToken(core_amqp_1.Constants.aadServiceBusScope);
+            if (!aadToken) {
+                throw new Error(`Failed to get token from the provided "TokenCredential" object`);
+            }
+            tokenObject = aadToken;
+            tokenType = core_amqp_1.TokenType.CbsTokenTypeJwt;
+            this._tokenTimeout = tokenObject.expiresOnTimestamp - Date.now() - 2 * 60 * 1000;
+        }
+        this._logger.verbose("%s %s: calling negotiateClaim for audience '%s'.", this.logPrefix, this._type, this.audience);
+        // Acquire the lock to negotiate the CBS claim.
+        this._logger.verbose("%s Acquiring cbs lock: '%s' for cbs auth for %s: '%s' with address '%s'.", this.logPrefix, this._context.negotiateClaimLock, this._type, this.name, this.address);
+        if (!tokenObject) {
+            throw new Error("Token cannot be null");
+        }
+        await core_amqp_1.defaultCancellableLock.acquire(this._context.negotiateClaimLock, () => {
+            this.checkIfConnectionReady();
+            return this._context.cbsSession.negotiateClaim(this.audience, tokenObject.token, tokenType, {
+                abortSignal,
+                timeoutInMs: timeoutInMs - (Date.now() - startTime),
+            });
+        }, {
+            abortSignal,
+            timeoutInMs: timeoutInMs - (Date.now() - startTime),
+        });
+        this._logger.verbose("%s Negotiated claim for %s '%s' with with address: %s", this.logPrefix, this._type, this.name, this.address);
+        if (setTokenRenewal) {
+            this._ensureTokenRenewal();
+        }
+    }
+    /**
+     * Checks to see if the connection is in a "reopening" state. If it is
+     * we need to _not_ use it otherwise we'll trigger some race conditions
+     * within rhea (for instance, errors about _process not being defined).
+     */
+    checkIfConnectionReady() {
+        if (!this._context.isConnectionClosing()) {
+            return;
+        }
+        this._logger.verbose(`${this._logPrefix} Connection is reopening, aborting link initialization.`);
+        const err = new serviceBusError_js_1.ServiceBusError("Connection is reopening, aborting link initialization.", "GeneralError");
+        err.retryable = true;
+        throw err;
+    }
+    /**
+     * Ensures that the token is renewed within the predefined renewal margin.
+     */
+    _ensureTokenRenewal() {
+        if (!this._tokenTimeout) {
+            return;
+        }
+        // Clear the existing token renewal timer.
+        // This scenario can happen if the connection goes down and is brought back up
+        // before the `nextRenewalTimeout` was reached.
+        if (this._tokenRenewalTimer) {
+            clearTimeout(this._tokenRenewalTimer);
+        }
+        this._tokenRenewalTimer = setTimeout(async () => {
+            try {
+                await this._negotiateClaim({
+                    setTokenRenewal: true,
+                    abortSignal: undefined,
+                    timeoutInMs: core_amqp_1.Constants.defaultOperationTimeoutInMs,
+                });
+            }
+            catch (err) {
+                this._logger.logError(err, "%s %s '%s' with address %s, an error occurred while renewing the token", this.logPrefix, this._type, this.name, this.address);
+            }
+        }, this._tokenTimeout);
+        this._logger.verbose("%s %s '%s' with address %s, has next token renewal in %d milliseconds @(%s).", this.logPrefix, this._type, this.name, this.address, this._tokenTimeout, new Date(Date.now() + this._tokenTimeout).toString());
+    }
+}
+exports.LinkEntity = LinkEntity;
+//# sourceMappingURL=linkEntity.js.map

package/dist/commonjs/core/linkEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linkEntity.js","sourceRoot":"","sources":["../../../src/core/linkEntity.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,gDAM0B;AAU1B,+CAA6C;AAC7C,+CAAiD;AAEjD,8DAAqD;AAErD,8DAAwD;AAiExD;;;GAGG;AACH,MAAsB,UAAU;IAsFZ;IACA;IAER;IACA;IAzFV;;;OAGG;IACH,IAAI,CAAS;IACb;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAS;IAChB;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAS;IACjB;;;OAGG;IACO,QAAQ,CAAoB;IACtC;;;OAGG;IACK,kBAAkB,CAAkB;IAC5C;;OAEG;IACO,aAAa,CAAU;IAEjC;;OAEG;IACK,KAAK,CAAS;IAEtB;;OAEG;IACK,UAAU,CAAS;IAE3B,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACK,qBAAqB,GAAY,KAAK,CAAC;IAE/C;;;OAGG;IACK,SAAS,GAAW,cAAc,IAAA,4BAAa,GAAE,EAAE,CAAC;IAE5D;;;;;;OAMG;IACH,YACkB,QAAgB,EAChB,UAAkB,EAClC,OAA0B,EAClB,SAA2B,EAC3B,OAAyB,EACjC,OAA2B;QALX,aAAQ,GAAR,QAAQ,CAAQ;QAChB,eAAU,GAAV,UAAU,CAAQ;QAE1B,cAAS,GAAT,SAAS,CAAkB;QAC3B,YAAO,GAAP,OAAO,CAAkB;QAGjC,IAAI,CAAC,OAAO;YAAE,OAAO,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,IAAI,GAAG,IAAA,wBAAa,EAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,UAAU,GAAG,IAAI,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QACjE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,aAAa,MAAM,EAAE,CAAC,CAAC;QAC9D,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CAAC,OAA4B,EAAE,WAA6B;QACxE,yGAAyG;QACzG,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC;QAEtC,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,GAAG,IAAI,CAAC,UAAU,qCAAqC,IAAI,CAAC,SAAS,wBAAwB,CAC9F,CAAC;QACF,OAAO,kCAAsB,CAAC,OAAO,CACnC,IAAI,CAAC,SAAS,EACd,GAAG,EAAE;YACH,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,GAAG,IAAI,CAAC,UAAU,SAAS,IAAI,CAAC,SAAS,iCAAiC,CAC3E,CAAC;YACF,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAClD,CAAC,EACD;YACE,WAAW,EAAE,WAAW;YACxB,WAAW,EAAE,qBAAS,CAAC,2BAA2B;SACnD,CACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,aAAa,CACzB,OAA4B,EAC5B,WAA6B;QAE7B,MAAM,YAAY,GAAG,GAAS,EAAE;YAC9B,IAAI,WAAW,EAAE,OAAO,EAAE,CAAC;gBACzB,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC;gBACpB,MAAM,IAAI,6BAAU,CAAC,gCAAoB,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QAChD,YAAY,EAAE,CAAC;QAEf,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YACzB,IAAI,CAAC,UAAU,GAAG,IAAI,YAAY,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC;QACvE,CAAC;QAED,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,mDAAmD,CAAC,CAAC;YAC5F,MAAM,IAAI,6BAAU,CAAC,kDAAkD,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,mCAAmC,CAAC,CAAC;YAC5E,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,GAAG,IAAI,CAAC,UAAU,wDAAwD,CAC3E,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,eAAe,CAAC;gBACzB,WAAW;gBACX,eAAe,EAAE,KAAK;gBACtB,WAAW,EAAE,qBAAS,CAAC,2BAA2B;aACnD,CAAC,CAAC;YAEH,YAAY,EAAE,CAAC;YACf,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAE9B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,2BAA2B,EAAE,OAAO,CAAC,CAAC;YAC7E,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YAChD,YAAY,EAAE,CAAC;YAEf,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAE3B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,yBAAyB,CAAC,CAAC;QACpE,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,sCAAsC,CAAC,CAAC;YACrF,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3B,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK;QACT,wFAAwF;QACxF,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QAElC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,iCAAiC,CAAC,CAAC;QAEzE,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE7B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,gCAAgC,CAAC,CAAC;IAC1E,CAAC;IAcD;;;OAGG;IACO,SAAS;QACjB,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,GAAG,IAAI,CAAC,UAAU,qCAAqC,IAAI,CAAC,SAAS,mBAAmB,CACzF,CAAC;QACF,OAAO,kCAAsB,CAAC,OAAO,CACnC,IAAI,CAAC,SAAS,EACd,GAAG,EAAE;YACH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,SAAS,IAAI,CAAC,SAAS,4BAA4B,CAAC,CAAC;YAC5F,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,EACD,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,CACnD,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,aAAa;QACzB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,yBAAyB,CAAC,CAAC;QAElE,YAAY,CAAC,IAAI,CAAC,kBAAoC,CAAC,CAAC;QACxD,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;QAEpC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;gBACxB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;gBAEvB,0FAA0F;gBAC1F,qCAAqC;gBACrC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;gBACnB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,UAAU,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,2CAA2C,CAAC,CAAC;YAC5F,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,IAAY,KAAK;QACf,IAAI,MAAM,GAAG,YAAY,CAAC;QAC1B,IAAK,IAAY,CAAC,WAAW,IAAK,IAAY,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAChE,MAAM,GAAI,IAAY,CAAC,WAAW,CAAC,IAAI,CAAC;QAC1C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAc,oBAAoB;QAChC,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;IAED,IAAc,IAAI;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,eAAe,CAAC,EAC5B,WAAW,EACX,eAAe,EACf,WAAW,GAKZ;QACC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,mCAAmC,CAAC,CAAC;QAE5E,+DAA+D;QAC/D,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,uFAAuF;QACvF,oFAAoF;QACpF,oFAAoF;QACpF,4EAA4E;QAC5E,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,kFAAkF;YAChF,0BAA0B,EAC5B,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAChC,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,CACb,CAAC;QAEF,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;YACvC,MAAM,kCAAsB,CAAC,OAAO,CAClC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAChC,GAAG,EAAE;gBACH,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;YACrE,CAAC,EACD;gBACE,WAAW;gBACX,WAAW,EAAE,WAAW,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;aACpD,CACF,CAAC;QACJ,CAAC;QAED,IAAI,WAAwB,CAAC;QAC7B,IAAI,SAAoB,CAAC;QACzB,IAAI,IAAA,8BAAkB,EAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YACtD,WAAW,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1E,SAAS,GAAG,qBAAS,CAAC,eAAe,CAAC;YAEtC,sCAAsC;YACtC,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,qBAAS,CAAC,kBAAkB,CAAC,CAAC;YAC5F,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;YACpF,CAAC;YACD,WAAW,GAAG,QAAQ,CAAC;YACvB,SAAS,GAAG,qBAAS,CAAC,eAAe,CAAC;YACtC,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QACnF,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,kDAAkD,EAClD,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,QAAQ,CACd,CAAC;QACF,+CAA+C;QAC/C,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,0EAA0E,EAC1E,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,QAAQ,CAAC,kBAAkB,EAChC,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,CACb,CAAC;QACF,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;QACD,MAAM,kCAAsB,CAAC,OAAO,CAClC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,EAChC,GAAG,EAAE;YACH,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,CAC5C,IAAI,CAAC,QAAQ,EACb,WAAW,CAAC,KAAK,EACjB,SAAS,EACT;gBACE,WAAW;gBACX,WAAW,EAAE,WAAW,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;aACpD,CACF,CAAC;QACJ,CAAC,EACD;YACE,WAAW;YACX,WAAW,EAAE,WAAW,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;SACpD,CACF,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,uDAAuD,EACvD,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,CACb,CAAC;QACF,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,sBAAsB;QAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,EAAE,CAAC;YACzC,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,GAAG,IAAI,CAAC,UAAU,yDAAyD,CAC5E,CAAC;QACF,MAAM,GAAG,GAAG,IAAI,oCAAe,CAC7B,wDAAwD,EACxD,cAAc,CACf,CAAC;QACF,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC;QACrB,MAAM,GAAG,CAAC;IACZ,CAAC;IAED;;OAEG;IACK,mBAAmB;QACzB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QACD,0CAA0C;QAC1C,8EAA8E;QAC9E,+CAA+C;QAC/C,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC5B,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,CAAC,kBAAkB,GAAG,UAAU,CAAC,KAAK,IAAI,EAAE;YAC9C,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,eAAe,CAAC;oBACzB,eAAe,EAAE,IAAI;oBACrB,WAAW,EAAE,SAAS;oBACtB,WAAW,EAAE,qBAAS,CAAC,2BAA2B;iBACnD,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,OAAO,CAAC,QAAQ,CACnB,GAAG,EACH,wEAAwE,EACxE,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,CACb,CAAC;YACJ,CAAC;QACH,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,8EAA8E,EAC9E,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,aAAa,EAClB,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CACrD,CAAC;IACJ,CAAC;CACF;AA3cD,gCA2cC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { RequestResponseLink } from \"@azure/core-amqp\";\nimport {\n  Constants,\n  TokenType,\n  defaultCancellableLock,\n  StandardAbortMessage,\n  isSasTokenProvider,\n} from \"@azure/core-amqp\";\nimport type { AccessToken } from \"@azure/core-auth\";\nimport type { ConnectionContext } from \"../connectionContext.js\";\nimport type {\n  AwaitableSender,\n  AwaitableSenderOptions,\n  Receiver,\n  ReceiverOptions,\n  SenderOptions,\n} from \"rhea-promise\";\nimport { generate_uuid } from \"rhea-promise\";\nimport { getUniqueName } from \"../util/utils.js\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport type { ServiceBusLogger } from \"../log.js\";\nimport { ServiceBusError } from \"../serviceBusError.js\";\n\n/**\n * @internal\n * Options passed to the constructor of LinkEntity\n */\nexport interface LinkEntityOptions {\n  /**\n   * The client entity address in one of the following forms:\n   */\n  address?: string;\n  /**\n   * The client entity token audience in one of the following forms:\n   */\n  audience?: string;\n}\n\n/**\n * A simple grouping of the sender and receiver options. Only used\n * with the ManagementClient today.\n *\n * @internal\n */\nexport interface RequestResponseLinkOptions {\n  senderOptions: SenderOptions;\n  receiverOptions: ReceiverOptions;\n  name?: string;\n}\n\n/**\n * @internal\n */\nexport type NonSessionReceiverType =\n  | \"batching\" // batching receiver\n  | \"streaming\"; // streaming receiver\n\n/**\n * @internal\n */\nexport type ReceiverType = NonSessionReceiverType | \"session\"; // message session\n\n/**\n * @internal\n */\ntype LinkOptionsT<LinkT extends Receiver | AwaitableSender | RequestResponseLink> =\n  LinkT extends Receiver\n    ? ReceiverOptions\n    : LinkT extends AwaitableSender\n      ? AwaitableSenderOptions\n      : LinkT extends RequestResponseLink\n        ? RequestResponseLinkOptions\n        : never;\n\n/**\n * @internal\n */\ntype LinkTypeT<LinkT extends Receiver | AwaitableSender | RequestResponseLink> =\n  LinkT extends Receiver\n    ? ReceiverType\n    : LinkT extends AwaitableSender\n      ? \"sender\" // sender\n      : LinkT extends RequestResponseLink\n        ? \"mgmt\" // management link\n        : never;\n\n/**\n * @internal\n * Describes the base class for entities like MessageSender, MessageReceiver and Management client.\n */\nexport abstract class LinkEntity<LinkT extends Receiver | AwaitableSender | RequestResponseLink> {\n  /**\n   * The unique name for the entity in the format:\n   * `${name of the entity}-${guid}`.\n   */\n  name: string;\n  /**\n   * The client entity address in one of the following forms:\n   *\n   * **Sender**\n   * - `\"<queue-name>\"`.\n   * - `\"<topic-name>\"`.\n   *\n   * **Receiver**\n   * - `\"<queue-name>\"`.\n   * - `\"<topic-name>\"`.\n   *\n   * **ManagementClient**\n   * -`\"$management\"`.\n   */\n  address: string;\n  /**\n   * The client entity token audience in one of the following forms:\n   *\n   * **Sender**\n   * - `\"sb://<yournamespace>.servicebus.windows.net/<queue-name>\"`\n   * - `\"sb://<yournamespace>.servicebus.windows.net/<topic-name>\"`\n   *\n   * **Receiver**\n   * - `\"sb://<yournamespace>.servicebus.windows.net/<queue-name>\"`\n   * - `\"sb://<yournamespace>.servicebus.windows.net/<topic-name>\"`\n   *\n   * **ManagementClient**\n   * - `\"sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management\"`.\n   * - `\"sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management\"`.\n   */\n  audience: string;\n  /**\n   * Provides relevant information about the amqp connection,\n   * cbs and $management sessions, token provider, sender and receivers.\n   */\n  protected _context: ConnectionContext;\n  /**\n   * The token renewal timer that keeps track of when\n   * the Client Entity is due for token renewal.\n   */\n  private _tokenRenewalTimer?: NodeJS.Timeout;\n  /**\n   * Indicates token timeout\n   */\n  protected _tokenTimeout?: number;\n\n  /**\n   * The actual rhea link (of type Receiver or AwaitableSender) or RequestResponseLink\n   */\n  private _link?: LinkT;\n\n  /**\n   * The log prefix for any log messages.\n   */\n  private _logPrefix: string;\n\n  public get logPrefix(): string {\n    return this._logPrefix;\n  }\n\n  /**\n   * Indicates that close() has been called on this link and\n   * that it should not be allowed to reopen.\n   */\n  private _wasClosedPermanently: boolean = false;\n\n  /**\n   * A lock that ensures that opening and closing this\n   * link properly cooperate.\n   */\n  private _openLock: string = `linkEntity-${generate_uuid()}`;\n\n  /**\n   * Creates a new ClientEntity instance.\n   * @param baseName - The base name to use for the link. A unique ID will be appended to this.\n   * @param entityPath - The entity path (ex: 'your-queue')\n   * @param context - The connection context.\n   * @param options - Options that can be provided while creating the LinkEntity.\n   */\n  constructor(\n    public readonly baseName: string,\n    public readonly entityPath: string,\n    context: ConnectionContext,\n    private _linkType: LinkTypeT<LinkT>,\n    private _logger: ServiceBusLogger,\n    options?: LinkEntityOptions,\n  ) {\n    if (!options) options = {};\n    this._context = context;\n    this.address = options.address || \"\";\n    this.audience = options.audience || \"\";\n    this.name = getUniqueName(baseName);\n    this._logPrefix = `[${context.connectionId}|${this._linkType}:${this.name}]`;\n  }\n\n  /**\n   * Determines whether the AMQP link is open. If open then returns true else returns false.\n   */\n  isOpen(): boolean {\n    const result: boolean = this._link ? this._link.isOpen() : false;\n    this._logger.verbose(`${this._logPrefix} is open? ${result}`);\n    return result;\n  }\n\n  /**\n   * Initializes this LinkEntity, setting this._link with the result of  `createRheaLink`, which\n   * is implemented by child classes.\n   *\n   * @returns A Promise that resolves when the link has been properly initialized\n   * @throws `AbortError` if the link has been closed via 'close'\n   */\n  async initLink(options: LinkOptionsT<LinkT>, abortSignal?: AbortSignalLike): Promise<void> {\n    // we'll check that the connection isn't in the process of recycling (and if so, wait for it to complete)\n    await this._context.readyToOpenLink();\n\n    this._logger.verbose(\n      `${this._logPrefix} Attempting to acquire lock token ${this._openLock} for initializing link`,\n    );\n    return defaultCancellableLock.acquire(\n      this._openLock,\n      () => {\n        this._logger.verbose(\n          `${this._logPrefix} Lock ${this._openLock} acquired for initializing link`,\n        );\n        return this._initLinkImpl(options, abortSignal);\n      },\n      {\n        abortSignal: abortSignal,\n        timeoutInMs: Constants.defaultOperationTimeoutInMs,\n      },\n    );\n  }\n\n  private async _initLinkImpl(\n    options: LinkOptionsT<LinkT>,\n    abortSignal?: AbortSignalLike,\n  ): Promise<void> {\n    const checkAborted = (): void => {\n      if (abortSignal?.aborted) {\n        this._link?.close();\n        throw new AbortError(StandardAbortMessage);\n      }\n    };\n\n    const connectionId = this._context.connectionId;\n    checkAborted();\n\n    if (options.name) {\n      this.name = options.name;\n      this._logPrefix = `[${connectionId}|${this._linkType}:${this.name}]`;\n    }\n\n    if (this._wasClosedPermanently) {\n      this._logger.verbose(`${this._logPrefix} Link has been permanently closed. Not reopening.`);\n      throw new AbortError(`Link has been permanently closed. Not reopening.`);\n    }\n\n    if (this.isOpen()) {\n      this._logger.verbose(`${this._logPrefix} Link is already open. Returning.`);\n      return;\n    }\n\n    this._logger.verbose(\n      `${this._logPrefix} Is not open and is not currently connecting. Opening.`,\n    );\n\n    try {\n      await this._negotiateClaim({\n        abortSignal,\n        setTokenRenewal: false,\n        timeoutInMs: Constants.defaultOperationTimeoutInMs,\n      });\n\n      checkAborted();\n      this.checkIfConnectionReady();\n\n      this._logger.verbose(`${this._logPrefix} Creating with options %O`, options);\n      this._link = await this.createRheaLink(options);\n      checkAborted();\n\n      this._ensureTokenRenewal();\n\n      this._logger.verbose(`${this._logPrefix} Link has been created.`);\n    } catch (err: any) {\n      this._logger.logError(err, `${this._logPrefix} Error thrown when creating the link`);\n      await this.closeLinkImpl();\n      throw err;\n    }\n  }\n\n  /**\n   * Clears token renewal for current link, removes current LinkEntity instance from cache,\n   * and closes the underlying AMQP link.\n   * Once closed, this instance of LinkEntity is not meant to be re-used.\n   */\n  async close(): Promise<void> {\n    // Set the flag to indicate that this instance of LinkEntity is not meant to be re-used.\n    this._wasClosedPermanently = true;\n\n    this._logger.verbose(`${this.logPrefix} permanently closing this link.`);\n\n    this.removeLinkFromContext();\n\n    await this.closeLink();\n    this._logger.verbose(`${this.logPrefix} permanently closed this link.`);\n  }\n\n  /**\n   * NOTE: This method should be implemented by any child classes to actually create the underlying\n   * Rhea link (AwaitableSender or Receiver or RequestResponseLink)\n   *\n   */\n  protected abstract createRheaLink(_options: LinkOptionsT<LinkT>): Promise<LinkT>;\n\n  /**\n   * Clears this link from context's link cache.\n   */\n  protected abstract removeLinkFromContext(): void;\n\n  /**\n   * Closes the internally held rhea link, stops the token renewal timer and sets\n   * the this._link field to undefined.\n   */\n  protected closeLink(): Promise<void> {\n    this._logger.verbose(\n      `${this._logPrefix} Attempting to acquire lock token ${this._openLock} for closing link`,\n    );\n    return defaultCancellableLock.acquire(\n      this._openLock,\n      () => {\n        this._logger.verbose(`${this._logPrefix} Lock ${this._openLock} acquired for closing link`);\n        return this.closeLinkImpl();\n      },\n      { abortSignal: undefined, timeoutInMs: undefined },\n    );\n  }\n\n  private async closeLinkImpl(): Promise<void> {\n    this._logger.verbose(`${this._logPrefix} closeLinkImpl() called`);\n\n    clearTimeout(this._tokenRenewalTimer as NodeJS.Timeout);\n    this._tokenRenewalTimer = undefined;\n\n    if (this._link) {\n      try {\n        const link = this._link;\n        this._link = undefined;\n\n        // This should take care of closing the link and it's underlying session. This should also\n        // remove them from the internal map.\n        await link.close();\n        this._logger.verbose(`${this._logPrefix} closed.`);\n      } catch (err: any) {\n        this._logger.logError(err, `${this._logPrefix} An error occurred while closing the link`);\n      }\n    }\n  }\n\n  /**\n   * Provides the current type of the ClientEntity.\n   * @returns The entity type.\n   */\n  private get _type(): string {\n    let result = \"LinkEntity\";\n    if ((this as any).constructor && (this as any).constructor.name) {\n      result = (this as any).constructor.name;\n    }\n    return result;\n  }\n\n  protected get wasClosedPermanently(): boolean {\n    return this._wasClosedPermanently;\n  }\n\n  protected get link(): LinkT | undefined {\n    return this._link;\n  }\n\n  /**\n   * Negotiates the cbs claim for the ClientEntity.\n   * @param setTokenRenewal - Set the token renewal timer. Default false.\n   */\n  private async _negotiateClaim({\n    abortSignal,\n    setTokenRenewal,\n    timeoutInMs,\n  }: {\n    setTokenRenewal: boolean;\n    abortSignal: AbortSignalLike | undefined;\n    timeoutInMs: number;\n  }): Promise<void> {\n    this._logger.verbose(`${this._logPrefix} negotiateclaim() has been called`);\n\n    // Wait for the connectionContext to be ready to open the link.\n    this.checkIfConnectionReady();\n\n    // Acquire the lock and establish a cbs session if it does not exist on the connection.\n    // Although node.js is single threaded, we need a locking mechanism to ensure that a\n    // race condition does not happen while creating a shared resource (in this case the\n    // cbs session, since we want to have exactly 1 cbs session per connection).\n    this._logger.verbose(\n      \"%s Acquiring cbs lock: '%s' for creating the cbs session while creating the %s: \" +\n        \"'%s' with address: '%s'.\",\n      this.logPrefix,\n      this._context.cbsSession.cbsLock,\n      this._type,\n      this.name,\n      this.address,\n    );\n\n    const startTime = Date.now();\n    if (!this._context.cbsSession.isOpen()) {\n      await defaultCancellableLock.acquire(\n        this._context.cbsSession.cbsLock,\n        () => {\n          this.checkIfConnectionReady();\n          return this._context.cbsSession.init({ abortSignal, timeoutInMs });\n        },\n        {\n          abortSignal,\n          timeoutInMs: timeoutInMs - (Date.now() - startTime),\n        },\n      );\n    }\n\n    let tokenObject: AccessToken;\n    let tokenType: TokenType;\n    if (isSasTokenProvider(this._context.tokenCredential)) {\n      tokenObject = await this._context.tokenCredential.getToken(this.audience);\n      tokenType = TokenType.CbsTokenTypeSas;\n\n      // renew sas token in every 45 minutes\n      this._tokenTimeout = (3600 - 900) * 1000;\n    } else {\n      const aadToken = await this._context.tokenCredential.getToken(Constants.aadServiceBusScope);\n      if (!aadToken) {\n        throw new Error(`Failed to get token from the provided \"TokenCredential\" object`);\n      }\n      tokenObject = aadToken;\n      tokenType = TokenType.CbsTokenTypeJwt;\n      this._tokenTimeout = tokenObject.expiresOnTimestamp - Date.now() - 2 * 60 * 1000;\n    }\n    this._logger.verbose(\n      \"%s %s: calling negotiateClaim for audience '%s'.\",\n      this.logPrefix,\n      this._type,\n      this.audience,\n    );\n    // Acquire the lock to negotiate the CBS claim.\n    this._logger.verbose(\n      \"%s Acquiring cbs lock: '%s' for cbs auth for %s: '%s' with address '%s'.\",\n      this.logPrefix,\n      this._context.negotiateClaimLock,\n      this._type,\n      this.name,\n      this.address,\n    );\n    if (!tokenObject) {\n      throw new Error(\"Token cannot be null\");\n    }\n    await defaultCancellableLock.acquire(\n      this._context.negotiateClaimLock,\n      () => {\n        this.checkIfConnectionReady();\n        return this._context.cbsSession.negotiateClaim(\n          this.audience,\n          tokenObject.token,\n          tokenType,\n          {\n            abortSignal,\n            timeoutInMs: timeoutInMs - (Date.now() - startTime),\n          },\n        );\n      },\n      {\n        abortSignal,\n        timeoutInMs: timeoutInMs - (Date.now() - startTime),\n      },\n    );\n    this._logger.verbose(\n      \"%s Negotiated claim for %s '%s' with with address: %s\",\n      this.logPrefix,\n      this._type,\n      this.name,\n      this.address,\n    );\n    if (setTokenRenewal) {\n      this._ensureTokenRenewal();\n    }\n  }\n\n  /**\n   * Checks to see if the connection is in a \"reopening\" state. If it is\n   * we need to _not_ use it otherwise we'll trigger some race conditions\n   * within rhea (for instance, errors about _process not being defined).\n   */\n  private checkIfConnectionReady(): void {\n    if (!this._context.isConnectionClosing()) {\n      return;\n    }\n\n    this._logger.verbose(\n      `${this._logPrefix} Connection is reopening, aborting link initialization.`,\n    );\n    const err = new ServiceBusError(\n      \"Connection is reopening, aborting link initialization.\",\n      \"GeneralError\",\n    );\n    err.retryable = true;\n    throw err;\n  }\n\n  /**\n   * Ensures that the token is renewed within the predefined renewal margin.\n   */\n  private _ensureTokenRenewal(): void {\n    if (!this._tokenTimeout) {\n      return;\n    }\n    // Clear the existing token renewal timer.\n    // This scenario can happen if the connection goes down and is brought back up\n    // before the `nextRenewalTimeout` was reached.\n    if (this._tokenRenewalTimer) {\n      clearTimeout(this._tokenRenewalTimer);\n    }\n    this._tokenRenewalTimer = setTimeout(async () => {\n      try {\n        await this._negotiateClaim({\n          setTokenRenewal: true,\n          abortSignal: undefined,\n          timeoutInMs: Constants.defaultOperationTimeoutInMs,\n        });\n      } catch (err: any) {\n        this._logger.logError(\n          err,\n          \"%s %s '%s' with address %s, an error occurred while renewing the token\",\n          this.logPrefix,\n          this._type,\n          this.name,\n          this.address,\n        );\n      }\n    }, this._tokenTimeout);\n    this._logger.verbose(\n      \"%s %s '%s' with address %s, has next token renewal in %d milliseconds @(%s).\",\n      this.logPrefix,\n      this._type,\n      this.name,\n      this.address,\n      this._tokenTimeout,\n      new Date(Date.now() + this._tokenTimeout).toString(),\n    );\n  }\n}\n"]}