@azure/event-hubs 5.13.0-beta.2 → 6.0.0-alpha.20250129.1

package/dist/commonjs/logger.js

@@ -0,0 +1,65 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+exports.logErrorStackTrace = logErrorStackTrace;
+exports.createReceiverLogPrefix = createReceiverLogPrefix;
+exports.createSenderLogPrefix = createSenderLogPrefix;
+exports.createManagementLogPrefix = createManagementLogPrefix;
+exports.createSimpleLogger = createSimpleLogger;
+exports.logObj = logObj;
+const logger_1 = require("@azure/logger");
+const core_util_1 = require("@azure/core-util");
+/**
+ * The `@azure/logger` configuration for this package.
+ * This will output logs using the `azure:event-hubs` namespace prefix.
+ */
+exports.logger = (0, logger_1.createClientLogger)("event-hubs");
+/**
+ * Logs the error's stack trace to "verbose" if a stack trace is available.
+ * @param error - Error containing a stack trace.
+ * @internal
+ */
+function logErrorStackTrace(error) {
+    if ((0, core_util_1.isObjectWithProperties)(error, ["stack"])) {
+        exports.logger.verbose(error.stack);
+    }
+}
+/**
+ * @internal
+ */
+function createReceiverLogPrefix(consumerId, connectionId, partitionId) {
+    return `[${connectionId}] Receiver P${partitionId}-${consumerId}`;
+}
+/**
+ * @internal
+ */
+function createSenderLogPrefix(senderId, connectionId) {
+    return `[${connectionId}] Sender ${senderId}`;
+}
+/**
+ * @internal
+ */
+function createManagementLogPrefix(connectionId) {
+    return `[${connectionId}] Management`;
+}
+function createLogFunction(azureLogger, prefix, level) {
+    return (arg, ...args) => azureLogger[level](...(typeof arg === "string" ? [`${prefix}: ${arg}`] : [prefix, arg]), ...args);
+}
+/**
+ * @internal
+ */
+function createSimpleLogger(azureLogger, prefix) {
+    return {
+        info: createLogFunction(azureLogger, prefix, "info"),
+        error: createLogFunction(azureLogger, prefix, "error"),
+        verbose: createLogFunction(azureLogger, prefix, "verbose"),
+        warning: createLogFunction(azureLogger, prefix, "warning"),
+    };
+}
+/** @internal */
+function logObj(obj) {
+    JSON.stringify(obj, undefined, 2);
+}
+//# sourceMappingURL=logger.js.map

package/dist/commonjs/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAiBlC,gDAIC;AAKD,0DAMC;AAKD,sDAEC;AAKD,8DAEC;AAwBD,gDAOC;AAGD,wBAEC;AA/ED,0CAAmD;AACnD,gDAA0D;AAE1D;;;GAGG;AACU,QAAA,MAAM,GAAG,IAAA,2BAAkB,EAAC,YAAY,CAAC,CAAC;AAEvD;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,KAAc;IAC/C,IAAI,IAAA,kCAAsB,EAAC,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAC7C,cAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,uBAAuB,CACrC,UAAkB,EAClB,YAAoB,EACpB,WAAmB;IAEnB,OAAO,IAAI,YAAY,eAAe,WAAW,IAAI,UAAU,EAAE,CAAC;AACpE,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,QAAgB,EAAE,YAAoB;IAC1E,OAAO,IAAI,YAAY,YAAY,QAAQ,EAAE,CAAC;AAChD,CAAC;AAED;;GAEG;AACH,SAAgB,yBAAyB,CAAC,YAAoB;IAC5D,OAAO,IAAI,YAAY,cAAc,CAAC;AACxC,CAAC;AASD,SAAS,iBAAiB,CACxB,WAAwB,EACxB,MAAc,EACd,KAAoB;IAEpB,OAAO,CAAC,GAAQ,EAAE,GAAG,IAAW,EAAE,EAAE,CAClC,WAAW,CAAC,KAAK,CAAC,CAChB,GAAG,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EACpE,GAAG,IAAI,CACR,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAAC,WAAwB,EAAE,MAAc;IACzE,OAAO;QACL,IAAI,EAAE,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC;QACpD,KAAK,EAAE,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC;QACtD,OAAO,EAAE,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC;QAC1D,OAAO,EAAE,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC;KAC3D,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,SAAgB,MAAM,CAAC,GAAY;IACjC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;AACpC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { AzureLogger, AzureLogLevel, Debugger } from \"@azure/logger\";\nimport { createClientLogger } from \"@azure/logger\";\nimport { isObjectWithProperties } from \"@azure/core-util\";\n\n/**\n * The `@azure/logger` configuration for this package.\n * This will output logs using the `azure:event-hubs` namespace prefix.\n */\nexport const logger = createClientLogger(\"event-hubs\");\n\n/**\n * Logs the error's stack trace to \"verbose\" if a stack trace is available.\n * @param error - Error containing a stack trace.\n * @internal\n */\nexport function logErrorStackTrace(error: unknown): void {\n  if (isObjectWithProperties(error, [\"stack\"])) {\n    logger.verbose(error.stack);\n  }\n}\n\n/**\n * @internal\n */\nexport function createReceiverLogPrefix(\n  consumerId: string,\n  connectionId: string,\n  partitionId: string,\n): string {\n  return `[${connectionId}] Receiver P${partitionId}-${consumerId}`;\n}\n\n/**\n * @internal\n */\nexport function createSenderLogPrefix(senderId: string, connectionId: string): string {\n  return `[${connectionId}] Sender ${senderId}`;\n}\n\n/**\n * @internal\n */\nexport function createManagementLogPrefix(connectionId: string): string {\n  return `[${connectionId}] Management`;\n}\n\n/**\n * @internal\n */\nexport type SimpleLogger = {\n  [Property in keyof AzureLogger]: Debugger[\"log\"];\n};\n\nfunction createLogFunction(\n  azureLogger: AzureLogger,\n  prefix: string,\n  level: AzureLogLevel,\n): (arg: any, ...args: any[]) => void {\n  return (arg: any, ...args: any[]) =>\n    azureLogger[level](\n      ...(typeof arg === \"string\" ? [`${prefix}: ${arg}`] : [prefix, arg]),\n      ...args,\n    );\n}\n\n/**\n * @internal\n */\nexport function createSimpleLogger(azureLogger: AzureLogger, prefix: string): SimpleLogger {\n  return {\n    info: createLogFunction(azureLogger, prefix, \"info\"),\n    error: createLogFunction(azureLogger, prefix, \"error\"),\n    verbose: createLogFunction(azureLogger, prefix, \"verbose\"),\n    warning: createLogFunction(azureLogger, prefix, \"warning\"),\n  };\n}\n\n/** @internal */\nexport function logObj(obj: unknown): void {\n  JSON.stringify(obj, undefined, 2);\n}\n"]}

package/dist/commonjs/managementClient.d.ts

