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

package/dist/react-native/constructorHelpers.js

@@ -0,0 +1,97 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { ConnectionConfig, createSasTokenProvider } from "@azure/core-amqp";
+import { isNamedKeyCredential, isSASCredential } from "@azure/core-auth";
+import { ConnectionContext } from "./connectionContext.js";
+import { parseServiceBusConnectionString } from "./util/connectionStringUtils.js";
+// TODO: extract parseEndpoint and setCustomEndpointAddress into core-amqp
+// ConnectionConfig so that it can be shared between Event Hubs and Service Bus
+/**
+ * Parses the host, hostname, and port from an endpoint.
+ * @param endpoint - And endpoint to parse.
+ * @internal
+ */
+export function parseEndpoint(endpoint) {
+    const hostMatch = endpoint.match(/.*:\/\/([^/]*)/);
+    if (!hostMatch) {
+        throw new TypeError(`Invalid endpoint missing host: ${endpoint}`);
+    }
+    const [, host] = hostMatch;
+    const [hostname, port] = host.split(":");
+    return { host, hostname, port };
+}
+/**
+ * Updates the provided ConnectionConfig to use the custom endpoint address.
+ * @param config - An existing connection configuration to be updated.
+ * @param customEndpointAddress - The custom endpoint address to use.
+ */
+function setCustomEndpointAddress(config, customEndpointAddress) {
+    // The amqpHostname should match the host prior to using the custom endpoint.
+    config.amqpHostname = config.host;
+    const { hostname, port } = parseEndpoint(customEndpointAddress);
+    // Since we specify the port separately, set host to the customEndpointAddress hostname.
+    config.host = hostname;
+    if (port) {
+        config.port = parseInt(port, 10);
+    }
+}
+/**
+ * @internal
+ *
+ */
+export function createConnectionContext(connectionString, credential, options) {
+    var _a, _b;
+    const config = ConnectionConfig.create(connectionString);
+    config.webSocket = (_a = options === null || options === void 0 ? void 0 : options.webSocketOptions) === null || _a === void 0 ? void 0 : _a.webSocket;
+    config.webSocketEndpointPath = "$servicebus/websocket";
+    config.webSocketConstructorOptions = (_b = options === null || options === void 0 ? void 0 : options.webSocketOptions) === null || _b === void 0 ? void 0 : _b.webSocketConstructorOptions;
+    if (options === null || options === void 0 ? void 0 : options.customEndpointAddress) {
+        setCustomEndpointAddress(config, options.customEndpointAddress);
+    }
+    return ConnectionContext.create(config, credential, options);
+}
+/**
+ * @internal
+ */
+export function createConnectionContextForConnectionString(connectionString, options = {}) {
+    const parsed = parseServiceBusConnectionString(connectionString);
+    const sasTokenProvider = createSasTokenProvider(parsed);
+    return createConnectionContext(connectionString, sasTokenProvider, options);
+}
+/**
+ *
+ * @internal
+ */
+export function createConnectionContextForCredential(credential, host, options = {}) {
+    if (typeof host !== "string") {
+        throw new TypeError("`host` parameter is not a string");
+    }
+    let tokenProvider;
+    // host, credential and options based constructor was invoked
+    if (!host.endsWith("/")) {
+        host += "/";
+    }
+    if (isNamedKeyCredential(credential) || isSASCredential(credential)) {
+        tokenProvider = createSasTokenProvider(credential);
+    }
+    else {
+        tokenProvider = credential;
+    }
+    const connectionString = `Endpoint=sb://${host};SharedAccessKeyName=defaultKeyName;SharedAccessKey=defaultKeyValue;`;
+    return createConnectionContext(connectionString, tokenProvider, options);
+}
+/**
+ * Parses a connection string and extracts the EntityPath named entity out.
+ * @param connectionString - An entity specific Service Bus connection string.
+ * @internal
+ */
+export function getEntityNameFromConnectionString(connectionString) {
+    const entityPathMatch = connectionString.match(/^.+EntityPath=(.+?);{0,1}$/);
+    if (entityPathMatch != null && entityPathMatch.length === 2) {
+        return entityPathMatch[1];
+    }
+    else {
+        throw new Error("No entity name present in the connection string");
+    }
+}
+//# sourceMappingURL=constructorHelpers.js.map

package/dist/react-native/constructorHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constructorHelpers.js","sourceRoot":"","sources":["../../src/constructorHelpers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE5E,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAG3D,OAAO,EAAE,+BAA+B,EAAE,MAAM,iCAAiC,CAAC;AA+ClF,0EAA0E;AAC1E,+EAA+E;AAC/E;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC5C,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACnD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,SAAS,CAAC,kCAAkC,QAAQ,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,CAAC,EAAE,IAAI,CAAC,GAAG,SAAS,CAAC;IAC3B,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEzC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;AAClC,CAAC;AACD;;;;GAIG;AACH,SAAS,wBAAwB,CAAC,MAAwB,EAAE,qBAA6B;IACvF,6EAA6E;IAC7E,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC;IAClC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAChE,wFAAwF;IACxF,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC;IACvB,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CACrC,gBAAwB,EACxB,UAA8C,EAC9C,OAAgC;;IAEhC,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAEzD,MAAM,CAAC,SAAS,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,0CAAE,SAAS,CAAC;IACxD,MAAM,CAAC,qBAAqB,GAAG,uBAAuB,CAAC;IACvD,MAAM,CAAC,2BAA2B,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,0CAAE,2BAA2B,CAAC;IAE5F,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,qBAAqB,EAAE,CAAC;QACnC,wBAAwB,CAAC,MAAM,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,iBAAiB,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,0CAA0C,CACxD,gBAAwB,EACxB,UAAmC,EAAE;IAErC,MAAM,MAAM,GAAG,+BAA+B,CAAC,gBAAgB,CAG9D,CAAC;IACF,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;IACxD,OAAO,uBAAuB,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;AAC9E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oCAAoC,CAClD,UAAgE,EAChE,IAAY,EACZ,UAAmC,EAAE;IAErC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,aAAiD,CAAC;IAEtD,6DAA6D;IAC7D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,IAAI,IAAI,GAAG,CAAC;IACd,CAAC;IACD,IAAI,oBAAoB,CAAC,UAAU,CAAC,IAAI,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;QACpE,aAAa,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;SAAM,CAAC;QACN,aAAa,GAAG,UAAU,CAAC;IAC7B,CAAC;IACD,MAAM,gBAAgB,GAAG,iBAAiB,IAAI,sEAAsE,CAAC;IACrH,OAAO,uBAAuB,CAAC,gBAAgB,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;AAC3E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iCAAiC,CAAC,gBAAwB;IACxE,MAAM,eAAe,GAAG,gBAAgB,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAE7E,IAAI,eAAe,IAAI,IAAI,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5D,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { RetryOptions, SasTokenProvider, WebSocketOptions } from \"@azure/core-amqp\";\nimport { ConnectionConfig, createSasTokenProvider } from \"@azure/core-amqp\";\nimport type { NamedKeyCredential, SASCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isNamedKeyCredential, isSASCredential } from \"@azure/core-auth\";\nimport { ConnectionContext } from \"./connectionContext.js\";\nimport type { UserAgentPolicyOptions } from \"@azure/core-rest-pipeline\";\nimport type { ServiceBusConnectionStringProperties } from \"./util/connectionStringUtils.js\";\nimport { parseServiceBusConnectionString } from \"./util/connectionStringUtils.js\";\n\n/**\n * Describes the options that can be provided while creating the ServiceBusClient.\n *\n * - `webSocketOptions` : Options to configure the channelling of the AMQP connection over Web Sockets.\n *    - `websocket`     : The WebSocket constructor used to create an AMQP connection if you choose to make the connection\n * over a WebSocket.\n *    - `webSocketConstructorOptions` : Options to pass to the Websocket constructor when you choose to make the connection\n * over a WebSocket.\n * - `retryOptions`     : The retry options for all the operations on the client.\n *    - `maxRetries` : The number of times the operation can be retried in case of a retryable error.\n *    - `maxRetryDelayInMs`: The maximum delay between retries. Applicable only when performing exponential retries.\n *    - `mode`: Which retry mode to apply, specified by the `RetryMode` enum. Options are `Exponential` and `Fixed`. Defaults to `Fixed`.\n *    - `retryDelayInMs`: Amount of time to wait in milliseconds before making the next attempt. When `mode` is set to `Exponential`,\n *       this is used to compute the exponentially increasing delays between retries. Default: 30000 milliseconds.\n *    - `timeoutInMs`: Amount of time in milliseconds to wait before the operation times out. This will trigger a retry if there are any\n *       retry attempts remaining. Minimum value: 60000 milliseconds.\n */\nexport interface ServiceBusClientOptions {\n  /**\n   * ID to identify this client. This can be used to correlate logs and exceptions.\n   */\n  identifier?: string;\n  /**\n   * A custom endpoint to use when connecting to the Service Bus service.\n   * This can be useful when your network does not allow connecting to the\n   * standard Azure Service Bus endpoint address, but does allow connecting\n   * through an intermediary.\n   *\n   * Example: \"https://my.custom.endpoint:100/\"\n   */\n  customEndpointAddress?: string;\n  /**\n   * Retry policy options that determine the mode, number of retries, retry interval etc.\n   */\n  retryOptions?: RetryOptions;\n  /**\n   * Options to configure the channelling of the AMQP connection over Web Sockets.\n   */\n  webSocketOptions?: WebSocketOptions;\n  /**\n   * Options for adding user agent details to outgoing requests.\n   */\n  userAgentOptions?: UserAgentPolicyOptions;\n}\n\n// TODO: extract parseEndpoint and setCustomEndpointAddress into core-amqp\n// ConnectionConfig so that it can be shared between Event Hubs and Service Bus\n/**\n * Parses the host, hostname, and port from an endpoint.\n * @param endpoint - And endpoint to parse.\n * @internal\n */\nexport function parseEndpoint(endpoint: string): { host: string; hostname: string; port?: string } {\n  const hostMatch = endpoint.match(/.*:\\/\\/([^/]*)/);\n  if (!hostMatch) {\n    throw new TypeError(`Invalid endpoint missing host: ${endpoint}`);\n  }\n\n  const [, host] = hostMatch;\n  const [hostname, port] = host.split(\":\");\n\n  return { host, hostname, port };\n}\n/**\n * Updates the provided ConnectionConfig to use the custom endpoint address.\n * @param config - An existing connection configuration to be updated.\n * @param customEndpointAddress - The custom endpoint address to use.\n */\nfunction setCustomEndpointAddress(config: ConnectionConfig, customEndpointAddress: string): void {\n  // The amqpHostname should match the host prior to using the custom endpoint.\n  config.amqpHostname = config.host;\n  const { hostname, port } = parseEndpoint(customEndpointAddress);\n  // Since we specify the port separately, set host to the customEndpointAddress hostname.\n  config.host = hostname;\n  if (port) {\n    config.port = parseInt(port, 10);\n  }\n}\n\n/**\n * @internal\n *\n */\nexport function createConnectionContext(\n  connectionString: string,\n  credential: SasTokenProvider | TokenCredential,\n  options: ServiceBusClientOptions,\n): ConnectionContext {\n  const config = ConnectionConfig.create(connectionString);\n\n  config.webSocket = options?.webSocketOptions?.webSocket;\n  config.webSocketEndpointPath = \"$servicebus/websocket\";\n  config.webSocketConstructorOptions = options?.webSocketOptions?.webSocketConstructorOptions;\n\n  if (options?.customEndpointAddress) {\n    setCustomEndpointAddress(config, options.customEndpointAddress);\n  }\n\n  return ConnectionContext.create(config, credential, options);\n}\n\n/**\n * @internal\n */\nexport function createConnectionContextForConnectionString(\n  connectionString: string,\n  options: ServiceBusClientOptions = {},\n): ConnectionContext {\n  const parsed = parseServiceBusConnectionString(connectionString) as Required<\n    | Pick<ServiceBusConnectionStringProperties, \"sharedAccessKey\" | \"sharedAccessKeyName\">\n    | Pick<ServiceBusConnectionStringProperties, \"sharedAccessSignature\">\n  >;\n  const sasTokenProvider = createSasTokenProvider(parsed);\n  return createConnectionContext(connectionString, sasTokenProvider, options);\n}\n\n/**\n *\n * @internal\n */\nexport function createConnectionContextForCredential(\n  credential: TokenCredential | NamedKeyCredential | SASCredential,\n  host: string,\n  options: ServiceBusClientOptions = {},\n): ConnectionContext {\n  if (typeof host !== \"string\") {\n    throw new TypeError(\"`host` parameter is not a string\");\n  }\n\n  let tokenProvider: TokenCredential | SasTokenProvider;\n\n  // host, credential and options based constructor was invoked\n  if (!host.endsWith(\"/\")) {\n    host += \"/\";\n  }\n  if (isNamedKeyCredential(credential) || isSASCredential(credential)) {\n    tokenProvider = createSasTokenProvider(credential);\n  } else {\n    tokenProvider = credential;\n  }\n  const connectionString = `Endpoint=sb://${host};SharedAccessKeyName=defaultKeyName;SharedAccessKey=defaultKeyValue;`;\n  return createConnectionContext(connectionString, tokenProvider, options);\n}\n\n/**\n * Parses a connection string and extracts the EntityPath named entity out.\n * @param connectionString - An entity specific Service Bus connection string.\n * @internal\n */\nexport function getEntityNameFromConnectionString(connectionString: string): string {\n  const entityPathMatch = connectionString.match(/^.+EntityPath=(.+?);{0,1}$/);\n\n  if (entityPathMatch != null && entityPathMatch.length === 2) {\n    return entityPathMatch[1];\n  } else {\n    throw new Error(\"No entity name present in the connection string\");\n  }\n}\n"]}