@@ -0,0 +1,145 @@
+import type { RetryOptions } from "@azure/core-amqp";
+import type { AccessToken } from "@azure/core-auth";
+import type { ConnectionContext } from "./connectionContext.js";
+import type { OperationOptions } from "./util/operationOptions.js";
+/**
+ * Describes the runtime information of an Event Hub.
+ */
+export interface EventHubProperties {
+    /**
+     * The name of the event hub.
+     */
+    name: string;
+    /**
+     * The date and time the hub was created in UTC.
+     */
+    createdOn: Date;
+    /**
+     * The slice of string partition identifiers.
+     */
+    partitionIds: string[];
+    /**
+     * Whether the hub has geographical disaster recovery enabled.
+     */
+    isGeoDrEnabled: boolean;
+}
+/**
+ * Describes the runtime information of an EventHub Partition.
+ */
+export interface PartitionProperties {
+    /**
+     * The name of the Event Hub.
+     */
+    eventHubName: string;
+    /**
+     * Identifier of the partition within the Event Hub.
+     */
+    partitionId: string;
+    /**
+     * The starting sequence number of the partition's message log.
+     */
+    beginningSequenceNumber: number;
+    /**
+     * The last sequence number of the partition's message log.
+     */
+    lastEnqueuedSequenceNumber: number;
+    /**
+     * The offset of the last enqueued message in the partition's message log.
+     */
+    lastEnqueuedOffset: string;
+    /**
+     * The time of the last enqueued message in the partition's message log in UTC.
+     */
+    lastEnqueuedOnUtc: Date;
+    /**
+     * Indicates whether the partition is empty.
+     */
+    isEmpty: boolean;
+}
+/**
+ * @internal
+ */
+export interface ManagementClientOptions {
+    address?: string;
+    audience?: string;
+}
+/**
+ * @internal
+ * Describes the EventHubs Management Client that talks
+ * to the $management endpoint over AMQP connection.
+ */
+export declare class ManagementClient {
+    readonly managementLock: string;
+    /**
+     * The name/path of the entity (hub name) for which the management
+     * request needs to be made.
+     */
+    private readonly entityPath;
+    /**
+     * The reply to Guid for the management client.
+     */
+    private readonly replyTo;
+    /**
+     * $management sender, receiver on the same session.
+     */
+    private _mgmtReqResLink?;
+    /**
+     * The address in the following form:
+     * `"$management"`.
+     */
+    private readonly address;
+    /**
+     * The token audience in the following form:
+     * `"sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/$management"`.
+     */
+    private readonly audience;
+    /**
+     * Provides relevant information about the amqp connection,
+     * cbs and $management sessions, token provider, sender and receivers.
+     */
+    private readonly _context;
+    /**
+     * The authentication loop that keeps the token refreshed.
+     */
+    private authLoop?;
+    private readonly logger;
+    /**
+     * Instantiates the management client.
+     * @param context - The connection context.
+     * @param address - The address for the management endpoint. For IotHub it will be
+     * `/messages/events/$management`.
+     */
+    constructor(context: ConnectionContext, { address, audience }?: ManagementClientOptions);
+    /**
+     * Gets the security token for the management application properties.
+     * @internal
+     */
+    getSecurityToken(): Promise<AccessToken | null>;
+    /**
+     * Provides the eventhub runtime information.
+     */
+    getEventHubProperties(options?: OperationOptions & {
+        retryOptions?: RetryOptions;
+    }): Promise<EventHubProperties>;
+    /**
+     * Provides information about the specified partition.
+     * @param partitionId - Partition ID for which partition information is required.
+     */
+    getPartitionProperties(partitionId: string, options?: OperationOptions & {
+        retryOptions?: RetryOptions;
+    }): Promise<PartitionProperties>;
+    /**
+     * Closes the AMQP management session to the Event Hub for this client,
+     * returning a promise that will be resolved when disconnection is completed.
+     */
+    close(): Promise<void>;
+    private _init;
+    /**
+     * Helper method to make the management request
+     * @param request - The AMQP message to send
+     * @param options - The options to use when sending a request over a $management link
+     */
+    private _makeManagementRequest;
+    private _isMgmtRequestResponseLinkOpen;
+}
+//# sourceMappingURL=managementClient.d.ts.map

package/dist/commonjs/managementClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"managementClient.d.ts","sourceRoot":"","sources":["../../src/managementClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAe,YAAY,EAAsB,MAAM,kBAAkB,CAAC;AAqBtF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAOnE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,0BAA0B,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,iBAAiB,EAAE,IAAI,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,gBAAgB;IAC3B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAiD;IAChF;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IACnD;;OAEG;IACH,OAAO,CAAC,eAAe,CAAC,CAAsB;IAC9C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAoB;IAC7C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,CAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IAEtC;;;;;OAKG;gBACS,OAAO,EAAE,iBAAiB,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAE,uBAA4B;IAS3F;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAiBrD;;OAEG;IACG,qBAAqB,CACzB,OAAO,GAAE,gBAAgB,GAAG;QAAE,YAAY,CAAC,EAAE,YAAY,CAAA;KAAO,GAC/D,OAAO,CAAC,kBAAkB,CAAC;IA8C9B;;;OAGG;IACG,sBAAsB,CAC1B,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,gBAAgB,GAAG;QAAE,YAAY,CAAC,EAAE,YAAY,CAAA;KAAO,GAC/D,OAAO,CAAC,mBAAmB,CAAC;IAyD/B;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAkBd,KAAK;IAuEnB;;;;OAIG;YACW,sBAAsB;IA6FpC,OAAO,CAAC,8BAA8B;CAGvC"}

package/dist/commonjs/managementClient.js

@@ -0,0 +1,275 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManagementClient = void 0;
+const core_amqp_1 = require("@azure/core-amqp");
+const rhea_promise_1 = require("rhea-promise");
+const logger_js_1 = require("./logger.js");
+const error_js_1 = require("./util/error.js");
+const tracing_js_1 = require("./diagnostics/tracing.js");
+const retries_js_1 = require("./util/retries.js");
+const withAuth_js_1 = require("./withAuth.js");
+const utils_js_1 = require("./util/utils.js");
+/**
+ * @internal
+ * Describes the EventHubs Management Client that talks
+ * to the $management endpoint over AMQP connection.
+ */
+class ManagementClient {
+    /**
+     * Instantiates the management client.
+     * @param context - The connection context.
+     * @param address - The address for the management endpoint. For IotHub it will be
+     * `/messages/events/$management`.
+     */
+    constructor(context, { address, audience } = {}) {
+        this.managementLock = (0, utils_js_1.getRandomName)(core_amqp_1.Constants.managementRequestKey);
+        /**
+         * The reply to Guid for the management client.
+         */
+        this.replyTo = (0, utils_js_1.getRandomName)();
+        this.address = address !== null && address !== void 0 ? address : core_amqp_1.Constants.management;
+        this.audience = audience !== null && audience !== void 0 ? audience : context.config.getManagementAudience();
+        this._context = context;
+        const logPrefix = (0, logger_js_1.createManagementLogPrefix)(this._context.connectionId);
+        this.logger = (0, logger_js_1.createSimpleLogger)(logger_js_1.logger, logPrefix);
+        this.entityPath = context.config.entityPath;
+    }
+    /**
+     * Gets the security token for the management application properties.
+     * @internal
+     */
+    async getSecurityToken() {
+        if ((0, core_amqp_1.isSasTokenProvider)(this._context.tokenCredential)) {
+            // the security_token has the $management address removed from the end of the audience
+            // expected audience: sb://fully.qualified.namespace/event-hub-name/$management
+            const audienceParts = this.audience.split("/");
+            // for management links, address should be '$management'
+            if (audienceParts[audienceParts.length - 1] === this.address) {
+                audienceParts.pop();
+            }
+            const audience = audienceParts.join("/");
+            return this._context.tokenCredential.getToken(audience);
+        }
+        // aad credentials use the aad scope
+        return this._context.tokenCredential.getToken(core_amqp_1.Constants.aadEventHubsScope);
+    }
+    /**
+     * Provides the eventhub runtime information.
+     */
+    async getEventHubProperties(options = {}) {
+        (0, error_js_1.throwErrorIfConnectionClosed)(this._context);
+        return tracing_js_1.tracingClient.withSpan("ManagementClient.getEventHubProperties", options, async (updatedOptions) => {
+            try {
+                const securityToken = await this.getSecurityToken();
+                const request = {
+                    body: Buffer.from(JSON.stringify([])),
+                    message_id: (0, utils_js_1.getRandomName)(),
+                    reply_to: this.replyTo,
+                    application_properties: {
+                        operation: core_amqp_1.Constants.readOperation,
+                        name: this.entityPath,
+                        type: `${core_amqp_1.Constants.vendorString}:${core_amqp_1.Constants.eventHub}`,
+                        security_token: securityToken === null || securityToken === void 0 ? void 0 : securityToken.token,
+                    },
+                };
+                const info = await this._makeManagementRequest(request, Object.assign(Object.assign({}, updatedOptions), { requestName: "getHubRuntimeInformation" }));
+                const runtimeInfo = {
+                    name: info.name,
+                    createdOn: new Date(info.created_at),
+                    partitionIds: info.partition_ids,
+                    isGeoDrEnabled: info.georeplication_factor > 1,
+                };
+                logger_js_1.logger.verbose("the hub runtime info is: %O", runtimeInfo);
+                return runtimeInfo;
+            }
+            catch (error) {
+                logger_js_1.logger.warning(`an error occurred while getting the hub runtime information: ${error === null || error === void 0 ? void 0 : error.name}: ${error === null || error === void 0 ? void 0 : error.message}`);
+                (0, logger_js_1.logErrorStackTrace)(error);
+                throw error;
+            }
+        }, (0, tracing_js_1.toSpanOptions)(this._context.config));
+    }
+    /**
+     * Provides information about the specified partition.
+     * @param partitionId - Partition ID for which partition information is required.
+     */
+    async getPartitionProperties(partitionId, options = {}) {
+        (0, error_js_1.throwErrorIfConnectionClosed)(this._context);
+        (0, error_js_1.throwTypeErrorIfParameterMissing)(this._context.connectionId, "getPartitionProperties", "partitionId", partitionId);
+        partitionId = String(partitionId);
+        return tracing_js_1.tracingClient.withSpan("ManagementClient.getPartitionProperties", options, async (updatedOptions) => {
+            try {
+                const securityToken = await this.getSecurityToken();
+                const request = {
+                    body: Buffer.from(JSON.stringify([])),
+                    message_id: (0, utils_js_1.getRandomName)(),
+                    reply_to: this.replyTo,
+                    application_properties: {
+                        operation: core_amqp_1.Constants.readOperation,
+                        name: this.entityPath,
+                        type: `${core_amqp_1.Constants.vendorString}:${core_amqp_1.Constants.partition}`,
+                        partition: `${partitionId}`,
+                        security_token: securityToken === null || securityToken === void 0 ? void 0 : securityToken.token,
+                    },
+                };
+                const info = await this._makeManagementRequest(request, Object.assign(Object.assign({}, updatedOptions), { requestName: "getPartitionInformation" }));
+                const partitionInfo = {
+                    beginningSequenceNumber: info.begin_sequence_number,
+                    eventHubName: info.name,
+                    lastEnqueuedOffset: info.last_enqueued_offset,
+                    lastEnqueuedOnUtc: new Date(info.last_enqueued_time_utc),
+                    lastEnqueuedSequenceNumber: info.last_enqueued_sequence_number,
+                    partitionId: info.partition,
+                    isEmpty: info.is_partition_empty,
+                };
+                logger_js_1.logger.verbose("the partition info is: %O.", partitionInfo);
+                return partitionInfo;
+            }
+            catch (error) {
+                logger_js_1.logger.warning(`an error occurred while getting the partition information: ${error === null || error === void 0 ? void 0 : error.name}: ${error === null || error === void 0 ? void 0 : error.message}`);
+                (0, logger_js_1.logErrorStackTrace)(error);
+                throw error;
+            }
+        }, (0, tracing_js_1.toSpanOptions)(this._context.config));
+    }
+    /**
+     * Closes the AMQP management session to the Event Hub for this client,
+     * returning a promise that will be resolved when disconnection is completed.
+     */
+    async close() {
+        var _a;
+        try {
+            // Always stop the auth loop when closing the management link.
+            (_a = this.authLoop) === null || _a === void 0 ? void 0 : _a.stop();
+            if (this._isMgmtRequestResponseLinkOpen()) {
+                const mgmtLink = this._mgmtReqResLink;
+                this._mgmtReqResLink = undefined;
+                await mgmtLink.close();
+                logger_js_1.logger.info("successfully closed the management session.");
+            }
+        }
+        catch (err) {
+            const msg = `an error occurred while closing the management session: ${err === null || err === void 0 ? void 0 : err.name}: ${err === null || err === void 0 ? void 0 : err.message}`;
+            logger_js_1.logger.warning(msg);
+            (0, logger_js_1.logErrorStackTrace)(err);
+            throw new Error(msg);
+        }
+    }
+    async _init({ abortSignal, timeoutInMs, }) {
+        const createLink = async () => {
+            const rxopt = {
+                source: { address: this.address },
+                name: this.replyTo,
+                target: { address: this.replyTo },
+                onSessionError: (context) => {
+                    const ehError = (0, core_amqp_1.translate)(context.session.error);
+                    logger_js_1.logger.verbose("an error occurred on the session for request/response links for " + "$management: %O", ehError);
+                },
+            };
+            const sropt = {
+                target: { address: this.address },
+            };
+            logger_js_1.logger.verbose("creating sender/receiver links with " + "srOpts: %o, receiverOpts: %O.", sropt, rxopt);
+            this._mgmtReqResLink = await core_amqp_1.RequestResponseLink.create(this._context.connection, sropt, rxopt, { abortSignal });
+            this._mgmtReqResLink.sender.on(rhea_promise_1.SenderEvents.senderError, (context) => {
+                const ehError = (0, core_amqp_1.translate)(context.sender.error);
+                logger_js_1.logger.verbose("an error occurred on the $management sender link.. %O", ehError);
+            });
+            this._mgmtReqResLink.receiver.on(rhea_promise_1.ReceiverEvents.receiverError, (context) => {
+                const ehError = (0, core_amqp_1.translate)(context.receiver.error);
+                logger_js_1.logger.verbose("an error occurred on the $management receiver link.. %O", ehError);
+            });
+            logger_js_1.logger.verbose("created sender '%s' and receiver '%s' links", this._mgmtReqResLink.sender.name, this._mgmtReqResLink.receiver.name);
+        };
+        try {
+            if (!this._isMgmtRequestResponseLinkOpen()) {
+                // Wait for the connectionContext to be ready to open the link.
+                await this._context.readyToOpenLink();
+                this.authLoop = await (0, withAuth_js_1.withAuth)(createLink, this._context, this.audience, timeoutInMs, this.logger, { abortSignal });
+            }
+        }
+        catch (err) {
+            const translatedError = (0, core_amqp_1.translate)(err);
+            logger_js_1.logger.warning(`an error occurred while establishing the links: ${translatedError === null || translatedError === void 0 ? void 0 : translatedError.name}: ${translatedError === null || translatedError === void 0 ? void 0 : translatedError.message}`);
+            (0, logger_js_1.logErrorStackTrace)(translatedError);
+            throw translatedError;
+        }
+    }
+    /**
+     * Helper method to make the management request
+     * @param request - The AMQP message to send
+     * @param options - The options to use when sending a request over a $management link
+     */
+    async _makeManagementRequest(request, options = {}) {
+        const retryOptions = options.retryOptions || {};
+        try {
+            const abortSignal = options && options.abortSignal;
+            const sendOperationPromise = async () => {
+                let count = 0;
+                const retryTimeoutInMs = (0, retries_js_1.getRetryAttemptTimeoutInMs)(options.retryOptions);
+                let timeTakenByInit = 0;
+                if (!this._isMgmtRequestResponseLinkOpen()) {
+                    logger_js_1.logger.verbose("acquiring lock to get the management req res link.");
+                    const initOperationStartTime = Date.now();
+                    try {
+                        await core_amqp_1.defaultCancellableLock.acquire(this.managementLock, () => {
+                            const acquireLockEndTime = Date.now();
+                            const timeoutInMs = retryTimeoutInMs - (acquireLockEndTime - initOperationStartTime);
+                            return this._init({ abortSignal, timeoutInMs });
+                        }, { abortSignal, timeoutInMs: retryTimeoutInMs });
+                    }
+                    catch (err) {
+                        const translatedError = (0, core_amqp_1.translate)(err);
+                        logger_js_1.logger.warning("an error occurred while creating the link: %s", `${translatedError === null || translatedError === void 0 ? void 0 : translatedError.name}: ${translatedError === null || translatedError === void 0 ? void 0 : translatedError.message}`);
+                        (0, logger_js_1.logErrorStackTrace)(translatedError);
+                        throw translatedError;
+                    }
+                    timeTakenByInit = Date.now() - initOperationStartTime;
+                }
+                const remainingOperationTimeoutInMs = retryTimeoutInMs - timeTakenByInit;
+                const sendRequestOptions = {
+                    abortSignal: options.abortSignal,
+                    requestName: options.requestName,
+                    timeoutInMs: remainingOperationTimeoutInMs,
+                };
+                count++;
+                if (count !== 1) {
+                    // Generate a new message_id every time after the first attempt
+                    request.message_id = (0, utils_js_1.getRandomName)();
+                }
+                else if (!request.message_id) {
+                    // Set the message_id in the first attempt only if it is not set
+                    request.message_id = (0, utils_js_1.getRandomName)();
+                }
+                return this._mgmtReqResLink.sendRequest(request, sendRequestOptions);
+            };
+            const config = Object.defineProperties({
+                operation: sendOperationPromise,
+                operationType: core_amqp_1.RetryOperationType.management,
+                abortSignal: abortSignal,
+                retryOptions: retryOptions,
+            }, {
+                connectionId: {
+                    enumerable: true,
+                    get: () => {
+                        return this._context.connectionId;
+                    },
+                },
+            });
+            return (await (0, core_amqp_1.retry)(config)).body;
+        }
+        catch (err) {
+            const translatedError = (0, core_amqp_1.translate)(err);
+            logger_js_1.logger.warning("an error occurred during send on management request-response link with address: %s", `${translatedError === null || translatedError === void 0 ? void 0 : translatedError.name}: ${translatedError === null || translatedError === void 0 ? void 0 : translatedError.message}`);
+            (0, logger_js_1.logErrorStackTrace)(translatedError);
+            throw translatedError;
+        }
+    }
+    _isMgmtRequestResponseLinkOpen() {
+        return this._mgmtReqResLink && this._mgmtReqResLink.isOpen();
+    }
+}
+exports.ManagementClient = ManagementClient;
+//# sourceMappingURL=managementClient.js.map