package/dist/react-native/core/autoLockRenewer.d.ts

@@ -0,0 +1,58 @@
+import type { ConnectionContext } from "../connectionContext.js";
+import type { ServiceBusMessageImpl } from "../serviceBusMessage.js";
+import type { LinkEntity } from "./linkEntity.js";
+import type { OnErrorNoContext } from "./messageReceiver.js";
+/**
+ * @internal
+ */
+export type RenewableMessageProperties = Readonly<Pick<ServiceBusMessageImpl, "lockToken" | "messageId">> & Pick<ServiceBusMessageImpl, "lockedUntilUtc">;
+/**
+ * @internal
+ */
+type MinimalLink = Pick<LinkEntity<any>, "name" | "logPrefix" | "entityPath">;
+/**
+ * Tracks locks for messages, renewing until a configurable duration.
+ *
+ * @internal
+ */
+export declare class LockRenewer {
+    private _context;
+    private _maxAutoRenewDurationInMs;
+    /**
+     * A map of link names to individual maps for each
+     * link that map a message ID to its auto-renewal timer.
+     */
+    private _messageRenewLockTimers;
+    private _calculateRenewAfterDuration;
+    constructor(_context: Pick<ConnectionContext, "getManagementClient">, _maxAutoRenewDurationInMs: number);
+    /**
+     * Creates an AutoLockRenewer.
+     *
+     * @param linkEntity - Your link entity instance (probably 'this')
+     * @param context - The connection context for your link entity (probably 'this._context')
+     * @param options - The ReceiveOptions passed through to your message receiver.
+     * @returns if the lock mode is peek lock (or if is unspecified, thus defaulting to peekLock)
+     * and the options.maxAutoLockRenewalDurationInMs is greater than 0..Otherwise, returns undefined.
+     */
+    static create(context: Pick<ConnectionContext, "getManagementClient">, maxAutoRenewLockDurationInMs: number, receiveMode: "peekLock" | "receiveAndDelete"): LockRenewer | undefined;
+    /**
+     * Cancels all pending lock renewals for messages on given link and removes all entries from our internal cache.
+     */
+    stopAll(linkEntity: MinimalLink): void;
+    /**
+     * Stops lock renewal for a single message.
+     *
+     * @param bMessage - The message whose lock renewal we will stop.
+     */
+    stop(linkEntity: MinimalLink, bMessage: RenewableMessageProperties): void;
+    /**
+     * Starts lock renewal for a single message.
+     *
+     * @param bMessage - The message whose lock renewal we will start.
+     */
+    start(linkEntity: MinimalLink, bMessage: RenewableMessageProperties, onError: OnErrorNoContext): void;
+    private _getOrCreateMapForLink;
+    private _stopAndRemoveById;
+}
+export {};
+//# sourceMappingURL=autoLockRenewer.d.ts.map

package/dist/react-native/core/autoLockRenewer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"autoLockRenewer.d.ts","sourceRoot":"","sources":["../../../src/core/autoLockRenewer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAC/C,IAAI,CAAC,qBAAqB,EAAE,WAAW,GAAG,WAAW,CAAC,CACvD,GAEC,IAAI,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;AAEhD;;GAEG;AACH,KAAK,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,YAAY,CAAC,CAAC;AAE9E;;;;GAIG;AACH,qBAAa,WAAW;IAWpB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,yBAAyB;IAXnC;;;OAGG;IACH,OAAO,CAAC,uBAAuB,CAA8D;IAG7F,OAAO,CAAC,4BAA4B,CAAqC;gBAG/D,QAAQ,EAAE,IAAI,CAAC,iBAAiB,EAAE,qBAAqB,CAAC,EACxD,yBAAyB,EAAE,MAAM;IAK3C;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,CACX,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,qBAAqB,CAAC,EACvD,4BAA4B,EAAE,MAAM,EACpC,WAAW,EAAE,UAAU,GAAG,kBAAkB,GAC3C,WAAW,GAAG,SAAS;IAY1B;;OAEG;IACH,OAAO,CAAC,UAAU,EAAE,WAAW,GAAG,IAAI;IAkBtC;;;;OAIG;IACH,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,0BAA0B,GAAG,IAAI;IAYzE;;;;OAIG;IACH,KAAK,CACH,UAAU,EAAE,WAAW,EACvB,QAAQ,EAAE,0BAA0B,EACpC,OAAO,EAAE,gBAAgB,GACxB,IAAI;IAkHP,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,kBAAkB;CAmB3B"}

package/dist/react-native/core/autoLockRenewer.js

@@ -0,0 +1,170 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { receiverLogger as logger } from "../log.js";
+import { calculateRenewAfterDuration } from "../util/utils.js";
+/**
+ * Tracks locks for messages, renewing until a configurable duration.
+ *
+ * @internal
+ */
+export class LockRenewer {
+    constructor(_context, _maxAutoRenewDurationInMs) {
+        this._context = _context;
+        this._maxAutoRenewDurationInMs = _maxAutoRenewDurationInMs;
+        /**
+         * A map of link names to individual maps for each
+         * link that map a message ID to its auto-renewal timer.
+         */
+        this._messageRenewLockTimers = new Map();
+        this._calculateRenewAfterDuration = calculateRenewAfterDuration;
+    }
+    /**
+     * Creates an AutoLockRenewer.
+     *
+     * @param linkEntity - Your link entity instance (probably 'this')
+     * @param context - The connection context for your link entity (probably 'this._context')
+     * @param options - The ReceiveOptions passed through to your message receiver.
+     * @returns if the lock mode is peek lock (or if is unspecified, thus defaulting to peekLock)
+     * and the options.maxAutoLockRenewalDurationInMs is greater than 0..Otherwise, returns undefined.
+     */
+    static create(context, maxAutoRenewLockDurationInMs, receiveMode) {
+        if (receiveMode !== "peekLock") {
+            return undefined;
+        }
+        if (maxAutoRenewLockDurationInMs <= 0) {
+            return undefined;
+        }
+        return new LockRenewer(context, maxAutoRenewLockDurationInMs);
+    }
+    /**
+     * Cancels all pending lock renewals for messages on given link and removes all entries from our internal cache.
+     */
+    stopAll(linkEntity) {
+        logger.verbose(`${linkEntity.logPrefix} Clearing message renew lock timers for all the active messages.`);
+        const messagesForLink = this._messageRenewLockTimers.get(linkEntity.name);
+        if (messagesForLink == null) {
+            return;
+        }
+        for (const messageId of messagesForLink.keys()) {
+            this._stopAndRemoveById(linkEntity, messagesForLink, messageId);
+        }
+        this._messageRenewLockTimers.delete(linkEntity.name);
+    }
+    /**
+     * Stops lock renewal for a single message.
+     *
+     * @param bMessage - The message whose lock renewal we will stop.
+     */
+    stop(linkEntity, bMessage) {
+        const messageId = bMessage.messageId;
+        const messagesForLink = this._messageRenewLockTimers.get(linkEntity.name);
+        if (messagesForLink == null) {
+            return;
+        }
+        this._stopAndRemoveById(linkEntity, messagesForLink, messageId);
+    }
+    /**
+     * Starts lock renewal for a single message.
+     *
+     * @param bMessage - The message whose lock renewal we will start.
+     */
+    start(linkEntity, bMessage, onError) {
+        try {
+            const logPrefix = linkEntity.logPrefix;
+            if (bMessage.lockToken == null) {
+                throw new Error(`Can't start auto lock renewal for message with message id '${bMessage.messageId}' since it does not have a lock token.`);
+            }
+            const lockToken = bMessage.lockToken;
+            const linkMessageMap = this._getOrCreateMapForLink(linkEntity);
+            // - We need to renew locks before they expire by looking at bMessage.lockedUntilUtc.
+            // - This autorenewal needs to happen **NO MORE** than maxAutoRenewDurationInMs
+            // - We should be able to clear the renewal timer when the user's message handler
+            // is done (whether it succeeds or fails).
+            // Setting the messageId with undefined value in the linkMessageMap because we
+            // track state by checking the presence of messageId in the map. It is removed from the map
+            // when an attempt is made to settle the message (either by the user or by the sdk) OR
+            // when the execution of user's message handler completes.
+            linkMessageMap.set(bMessage.messageId, undefined);
+            logger.verbose(`${logPrefix} message with id '${bMessage.messageId}' is locked until ${bMessage.lockedUntilUtc.toString()}.`);
+            const totalAutoLockRenewDuration = Date.now() + this._maxAutoRenewDurationInMs;
+            const totalAutoLockRenewDurationDate = new Date(totalAutoLockRenewDuration);
+            logger.verbose(`${logPrefix} Total autolockrenew duration for message with id '${bMessage.messageId}' is: ${totalAutoLockRenewDurationDate.toString()}`);
+            const autoRenewLockTask = () => {
+                const renewalNeededToMaintainLock = 
+                // if the lock expires _after_ our max auto-renew duration there's no reason to
+                // spin up an auto-renewer - it's already held for the duration.
+                totalAutoLockRenewDurationDate > bMessage.lockedUntilUtc;
+                if (!renewalNeededToMaintainLock) {
+                    logger.verbose(`${logPrefix} Autolockrenew not needed as message's lockedUntilUtc ${bMessage.lockedUntilUtc} is after the total autolockrenew duration ${totalAutoLockRenewDurationDate} for message with messageId '${bMessage.messageId}'. Hence we will stop the autoLockRenewTask.`);
+                    this.stop(linkEntity, bMessage);
+                }
+                else if (Date.now() >= totalAutoLockRenewDuration) {
+                    // once we've exceeded the max amount of time we'll renew we can stop.
+                    logger.verbose(`${logPrefix} Current time ${new Date()} exceeds the total autolockrenew duration ${totalAutoLockRenewDurationDate} for message with messageId '${bMessage.messageId}'. Hence we will stop the autoLockRenewTask.`);
+                    this.stop(linkEntity, bMessage);
+                }
+                else {
+                    if (linkMessageMap.has(bMessage.messageId)) {
+                        // TODO: We can run into problems with clock skew between the client and the server.
+                        // It would be better to calculate the duration based on the "lockDuration" property
+                        // of the queue. However, we do not have the management plane of the client ready for
+                        // now. Hence we rely on the lockedUntilUtc property on the message set by ServiceBus.
+                        const amount = this._calculateRenewAfterDuration(bMessage.lockedUntilUtc);
+                        logger.verbose(`${logPrefix} Sleeping for ${amount} milliseconds while renewing the lock for message with id '${bMessage.messageId}'`);
+                        // Setting the value of the messageId to the actual timer. This will be cleared when
+                        // an attempt is made to settle the message (either by the user or by the sdk) OR
+                        // when the execution of user's message handler completes.
+                        const autoRenewTimer = setTimeout(async () => {
+                            try {
+                                logger.verbose(`${logPrefix} Attempting to renew the lock for message with id '${bMessage.messageId}'.`);
+                                bMessage.lockedUntilUtc = await this._context
+                                    .getManagementClient(linkEntity.entityPath)
+                                    .renewLock(lockToken, {
+                                    associatedLinkName: linkEntity.name,
+                                });
+                                logger.verbose(`${logPrefix} Successfully renewed the lock for message with id '${bMessage.messageId}'. Starting next auto-lock-renew cycle for message.`);
+                                autoRenewLockTask();
+                            }
+                            catch (err) {
+                                logger.logError(err, `${logPrefix} An error occurred while auto renewing the message lock '${bMessage.lockToken}' for message with id '${bMessage.messageId}'`);
+                                onError(err);
+                            }
+                        }, amount);
+                        // Prevent the active Timer from keeping the Node.js event loop active.
+                        if (typeof autoRenewTimer.unref === "function") {
+                            autoRenewTimer.unref();
+                        }
+                        linkMessageMap.set(bMessage.messageId, autoRenewTimer);
+                    }
+                    else {
+                        logger.verbose(`${logPrefix} Looks like the message lock renew timer has already been cleared for message with id '${bMessage.messageId}'.`);
+                    }
+                }
+            };
+            // start
+            autoRenewLockTask();
+        }
+        catch (err) {
+            onError(err);
+        }
+    }
+    _getOrCreateMapForLink(linkEntity) {
+        if (!this._messageRenewLockTimers.has(linkEntity.name)) {
+            this._messageRenewLockTimers.set(linkEntity.name, new Map());
+        }
+        return this._messageRenewLockTimers.get(linkEntity.name);
+    }
+    _stopAndRemoveById(linkEntity, linkMessageMap, messageId) {
+        if (messageId == null) {
+            throw new Error("Failed to stop auto lock renewal - no message ID");
+        }
+        // TODO: messageId doesn't actually need to be unique. Perhaps we should use lockToken
+        // instead?
+        if (linkMessageMap.has(messageId)) {
+            clearTimeout(linkMessageMap.get(messageId));
+            logger.verbose(`${linkEntity.logPrefix} Cleared the message renew lock timer for message with id '${messageId}'.`);
+            linkMessageMap.delete(messageId);
+        }
+    }
+}
+//# sourceMappingURL=autoLockRenewer.js.map