package/dist/commonjs/managementClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"managementClient.js","sourceRoot":"","sources":["../../src/managementClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,gDAQ0B;AAE1B,+CAA4D;AAE5D,2CAKqB;AACrB,8CAAiG;AAKjG,yDAAwE;AACxE,kDAA+D;AAE/D,+CAAyC;AACzC,8CAAgD;AAkEhD;;;;GAIG;AACH,MAAa,gBAAgB;IAoC3B;;;;;OAKG;IACH,YAAY,OAA0B,EAAE,EAAE,OAAO,EAAE,QAAQ,KAA8B,EAAE;QAzClF,mBAAc,GAAW,IAAA,wBAAa,EAAC,qBAAS,CAAC,oBAAoB,CAAC,CAAC;QAMhF;;WAEG;QACc,YAAO,GAAW,IAAA,wBAAa,GAAE,CAAC;QAiCjD,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,qBAAS,CAAC,UAAU,CAAC;QAC/C,IAAI,CAAC,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,OAAO,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC;QACnE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,MAAM,SAAS,GAAG,IAAA,qCAAyB,EAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM,GAAG,IAAA,8BAAkB,EAAC,kBAAM,EAAE,SAAS,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,UAAoB,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACpB,IAAI,IAAA,8BAAkB,EAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YACtD,sFAAsF;YACtF,+EAA+E;YAC/E,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC/C,wDAAwD;YACxD,IAAI,aAAa,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC7D,aAAa,CAAC,GAAG,EAAE,CAAC;YACtB,CAAC;YACD,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACzC,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC1D,CAAC;QAED,oCAAoC;QACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,qBAAS,CAAC,iBAAiB,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,qBAAqB,CACzB,UAA8D,EAAE;QAEhE,IAAA,uCAA4B,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,OAAO,0BAAa,CAAC,QAAQ,CAC3B,wCAAwC,EACxC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,IAAI,CAAC;gBACH,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAEpD,MAAM,OAAO,GAAY;oBACvB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;oBACrC,UAAU,EAAE,IAAA,wBAAa,GAAE;oBAC3B,QAAQ,EAAE,IAAI,CAAC,OAAO;oBACtB,sBAAsB,EAAE;wBACtB,SAAS,EAAE,qBAAS,CAAC,aAAa;wBAClC,IAAI,EAAE,IAAI,CAAC,UAAoB;wBAC/B,IAAI,EAAE,GAAG,qBAAS,CAAC,YAAY,IAAI,qBAAS,CAAC,QAAQ,EAAE;wBACvD,cAAc,EAAE,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,KAAK;qBACrC;iBACF,CAAC;gBAEF,MAAM,IAAI,GAAQ,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,kCACtD,cAAc,KACjB,WAAW,EAAE,0BAA0B,IACvC,CAAC;gBACH,MAAM,WAAW,GAAuB;oBACtC,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;oBACpC,YAAY,EAAE,IAAI,CAAC,aAAa;oBAChC,cAAc,EAAE,IAAI,CAAC,qBAAqB,GAAG,CAAC;iBAC/C,CAAC;gBACF,kBAAM,CAAC,OAAO,CAAC,6BAA6B,EAAE,WAAW,CAAC,CAAC;gBAE3D,OAAO,WAAW,CAAC;YACrB,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,kBAAM,CAAC,OAAO,CACZ,gEAAgE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,KAAK,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,EAAE,CACjG,CAAC;gBACF,IAAA,8BAAkB,EAAC,KAAK,CAAC,CAAC;gBAC1B,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC,EACD,IAAA,0BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CACpC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAC1B,WAAmB,EACnB,UAA8D,EAAE;QAEhE,IAAA,uCAA4B,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAA,2CAAgC,EAC9B,IAAI,CAAC,QAAQ,CAAC,YAAY,EAC1B,wBAAwB,EACxB,aAAa,EACb,WAAW,CACZ,CAAC;QACF,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAElC,OAAO,0BAAa,CAAC,QAAQ,CAC3B,yCAAyC,EACzC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,IAAI,CAAC;gBACH,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACpD,MAAM,OAAO,GAAY;oBACvB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;oBACrC,UAAU,EAAE,IAAA,wBAAa,GAAE;oBAC3B,QAAQ,EAAE,IAAI,CAAC,OAAO;oBACtB,sBAAsB,EAAE;wBACtB,SAAS,EAAE,qBAAS,CAAC,aAAa;wBAClC,IAAI,EAAE,IAAI,CAAC,UAAoB;wBAC/B,IAAI,EAAE,GAAG,qBAAS,CAAC,YAAY,IAAI,qBAAS,CAAC,SAAS,EAAE;wBACxD,SAAS,EAAE,GAAG,WAAW,EAAE;wBAC3B,cAAc,EAAE,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,KAAK;qBACrC;iBACF,CAAC;gBAEF,MAAM,IAAI,GAAQ,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,kCACtD,cAAc,KACjB,WAAW,EAAE,yBAAyB,IACtC,CAAC;gBAEH,MAAM,aAAa,GAAwB;oBACzC,uBAAuB,EAAE,IAAI,CAAC,qBAAqB;oBACnD,YAAY,EAAE,IAAI,CAAC,IAAI;oBACvB,kBAAkB,EAAE,IAAI,CAAC,oBAAoB;oBAC7C,iBAAiB,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC;oBACxD,0BAA0B,EAAE,IAAI,CAAC,6BAA6B;oBAC9D,WAAW,EAAE,IAAI,CAAC,SAAS;oBAC3B,OAAO,EAAE,IAAI,CAAC,kBAAkB;iBACjC,CAAC;gBACF,kBAAM,CAAC,OAAO,CAAC,4BAA4B,EAAE,aAAa,CAAC,CAAC;gBAC5D,OAAO,aAAa,CAAC;YACvB,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,kBAAM,CAAC,OAAO,CACZ,8DAA8D,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,KAAK,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,EAAE,CAC/F,CAAC;gBACF,IAAA,8BAAkB,EAAC,KAAK,CAAC,CAAC;gBAC1B,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC,EACD,IAAA,0BAAa,EAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CACpC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK;;QACT,IAAI,CAAC;YACH,8DAA8D;YAC9D,MAAA,IAAI,CAAC,QAAQ,0CAAE,IAAI,EAAE,CAAC;YACtB,IAAI,IAAI,CAAC,8BAA8B,EAAE,EAAE,CAAC;gBAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC;gBACtC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;gBACjC,MAAM,QAAS,CAAC,KAAK,EAAE,CAAC;gBACxB,kBAAM,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,GAAG,GAAG,2DAA2D,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,KAAK,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,EAAE,CAAC;YACpG,kBAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACpB,IAAA,8BAAkB,EAAC,GAAG,CAAC,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,KAAK,CAAC,EAClB,WAAW,EACX,WAAW,GAIZ;QACC,MAAM,UAAU,GAAG,KAAK,IAAI,EAAE;YAC5B,MAAM,KAAK,GAAoB;gBAC7B,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;gBACjC,IAAI,EAAE,IAAI,CAAC,OAAO;gBAClB,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;gBACjC,cAAc,EAAE,CAAC,OAAqB,EAAE,EAAE;oBACxC,MAAM,OAAO,GAAG,IAAA,qBAAS,EAAC,OAAO,CAAC,OAAQ,CAAC,KAAM,CAAC,CAAC;oBACnD,kBAAM,CAAC,OAAO,CACZ,kEAAkE,GAAG,iBAAiB,EACtF,OAAO,CACR,CAAC;gBACJ,CAAC;aACF,CAAC;YACF,MAAM,KAAK,GAAkB;gBAC3B,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;aAClC,CAAC;YACF,kBAAM,CAAC,OAAO,CACZ,sCAAsC,GAAG,+BAA+B,EACxE,KAAK,EACL,KAAK,CACN,CAAC;YACF,IAAI,CAAC,eAAe,GAAG,MAAM,+BAAmB,CAAC,MAAM,CACrD,IAAI,CAAC,QAAQ,CAAC,UAAU,EACxB,KAAK,EACL,KAAK,EACL,EAAE,WAAW,EAAE,CAChB,CAAC;YACF,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC,2BAAY,CAAC,WAAW,EAAE,CAAC,OAAqB,EAAE,EAAE;gBACjF,MAAM,OAAO,GAAG,IAAA,qBAAS,EAAC,OAAO,CAAC,MAAO,CAAC,KAAM,CAAC,CAAC;gBAClD,kBAAM,CAAC,OAAO,CAAC,uDAAuD,EAAE,OAAO,CAAC,CAAC;YACnF,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,6BAAc,CAAC,aAAa,EAAE,CAAC,OAAqB,EAAE,EAAE;gBACvF,MAAM,OAAO,GAAG,IAAA,qBAAS,EAAC,OAAO,CAAC,QAAS,CAAC,KAAM,CAAC,CAAC;gBACpD,kBAAM,CAAC,OAAO,CAAC,yDAAyD,EAAE,OAAO,CAAC,CAAC;YACrF,CAAC,CAAC,CAAC;YACH,kBAAM,CAAC,OAAO,CACZ,6CAA6C,EAC7C,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,EAChC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CACnC,CAAC;QACJ,CAAC,CAAC;QACF,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,CAAC;gBAC3C,+DAA+D;gBAC/D,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC;gBACtC,IAAI,CAAC,QAAQ,GAAG,MAAM,IAAA,sBAAQ,EAC5B,UAAU,EACV,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,QAAQ,EACb,WAAW,EACX,IAAI,CAAC,MAAM,EACX,EAAE,WAAW,EAAE,CAChB,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,eAAe,GAAG,IAAA,qBAAS,EAAC,GAAG,CAAC,CAAC;YACvC,kBAAM,CAAC,OAAO,CACZ,mDAAmD,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,KAAK,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,EAAE,CACxG,CAAC;YACF,IAAA,8BAAkB,EAAC,eAAe,CAAC,CAAC;YACpC,MAAM,eAAe,CAAC;QACxB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,sBAAsB,CAClC,OAAgB,EAChB,UAII,EAAE;QAEN,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;QAChD,IAAI,CAAC;YACH,MAAM,WAAW,GAAgC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC;YAEhF,MAAM,oBAAoB,GAAG,KAAK,IAAsB,EAAE;gBACxD,IAAI,KAAK,GAAG,CAAC,CAAC;gBAEd,MAAM,gBAAgB,GAAG,IAAA,uCAA0B,EAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBAC1E,IAAI,eAAe,GAAG,CAAC,CAAC;gBAExB,IAAI,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,CAAC;oBAC3C,kBAAM,CAAC,OAAO,CAAC,oDAAoD,CAAC,CAAC;oBAErE,MAAM,sBAAsB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC1C,IAAI,CAAC;wBACH,MAAM,kCAAsB,CAAC,OAAO,CAClC,IAAI,CAAC,cAAc,EACnB,GAAG,EAAE;4BACH,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;4BACtC,MAAM,WAAW,GACf,gBAAgB,GAAG,CAAC,kBAAkB,GAAG,sBAAsB,CAAC,CAAC;4BACnE,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;wBAClD,CAAC,EACD,EAAE,WAAW,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAC/C,CAAC;oBACJ,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,MAAM,eAAe,GAAG,IAAA,qBAAS,EAAC,GAAG,CAAC,CAAC;wBACvC,kBAAM,CAAC,OAAO,CACZ,+CAA+C,EAC/C,GAAG,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,KAAK,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,EAAE,CACxD,CAAC;wBACF,IAAA,8BAAkB,EAAC,eAAe,CAAC,CAAC;wBACpC,MAAM,eAAe,CAAC;oBACxB,CAAC;oBACD,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,sBAAsB,CAAC;gBACxD,CAAC;gBAED,MAAM,6BAA6B,GAAG,gBAAgB,GAAG,eAAe,CAAC;gBAEzE,MAAM,kBAAkB,GAAuB;oBAC7C,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,WAAW,EAAE,6BAA6B;iBAC3C,CAAC;gBAEF,KAAK,EAAE,CAAC;gBACR,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBAChB,+DAA+D;oBAC/D,OAAO,CAAC,UAAU,GAAG,IAAA,wBAAa,GAAE,CAAC;gBACvC,CAAC;qBAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;oBAC/B,gEAAgE;oBAChE,OAAO,CAAC,UAAU,GAAG,IAAA,wBAAa,GAAE,CAAC;gBACvC,CAAC;gBAED,OAAO,IAAI,CAAC,eAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;YACxE,CAAC,CAAC;YAEF,MAAM,MAAM,GAAyB,MAAM,CAAC,gBAAgB,CAC1D;gBACE,SAAS,EAAE,oBAAoB;gBAC/B,aAAa,EAAE,8BAAkB,CAAC,UAAU;gBAC5C,WAAW,EAAE,WAAW;gBACxB,YAAY,EAAE,YAAY;aAC3B,EACD;gBACE,YAAY,EAAE;oBACZ,UAAU,EAAE,IAAI;oBAChB,GAAG,EAAE,GAAG,EAAE;wBACR,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;oBACpC,CAAC;iBACF;aACF,CACsB,CAAC;YAC1B,OAAO,CAAC,MAAM,IAAA,iBAAK,EAAU,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,eAAe,GAAG,IAAA,qBAAS,EAAC,GAAG,CAAC,CAAC;YACvC,kBAAM,CAAC,OAAO,CACZ,oFAAoF,EACpF,GAAG,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,KAAK,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,EAAE,CACxD,CAAC;YACF,IAAA,8BAAkB,EAAC,eAAe,CAAC,CAAC;YACpC,MAAM,eAAe,CAAC;QACxB,CAAC;IACH,CAAC;IAEO,8BAA8B;QACpC,OAAO,IAAI,CAAC,eAAgB,IAAI,IAAI,CAAC,eAAgB,CAAC,MAAM,EAAE,CAAC;IACjE,CAAC;CACF;AA7XD,4CA6XC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { RetryConfig, RetryOptions, SendRequestOptions } from \"@azure/core-amqp\";\nimport {\n  Constants,\n  RequestResponseLink,\n  RetryOperationType,\n  defaultCancellableLock,\n  isSasTokenProvider,\n  retry,\n  translate,\n} from \"@azure/core-amqp\";\nimport type { EventContext, Message, ReceiverOptions, SenderOptions } from \"rhea-promise\";\nimport { ReceiverEvents, SenderEvents } from \"rhea-promise\";\nimport type { SimpleLogger } from \"./logger.js\";\nimport {\n  logErrorStackTrace,\n  createSimpleLogger,\n  logger,\n  createManagementLogPrefix,\n} from \"./logger.js\";\nimport { throwErrorIfConnectionClosed, throwTypeErrorIfParameterMissing } from \"./util/error.js\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport type { AccessToken } from \"@azure/core-auth\";\nimport type { ConnectionContext } from \"./connectionContext.js\";\nimport type { OperationOptions } from \"./util/operationOptions.js\";\nimport { toSpanOptions, tracingClient } from \"./diagnostics/tracing.js\";\nimport { getRetryAttemptTimeoutInMs } from \"./util/retries.js\";\nimport type { TimerLoop } from \"./util/timerLoop.js\";\nimport { withAuth } from \"./withAuth.js\";\nimport { getRandomName } from \"./util/utils.js\";\n\n/**\n * Describes the runtime information of an Event Hub.\n */\nexport interface EventHubProperties {\n  /**\n   * The name of the event hub.\n   */\n  name: string;\n  /**\n   * The date and time the hub was created in UTC.\n   */\n  createdOn: Date;\n  /**\n   * The slice of string partition identifiers.\n   */\n  partitionIds: string[];\n  /**\n   * Whether the hub has geographical disaster recovery enabled.\n   */\n  isGeoDrEnabled: boolean;\n}\n\n/**\n * Describes the runtime information of an EventHub Partition.\n */\nexport interface PartitionProperties {\n  /**\n   * The name of the Event Hub.\n   */\n  eventHubName: string;\n  /**\n   * Identifier of the partition within the Event Hub.\n   */\n  partitionId: string;\n  /**\n   * The starting sequence number of the partition's message log.\n   */\n  beginningSequenceNumber: number;\n  /**\n   * The last sequence number of the partition's message log.\n   */\n  lastEnqueuedSequenceNumber: number;\n  /**\n   * The offset of the last enqueued message in the partition's message log.\n   */\n  lastEnqueuedOffset: string;\n  /**\n   * The time of the last enqueued message in the partition's message log in UTC.\n   */\n  lastEnqueuedOnUtc: Date;\n  /**\n   * Indicates whether the partition is empty.\n   */\n  isEmpty: boolean;\n}\n\n/**\n * @internal\n */\nexport interface ManagementClientOptions {\n  address?: string;\n  audience?: string;\n}\n\n/**\n * @internal\n * Describes the EventHubs Management Client that talks\n * to the $management endpoint over AMQP connection.\n */\nexport class ManagementClient {\n  readonly managementLock: string = getRandomName(Constants.managementRequestKey);\n  /**\n   * The name/path of the entity (hub name) for which the management\n   * request needs to be made.\n   */\n  private readonly entityPath: string;\n  /**\n   * The reply to Guid for the management client.\n   */\n  private readonly replyTo: string = getRandomName();\n  /**\n   * $management sender, receiver on the same session.\n   */\n  private _mgmtReqResLink?: RequestResponseLink;\n  /**\n   * The address in the following form:\n   * `\"$management\"`.\n   */\n  private readonly address: string;\n  /**\n   * The token audience in the following form:\n   * `\"sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/$management\"`.\n   */\n  private readonly audience: string;\n  /**\n   * Provides relevant information about the amqp connection,\n   * cbs and $management sessions, token provider, sender and receivers.\n   */\n  private readonly _context: ConnectionContext;\n  /**\n   * The authentication loop that keeps the token refreshed.\n   */\n  private authLoop?: TimerLoop;\n  private readonly logger: SimpleLogger;\n\n  /**\n   * Instantiates the management client.\n   * @param context - The connection context.\n   * @param address - The address for the management endpoint. For IotHub it will be\n   * `/messages/events/$management`.\n   */\n  constructor(context: ConnectionContext, { address, audience }: ManagementClientOptions = {}) {\n    this.address = address ?? Constants.management;\n    this.audience = audience ?? context.config.getManagementAudience();\n    this._context = context;\n    const logPrefix = createManagementLogPrefix(this._context.connectionId);\n    this.logger = createSimpleLogger(logger, logPrefix);\n    this.entityPath = context.config.entityPath as string;\n  }\n\n  /**\n   * Gets the security token for the management application properties.\n   * @internal\n   */\n  async getSecurityToken(): Promise<AccessToken | null> {\n    if (isSasTokenProvider(this._context.tokenCredential)) {\n      // the security_token has the $management address removed from the end of the audience\n      // expected audience: sb://fully.qualified.namespace/event-hub-name/$management\n      const audienceParts = this.audience.split(\"/\");\n      // for management links, address should be '$management'\n      if (audienceParts[audienceParts.length - 1] === this.address) {\n        audienceParts.pop();\n      }\n      const audience = audienceParts.join(\"/\");\n      return this._context.tokenCredential.getToken(audience);\n    }\n\n    // aad credentials use the aad scope\n    return this._context.tokenCredential.getToken(Constants.aadEventHubsScope);\n  }\n\n  /**\n   * Provides the eventhub runtime information.\n   */\n  async getEventHubProperties(\n    options: OperationOptions & { retryOptions?: RetryOptions } = {},\n  ): Promise<EventHubProperties> {\n    throwErrorIfConnectionClosed(this._context);\n    return tracingClient.withSpan(\n      \"ManagementClient.getEventHubProperties\",\n      options,\n      async (updatedOptions) => {\n        try {\n          const securityToken = await this.getSecurityToken();\n\n          const request: Message = {\n            body: Buffer.from(JSON.stringify([])),\n            message_id: getRandomName(),\n            reply_to: this.replyTo,\n            application_properties: {\n              operation: Constants.readOperation,\n              name: this.entityPath as string,\n              type: `${Constants.vendorString}:${Constants.eventHub}`,\n              security_token: securityToken?.token,\n            },\n          };\n\n          const info: any = await this._makeManagementRequest(request, {\n            ...updatedOptions,\n            requestName: \"getHubRuntimeInformation\",\n          });\n          const runtimeInfo: EventHubProperties = {\n            name: info.name,\n            createdOn: new Date(info.created_at),\n            partitionIds: info.partition_ids,\n            isGeoDrEnabled: info.georeplication_factor > 1,\n          };\n          logger.verbose(\"the hub runtime info is: %O\", runtimeInfo);\n\n          return runtimeInfo;\n        } catch (error: any) {\n          logger.warning(\n            `an error occurred while getting the hub runtime information: ${error?.name}: ${error?.message}`,\n          );\n          logErrorStackTrace(error);\n          throw error;\n        }\n      },\n      toSpanOptions(this._context.config),\n    );\n  }\n\n  /**\n   * Provides information about the specified partition.\n   * @param partitionId - Partition ID for which partition information is required.\n   */\n  async getPartitionProperties(\n    partitionId: string,\n    options: OperationOptions & { retryOptions?: RetryOptions } = {},\n  ): Promise<PartitionProperties> {\n    throwErrorIfConnectionClosed(this._context);\n    throwTypeErrorIfParameterMissing(\n      this._context.connectionId,\n      \"getPartitionProperties\",\n      \"partitionId\",\n      partitionId,\n    );\n    partitionId = String(partitionId);\n\n    return tracingClient.withSpan(\n      \"ManagementClient.getPartitionProperties\",\n      options,\n      async (updatedOptions) => {\n        try {\n          const securityToken = await this.getSecurityToken();\n          const request: Message = {\n            body: Buffer.from(JSON.stringify([])),\n            message_id: getRandomName(),\n            reply_to: this.replyTo,\n            application_properties: {\n              operation: Constants.readOperation,\n              name: this.entityPath as string,\n              type: `${Constants.vendorString}:${Constants.partition}`,\n              partition: `${partitionId}`,\n              security_token: securityToken?.token,\n            },\n          };\n\n          const info: any = await this._makeManagementRequest(request, {\n            ...updatedOptions,\n            requestName: \"getPartitionInformation\",\n          });\n\n          const partitionInfo: PartitionProperties = {\n            beginningSequenceNumber: info.begin_sequence_number,\n            eventHubName: info.name,\n            lastEnqueuedOffset: info.last_enqueued_offset,\n            lastEnqueuedOnUtc: new Date(info.last_enqueued_time_utc),\n            lastEnqueuedSequenceNumber: info.last_enqueued_sequence_number,\n            partitionId: info.partition,\n            isEmpty: info.is_partition_empty,\n          };\n          logger.verbose(\"the partition info is: %O.\", partitionInfo);\n          return partitionInfo;\n        } catch (error: any) {\n          logger.warning(\n            `an error occurred while getting the partition information: ${error?.name}: ${error?.message}`,\n          );\n          logErrorStackTrace(error);\n          throw error;\n        }\n      },\n      toSpanOptions(this._context.config),\n    );\n  }\n\n  /**\n   * Closes the AMQP management session to the Event Hub for this client,\n   * returning a promise that will be resolved when disconnection is completed.\n   */\n  async close(): Promise<void> {\n    try {\n      // Always stop the auth loop when closing the management link.\n      this.authLoop?.stop();\n      if (this._isMgmtRequestResponseLinkOpen()) {\n        const mgmtLink = this._mgmtReqResLink;\n        this._mgmtReqResLink = undefined;\n        await mgmtLink!.close();\n        logger.info(\"successfully closed the management session.\");\n      }\n    } catch (err: any) {\n      const msg = `an error occurred while closing the management session: ${err?.name}: ${err?.message}`;\n      logger.warning(msg);\n      logErrorStackTrace(err);\n      throw new Error(msg);\n    }\n  }\n\n  private async _init({\n    abortSignal,\n    timeoutInMs,\n  }: {\n    abortSignal: AbortSignalLike | undefined;\n    timeoutInMs: number;\n  }): Promise<void> {\n    const createLink = async () => {\n      const rxopt: ReceiverOptions = {\n        source: { address: this.address },\n        name: this.replyTo,\n        target: { address: this.replyTo },\n        onSessionError: (context: EventContext) => {\n          const ehError = translate(context.session!.error!);\n          logger.verbose(\n            \"an error occurred on the session for request/response links for \" + \"$management: %O\",\n            ehError,\n          );\n        },\n      };\n      const sropt: SenderOptions = {\n        target: { address: this.address },\n      };\n      logger.verbose(\n        \"creating sender/receiver links with \" + \"srOpts: %o, receiverOpts: %O.\",\n        sropt,\n        rxopt,\n      );\n      this._mgmtReqResLink = await RequestResponseLink.create(\n        this._context.connection,\n        sropt,\n        rxopt,\n        { abortSignal },\n      );\n      this._mgmtReqResLink.sender.on(SenderEvents.senderError, (context: EventContext) => {\n        const ehError = translate(context.sender!.error!);\n        logger.verbose(\"an error occurred on the $management sender link.. %O\", ehError);\n      });\n      this._mgmtReqResLink.receiver.on(ReceiverEvents.receiverError, (context: EventContext) => {\n        const ehError = translate(context.receiver!.error!);\n        logger.verbose(\"an error occurred on the $management receiver link.. %O\", ehError);\n      });\n      logger.verbose(\n        \"created sender '%s' and receiver '%s' links\",\n        this._mgmtReqResLink.sender.name,\n        this._mgmtReqResLink.receiver.name,\n      );\n    };\n    try {\n      if (!this._isMgmtRequestResponseLinkOpen()) {\n        // Wait for the connectionContext to be ready to open the link.\n        await this._context.readyToOpenLink();\n        this.authLoop = await withAuth(\n          createLink,\n          this._context,\n          this.audience,\n          timeoutInMs,\n          this.logger,\n          { abortSignal },\n        );\n      }\n    } catch (err) {\n      const translatedError = translate(err);\n      logger.warning(\n        `an error occurred while establishing the links: ${translatedError?.name}: ${translatedError?.message}`,\n      );\n      logErrorStackTrace(translatedError);\n      throw translatedError;\n    }\n  }\n\n  /**\n   * Helper method to make the management request\n   * @param request - The AMQP message to send\n   * @param options - The options to use when sending a request over a $management link\n   */\n  private async _makeManagementRequest(\n    request: Message,\n    options: {\n      retryOptions?: RetryOptions;\n      abortSignal?: AbortSignalLike;\n      requestName?: string;\n    } = {},\n  ): Promise<any> {\n    const retryOptions = options.retryOptions || {};\n    try {\n      const abortSignal: AbortSignalLike | undefined = options && options.abortSignal;\n\n      const sendOperationPromise = async (): Promise<Message> => {\n        let count = 0;\n\n        const retryTimeoutInMs = getRetryAttemptTimeoutInMs(options.retryOptions);\n        let timeTakenByInit = 0;\n\n        if (!this._isMgmtRequestResponseLinkOpen()) {\n          logger.verbose(\"acquiring lock to get the management req res link.\");\n\n          const initOperationStartTime = Date.now();\n          try {\n            await defaultCancellableLock.acquire(\n              this.managementLock,\n              () => {\n                const acquireLockEndTime = Date.now();\n                const timeoutInMs =\n                  retryTimeoutInMs - (acquireLockEndTime - initOperationStartTime);\n                return this._init({ abortSignal, timeoutInMs });\n              },\n              { abortSignal, timeoutInMs: retryTimeoutInMs },\n            );\n          } catch (err) {\n            const translatedError = translate(err);\n            logger.warning(\n              \"an error occurred while creating the link: %s\",\n              `${translatedError?.name}: ${translatedError?.message}`,\n            );\n            logErrorStackTrace(translatedError);\n            throw translatedError;\n          }\n          timeTakenByInit = Date.now() - initOperationStartTime;\n        }\n\n        const remainingOperationTimeoutInMs = retryTimeoutInMs - timeTakenByInit;\n\n        const sendRequestOptions: SendRequestOptions = {\n          abortSignal: options.abortSignal,\n          requestName: options.requestName,\n          timeoutInMs: remainingOperationTimeoutInMs,\n        };\n\n        count++;\n        if (count !== 1) {\n          // Generate a new message_id every time after the first attempt\n          request.message_id = getRandomName();\n        } else if (!request.message_id) {\n          // Set the message_id in the first attempt only if it is not set\n          request.message_id = getRandomName();\n        }\n\n        return this._mgmtReqResLink!.sendRequest(request, sendRequestOptions);\n      };\n\n      const config: RetryConfig<Message> = Object.defineProperties(\n        {\n          operation: sendOperationPromise,\n          operationType: RetryOperationType.management,\n          abortSignal: abortSignal,\n          retryOptions: retryOptions,\n        },\n        {\n          connectionId: {\n            enumerable: true,\n            get: () => {\n              return this._context.connectionId;\n            },\n          },\n        },\n      ) as RetryConfig<Message>;\n      return (await retry<Message>(config)).body;\n    } catch (err) {\n      const translatedError = translate(err);\n      logger.warning(\n        \"an error occurred during send on management request-response link with address: %s\",\n        `${translatedError?.name}: ${translatedError?.message}`,\n      );\n      logErrorStackTrace(translatedError);\n      throw translatedError;\n    }\n  }\n\n  private _isMgmtRequestResponseLinkOpen(): boolean {\n    return this._mgmtReqResLink! && this._mgmtReqResLink!.isOpen();\n  }\n}\n"]}