package/dist/react-native/core/autoLockRenewer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"autoLockRenewer.js","sourceRoot":"","sources":["../../../src/core/autoLockRenewer.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,cAAc,IAAI,MAAM,EAAE,MAAM,WAAW,CAAC;AAErD,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AAkB/D;;;;GAIG;AACH,MAAM,OAAO,WAAW;IAUtB,YACU,QAAwD,EACxD,yBAAiC;QADjC,aAAQ,GAAR,QAAQ,CAAgD;QACxD,8BAAyB,GAAzB,yBAAyB,CAAQ;QAX3C;;;WAGG;QACK,4BAAuB,GAAG,IAAI,GAAG,EAAmD,CAAC;QAS3F,IAAI,CAAC,4BAA4B,GAAG,2BAA2B,CAAC;IAClE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,CACX,OAAuD,EACvD,4BAAoC,EACpC,WAA4C;QAE5C,IAAI,WAAW,KAAK,UAAU,EAAE,CAAC;YAC/B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,4BAA4B,IAAI,CAAC,EAAE,CAAC;YACtC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,UAAuB;QAC7B,MAAM,CAAC,OAAO,CACZ,GAAG,UAAU,CAAC,SAAS,kEAAkE,CAC1F,CAAC;QAEF,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAE1E,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;YAC5B,OAAO;QACT,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/C,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,UAAuB,EAAE,QAAoC;QAChE,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAmB,CAAC;QAE/C,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAE1E,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;YAC5B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACH,KAAK,CACH,UAAuB,EACvB,QAAoC,EACpC,OAAyB;QAEzB,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;YAEvC,IAAI,QAAQ,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CACb,8DAA8D,QAAQ,CAAC,SAAS,wCAAwC,CACzH,CAAC;YACJ,CAAC;YAED,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;YACrC,MAAM,cAAc,GAAG,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;YAC/D,qFAAqF;YACrF,+EAA+E;YAC/E,iFAAiF;YACjF,0CAA0C;YAC1C,8EAA8E;YAC9E,2FAA2F;YAC3F,sFAAsF;YACtF,0DAA0D;YAC1D,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAmB,EAAE,SAAS,CAAC,CAAC;YAE5D,MAAM,CAAC,OAAO,CACZ,GAAG,SAAS,qBACV,QAAQ,CAAC,SACX,qBAAqB,QAAQ,CAAC,cAAe,CAAC,QAAQ,EAAE,GAAG,CAC5D,CAAC;YACF,MAAM,0BAA0B,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,yBAAyB,CAAC;YAC/E,MAAM,8BAA8B,GAAG,IAAI,IAAI,CAAC,0BAA0B,CAAC,CAAC;YAC5E,MAAM,CAAC,OAAO,CACZ,GAAG,SAAS,sDACV,QAAQ,CAAC,SACX,SAAS,8BAA8B,CAAC,QAAQ,EAAE,EAAE,CACrD,CAAC;YAEF,MAAM,iBAAiB,GAAG,GAAS,EAAE;gBACnC,MAAM,2BAA2B;gBAC/B,+EAA+E;gBAC/E,gEAAgE;gBAChE,8BAA8B,GAAG,QAAQ,CAAC,cAAe,CAAC;gBAE5D,IAAI,CAAC,2BAA2B,EAAE,CAAC;oBACjC,MAAM,CAAC,OAAO,CACZ,GAAG,SAAS,yDAAyD,QAAQ,CAAC,cAAc,8CAA8C,8BAA8B,gCAAgC,QAAQ,CAAC,SAAS,8CAA8C,CACzQ,CAAC;oBACF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;gBAClC,CAAC;qBAAM,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,0BAA0B,EAAE,CAAC;oBACpD,sEAAsE;oBACtE,MAAM,CAAC,OAAO,CACZ,GAAG,SAAS,iBAAiB,IAAI,IAAI,EAAE,6CAA6C,8BAA8B,gCAChH,QAAQ,CAAC,SACX,8CAA8C,CAC/C,CAAC;oBACF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;gBAClC,CAAC;qBAAM,CAAC;oBACN,IAAI,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAmB,CAAC,EAAE,CAAC;wBACrD,oFAAoF;wBACpF,oFAAoF;wBACpF,qFAAqF;wBACrF,sFAAsF;wBACtF,MAAM,MAAM,GAAG,IAAI,CAAC,4BAA4B,CAAC,QAAQ,CAAC,cAAe,CAAC,CAAC;wBAE3E,MAAM,CAAC,OAAO,CACZ,GAAG,SAAS,iBAAiB,MAAM,8DAA8D,QAAQ,CAAC,SAAS,GAAG,CACvH,CAAC;wBACF,oFAAoF;wBACpF,iFAAiF;wBACjF,0DAA0D;wBAC1D,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,IAAI,EAAE;4BAC3C,IAAI,CAAC;gCACH,MAAM,CAAC,OAAO,CACZ,GAAG,SAAS,sDAAsD,QAAQ,CAAC,SAAS,IAAI,CACzF,CAAC;gCAEF,QAAQ,CAAC,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ;qCAC1C,mBAAmB,CAAC,UAAU,CAAC,UAAU,CAAC;qCAC1C,SAAS,CAAC,SAAS,EAAE;oCACpB,kBAAkB,EAAE,UAAU,CAAC,IAAI;iCACpC,CAAC,CAAC;gCACL,MAAM,CAAC,OAAO,CACZ,GAAG,SAAS,uDAAuD,QAAQ,CAAC,SAAS,qDAAqD,CAC3I,CAAC;gCAEF,iBAAiB,EAAE,CAAC;4BACtB,CAAC;4BAAC,OAAO,GAAQ,EAAE,CAAC;gCAClB,MAAM,CAAC,QAAQ,CACb,GAAG,EACH,GAAG,SAAS,4DAA4D,QAAQ,CAAC,SAAS,0BAA0B,QAAQ,CAAC,SAAS,GAAG,CAC1I,CAAC;gCACF,OAAO,CAAC,GAAG,CAAC,CAAC;4BACf,CAAC;wBACH,CAAC,EAAE,MAAM,CAAC,CAAC;wBAEX,uEAAuE;wBACvE,IAAI,OAAO,cAAc,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;4BAC/C,cAAc,CAAC,KAAK,EAAE,CAAC;wBACzB,CAAC;wBAED,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAmB,EAAE,cAAc,CAAC,CAAC;oBACnE,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,OAAO,CACZ,GAAG,SAAS,0FAA0F,QAAQ,CAAC,SAAS,IAAI,CAC7H,CAAC;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC,CAAC;YAEF,QAAQ;YACR,iBAAiB,EAAE,CAAC;QACtB,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,OAAO,CAAC,GAAG,CAAC,CAAC;QACf,CAAC;IACH,CAAC;IAEO,sBAAsB,CAAC,UAAuB;QACpD,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAC9B,UAAU,CAAC,IAAI,EACf,IAAI,GAAG,EAAsC,CAC9C,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAE,CAAC;IAC5D,CAAC;IAEO,kBAAkB,CACxB,UAAuB,EACvB,cAAuD,EACvD,SAA6B;QAE7B,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,CAAC;QAED,sFAAsF;QACtF,WAAW;QACX,IAAI,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YAClC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAmB,CAAC,CAAC;YAC9D,MAAM,CAAC,OAAO,CACZ,GAAG,UAAU,CAAC,SAAS,8DAA8D,SAAS,IAAI,CACnG,CAAC;YACF,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ConnectionContext } from \"../connectionContext.js\";\nimport { receiverLogger as logger } from \"../log.js\";\nimport type { ServiceBusMessageImpl } from \"../serviceBusMessage.js\";\nimport { calculateRenewAfterDuration } from \"../util/utils.js\";\nimport type { LinkEntity } from \"./linkEntity.js\";\nimport type { OnErrorNoContext } from \"./messageReceiver.js\";\n\n/**\n * @internal\n */\nexport type RenewableMessageProperties = Readonly<\n  Pick<ServiceBusMessageImpl, \"lockToken\" | \"messageId\">\n> &\n  // updated when we renew the lock\n  Pick<ServiceBusMessageImpl, \"lockedUntilUtc\">;\n\n/**\n * @internal\n */\ntype MinimalLink = Pick<LinkEntity<any>, \"name\" | \"logPrefix\" | \"entityPath\">;\n\n/**\n * Tracks locks for messages, renewing until a configurable duration.\n *\n * @internal\n */\nexport class LockRenewer {\n  /**\n   * A map of link names to individual maps for each\n   * link that map a message ID to its auto-renewal timer.\n   */\n  private _messageRenewLockTimers = new Map<string, Map<string, NodeJS.Timeout | undefined>>();\n\n  // just here for make unit testing a bit easier.\n  private _calculateRenewAfterDuration: typeof calculateRenewAfterDuration;\n\n  constructor(\n    private _context: Pick<ConnectionContext, \"getManagementClient\">,\n    private _maxAutoRenewDurationInMs: number,\n  ) {\n    this._calculateRenewAfterDuration = calculateRenewAfterDuration;\n  }\n\n  /**\n   * Creates an AutoLockRenewer.\n   *\n   * @param linkEntity - Your link entity instance (probably 'this')\n   * @param context - The connection context for your link entity (probably 'this._context')\n   * @param options - The ReceiveOptions passed through to your message receiver.\n   * @returns if the lock mode is peek lock (or if is unspecified, thus defaulting to peekLock)\n   * and the options.maxAutoLockRenewalDurationInMs is greater than 0..Otherwise, returns undefined.\n   */\n  static create(\n    context: Pick<ConnectionContext, \"getManagementClient\">,\n    maxAutoRenewLockDurationInMs: number,\n    receiveMode: \"peekLock\" | \"receiveAndDelete\",\n  ): LockRenewer | undefined {\n    if (receiveMode !== \"peekLock\") {\n      return undefined;\n    }\n\n    if (maxAutoRenewLockDurationInMs <= 0) {\n      return undefined;\n    }\n\n    return new LockRenewer(context, maxAutoRenewLockDurationInMs);\n  }\n\n  /**\n   * Cancels all pending lock renewals for messages on given link and removes all entries from our internal cache.\n   */\n  stopAll(linkEntity: MinimalLink): void {\n    logger.verbose(\n      `${linkEntity.logPrefix} Clearing message renew lock timers for all the active messages.`,\n    );\n\n    const messagesForLink = this._messageRenewLockTimers.get(linkEntity.name);\n\n    if (messagesForLink == null) {\n      return;\n    }\n\n    for (const messageId of messagesForLink.keys()) {\n      this._stopAndRemoveById(linkEntity, messagesForLink, messageId);\n    }\n\n    this._messageRenewLockTimers.delete(linkEntity.name);\n  }\n\n  /**\n   * Stops lock renewal for a single message.\n   *\n   * @param bMessage - The message whose lock renewal we will stop.\n   */\n  stop(linkEntity: MinimalLink, bMessage: RenewableMessageProperties): void {\n    const messageId = bMessage.messageId as string;\n\n    const messagesForLink = this._messageRenewLockTimers.get(linkEntity.name);\n\n    if (messagesForLink == null) {\n      return;\n    }\n\n    this._stopAndRemoveById(linkEntity, messagesForLink, messageId);\n  }\n\n  /**\n   * Starts lock renewal for a single message.\n   *\n   * @param bMessage - The message whose lock renewal we will start.\n   */\n  start(\n    linkEntity: MinimalLink,\n    bMessage: RenewableMessageProperties,\n    onError: OnErrorNoContext,\n  ): void {\n    try {\n      const logPrefix = linkEntity.logPrefix;\n\n      if (bMessage.lockToken == null) {\n        throw new Error(\n          `Can't start auto lock renewal for message with message id '${bMessage.messageId}' since it does not have a lock token.`,\n        );\n      }\n\n      const lockToken = bMessage.lockToken;\n      const linkMessageMap = this._getOrCreateMapForLink(linkEntity);\n      // - We need to renew locks before they expire by looking at bMessage.lockedUntilUtc.\n      // - This autorenewal needs to happen **NO MORE** than maxAutoRenewDurationInMs\n      // - We should be able to clear the renewal timer when the user's message handler\n      // is done (whether it succeeds or fails).\n      // Setting the messageId with undefined value in the linkMessageMap because we\n      // track state by checking the presence of messageId in the map. It is removed from the map\n      // when an attempt is made to settle the message (either by the user or by the sdk) OR\n      // when the execution of user's message handler completes.\n      linkMessageMap.set(bMessage.messageId as string, undefined);\n\n      logger.verbose(\n        `${logPrefix} message with id '${\n          bMessage.messageId\n        }' is locked until ${bMessage.lockedUntilUtc!.toString()}.`,\n      );\n      const totalAutoLockRenewDuration = Date.now() + this._maxAutoRenewDurationInMs;\n      const totalAutoLockRenewDurationDate = new Date(totalAutoLockRenewDuration);\n      logger.verbose(\n        `${logPrefix} Total autolockrenew duration for message with id '${\n          bMessage.messageId\n        }' is: ${totalAutoLockRenewDurationDate.toString()}`,\n      );\n\n      const autoRenewLockTask = (): void => {\n        const renewalNeededToMaintainLock =\n          // if the lock expires _after_ our max auto-renew duration there's no reason to\n          // spin up an auto-renewer - it's already held for the duration.\n          totalAutoLockRenewDurationDate > bMessage.lockedUntilUtc!;\n\n        if (!renewalNeededToMaintainLock) {\n          logger.verbose(\n            `${logPrefix} Autolockrenew not needed as message's lockedUntilUtc ${bMessage.lockedUntilUtc} is after the total autolockrenew duration ${totalAutoLockRenewDurationDate} for message with messageId '${bMessage.messageId}'. Hence we will stop the autoLockRenewTask.`,\n          );\n          this.stop(linkEntity, bMessage);\n        } else if (Date.now() >= totalAutoLockRenewDuration) {\n          // once we've exceeded the max amount of time we'll renew we can stop.\n          logger.verbose(\n            `${logPrefix} Current time ${new Date()} exceeds the total autolockrenew duration ${totalAutoLockRenewDurationDate} for message with messageId '${\n              bMessage.messageId\n            }'. Hence we will stop the autoLockRenewTask.`,\n          );\n          this.stop(linkEntity, bMessage);\n        } else {\n          if (linkMessageMap.has(bMessage.messageId as string)) {\n            // TODO: We can run into problems with clock skew between the client and the server.\n            // It would be better to calculate the duration based on the \"lockDuration\" property\n            // of the queue. However, we do not have the management plane of the client ready for\n            // now. Hence we rely on the lockedUntilUtc property on the message set by ServiceBus.\n            const amount = this._calculateRenewAfterDuration(bMessage.lockedUntilUtc!);\n\n            logger.verbose(\n              `${logPrefix} Sleeping for ${amount} milliseconds while renewing the lock for message with id '${bMessage.messageId}'`,\n            );\n            // Setting the value of the messageId to the actual timer. This will be cleared when\n            // an attempt is made to settle the message (either by the user or by the sdk) OR\n            // when the execution of user's message handler completes.\n            const autoRenewTimer = setTimeout(async () => {\n              try {\n                logger.verbose(\n                  `${logPrefix} Attempting to renew the lock for message with id '${bMessage.messageId}'.`,\n                );\n\n                bMessage.lockedUntilUtc = await this._context\n                  .getManagementClient(linkEntity.entityPath)\n                  .renewLock(lockToken, {\n                    associatedLinkName: linkEntity.name,\n                  });\n                logger.verbose(\n                  `${logPrefix} Successfully renewed the lock for message with id '${bMessage.messageId}'. Starting next auto-lock-renew cycle for message.`,\n                );\n\n                autoRenewLockTask();\n              } catch (err: any) {\n                logger.logError(\n                  err,\n                  `${logPrefix} An error occurred while auto renewing the message lock '${bMessage.lockToken}' for message with id '${bMessage.messageId}'`,\n                );\n                onError(err);\n              }\n            }, amount);\n\n            // Prevent the active Timer from keeping the Node.js event loop active.\n            if (typeof autoRenewTimer.unref === \"function\") {\n              autoRenewTimer.unref();\n            }\n\n            linkMessageMap.set(bMessage.messageId as string, autoRenewTimer);\n          } else {\n            logger.verbose(\n              `${logPrefix} Looks like the message lock renew timer has already been cleared for message with id '${bMessage.messageId}'.`,\n            );\n          }\n        }\n      };\n\n      // start\n      autoRenewLockTask();\n    } catch (err: any) {\n      onError(err);\n    }\n  }\n\n  private _getOrCreateMapForLink(linkEntity: MinimalLink): Map<string, NodeJS.Timeout | undefined> {\n    if (!this._messageRenewLockTimers.has(linkEntity.name)) {\n      this._messageRenewLockTimers.set(\n        linkEntity.name,\n        new Map<string, NodeJS.Timeout | undefined>(),\n      );\n    }\n\n    return this._messageRenewLockTimers.get(linkEntity.name)!;\n  }\n\n  private _stopAndRemoveById(\n    linkEntity: MinimalLink,\n    linkMessageMap: Map<string, NodeJS.Timeout | undefined>,\n    messageId: string | undefined,\n  ): void {\n    if (messageId == null) {\n      throw new Error(\"Failed to stop auto lock renewal - no message ID\");\n    }\n\n    // TODO: messageId doesn't actually need to be unique. Perhaps we should use lockToken\n    // instead?\n    if (linkMessageMap.has(messageId)) {\n      clearTimeout(linkMessageMap.get(messageId) as NodeJS.Timeout);\n      logger.verbose(\n        `${linkEntity.logPrefix} Cleared the message renew lock timer for message with id '${messageId}'.`,\n      );\n      linkMessageMap.delete(messageId);\n    }\n  }\n}\n"]}

package/dist/react-native/core/batchingReceiver.d.ts

@@ -0,0 +1,120 @@
+import type { AmqpError, Receiver as RheaPromiseReceiver, Session } from "rhea-promise";
+import { ServiceBusMessageImpl } from "../serviceBusMessage.js";
+import type { ReceiveOptions } from "./messageReceiver.js";
+import { MessageReceiver } from "./messageReceiver.js";
+import type { ConnectionContext } from "../connectionContext.js";
+import type { AbortSignalLike } from "@azure/abort-controller";
+import type { OperationOptionsBase } from "../modelsToBeSharedWithEventHubs.js";
+import type { ReceiveMode } from "../models.js";
+/**
+ * Describes the batching receiver where the user can receive a specified number of messages for
+ * a predefined time.
+ * @internal
+ */
+export declare class BatchingReceiver extends MessageReceiver {
+    /**
+     * Instantiate a new BatchingReceiver.
+     *
+     * @param identifier - name to identify this receiver.
+     * @param connectionContext - The client entity context.
+     * @param options - Options for how you'd like to connect.
+     */
+    constructor(identifier: string, connectionContext: ConnectionContext, entityPath: string, options: ReceiveOptions);
+    private _batchingReceiverLite;
+    get isReceivingMessages(): boolean;
+    /**
+     * To be called when connection is disconnected to gracefully close ongoing receive request.
+     * @param connectionError - The connection error if any.
+     */
+    onDetached(connectionError?: AmqpError | Error): Promise<void>;
+    /**
+     * Receives a batch of messages from a ServiceBus Queue/Topic.
+     * @param maxMessageCount - The maximum number of messages to receive.
+     * In Peeklock mode, this number is capped at 2047 due to constraints of the underlying buffer.
+     * @param maxWaitTimeInMs - The total wait time in milliseconds until which the receiver will attempt to receive specified number of messages.
+     * @param maxTimeAfterFirstMessageInMs - The total amount of time to wait after the first message
+     * has been received. Defaults to 1 second.
+     * If this time elapses before the `maxMessageCount` is reached, then messages collected till then will be returned to the user.
+     * @returns A promise that resolves with an array of Message objects.
+     */
+    receive(maxMessageCount: number, maxWaitTimeInMs: number, maxTimeAfterFirstMessageInMs: number, options: OperationOptionsBase): Promise<ServiceBusMessageImpl[]>;
+    static create(clientId: string, context: ConnectionContext, entityPath: string, options: ReceiveOptions): BatchingReceiver;
+    protected removeLinkFromContext(): void;
+}
+/**
+ * Gets a function that returns the smaller of the two timeouts,
+ * taking into account elapsed time from when getRemainingWaitTimeInMsFn
+ * was called.
+ *
+ * @param maxWaitTimeInMs - Maximum time to wait for the first message
+ * @param maxTimeAfterFirstMessageInMs - Maximum time to wait after the first message before completing the receive.
+ *
+ * @internal
+ */
+export declare function getRemainingWaitTimeInMsFn(maxWaitTimeInMs: number, maxTimeAfterFirstMessageInMs: number): () => number;
+/**
+ * Useful interface that mimics EventEmitter without requiring us to actually
+ * import the events definition (which is annoying with browsers).
+ *
+ * @internal
+ */
+type EventEmitterLike<T extends RheaPromiseReceiver | Session> = Pick<T, "once" | "removeListener" | "on">;
+/**
+ * The bare minimum needed to receive messages for batched
+ * message receiving.
+ *
+ * @internal
+ */
+export type MinimalReceiver = Pick<RheaPromiseReceiver, "name" | "isOpen" | "credit" | "addCredit" | "drain" | "drainCredit" | "close"> & EventEmitterLike<RheaPromiseReceiver> & {
+    session: EventEmitterLike<Session>;
+} & {
+    connection: {
+        id: string;
+    };
+};
+/**
+ * @internal
+ */
+interface ReceiveMessageArgs extends OperationOptionsBase {
+    maxMessageCount: number;
+    maxWaitTimeInMs: number;
+    maxTimeAfterFirstMessageInMs: number;
+}
+/**
+ * The internals of a batching receiver minus anything that would require us to hold onto a client entity context
+ * or a receiver on a permanent basis.
+ *
+ * Usable with both session and non-session receivers.
+ *
+ * @internal
+ */
+export declare class BatchingReceiverLite {
+    private _connectionContext;
+    entityPath: string;
+    private _getCurrentReceiver;
+    private _receiveMode;
+    private _drainTimeoutInMs;
+    constructor(_connectionContext: ConnectionContext, entityPath: string, _getCurrentReceiver: (abortSignal?: AbortSignalLike) => Promise<MinimalReceiver | undefined>, _receiveMode: ReceiveMode, _skipParsingBodyAsJson: boolean, _skipConvertingDate: boolean);
+    private _createServiceBusMessage;
+    private _getRemainingWaitTimeInMsFn;
+    private _closeHandler;
+    private _finalAction;
+    isReceivingMessages: boolean;
+    /**
+     * Receives a set of messages,
+     *
+     * @internal
+     * @hidden
+     */
+    receiveMessages(args: ReceiveMessageArgs): Promise<ServiceBusMessageImpl[]>;
+    /**
+     * Closes the receiver (optionally with an error), cancelling any current operations.
+     *
+     * @param connectionError - An optional error (rhea doesn't always deliver one for certain disconnection events)
+     */
+    terminate(connectionError?: Error | AmqpError): void;
+    private tryDrainReceiver;
+    private _receiveMessagesImpl;
+}
+export {};
+//# sourceMappingURL=batchingReceiver.d.ts.map

package/dist/react-native/core/batchingReceiver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batchingReceiver.d.ts","sourceRoot":"","sources":["../../../src/core/batchingReceiver.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,SAAS,EAGT,QAAQ,IAAI,mBAAmB,EAC/B,OAAO,EACR,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAAwB,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAG/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAEhF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAIhD;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,eAAe;IACnD;;;;;;OAMG;gBAED,UAAU,EAAE,MAAM,EAClB,iBAAiB,EAAE,iBAAiB,EACpC,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,cAAc;IA0CzB,OAAO,CAAC,qBAAqB,CAAuB;IAEpD,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IAED;;;OAGG;IACG,UAAU,CAAC,eAAe,CAAC,EAAE,SAAS,GAAG,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAYpE;;;;;;;;;OASG;IACG,OAAO,CACX,eAAe,EAAE,MAAM,EACvB,eAAe,EAAE,MAAM,EACvB,4BAA4B,EAAE,MAAM,EACpC,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,qBAAqB,EAAE,CAAC;IA0BnC,MAAM,CAAC,MAAM,CACX,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,iBAAiB,EAC1B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,cAAc,GACtB,gBAAgB;IAOnB,SAAS,CAAC,qBAAqB,IAAI,IAAI;CAGxC;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACxC,eAAe,EAAE,MAAM,EACvB,4BAA4B,EAAE,MAAM,GACnC,MAAM,MAAM,CAYd;AAED;;;;;GAKG;AACH,KAAK,gBAAgB,CAAC,CAAC,SAAS,mBAAmB,GAAG,OAAO,IAAI,IAAI,CACnE,CAAC,EACD,MAAM,GAAG,gBAAgB,GAAG,IAAI,CACjC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,CAChC,mBAAmB,EACnB,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,OAAO,CAC/E,GACC,gBAAgB,CAAC,mBAAmB,CAAC,GAAG;IACtC,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;CACpC,GAAG;IACF,UAAU,EAAE;QACV,EAAE,EAAE,MAAM,CAAC;KACZ,CAAC;CACH,CAAC;AAOJ;;GAEG;AACH,UAAU,kBAAmB,SAAQ,oBAAoB;IACvD,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,4BAA4B,EAAE,MAAM,CAAC;CACtC;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAoB;IAI7B,OAAO,CAAC,kBAAkB;IACnB,UAAU,EAAE,MAAM;IACzB,OAAO,CAAC,mBAAmB;IAG3B,OAAO,CAAC,YAAY;IAPtB,OAAO,CAAC,iBAAiB,CAAmC;gBAElD,kBAAkB,EAAE,iBAAiB,EACtC,UAAU,EAAE,MAAM,EACjB,mBAAmB,EAAE,CAC3B,WAAW,CAAC,EAAE,eAAe,KAC1B,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,EACjC,YAAY,EAAE,WAAW,EACjC,sBAAsB,EAAE,OAAO,EAC/B,mBAAmB,EAAE,OAAO;IAqB9B,OAAO,CAAC,wBAAwB,CAEL;IAE3B,OAAO,CAAC,2BAA2B,CAAoC;IACvE,OAAO,CAAC,aAAa,CAA8D;IACnF,OAAO,CAAC,YAAY,CAA2B;IAE/C,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;;;;OAKG;IACU,eAAe,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAyBxF;;;;OAIG;IACH,SAAS,CAAC,eAAe,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,IAAI;YAOtC,gBAAgB;IAuD9B,OAAO,CAAC,oBAAoB;CAiN7B"}