@azure/core-amqp 4.1.1-alpha.20240108.2 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (22) hide show
  1. package/dist/index.js +28 -3
  2. package/dist/index.js.map +1 -1
  3. package/dist-esm/src/ConnectionContextBase.js.map +1 -1
  4. package/dist-esm/src/amqpAnnotatedMessage.js +28 -3
  5. package/dist-esm/src/amqpAnnotatedMessage.js.map +1 -1
  6. package/dist-esm/src/auth/tokenProvider.js.map +1 -1
  7. package/dist-esm/src/cbs.js.map +1 -1
  8. package/dist-esm/src/connectionConfig/connectionConfig.js.map +1 -1
  9. package/dist-esm/src/errors.js.map +1 -1
  10. package/dist-esm/src/log.js.map +1 -1
  11. package/dist-esm/src/messageHeader.js.map +1 -1
  12. package/dist-esm/src/messageProperties.js.map +1 -1
  13. package/dist-esm/src/requestResponseLink.js.map +1 -1
  14. package/dist-esm/src/retry.js.map +1 -1
  15. package/dist-esm/src/util/checkNetworkConnection.js.map +1 -1
  16. package/dist-esm/src/util/constants.js +1 -0
  17. package/dist-esm/src/util/constants.js.map +1 -1
  18. package/dist-esm/src/util/lock.js.map +1 -1
  19. package/dist-esm/src/util/runtimeInfo.browser.js.map +1 -1
  20. package/dist-esm/src/util/utils.js.map +1 -1
  21. package/package.json +4 -4
  22. package/types/latest/core-amqp.d.ts +19 -18
package/dist-esm/src/requestResponseLink.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"requestResponseLink.js","sourceRoot":"","sources":["../../src/requestResponseLink.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAmB,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAIL,cAAc,EAKd,YAAY,EAGZ,aAAa,GACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAiC7C;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;;;OAIG;IACH,YACS,OAAgB,EAChB,MAAc,EACd,QAAkB;QAFlB,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAQ;QACd,aAAQ,GAAR,QAAQ,CAAU;QAa3B;;;;WAIG;QACK,kBAAa,GAA6C,IAAI,GAAG,EAGtE,CAAC;QAnBF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;YACnD,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,EAAE;YACnD,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;IACL,CAAC;IAYD;;;OAGG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,OAAoB,EAAE,UAA8B,EAAE;QAChE,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,SAAS,CAAC,2BAA2B,CAAC;QAEjF,MAAM,OAAO,GAAgC,OAAO,CAAC,WAAW,CAAC;QAEjE,4EAA4E;QAC5E,oGAAoG;QACpG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YACvB,OAAO,CAAC,UAAU,GAAG,aAAa,EAAE,CAAC;SACtC;QAED,OAAO,IAAI,OAAO,CAAc,CAAC,OAAY,EAAE,MAAW,EAAE,EAAE;YAC5D,IAAI,KAAK,GAA8C,SAAS,CAAC;YAEjE,MAAM,aAAa,GAAG,GAAS,EAAE;gBAC/B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,UAAoB,CAAC,CAAC;gBACxD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,SAAS,CAAC;gBACnD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;gBACxC,MAAM,IAAI,GACR,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,kBAAkB,WAAW,IAAI;oBACvD,OAAO,OAAO,mCAAmC,CAAC;gBACpD,6EAA6E;gBAC7E,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAClB,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC;gBAEnD,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC;YAEF,MAAM,OAAO,GAAG,GAAS,EAAE;gBACzB,2DAA2D;gBAC3D,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;oBACpB,YAAY,CAAC,KAAK,CAAC,CAAC;iBACrB;gBACD,OAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAE/C,aAAa,EAAE,CAAC;YAClB,CAAC,CAAC;YAEF,IAAI,OAAO,EAAE;gBACX,+DAA+D;gBAC/D,qDAAqD;gBACrD,IAAI,OAAO,CAAC,OAAO,EAAE;oBACnB,OAAO,aAAa,EAAE,CAAC;iBACxB;gBACD,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;aAC5C;YAED,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;;gBACtB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,UAAoB,CAAC,CAAC;gBACxD,IAAI,OAAO,EAAE;oBACX,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;iBAC/C;gBACD,MAAM,OAAO,GAAG,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,KAAI,SAAS,CAAC;gBACpD,MAAM,IAAI,GACR,gCAAgC,OAAO,CAAC,UAAU,SAAS,OAAO,IAAI;oBACtE,6CAA6C,CAAC;gBAChD,MAAM,CAAC,GAAU;oBACf,IAAI,EAAE,uBAAuB;oBAC7B,OAAO,EAAE,IAAI;iBACd,CAAC;gBACF,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9B,CAAC,EAAE,WAAW,CAAC,CAAC;YAEhB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,UAAoB,EAAE;gBACnD,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,MAAM;gBACd,4BAA4B,EAAE,GAAG,EAAE;oBACjC,IAAI,OAAO;wBAAE,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBAC3D,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;wBACpB,YAAY,CAAC,KAAK,CAAC,CAAC;qBACrB;gBACH,CAAC;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,OAAO,CACZ,0BAA0B,EAC1B,IAAI,CAAC,UAAU,CAAC,EAAE,EAClB,OAAO,CAAC,EAAE,IAAI,aAAa,EAC3B,OAAO,CACR,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACjD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,UAAsB,EACtB,aAA4B,EAC5B,eAAgC,EAChC,gBAAmD,EAAE;QAErD,MAAM,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC;QACtC,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,YAAY,iCAAM,aAAa,KAAE,WAAW,IAAG,CAAC;QAC7E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,cAAc,iCAAM,eAAe,KAAE,WAAW,IAAG,CAAC;QACnF,MAAM,CAAC,OAAO,CACZ,8EAA8E,EAC9E,UAAU,CAAC,EAAE,CACd,CAAC;QACF,OAAO,IAAI,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;CACF;AAYD;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,QAAwD,EAAE,EAC1C,EAAE;IAClB,OAAO;QACL,UAAU,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,UAAU,CAAW;QACvE,iBAAiB,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAW;QAC5F,cAAc,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,KAAK,CAAC,cAAc,CAAW;KACpF,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAsC,EACtC,YAAoB,EACpB,YAAsD;IAEtD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,CAAC,OAAO,CACZ,IAAI,YAAY,+EAA+E;YAC7F,4FAA4F;YAC5F,sCAAsC,CACzC,CAAC;QACF,OAAO;KACR;IAED,MAAM,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IACrD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,qBAA+B,CAAC,EAAE;QACtD,MAAM,CAAC,OAAO,CACZ,IAAI,YAAY,oBAAoB,qBAAqB,iDAAiD;YACxG,wGAAwG;YACxG,+DAA+D,CAClE,CAAC;QACF,OAAO;KACR;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,qBAA+B,CAAgC,CAAC;IACjG,OAAO,CAAC,4BAA4B,EAAE,CAAC;IAEvC,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,qBAA+B,CAAC,CAAC;IAC1E,MAAM,CAAC,OAAO,CACZ,IAAI,YAAY,+CAA+C,qBAAqB,iBAAiB;QACnG,mBAAmB,YAAY,EAAE,CACpC,CAAC;IAEF,MAAM,IAAI,GAAG,0BAA0B,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACxE,IAAI,KAAK,CAAC;IACV,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;QACpB,KAAK,GAAG,IAAI,KAAK,CACf,IAAI,YAAY,iGAAiG,qBAAqB,EAAE,CACzI,CAAC;KACH;IACD,IAAI,IAAI,CAAC,UAAU,GAAG,GAAG,IAAI,IAAI,CAAC,UAAU,GAAG,GAAG,EAAE;QAClD,MAAM,CAAC,OAAO,CACZ,IAAI,YAAY,iDAAiD,qBAAqB,EAAE,CACzF,CAAC;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;KACjC;IACD,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,SAAS,GACb,IAAI,CAAC,cAAc,IAAI,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,qBAAqB,CAAC;QACzF,KAAK,GAAG,SAAS,CAAC;YAChB,SAAS,EAAE,SAAS;YACpB,WAAW,EAAE,IAAI,CAAC,iBAAiB;SACpC,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,KAAK,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,EAAE,CAAC,CAAC;KACrD;IACD,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC1B,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,aAAa,CACpB,OAAqC,EACrC,YAAoB,EACpB,YAAsD;IAEtD,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,YAAY,CAAC,OAAO,EAAE,EAAE;YACnD,MAAM,CAAC,OAAO,CACZ,IAAI,YAAY,sEAAsE,GAAG,GAAG,CAC7F,CAAC;YACF,OAAO,CAAC,4BAA4B,EAAE,CAAC;YACvC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACtC;QACD,YAAY,CAAC,KAAK,EAAE,CAAC;KACtB;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AbortError, AbortSignalLike } from \"@azure/abort-controller\";\nimport { ConditionStatusMapper, translate } from \"./errors\";\nimport {\n Connection,\n EventContext,\n Receiver,\n ReceiverEvents,\n ReceiverOptions,\n ReqResLink,\n Message as RheaMessage,\n Sender,\n SenderEvents,\n SenderOptions,\n Session,\n generate_uuid,\n} from \"rhea-promise\";\nimport { Constants, StandardAbortMessage } from \"./util/constants\";\nimport { logErrorStackTrace, logger } from \"./log\";\nimport { isDefined } from \"@azure/core-util\";\n\n/**\n * Describes the options that can be specified while sending a request.\n */\nexport interface SendRequestOptions {\n /**\n * Cancels the operation.\n */\n abortSignal?: AbortSignalLike;\n /**\n * Max time to wait for the operation to complete.\n * Default: `60000 milliseconds`.\n */\n timeoutInMs?: number;\n /**\n * Name of the request being performed.\n */\n requestName?: string;\n}\n\n/**\n * @internal\n */\nexport interface DeferredPromiseWithCallback {\n resolve: (value?: any) => void;\n reject: (reason?: any) => void;\n /**\n * To be called before resolving or rejecting the deferred promise\n */\n cleanupBeforeResolveOrReject: () => void;\n}\n\n/**\n * Describes an amqp request(sender)-response(receiver) link that is created over an amqp session.\n */\nexport class RequestResponseLink implements ReqResLink {\n /**\n * @param session - The amqp session.\n * @param sender - The amqp sender link.\n * @param receiver - The amqp receiver link.\n */\n constructor(\n public session: Session,\n public sender: Sender,\n public receiver: Receiver,\n ) {\n this.session = session;\n this.sender = sender;\n this.receiver = receiver;\n this.receiver.on(ReceiverEvents.message, (context) => {\n onMessageReceived(context, this.connection.id, this._responsesMap);\n });\n this.sender.on(SenderEvents.senderError, (context) => {\n onSenderError(context, this.connection.id, this._responsesMap);\n });\n }\n\n /**\n * Maintains a map of responses that\n * are being actively returned. It acts as a store for correlating the responses received for\n * the send requests.\n */\n private _responsesMap: Map<string, DeferredPromiseWithCallback> = new Map<\n string,\n DeferredPromiseWithCallback\n >();\n\n /**\n * Provides the underlying amqp connection object.\n * @returns Connection.\n */\n get connection(): Connection {\n return this.session.connection;\n }\n\n /**\n * Indicates whether the session and the sender and receiver links are all open or closed.\n * @returns boolean - `true` - `open`, `false` - `closed`.\n */\n isOpen(): boolean {\n return this.session.isOpen() && this.sender.isOpen() && this.receiver.isOpen();\n }\n\n /**\n * Sends the given request message and returns the received response. If the operation is not\n * completed in the provided timeout in milliseconds `default: 60000`, then `OperationTimeoutError` is thrown.\n *\n * @param request - The AMQP (request) message.\n * @param options - Options that can be provided while sending a request.\n * @returns Promise<Message> The AMQP (response) message.\n */\n sendRequest(request: RheaMessage, options: SendRequestOptions = {}): Promise<RheaMessage> {\n const timeoutInMs = options.timeoutInMs || Constants.defaultOperationTimeoutInMs;\n\n const aborter: AbortSignalLike | undefined = options.abortSignal;\n\n // If message_id is not already set on the request, set it to a unique value\n // This helps in determining the right response for current request among multiple incoming messages\n if (!request.message_id) {\n request.message_id = generate_uuid();\n }\n\n return new Promise<RheaMessage>((resolve: any, reject: any) => {\n let timer: ReturnType<typeof setTimeout> | undefined = undefined;\n\n const rejectOnAbort = (): void => {\n this._responsesMap.delete(request.message_id as string);\n const address = this.receiver.address || \"address\";\n const requestName = options.requestName;\n const desc: string =\n `[${this.connection.id}] The request \"${requestName}\" ` +\n `to \"${address}\" has been cancelled by the user.`;\n // Cancellation is a user-intended action, so log to info instead of warning.\n logger.info(desc);\n const error = new AbortError(StandardAbortMessage);\n\n reject(error);\n };\n\n const onAbort = (): void => {\n // safe to clear the timeout if it hasn't already occurred.\n if (isDefined(timer)) {\n clearTimeout(timer);\n }\n aborter!.removeEventListener(\"abort\", onAbort);\n\n rejectOnAbort();\n };\n\n if (aborter) {\n // the aborter may have been triggered between request attempts\n // so check if it was triggered and reject if needed.\n if (aborter.aborted) {\n return rejectOnAbort();\n }\n aborter.addEventListener(\"abort\", onAbort);\n }\n\n timer = setTimeout(() => {\n this._responsesMap.delete(request.message_id as string);\n if (aborter) {\n aborter.removeEventListener(\"abort\", onAbort);\n }\n const address = this.receiver?.address || \"address\";\n const desc: string =\n `The request with message_id \"${request.message_id}\" to \"${address}\" ` +\n `endpoint timed out. Please try again later.`;\n const e: Error = {\n name: \"OperationTimeoutError\",\n message: desc,\n };\n return reject(translate(e));\n }, timeoutInMs);\n\n this._responsesMap.set(request.message_id as string, {\n resolve: resolve,\n reject: reject,\n cleanupBeforeResolveOrReject: () => {\n if (aborter) aborter.removeEventListener(\"abort\", onAbort);\n if (isDefined(timer)) {\n clearTimeout(timer);\n }\n },\n });\n\n logger.verbose(\n \"[%s] %s request sent: %O\",\n this.connection.id,\n request.to || \"$management\",\n request,\n );\n this.sender.send(request);\n });\n }\n\n /**\n * Closes the sender, receiver link and the underlying session.\n * @returns Promise<void>\n */\n async close(): Promise<void> {\n await this.sender.close({ closeSession: false });\n await this.receiver.close({ closeSession: false });\n await this.session.close();\n }\n\n /**\n * Removes the sender, receiver link and it's underlying session.\n * @returns void\n */\n remove(): void {\n this.sender.remove();\n this.receiver.remove();\n this.session.remove();\n }\n\n /**\n * Creates an amqp request/response link.\n *\n * @param connection - The amqp connection.\n * @param senderOptions - Options that must be provided to create the sender link.\n * @param receiverOptions - Options that must be provided to create the receiver link.\n * @param createOptions - Optional parameters that can be used to affect this method's behavior.\n * For example, `abortSignal` can be passed to allow cancelling an in-progress `create` invocation.\n * @returns Promise<RequestResponseLink>\n */\n static async create(\n connection: Connection,\n senderOptions: SenderOptions,\n receiverOptions: ReceiverOptions,\n createOptions: { abortSignal?: AbortSignalLike } = {},\n ): Promise<RequestResponseLink> {\n const { abortSignal } = createOptions;\n const session = await connection.createSession({ abortSignal });\n const sender = await session.createSender({ ...senderOptions, abortSignal });\n const receiver = await session.createReceiver({ ...receiverOptions, abortSignal });\n logger.verbose(\n \"[%s] Successfully created the sender and receiver links on the same session.\",\n connection.id,\n );\n return new RequestResponseLink(session, sender, receiver);\n }\n}\n/**\n * @internal\n *\n * Type used in getCodeDescriptionAndError to get the normalized info from the responses emitted by EventHubs and ServiceBus.\n */\ntype NormalizedInfo = {\n statusCode: number;\n statusDescription: string;\n errorCondition: string;\n};\n\n/**\n * @internal\n *\n * Handle different variations of property names in responses emitted by EventHubs and ServiceBus.\n */\nexport const getCodeDescriptionAndError = (\n props: { [key: string]: string | number | undefined } = {},\n): NormalizedInfo => {\n return {\n statusCode: (props[Constants.statusCode] || props.statusCode) as number,\n statusDescription: (props[Constants.statusDescription] || props.statusDescription) as string,\n errorCondition: (props[Constants.errorCondition] || props.errorCondition) as string,\n };\n};\n\n/**\n * This is used as the onMessage handler for the \"message\" event on the receiver.\n *\n * (This is inspired from the message settlement sequence in service-bus SDK which\n * relies on a single listener for settled event for all the messages.)\n * The sequence is as follows:\n * 1. User calls `await RequestResponseLink.sendRequest()`\n * 2. This creates a `Promise` that gets stored in the _responsesMap\n * 3. When the service acknowledges the response, this method gets called for that request.\n * 4. We resolve() the promise from the _responsesMap with the message.\n * 5. User's code after the sendRequest continues.\n *\n * @internal\n */\nexport function onMessageReceived(\n context: Pick<EventContext, \"message\">,\n connectionId: string,\n responsesMap: Map<string, DeferredPromiseWithCallback>,\n): void {\n const message = context.message;\n if (!message) {\n logger.verbose(\n `[${connectionId}] \"message\" property on the EventContext is \"undefined\" which is unexpected, ` +\n `returning from the \"onMessageReceived\" handler without resolving or rejecting the promise ` +\n `upon encountering the message event.`,\n );\n return;\n }\n\n const responseCorrelationId = message.correlation_id;\n if (!responsesMap.has(responseCorrelationId as string)) {\n logger.verbose(\n `[${connectionId}] correlationId \"${responseCorrelationId}\" property on the response does not match with ` +\n `any of the \"request-id\"s in the map, returning from the \"onMessageReceived\" handler without resolving ` +\n `or rejecting the promise upon encountering the message event.`,\n );\n return;\n }\n\n const promise = responsesMap.get(responseCorrelationId as string) as DeferredPromiseWithCallback;\n promise.cleanupBeforeResolveOrReject();\n\n const deleteResult = responsesMap.delete(responseCorrelationId as string);\n logger.verbose(\n `[${connectionId}] Successfully deleted the response with id ${responseCorrelationId} from the map. ` +\n `Delete result - ${deleteResult}`,\n );\n\n const info = getCodeDescriptionAndError(message.application_properties);\n let error;\n if (!info.statusCode) {\n error = new Error(\n `[${connectionId}] No statusCode in the \"application_properties\" in the returned response with correlation-id: ${responseCorrelationId}`,\n );\n }\n if (info.statusCode > 199 && info.statusCode < 300) {\n logger.verbose(\n `[${connectionId}] Resolving the response with correlation-id: ${responseCorrelationId}`,\n );\n return promise.resolve(message);\n }\n if (!error) {\n const condition =\n info.errorCondition || ConditionStatusMapper[info.statusCode] || \"amqp:internal-error\";\n error = translate({\n condition: condition,\n description: info.statusDescription,\n });\n logger.warning(`${error?.name}: ${error?.message}`);\n }\n logErrorStackTrace(error);\n return promise.reject(error);\n}\n\nfunction onSenderError(\n context: Pick<EventContext, \"sender\">,\n connectionId: string,\n responsesMap: Map<string, DeferredPromiseWithCallback>,\n): void {\n if (context.sender) {\n for (const [key, promise] of responsesMap.entries()) {\n logger.verbose(\n `[${connectionId}] Sender closed due to error when sending request with message_id \"${key}\"`,\n );\n promise.cleanupBeforeResolveOrReject();\n promise.reject(context.sender.error);\n }\n responsesMap.clear();\n }\n}\n"]}
1
+ {"version":3,"file":"requestResponseLink.js","sourceRoot":"","sources":["../../src/requestResponseLink.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAmB,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAIL,cAAc,EAKd,YAAY,EAGZ,aAAa,GACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAiC7C;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;;;OAIG;IACH,YACS,OAAgB,EAChB,MAAc,EACd,QAAkB;QAFlB,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAQ;QACd,aAAQ,GAAR,QAAQ,CAAU;QAa3B;;;;WAIG;QACK,kBAAa,GAA6C,IAAI,GAAG,EAGtE,CAAC;QAnBF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;YACnD,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,EAAE;YACnD,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;IACL,CAAC;IAYD;;;OAGG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,OAAoB,EAAE,UAA8B,EAAE;QAChE,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,SAAS,CAAC,2BAA2B,CAAC;QAEjF,MAAM,OAAO,GAAgC,OAAO,CAAC,WAAW,CAAC;QAEjE,4EAA4E;QAC5E,oGAAoG;QACpG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACxB,OAAO,CAAC,UAAU,GAAG,aAAa,EAAE,CAAC;QACvC,CAAC;QAED,OAAO,IAAI,OAAO,CAAc,CAAC,OAAY,EAAE,MAAW,EAAE,EAAE;YAC5D,IAAI,KAAK,GAA8C,SAAS,CAAC;YAEjE,MAAM,aAAa,GAAG,GAAS,EAAE;gBAC/B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,UAAoB,CAAC,CAAC;gBACxD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,SAAS,CAAC;gBACnD,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;gBACxC,MAAM,IAAI,GACR,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,kBAAkB,WAAW,IAAI;oBACvD,OAAO,OAAO,mCAAmC,CAAC;gBACpD,6EAA6E;gBAC7E,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAClB,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC;gBAEnD,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC;YAEF,MAAM,OAAO,GAAG,GAAS,EAAE;gBACzB,2DAA2D;gBAC3D,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrB,YAAY,CAAC,KAAK,CAAC,CAAC;gBACtB,CAAC;gBACD,OAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAE/C,aAAa,EAAE,CAAC;YAClB,CAAC,CAAC;YAEF,IAAI,OAAO,EAAE,CAAC;gBACZ,+DAA+D;gBAC/D,qDAAqD;gBACrD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;oBACpB,OAAO,aAAa,EAAE,CAAC;gBACzB,CAAC;gBACD,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7C,CAAC;YAED,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;;gBACtB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,UAAoB,CAAC,CAAC;gBACxD,IAAI,OAAO,EAAE,CAAC;oBACZ,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAChD,CAAC;gBACD,MAAM,OAAO,GAAG,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,KAAI,SAAS,CAAC;gBACpD,MAAM,IAAI,GACR,gCAAgC,OAAO,CAAC,UAAU,SAAS,OAAO,IAAI;oBACtE,6CAA6C,CAAC;gBAChD,MAAM,CAAC,GAAU;oBACf,IAAI,EAAE,uBAAuB;oBAC7B,OAAO,EAAE,IAAI;iBACd,CAAC;gBACF,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9B,CAAC,EAAE,WAAW,CAAC,CAAC;YAEhB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,UAAoB,EAAE;gBACnD,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,MAAM;gBACd,4BAA4B,EAAE,GAAG,EAAE;oBACjC,IAAI,OAAO;wBAAE,OAAO,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBAC3D,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;wBACrB,YAAY,CAAC,KAAK,CAAC,CAAC;oBACtB,CAAC;gBACH,CAAC;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,OAAO,CACZ,0BAA0B,EAC1B,IAAI,CAAC,UAAU,CAAC,EAAE,EAClB,OAAO,CAAC,EAAE,IAAI,aAAa,EAC3B,OAAO,CACR,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACjD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,UAAsB,EACtB,aAA4B,EAC5B,eAAgC,EAChC,gBAAmD,EAAE;QAErD,MAAM,EAAE,WAAW,EAAE,GAAG,aAAa,CAAC;QACtC,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,YAAY,iCAAM,aAAa,KAAE,WAAW,IAAG,CAAC;QAC7E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,cAAc,iCAAM,eAAe,KAAE,WAAW,IAAG,CAAC;QACnF,MAAM,CAAC,OAAO,CACZ,8EAA8E,EAC9E,UAAU,CAAC,EAAE,CACd,CAAC;QACF,OAAO,IAAI,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;CACF;AAYD;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,QAAwD,EAAE,EAC1C,EAAE;IAClB,OAAO;QACL,UAAU,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,UAAU,CAAW;QACvE,iBAAiB,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAW;QAC5F,cAAc,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,KAAK,CAAC,cAAc,CAAW;KACpF,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAsC,EACtC,YAAoB,EACpB,YAAsD;IAEtD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,CAAC,OAAO,CACZ,IAAI,YAAY,+EAA+E;YAC7F,4FAA4F;YAC5F,sCAAsC,CACzC,CAAC;QACF,OAAO;IACT,CAAC;IAED,MAAM,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IACrD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,qBAA+B,CAAC,EAAE,CAAC;QACvD,MAAM,CAAC,OAAO,CACZ,IAAI,YAAY,oBAAoB,qBAAqB,iDAAiD;YACxG,wGAAwG;YACxG,+DAA+D,CAClE,CAAC;QACF,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,qBAA+B,CAAgC,CAAC;IACjG,OAAO,CAAC,4BAA4B,EAAE,CAAC;IAEvC,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,qBAA+B,CAAC,CAAC;IAC1E,MAAM,CAAC,OAAO,CACZ,IAAI,YAAY,+CAA+C,qBAAqB,iBAAiB;QACnG,mBAAmB,YAAY,EAAE,CACpC,CAAC;IAEF,MAAM,IAAI,GAAG,0BAA0B,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACxE,IAAI,KAAK,CAAC;IACV,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;QACrB,KAAK,GAAG,IAAI,KAAK,CACf,IAAI,YAAY,iGAAiG,qBAAqB,EAAE,CACzI,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,GAAG,GAAG,IAAI,IAAI,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;QACnD,MAAM,CAAC,OAAO,CACZ,IAAI,YAAY,iDAAiD,qBAAqB,EAAE,CACzF,CAAC;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,SAAS,GACb,IAAI,CAAC,cAAc,IAAI,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,qBAAqB,CAAC;QACzF,KAAK,GAAG,SAAS,CAAC;YAChB,SAAS,EAAE,SAAS;YACpB,WAAW,EAAE,IAAI,CAAC,iBAAiB;SACpC,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,KAAK,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,EAAE,CAAC,CAAC;IACtD,CAAC;IACD,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC1B,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,aAAa,CACpB,OAAqC,EACrC,YAAoB,EACpB,YAAsD;IAEtD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,YAAY,CAAC,OAAO,EAAE,EAAE,CAAC;YACpD,MAAM,CAAC,OAAO,CACZ,IAAI,YAAY,sEAAsE,GAAG,GAAG,CAC7F,CAAC;YACF,OAAO,CAAC,4BAA4B,EAAE,CAAC;YACvC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;QACD,YAAY,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AbortError, AbortSignalLike } from \"@azure/abort-controller\";\nimport { ConditionStatusMapper, translate } from \"./errors\";\nimport {\n Connection,\n EventContext,\n Receiver,\n ReceiverEvents,\n ReceiverOptions,\n ReqResLink,\n Message as RheaMessage,\n Sender,\n SenderEvents,\n SenderOptions,\n Session,\n generate_uuid,\n} from \"rhea-promise\";\nimport { Constants, StandardAbortMessage } from \"./util/constants\";\nimport { logErrorStackTrace, logger } from \"./log\";\nimport { isDefined } from \"@azure/core-util\";\n\n/**\n * Describes the options that can be specified while sending a request.\n */\nexport interface SendRequestOptions {\n /**\n * Cancels the operation.\n */\n abortSignal?: AbortSignalLike;\n /**\n * Max time to wait for the operation to complete.\n * Default: `60000 milliseconds`.\n */\n timeoutInMs?: number;\n /**\n * Name of the request being performed.\n */\n requestName?: string;\n}\n\n/**\n * @internal\n */\nexport interface DeferredPromiseWithCallback {\n resolve: (value?: any) => void;\n reject: (reason?: any) => void;\n /**\n * To be called before resolving or rejecting the deferred promise\n */\n cleanupBeforeResolveOrReject: () => void;\n}\n\n/**\n * Describes an amqp request(sender)-response(receiver) link that is created over an amqp session.\n */\nexport class RequestResponseLink implements ReqResLink {\n /**\n * @param session - The amqp session.\n * @param sender - The amqp sender link.\n * @param receiver - The amqp receiver link.\n */\n constructor(\n public session: Session,\n public sender: Sender,\n public receiver: Receiver,\n ) {\n this.session = session;\n this.sender = sender;\n this.receiver = receiver;\n this.receiver.on(ReceiverEvents.message, (context) => {\n onMessageReceived(context, this.connection.id, this._responsesMap);\n });\n this.sender.on(SenderEvents.senderError, (context) => {\n onSenderError(context, this.connection.id, this._responsesMap);\n });\n }\n\n /**\n * Maintains a map of responses that\n * are being actively returned. It acts as a store for correlating the responses received for\n * the send requests.\n */\n private _responsesMap: Map<string, DeferredPromiseWithCallback> = new Map<\n string,\n DeferredPromiseWithCallback\n >();\n\n /**\n * Provides the underlying amqp connection object.\n * @returns Connection.\n */\n get connection(): Connection {\n return this.session.connection;\n }\n\n /**\n * Indicates whether the session and the sender and receiver links are all open or closed.\n * @returns boolean - `true` - `open`, `false` - `closed`.\n */\n isOpen(): boolean {\n return this.session.isOpen() && this.sender.isOpen() && this.receiver.isOpen();\n }\n\n /**\n * Sends the given request message and returns the received response. If the operation is not\n * completed in the provided timeout in milliseconds `default: 60000`, then `OperationTimeoutError` is thrown.\n *\n * @param request - The AMQP (request) message.\n * @param options - Options that can be provided while sending a request.\n * @returns Promise<Message> The AMQP (response) message.\n */\n sendRequest(request: RheaMessage, options: SendRequestOptions = {}): Promise<RheaMessage> {\n const timeoutInMs = options.timeoutInMs || Constants.defaultOperationTimeoutInMs;\n\n const aborter: AbortSignalLike | undefined = options.abortSignal;\n\n // If message_id is not already set on the request, set it to a unique value\n // This helps in determining the right response for current request among multiple incoming messages\n if (!request.message_id) {\n request.message_id = generate_uuid();\n }\n\n return new Promise<RheaMessage>((resolve: any, reject: any) => {\n let timer: ReturnType<typeof setTimeout> | undefined = undefined;\n\n const rejectOnAbort = (): void => {\n this._responsesMap.delete(request.message_id as string);\n const address = this.receiver.address || \"address\";\n const requestName = options.requestName;\n const desc: string =\n `[${this.connection.id}] The request \"${requestName}\" ` +\n `to \"${address}\" has been cancelled by the user.`;\n // Cancellation is a user-intended action, so log to info instead of warning.\n logger.info(desc);\n const error = new AbortError(StandardAbortMessage);\n\n reject(error);\n };\n\n const onAbort = (): void => {\n // safe to clear the timeout if it hasn't already occurred.\n if (isDefined(timer)) {\n clearTimeout(timer);\n }\n aborter!.removeEventListener(\"abort\", onAbort);\n\n rejectOnAbort();\n };\n\n if (aborter) {\n // the aborter may have been triggered between request attempts\n // so check if it was triggered and reject if needed.\n if (aborter.aborted) {\n return rejectOnAbort();\n }\n aborter.addEventListener(\"abort\", onAbort);\n }\n\n timer = setTimeout(() => {\n this._responsesMap.delete(request.message_id as string);\n if (aborter) {\n aborter.removeEventListener(\"abort\", onAbort);\n }\n const address = this.receiver?.address || \"address\";\n const desc: string =\n `The request with message_id \"${request.message_id}\" to \"${address}\" ` +\n `endpoint timed out. Please try again later.`;\n const e: Error = {\n name: \"OperationTimeoutError\",\n message: desc,\n };\n return reject(translate(e));\n }, timeoutInMs);\n\n this._responsesMap.set(request.message_id as string, {\n resolve: resolve,\n reject: reject,\n cleanupBeforeResolveOrReject: () => {\n if (aborter) aborter.removeEventListener(\"abort\", onAbort);\n if (isDefined(timer)) {\n clearTimeout(timer);\n }\n },\n });\n\n logger.verbose(\n \"[%s] %s request sent: %O\",\n this.connection.id,\n request.to || \"$management\",\n request,\n );\n this.sender.send(request);\n });\n }\n\n /**\n * Closes the sender, receiver link and the underlying session.\n * @returns Promise<void>\n */\n async close(): Promise<void> {\n await this.sender.close({ closeSession: false });\n await this.receiver.close({ closeSession: false });\n await this.session.close();\n }\n\n /**\n * Removes the sender, receiver link and it's underlying session.\n * @returns void\n */\n remove(): void {\n this.sender.remove();\n this.receiver.remove();\n this.session.remove();\n }\n\n /**\n * Creates an amqp request/response link.\n *\n * @param connection - The amqp connection.\n * @param senderOptions - Options that must be provided to create the sender link.\n * @param receiverOptions - Options that must be provided to create the receiver link.\n * @param createOptions - Optional parameters that can be used to affect this method's behavior.\n * For example, `abortSignal` can be passed to allow cancelling an in-progress `create` invocation.\n * @returns Promise<RequestResponseLink>\n */\n static async create(\n connection: Connection,\n senderOptions: SenderOptions,\n receiverOptions: ReceiverOptions,\n createOptions: { abortSignal?: AbortSignalLike } = {},\n ): Promise<RequestResponseLink> {\n const { abortSignal } = createOptions;\n const session = await connection.createSession({ abortSignal });\n const sender = await session.createSender({ ...senderOptions, abortSignal });\n const receiver = await session.createReceiver({ ...receiverOptions, abortSignal });\n logger.verbose(\n \"[%s] Successfully created the sender and receiver links on the same session.\",\n connection.id,\n );\n return new RequestResponseLink(session, sender, receiver);\n }\n}\n/**\n * @internal\n *\n * Type used in getCodeDescriptionAndError to get the normalized info from the responses emitted by EventHubs and ServiceBus.\n */\ntype NormalizedInfo = {\n statusCode: number;\n statusDescription: string;\n errorCondition: string;\n};\n\n/**\n * @internal\n *\n * Handle different variations of property names in responses emitted by EventHubs and ServiceBus.\n */\nexport const getCodeDescriptionAndError = (\n props: { [key: string]: string | number | undefined } = {},\n): NormalizedInfo => {\n return {\n statusCode: (props[Constants.statusCode] || props.statusCode) as number,\n statusDescription: (props[Constants.statusDescription] || props.statusDescription) as string,\n errorCondition: (props[Constants.errorCondition] || props.errorCondition) as string,\n };\n};\n\n/**\n * This is used as the onMessage handler for the \"message\" event on the receiver.\n *\n * (This is inspired from the message settlement sequence in service-bus SDK which\n * relies on a single listener for settled event for all the messages.)\n * The sequence is as follows:\n * 1. User calls `await RequestResponseLink.sendRequest()`\n * 2. This creates a `Promise` that gets stored in the _responsesMap\n * 3. When the service acknowledges the response, this method gets called for that request.\n * 4. We resolve() the promise from the _responsesMap with the message.\n * 5. User's code after the sendRequest continues.\n *\n * @internal\n */\nexport function onMessageReceived(\n context: Pick<EventContext, \"message\">,\n connectionId: string,\n responsesMap: Map<string, DeferredPromiseWithCallback>,\n): void {\n const message = context.message;\n if (!message) {\n logger.verbose(\n `[${connectionId}] \"message\" property on the EventContext is \"undefined\" which is unexpected, ` +\n `returning from the \"onMessageReceived\" handler without resolving or rejecting the promise ` +\n `upon encountering the message event.`,\n );\n return;\n }\n\n const responseCorrelationId = message.correlation_id;\n if (!responsesMap.has(responseCorrelationId as string)) {\n logger.verbose(\n `[${connectionId}] correlationId \"${responseCorrelationId}\" property on the response does not match with ` +\n `any of the \"request-id\"s in the map, returning from the \"onMessageReceived\" handler without resolving ` +\n `or rejecting the promise upon encountering the message event.`,\n );\n return;\n }\n\n const promise = responsesMap.get(responseCorrelationId as string) as DeferredPromiseWithCallback;\n promise.cleanupBeforeResolveOrReject();\n\n const deleteResult = responsesMap.delete(responseCorrelationId as string);\n logger.verbose(\n `[${connectionId}] Successfully deleted the response with id ${responseCorrelationId} from the map. ` +\n `Delete result - ${deleteResult}`,\n );\n\n const info = getCodeDescriptionAndError(message.application_properties);\n let error;\n if (!info.statusCode) {\n error = new Error(\n `[${connectionId}] No statusCode in the \"application_properties\" in the returned response with correlation-id: ${responseCorrelationId}`,\n );\n }\n if (info.statusCode > 199 && info.statusCode < 300) {\n logger.verbose(\n `[${connectionId}] Resolving the response with correlation-id: ${responseCorrelationId}`,\n );\n return promise.resolve(message);\n }\n if (!error) {\n const condition =\n info.errorCondition || ConditionStatusMapper[info.statusCode] || \"amqp:internal-error\";\n error = translate({\n condition: condition,\n description: info.statusDescription,\n });\n logger.warning(`${error?.name}: ${error?.message}`);\n }\n logErrorStackTrace(error);\n return promise.reject(error);\n}\n\nfunction onSenderError(\n context: Pick<EventContext, \"sender\">,\n connectionId: string,\n responsesMap: Map<string, DeferredPromiseWithCallback>,\n): void {\n if (context.sender) {\n for (const [key, promise] of responsesMap.entries()) {\n logger.verbose(\n `[${connectionId}] Sender closed due to error when sending request with message_id \"${key}\"`,\n );\n promise.cleanupBeforeResolveOrReject();\n promise.reject(context.sender.error);\n }\n responsesMap.clear();\n }\n}\n"]}
package/dist-esm/src/retry.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"retry.js","sourceRoot":"","sources":["../../src/retry.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,2BAA2B;AAE3B,OAAO,EAAkB,SAAS,EAAE,MAAM,UAAU,CAAC;AAErD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B;;;GAGG;AACH,SAAS,UAAU,CAAC,GAAQ;IAC1B,IAAI,MAAM,GAAY,KAAK,CAAC;IAC5B,IACE,GAAG;QACH,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ;QAC1B,OAAO,GAAG,CAAC,OAAO,KAAK,SAAS;QAChC,OAAO,GAAG,CAAC,cAAc,KAAK,SAAS;QACvC,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,EAC9B;QACA,MAAM,GAAG,IAAI,CAAC;KACf;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,uDAAW,CAAA;IACX,2CAAK,CAAA;AACP,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,+CAAyB,CAAA;IACzB,+CAAyB,CAAA;IACzB,mDAA6B,CAAA;IAC7B,+CAAyB,CAAA;IACzB,iDAA2B,CAAA;IAC3B,uDAAiC,CAAA;IACjC,yCAAmB,CAAA;IACnB,sDAAgC,CAAA;AAClC,CAAC,EAVW,kBAAkB,KAAlB,kBAAkB,QAU7B;AAoED;;;GAGG;AACH,SAAS,mBAAmB,CAAI,MAAsB;IACpD,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;QACrB,MAAM,IAAI,SAAS,CAAC,4CAA4C,CAAC,CAAC;KACnE;IAED,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;QACxB,MAAM,IAAI,SAAS,CAAC,+CAA+C,CAAC,CAAC;KACtE;IAED,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE;QACzB,MAAM,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAAC;KACvE;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CACrB,YAAoB,EACpB,cAAsB,EACtB,iBAAyB,EACzB,IAAe;IAEf,IAAI,IAAI,KAAK,SAAS,CAAC,WAAW,EAAE;QAClC,MAAM,gBAAgB,GACpB,cAAc,GAAG,GAAG;YACpB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG,GAAG,GAAG,cAAc,GAAG,GAAG,CAAC,CAAC,CAAC;QAE5E,MAAM,cAAc,GAAG,gBAAgB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;KACpD;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAI,MAAsB;IACnD,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,aAAa,qBAAQ,MAAM,CAAE,CAAC;IACpC,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE;QAC/B,aAAa,CAAC,YAAY,GAAG,EAAE,CAAC;KACjC;IACD,IACE,aAAa,CAAC,YAAY,CAAC,UAAU,IAAI,SAAS;QAClD,aAAa,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,EACzC;QACA,aAAa,CAAC,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,iBAAiB,CAAC;KACrE;IACD,IACE,aAAa,CAAC,YAAY,CAAC,cAAc,IAAI,SAAS;QACtD,aAAa,CAAC,YAAY,CAAC,cAAc,GAAG,CAAC,EAC7C;QACA,aAAa,CAAC,YAAY,CAAC,cAAc,GAAG,SAAS,CAAC,uCAAuC,CAAC;KAC/F;IACD,IACE,aAAa,CAAC,YAAY,CAAC,iBAAiB,IAAI,SAAS;QACzD,aAAa,CAAC,YAAY,CAAC,iBAAiB,GAAG,CAAC,EAChD;QACA,aAAa,CAAC,YAAY,CAAC,iBAAiB,GAAG,SAAS,CAAC,sCAAsC,CAAC;KACjG;IACD,IAAI,aAAa,CAAC,YAAY,CAAC,IAAI,IAAI,SAAS,EAAE;QAChD,aAAa,CAAC,YAAY,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC;KACnD;IACD,IAAI,SAA6C,CAAC;IAClD,IAAI,MAAW,CAAC;IAChB,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,MAAM,qBAAqB,GAAG,aAAa,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC;IACxE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,qBAAqB,EAAE,CAAC,EAAE,EAAE;QAC/C,MAAM,CAAC,OAAO,CACZ,mCAAmC,EACnC,aAAa,CAAC,YAAY,EAC1B,aAAa,CAAC,aAAa,EAC3B,CAAC,CACF,CAAC;QACF,IAAI;YACF,MAAM,GAAG,MAAM,aAAa,CAAC,SAAS,EAAE,CAAC;YACzC,OAAO,GAAG,IAAI,CAAC;YACf,MAAM,CAAC,OAAO,CACZ,kDAAkD,EAClD,aAAa,CAAC,YAAY,EAC1B,aAAa,CAAC,aAAa,EAC3B,CAAC,CACF,CAAC;YACF,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;gBACjC,MAAM,CAAC,OAAO,CACZ,kCAAkC,EAClC,aAAa,CAAC,YAAY,EAC1B,aAAa,CAAC,aAAa,EAC3B,MAAM,CACP,CAAC;aACH;YACD,MAAM;SACP;QAAC,OAAO,IAAI,EAAE;YACb,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;YAE5B,IACE,CAAE,GAAW,CAAC,SAAS;gBACvB,GAAG,CAAC,IAAI,KAAK,2BAA2B;gBACxC,aAAa,CAAC,cAAc,EAC5B;gBACA,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;gBAC/E,IAAI,CAAC,WAAW,EAAE;oBAChB,GAAG,CAAC,IAAI,GAAG,qBAAqB,CAAC;oBAChC,GAAW,CAAC,SAAS,GAAG,IAAI,CAAC;iBAC/B;aACF;YACD,MAAM,CAAC,OAAO,CACZ,uDAAuD,EACvD,aAAa,CAAC,YAAY,EAC1B,aAAa,CAAC,aAAa,EAC3B,CAAC,EACD,GAAG,CACJ,CAAC;YAEF,SAAS,GAAG,GAAG,CAAC;YAChB,IAAK,SAAiB,CAAC,SAAS,IAAI,qBAAqB,GAAG,CAAC,EAAE;gBAC7D,MAAM,eAAe,GAAG,cAAc,CACpC,CAAC,EACD,aAAa,CAAC,YAAY,CAAC,cAAc,EACzC,aAAa,CAAC,YAAY,CAAC,iBAAiB,EAC5C,aAAa,CAAC,YAAY,CAAC,IAAI,CAChC,CAAC;gBACF,MAAM,CAAC,OAAO,CACZ,6CAA6C,EAC7C,aAAa,CAAC,YAAY,EAC1B,eAAe,EACf,aAAa,CAAC,aAAa,CAC5B,CAAC;gBACF,MAAM,KAAK,CAAC,eAAe,EAAE;oBAC3B,WAAW,EAAE,aAAa,CAAC,WAAW;oBACtC,aAAa,EAAE,qDAAqD;iBACrE,CAAC,CAAC;gBAEH,SAAS;aACV;iBAAM;gBACL,MAAM;aACP;SACF;KACF;IACD,IAAI,OAAO,EAAE;QACX,OAAO,MAAM,CAAC;KACf;SAAM;QACL,MAAM,SAAS,CAAC;KACjB;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n/* eslint-disable eqeqeq */\n\nimport { MessagingError, translate } from \"./errors\";\nimport { AbortSignalLike } from \"@azure/abort-controller\";\nimport { Constants } from \"./util/constants\";\nimport { checkNetworkConnection } from \"./util/checkNetworkConnection\";\nimport { delay } from \"@azure/core-util\";\nimport { logger } from \"./log\";\n\n/**\n * Determines whether the object is a Delivery object.\n * @internal\n */\nfunction isDelivery(obj: any): boolean {\n let result: boolean = false;\n if (\n obj &&\n typeof obj.id === \"number\" &&\n typeof obj.settled === \"boolean\" &&\n typeof obj.remote_settled === \"boolean\" &&\n typeof obj.format === \"number\"\n ) {\n result = true;\n }\n return result;\n}\n\n/**\n * Describes the Retry Mode type\n */\nexport enum RetryMode {\n Exponential,\n Fixed,\n}\n\n/**\n * Describes the retry operation type.\n */\nexport enum RetryOperationType {\n cbsAuth = \"cbsAuth\",\n connection = \"connection\",\n management = \"management\",\n receiverLink = \"receiverLink\",\n senderLink = \"senderLink\",\n sendMessage = \"sendMessage\",\n receiveMessage = \"receiveMessage\",\n session = \"session\",\n messageSettlement = \"settlement\",\n}\n\n/**\n * Retry policy options that determine the mode, number of retries, retry interval etc.\n */\nexport interface RetryOptions {\n /**\n * Number of times the operation needs to be retried in case\n * of retryable error. Default: 3.\n */\n maxRetries?: number;\n /**\n * Amount of time to wait in milliseconds before making the\n * next attempt. Default: `30000 milliseconds`.\n * When `mode` option is set to `Exponential`,\n * this is used to compute the exponentially increasing delays between retries.\n */\n retryDelayInMs?: number;\n /**\n * Number of milliseconds to wait before declaring that current attempt has timed out which will trigger a retry\n * A minimum value of `60000` milliseconds will be used if a value not greater than this is provided.\n */\n timeoutInMs?: number;\n /**\n * Denotes which retry mode to apply. If undefined, defaults to `Fixed`\n */\n mode?: RetryMode;\n /**\n * Denotes the maximum delay between retries\n * that the retry attempts will be capped at. Applicable only when performing exponential retry.\n */\n maxRetryDelayInMs?: number;\n}\n\n/**\n * Describes the parameters that need to be configured for the retry operation.\n */\nexport interface RetryConfig<T> {\n /**\n * The operation that needs to be retried.\n */\n operation: () => Promise<T>;\n /**\n * The connection identifier. Used in logging information.\n * Extremely useful when multiple connections are logged in the same file.\n */\n connectionId: string;\n /**\n * The name/type of operation to be performed.\n * Extremely useful in providing better debug logs.\n */\n operationType: RetryOperationType;\n /**\n * The host \"<yournamespace>.servicebus.windows.net\".\n * Used to check network connectivity.\n */\n connectionHost?: string;\n /**\n * The retry related options associated with given operation execution.\n */\n retryOptions?: RetryOptions;\n /**\n * The `AbortSignal` associated with the operation being retried on.\n * If this signal is fired during the wait time between retries, then the `retry()` method will ensure that the wait is abandoned and the retry process gets cancelled. If this signal is fired when the operation is in progress, then the operation is expected to react to it.\n */\n abortSignal?: AbortSignalLike;\n}\n\n/**\n * Validates the retry config.\n * @internal\n */\nfunction validateRetryConfig<T>(config: RetryConfig<T>): void {\n if (!config.operation) {\n throw new TypeError(\"Missing 'operation' in retry configuration\");\n }\n\n if (!config.connectionId) {\n throw new TypeError(\"Missing 'connectionId' in retry configuration\");\n }\n\n if (!config.operationType) {\n throw new TypeError(\"Missing 'operationType' in retry configuration\");\n }\n}\n\n/**\n * Calculates delay between retries, in milliseconds.\n * @internal\n */\nfunction calculateDelay(\n attemptCount: number,\n retryDelayInMs: number,\n maxRetryDelayInMs: number,\n mode: RetryMode,\n): number {\n if (mode === RetryMode.Exponential) {\n const boundedRandDelta =\n retryDelayInMs * 0.8 +\n Math.floor(Math.random() * (retryDelayInMs * 1.2 - retryDelayInMs * 0.8));\n\n const incrementDelta = boundedRandDelta * (Math.pow(2, attemptCount) - 1);\n return Math.min(incrementDelta, maxRetryDelayInMs);\n }\n\n return retryDelayInMs;\n}\n\n/**\n * Every operation is attempted at least once. Additional attempts are made if the previous attempt failed\n * with a retryable error. The number of additional attempts is governed by the `maxRetries` property provided\n * on the `RetryConfig` argument.\n *\n * If `mode` option is set to `Fixed`, then the retries are made on the\n * given operation for a specified number of times, with a fixed delay in between each retry each time.\n *\n * If `mode` option is set to `Exponential`, then the delay between retries is adjusted to increase\n * exponentially with each attempt using back-off factor of power 2.\n *\n * @param config - Parameters to configure retry operation\n *\n * @returns Promise<T>.\n */\nexport async function retry<T>(config: RetryConfig<T>): Promise<T> {\n validateRetryConfig(config);\n const updatedConfig = { ...config };\n if (!updatedConfig.retryOptions) {\n updatedConfig.retryOptions = {};\n }\n if (\n updatedConfig.retryOptions.maxRetries == undefined ||\n updatedConfig.retryOptions.maxRetries < 0\n ) {\n updatedConfig.retryOptions.maxRetries = Constants.defaultMaxRetries;\n }\n if (\n updatedConfig.retryOptions.retryDelayInMs == undefined ||\n updatedConfig.retryOptions.retryDelayInMs < 0\n ) {\n updatedConfig.retryOptions.retryDelayInMs = Constants.defaultDelayBetweenOperationRetriesInMs;\n }\n if (\n updatedConfig.retryOptions.maxRetryDelayInMs == undefined ||\n updatedConfig.retryOptions.maxRetryDelayInMs < 0\n ) {\n updatedConfig.retryOptions.maxRetryDelayInMs = Constants.defaultMaxDelayForExponentialRetryInMs;\n }\n if (updatedConfig.retryOptions.mode == undefined) {\n updatedConfig.retryOptions.mode = RetryMode.Fixed;\n }\n let lastError: MessagingError | Error | undefined;\n let result: any;\n let success = false;\n const totalNumberOfAttempts = updatedConfig.retryOptions.maxRetries + 1;\n for (let i = 1; i <= totalNumberOfAttempts; i++) {\n logger.verbose(\n \"[%s] Attempt number for '%s': %d.\",\n updatedConfig.connectionId,\n updatedConfig.operationType,\n i,\n );\n try {\n result = await updatedConfig.operation();\n success = true;\n logger.verbose(\n \"[%s] Success for '%s', after attempt number: %d.\",\n updatedConfig.connectionId,\n updatedConfig.operationType,\n i,\n );\n if (result && !isDelivery(result)) {\n logger.verbose(\n \"[%s] Success result for '%s': %O\",\n updatedConfig.connectionId,\n updatedConfig.operationType,\n result,\n );\n }\n break;\n } catch (_err) {\n const err = translate(_err);\n\n if (\n !(err as any).retryable &&\n err.name === \"ServiceCommunicationError\" &&\n updatedConfig.connectionHost\n ) {\n const isConnected = await checkNetworkConnection(updatedConfig.connectionHost);\n if (!isConnected) {\n err.name = \"ConnectionLostError\";\n (err as any).retryable = true;\n }\n }\n logger.verbose(\n \"[%s] Error occurred for '%s' in attempt number %d: %O\",\n updatedConfig.connectionId,\n updatedConfig.operationType,\n i,\n err,\n );\n\n lastError = err;\n if ((lastError as any).retryable && totalNumberOfAttempts > i) {\n const targetDelayInMs = calculateDelay(\n i,\n updatedConfig.retryOptions.retryDelayInMs,\n updatedConfig.retryOptions.maxRetryDelayInMs,\n updatedConfig.retryOptions.mode,\n );\n logger.verbose(\n \"[%s] Sleeping for %d milliseconds for '%s'.\",\n updatedConfig.connectionId,\n targetDelayInMs,\n updatedConfig.operationType,\n );\n await delay(targetDelayInMs, {\n abortSignal: updatedConfig.abortSignal,\n abortErrorMsg: `The retry operation has been cancelled by the user.`,\n });\n\n continue;\n } else {\n break;\n }\n }\n }\n if (success) {\n return result;\n } else {\n throw lastError;\n }\n}\n"]}
1
+ {"version":3,"file":"retry.js","sourceRoot":"","sources":["../../src/retry.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,2BAA2B;AAE3B,OAAO,EAAkB,SAAS,EAAE,MAAM,UAAU,CAAC;AAErD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B;;;GAGG;AACH,SAAS,UAAU,CAAC,GAAQ;IAC1B,IAAI,MAAM,GAAY,KAAK,CAAC;IAC5B,IACE,GAAG;QACH,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ;QAC1B,OAAO,GAAG,CAAC,OAAO,KAAK,SAAS;QAChC,OAAO,GAAG,CAAC,cAAc,KAAK,SAAS;QACvC,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,EAC9B,CAAC;QACD,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,uDAAW,CAAA;IACX,2CAAK,CAAA;AACP,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,+CAAyB,CAAA;IACzB,+CAAyB,CAAA;IACzB,mDAA6B,CAAA;IAC7B,+CAAyB,CAAA;IACzB,iDAA2B,CAAA;IAC3B,uDAAiC,CAAA;IACjC,yCAAmB,CAAA;IACnB,sDAAgC,CAAA;AAClC,CAAC,EAVW,kBAAkB,KAAlB,kBAAkB,QAU7B;AAoED;;;GAGG;AACH,SAAS,mBAAmB,CAAI,MAAsB;IACpD,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QACtB,MAAM,IAAI,SAAS,CAAC,4CAA4C,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;QACzB,MAAM,IAAI,SAAS,CAAC,+CAA+C,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QAC1B,MAAM,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAAC;IACxE,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CACrB,YAAoB,EACpB,cAAsB,EACtB,iBAAyB,EACzB,IAAe;IAEf,IAAI,IAAI,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC;QACnC,MAAM,gBAAgB,GACpB,cAAc,GAAG,GAAG;YACpB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG,GAAG,GAAG,cAAc,GAAG,GAAG,CAAC,CAAC,CAAC;QAE5E,MAAM,cAAc,GAAG,gBAAgB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAI,MAAsB;IACnD,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,aAAa,qBAAQ,MAAM,CAAE,CAAC;IACpC,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;QAChC,aAAa,CAAC,YAAY,GAAG,EAAE,CAAC;IAClC,CAAC;IACD,IACE,aAAa,CAAC,YAAY,CAAC,UAAU,IAAI,SAAS;QAClD,aAAa,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,EACzC,CAAC;QACD,aAAa,CAAC,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,iBAAiB,CAAC;IACtE,CAAC;IACD,IACE,aAAa,CAAC,YAAY,CAAC,cAAc,IAAI,SAAS;QACtD,aAAa,CAAC,YAAY,CAAC,cAAc,GAAG,CAAC,EAC7C,CAAC;QACD,aAAa,CAAC,YAAY,CAAC,cAAc,GAAG,SAAS,CAAC,uCAAuC,CAAC;IAChG,CAAC;IACD,IACE,aAAa,CAAC,YAAY,CAAC,iBAAiB,IAAI,SAAS;QACzD,aAAa,CAAC,YAAY,CAAC,iBAAiB,GAAG,CAAC,EAChD,CAAC;QACD,aAAa,CAAC,YAAY,CAAC,iBAAiB,GAAG,SAAS,CAAC,sCAAsC,CAAC;IAClG,CAAC;IACD,IAAI,aAAa,CAAC,YAAY,CAAC,IAAI,IAAI,SAAS,EAAE,CAAC;QACjD,aAAa,CAAC,YAAY,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC;IACpD,CAAC;IACD,IAAI,SAA6C,CAAC;IAClD,IAAI,MAAW,CAAC;IAChB,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,MAAM,qBAAqB,GAAG,aAAa,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,CAAC;IACxE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,qBAAqB,EAAE,CAAC,EAAE,EAAE,CAAC;QAChD,MAAM,CAAC,OAAO,CACZ,mCAAmC,EACnC,aAAa,CAAC,YAAY,EAC1B,aAAa,CAAC,aAAa,EAC3B,CAAC,CACF,CAAC;QACF,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,aAAa,CAAC,SAAS,EAAE,CAAC;YACzC,OAAO,GAAG,IAAI,CAAC;YACf,MAAM,CAAC,OAAO,CACZ,kDAAkD,EAClD,aAAa,CAAC,YAAY,EAC1B,aAAa,CAAC,aAAa,EAC3B,CAAC,CACF,CAAC;YACF,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAClC,MAAM,CAAC,OAAO,CACZ,kCAAkC,EAClC,aAAa,CAAC,YAAY,EAC1B,aAAa,CAAC,aAAa,EAC3B,MAAM,CACP,CAAC;YACJ,CAAC;YACD,MAAM;QACR,CAAC;QAAC,OAAO,IAAI,EAAE,CAAC;YACd,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;YAE5B,IACE,CAAE,GAAW,CAAC,SAAS;gBACvB,GAAG,CAAC,IAAI,KAAK,2BAA2B;gBACxC,aAAa,CAAC,cAAc,EAC5B,CAAC;gBACD,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;gBAC/E,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,GAAG,CAAC,IAAI,GAAG,qBAAqB,CAAC;oBAChC,GAAW,CAAC,SAAS,GAAG,IAAI,CAAC;gBAChC,CAAC;YACH,CAAC;YACD,MAAM,CAAC,OAAO,CACZ,uDAAuD,EACvD,aAAa,CAAC,YAAY,EAC1B,aAAa,CAAC,aAAa,EAC3B,CAAC,EACD,GAAG,CACJ,CAAC;YAEF,SAAS,GAAG,GAAG,CAAC;YAChB,IAAK,SAAiB,CAAC,SAAS,IAAI,qBAAqB,GAAG,CAAC,EAAE,CAAC;gBAC9D,MAAM,eAAe,GAAG,cAAc,CACpC,CAAC,EACD,aAAa,CAAC,YAAY,CAAC,cAAc,EACzC,aAAa,CAAC,YAAY,CAAC,iBAAiB,EAC5C,aAAa,CAAC,YAAY,CAAC,IAAI,CAChC,CAAC;gBACF,MAAM,CAAC,OAAO,CACZ,6CAA6C,EAC7C,aAAa,CAAC,YAAY,EAC1B,eAAe,EACf,aAAa,CAAC,aAAa,CAC5B,CAAC;gBACF,MAAM,KAAK,CAAC,eAAe,EAAE;oBAC3B,WAAW,EAAE,aAAa,CAAC,WAAW;oBACtC,aAAa,EAAE,qDAAqD;iBACrE,CAAC,CAAC;gBAEH,SAAS;YACX,CAAC;iBAAM,CAAC;gBACN,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,MAAM,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,MAAM,SAAS,CAAC;IAClB,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n/* eslint-disable eqeqeq */\n\nimport { MessagingError, translate } from \"./errors\";\nimport { AbortSignalLike } from \"@azure/abort-controller\";\nimport { Constants } from \"./util/constants\";\nimport { checkNetworkConnection } from \"./util/checkNetworkConnection\";\nimport { delay } from \"@azure/core-util\";\nimport { logger } from \"./log\";\n\n/**\n * Determines whether the object is a Delivery object.\n * @internal\n */\nfunction isDelivery(obj: any): boolean {\n let result: boolean = false;\n if (\n obj &&\n typeof obj.id === \"number\" &&\n typeof obj.settled === \"boolean\" &&\n typeof obj.remote_settled === \"boolean\" &&\n typeof obj.format === \"number\"\n ) {\n result = true;\n }\n return result;\n}\n\n/**\n * Describes the Retry Mode type\n */\nexport enum RetryMode {\n Exponential,\n Fixed,\n}\n\n/**\n * Describes the retry operation type.\n */\nexport enum RetryOperationType {\n cbsAuth = \"cbsAuth\",\n connection = \"connection\",\n management = \"management\",\n receiverLink = \"receiverLink\",\n senderLink = \"senderLink\",\n sendMessage = \"sendMessage\",\n receiveMessage = \"receiveMessage\",\n session = \"session\",\n messageSettlement = \"settlement\",\n}\n\n/**\n * Retry policy options that determine the mode, number of retries, retry interval etc.\n */\nexport interface RetryOptions {\n /**\n * Number of times the operation needs to be retried in case\n * of retryable error. Default: 3.\n */\n maxRetries?: number;\n /**\n * Amount of time to wait in milliseconds before making the\n * next attempt. Default: `30000 milliseconds`.\n * When `mode` option is set to `Exponential`,\n * this is used to compute the exponentially increasing delays between retries.\n */\n retryDelayInMs?: number;\n /**\n * Number of milliseconds to wait before declaring that current attempt has timed out which will trigger a retry\n * A minimum value of `60000` milliseconds will be used if a value not greater than this is provided.\n */\n timeoutInMs?: number;\n /**\n * Denotes which retry mode to apply. If undefined, defaults to `Fixed`\n */\n mode?: RetryMode;\n /**\n * Denotes the maximum delay between retries\n * that the retry attempts will be capped at. Applicable only when performing exponential retry.\n */\n maxRetryDelayInMs?: number;\n}\n\n/**\n * Describes the parameters that need to be configured for the retry operation.\n */\nexport interface RetryConfig<T> {\n /**\n * The operation that needs to be retried.\n */\n operation: () => Promise<T>;\n /**\n * The connection identifier. Used in logging information.\n * Extremely useful when multiple connections are logged in the same file.\n */\n connectionId: string;\n /**\n * The name/type of operation to be performed.\n * Extremely useful in providing better debug logs.\n */\n operationType: RetryOperationType;\n /**\n * The host \"<yournamespace>.servicebus.windows.net\".\n * Used to check network connectivity.\n */\n connectionHost?: string;\n /**\n * The retry related options associated with given operation execution.\n */\n retryOptions?: RetryOptions;\n /**\n * The `AbortSignal` associated with the operation being retried on.\n * If this signal is fired during the wait time between retries, then the `retry()` method will ensure that the wait is abandoned and the retry process gets cancelled. If this signal is fired when the operation is in progress, then the operation is expected to react to it.\n */\n abortSignal?: AbortSignalLike;\n}\n\n/**\n * Validates the retry config.\n * @internal\n */\nfunction validateRetryConfig<T>(config: RetryConfig<T>): void {\n if (!config.operation) {\n throw new TypeError(\"Missing 'operation' in retry configuration\");\n }\n\n if (!config.connectionId) {\n throw new TypeError(\"Missing 'connectionId' in retry configuration\");\n }\n\n if (!config.operationType) {\n throw new TypeError(\"Missing 'operationType' in retry configuration\");\n }\n}\n\n/**\n * Calculates delay between retries, in milliseconds.\n * @internal\n */\nfunction calculateDelay(\n attemptCount: number,\n retryDelayInMs: number,\n maxRetryDelayInMs: number,\n mode: RetryMode,\n): number {\n if (mode === RetryMode.Exponential) {\n const boundedRandDelta =\n retryDelayInMs * 0.8 +\n Math.floor(Math.random() * (retryDelayInMs * 1.2 - retryDelayInMs * 0.8));\n\n const incrementDelta = boundedRandDelta * (Math.pow(2, attemptCount) - 1);\n return Math.min(incrementDelta, maxRetryDelayInMs);\n }\n\n return retryDelayInMs;\n}\n\n/**\n * Every operation is attempted at least once. Additional attempts are made if the previous attempt failed\n * with a retryable error. The number of additional attempts is governed by the `maxRetries` property provided\n * on the `RetryConfig` argument.\n *\n * If `mode` option is set to `Fixed`, then the retries are made on the\n * given operation for a specified number of times, with a fixed delay in between each retry each time.\n *\n * If `mode` option is set to `Exponential`, then the delay between retries is adjusted to increase\n * exponentially with each attempt using back-off factor of power 2.\n *\n * @param config - Parameters to configure retry operation\n *\n * @returns Promise<T>.\n */\nexport async function retry<T>(config: RetryConfig<T>): Promise<T> {\n validateRetryConfig(config);\n const updatedConfig = { ...config };\n if (!updatedConfig.retryOptions) {\n updatedConfig.retryOptions = {};\n }\n if (\n updatedConfig.retryOptions.maxRetries == undefined ||\n updatedConfig.retryOptions.maxRetries < 0\n ) {\n updatedConfig.retryOptions.maxRetries = Constants.defaultMaxRetries;\n }\n if (\n updatedConfig.retryOptions.retryDelayInMs == undefined ||\n updatedConfig.retryOptions.retryDelayInMs < 0\n ) {\n updatedConfig.retryOptions.retryDelayInMs = Constants.defaultDelayBetweenOperationRetriesInMs;\n }\n if (\n updatedConfig.retryOptions.maxRetryDelayInMs == undefined ||\n updatedConfig.retryOptions.maxRetryDelayInMs < 0\n ) {\n updatedConfig.retryOptions.maxRetryDelayInMs = Constants.defaultMaxDelayForExponentialRetryInMs;\n }\n if (updatedConfig.retryOptions.mode == undefined) {\n updatedConfig.retryOptions.mode = RetryMode.Fixed;\n }\n let lastError: MessagingError | Error | undefined;\n let result: any;\n let success = false;\n const totalNumberOfAttempts = updatedConfig.retryOptions.maxRetries + 1;\n for (let i = 1; i <= totalNumberOfAttempts; i++) {\n logger.verbose(\n \"[%s] Attempt number for '%s': %d.\",\n updatedConfig.connectionId,\n updatedConfig.operationType,\n i,\n );\n try {\n result = await updatedConfig.operation();\n success = true;\n logger.verbose(\n \"[%s] Success for '%s', after attempt number: %d.\",\n updatedConfig.connectionId,\n updatedConfig.operationType,\n i,\n );\n if (result && !isDelivery(result)) {\n logger.verbose(\n \"[%s] Success result for '%s': %O\",\n updatedConfig.connectionId,\n updatedConfig.operationType,\n result,\n );\n }\n break;\n } catch (_err) {\n const err = translate(_err);\n\n if (\n !(err as any).retryable &&\n err.name === \"ServiceCommunicationError\" &&\n updatedConfig.connectionHost\n ) {\n const isConnected = await checkNetworkConnection(updatedConfig.connectionHost);\n if (!isConnected) {\n err.name = \"ConnectionLostError\";\n (err as any).retryable = true;\n }\n }\n logger.verbose(\n \"[%s] Error occurred for '%s' in attempt number %d: %O\",\n updatedConfig.connectionId,\n updatedConfig.operationType,\n i,\n err,\n );\n\n lastError = err;\n if ((lastError as any).retryable && totalNumberOfAttempts > i) {\n const targetDelayInMs = calculateDelay(\n i,\n updatedConfig.retryOptions.retryDelayInMs,\n updatedConfig.retryOptions.maxRetryDelayInMs,\n updatedConfig.retryOptions.mode,\n );\n logger.verbose(\n \"[%s] Sleeping for %d milliseconds for '%s'.\",\n updatedConfig.connectionId,\n targetDelayInMs,\n updatedConfig.operationType,\n );\n await delay(targetDelayInMs, {\n abortSignal: updatedConfig.abortSignal,\n abortErrorMsg: `The retry operation has been cancelled by the user.`,\n });\n\n continue;\n } else {\n break;\n }\n }\n }\n if (success) {\n return result;\n } else {\n throw lastError;\n }\n}\n"]}
package/dist-esm/src/util/checkNetworkConnection.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"checkNetworkConnection.js","sourceRoot":"","sources":["../../../src/util/checkNetworkConnection.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,KAAK,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,CAAC,OAAO,CAAC,6DAA6D,CAAC,CAAC;QAC9E,UAAU,CAAC,IAAI,EAAE,UAAU,GAAQ;YACjC,IAAI,GAAG,EAAE;gBACP,MAAM,CAAC,OAAO,CACZ,qEAAqE,EACrE,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,EACpB,GAAG,CACJ,CAAC;gBACF,2GAA2G;gBAC3G,8GAA8G;gBAC9G,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE;oBACpD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;iBACvB;aACF;iBAAM;gBACL,MAAM,CAAC,OAAO,CAAC,yEAAyE,CAAC,CAAC;aAC3F;YAED,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { CONNREFUSED, TIMEOUT, resolve as dnsResolve } from \"dns\";\nimport { logger } from \"../log\";\n\n/**\n * Checks whether a network connection is detected.\n * @internal\n */\nexport function checkNetworkConnection(host: string): Promise<boolean> {\n return new Promise((resolve) => {\n logger.verbose(\"Calling dns.resolve to determine network connection status.\");\n dnsResolve(host, function (err: any): void {\n if (err) {\n logger.verbose(\n \"Error thrown from dns.resolve in network connection check: '%s', %O\",\n err.code || err.name,\n err,\n );\n // List of possible DNS error codes: https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_error_codes\n // We only resolve with `false` when dnsResolve fails with an error we expect to see when the network is down.\n if (err.code === CONNREFUSED || err.code === TIMEOUT) {\n return resolve(false);\n }\n } else {\n logger.verbose(\"Successfully resolved host via dns.resolve in network connection check.\");\n }\n\n return resolve(true);\n });\n });\n}\n"]}
1
+ {"version":3,"file":"checkNetworkConnection.js","sourceRoot":"","sources":["../../../src/util/checkNetworkConnection.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,KAAK,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,CAAC,OAAO,CAAC,6DAA6D,CAAC,CAAC;QAC9E,UAAU,CAAC,IAAI,EAAE,UAAU,GAAQ;YACjC,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,OAAO,CACZ,qEAAqE,EACrE,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,EACpB,GAAG,CACJ,CAAC;gBACF,2GAA2G;gBAC3G,8GAA8G;gBAC9G,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBACrD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,OAAO,CAAC,yEAAyE,CAAC,CAAC;YAC5F,CAAC;YAED,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { CONNREFUSED, TIMEOUT, resolve as dnsResolve } from \"dns\";\nimport { logger } from \"../log\";\n\n/**\n * Checks whether a network connection is detected.\n * @internal\n */\nexport function checkNetworkConnection(host: string): Promise<boolean> {\n return new Promise((resolve) => {\n logger.verbose(\"Calling dns.resolve to determine network connection status.\");\n dnsResolve(host, function (err: any): void {\n if (err) {\n logger.verbose(\n \"Error thrown from dns.resolve in network connection check: '%s', %O\",\n err.code || err.name,\n err,\n );\n // List of possible DNS error codes: https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_error_codes\n // We only resolve with `false` when dnsResolve fails with an error we expect to see when the network is down.\n if (err.code === CONNREFUSED || err.code === TIMEOUT) {\n return resolve(false);\n }\n } else {\n logger.verbose(\"Successfully resolved host via dns.resolve in network connection check.\");\n }\n\n return resolve(true);\n });\n });\n}\n"]}
package/dist-esm/src/util/constants.js CHANGED
@@ -73,6 +73,7 @@ export const Constants = {
73
73
  minDurationValue: -922337203685477,
74
74
  // https://github.com/Azure/azure-amqp/blob/master/Microsoft.Azure.Amqp/Amqp/AmqpConstants.cs#L47
75
75
  maxAbsoluteExpiryTime: new Date("9999-12-31T07:59:59.000Z").getTime(),
76
+ maxUint32Value: 4294967295,
76
77
  aadTokenValidityMarginInMs: 5000,
77
78
  connectionReconnectDelay: 300,
78
79
  defaultMaxRetries: 3,
package/dist-esm/src/util/constants.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/util/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,kBAAkB,EAAE,sBAAsB;IAC1C,YAAY,EAAE,qBAAqB;IACnC,cAAc,EAAE,uBAAuB;IACvC,qBAAqB,EAAE,+BAA+B;IACtD,YAAY,EAAE,qBAAqB;IACnC,oBAAoB,EAAE,8BAA8B;IACpD,MAAM,EAAE,cAAc;IACtB,WAAW,EAAE,oBAAoB;IACjC,eAAe,EAAE,oBAAoB;IACrC,SAAS,EAAE,sBAAsB;IACjC,eAAe,EAAE,yBAAyB;IAC1C,gBAAgB,EAAE,yBAAyB;IAC3C,YAAY,EAAE,qBAAqB;IACnC,sBAAsB,EAAE,qCAAqC;IAC7D,gBAAgB,EAAE,8BAA8B;IAChD,wBAAwB,EAAE,uCAAuC;IACjE,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,aAAa;IACzB,iBAAiB,EAAE,oBAAoB;IACvC,cAAc,EAAE,iBAAiB;IACjC,UAAU,EAAE,aAAa;IACzB,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,aAAa;IAC1B,aAAa,EAAE,MAAM;IACrB,GAAG,EAAE,KAAK;IACV,mBAAmB,EAAE,qBAAqB;IAC1C,oBAAoB,EAAE,UAAU;IAChC,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,MAAM;IACnB,UAAU,EAAE,KAAK;IACjB,iBAAiB,EAAE,WAAW;IAC9B,oBAAoB,EAAE,8BAA8B;IACpD,iBAAiB,EAAE,uCAAuC;IAC1D,qBAAqB,EAAE,+BAA+B;IACtD,kBAAkB,EAAE,wCAAwC;IAC5D,kBAAkB,EAAE,GAAG;IACvB,YAAY,EAAE,eAAe;IAC7B,WAAW,EAAE,qBAAqB;IAClC,sBAAsB,EAAE,6BAA6B;IACrD,+BAA+B,EAAE,8CAA8C;IAC/E,QAAQ,EAAE,wBAAwB;IAClC,GAAG,EAAE,mBAAmB;IACxB,cAAc,EAAE,+BAA+B;IAC/C,iBAAiB,EAAE,8BAA8B;IACjD,aAAa,EAAE,gBAAgB;IAC/B,WAAW,EAAE,cAAc;IAC3B,YAAY,EAAE,eAAe;IAC7B,eAAe,EAAE,kBAAkB;IACnC,2BAA2B,EAAE,KAAK;IAClC,gCAAgC,EAAE,KAAK;IACvC,oBAAoB,EAAE,mBAAmB;IACzC,eAAe,EAAE,cAAc;IAC/B,cAAc,EAAE,gBAAgB;IAChC,sBAAsB,EAAE,wBAAwB;IAChD,oBAAoB,EAAE,IAAI;IAC1B,cAAc,EAAE,GAAG;IACnB,kBAAkB,EAAE,GAAG;IACvB,qBAAqB,EAAE,GAAG;IAC1B,kBAAkB,EAAE,GAAG;IACvB,aAAa,EAAE,GAAG;IAClB,qBAAqB,EAAE,EAAE;IACzB,+BAA+B,EAAE,IAAI;IACrC,mCAAmC,EAAE,IAAI;IACzC,yBAAyB,EAAE,IAAI;IAC/B,+EAA+E;IAC/E,8DAA8D;IAC9D,gBAAgB,EAAE,eAAe;IACjC,gBAAgB,EAAE,CAAC,eAAe;IAClC,iGAAiG;IACjG,qBAAqB,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC,CAAC,OAAO,EAAE;IACrE,0BAA0B,EAAE,IAAI;IAChC,wBAAwB,EAAE,GAAG;IAC7B,iBAAiB,EAAE,CAAC;IACpB,8BAA8B,EAAE,GAAG;IACnC,uCAAuC,EAAE,KAAK;IAC9C,sCAAsC,EAAE,KAAK;IAC7C,kBAAkB,EAAE,sBAAsB;IAC1C,iBAAiB,EAAE,oBAAoB;IACvC,kBAAkB,EAAE,sBAAsB;IAC1C,YAAY,EAAE,eAAe;IAC7B,UAAU,EAAE,aAAa;IACzB,eAAe,EAAE,YAAY;IAC7B,oBAAoB,EAAE,iBAAiB;IACvC,eAAe,EAAE,YAAY;IAC7B,eAAe,EAAE,YAAY;IAC7B,eAAe,EAAE,kBAAkB;IACnC,gBAAgB,EAAE,mBAAmB;IACrC,qBAAqB,EAAE,wBAAwB;IAC/C,kBAAkB,EAAE,sBAAsB;IAC1C,cAAc,EAAE,2BAA2B;IAC3C,UAAU,EAAE,2BAA2B;IACvC,aAAa,EAAE,8BAA8B;IAC7C,UAAU,EAAE;QACV,QAAQ,EAAE,WAAW;QACrB,IAAI,EAAE,MAAM;QACZ,sBAAsB,EAAE,wCAAwC;QAChE,eAAe,EAAE,gCAAgC;QACjD,SAAS,EAAE,0BAA0B;QACrC,WAAW,EAAE,4BAA4B;QACzC,uBAAuB,EAAE,0CAA0C;QACnE,iBAAiB,EAAE,kCAAkC;QACrD,gBAAgB,EAAE,kCAAkC;QACpD,eAAe,EAAE,iCAAiC;QAClD,eAAe,EAAE,iCAAiC;QAClD,iBAAiB,EAAE,oCAAoC;QACvD,OAAO,EAAE,wBAAwB;QACjC,UAAU,EAAE,2BAA2B;QACvC,cAAc,EAAE,+BAA+B;KAChD;IACD,eAAe,EAAE;QACf,mBAAmB,EAAE,aAAa;QAClC,aAAa,EAAE,WAAW;QAC1B,qBAAqB,EAAE,WAAW;QAClC,iBAAiB,EAAE,aAAa;QAChC,cAAc,EAAE,WAAW;QAC3B,eAAe,EAAE,WAAW;KAC7B;CACO,CAAC;AAEX;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,4BAA4B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport const Constants = {\n associatedLinkName: \"associated-link-name\",\n partitionKey: \"x-opt-partition-key\",\n sequenceNumber: \"x-opt-sequence-number\",\n enqueueSequenceNumber: \"x-opt-enqueue-sequence-number\",\n enqueuedTime: \"x-opt-enqueued-time\",\n scheduledEnqueueTime: \"x-opt-scheduled-enqueue-time\",\n offset: \"x-opt-offset\",\n lockedUntil: \"x-opt-locked-until\",\n partitionIdName: \"x-opt-partition-id\",\n publisher: \"x-opt-publisher-name\",\n viaPartitionKey: \"x-opt-via-partition-key\",\n deadLetterSource: \"x-opt-deadletter-source\",\n messageState: \"x-opt-message-state\",\n enqueuedTimeAnnotation: `amqp.annotation.x-opt-enqueued-time`,\n offsetAnnotation: `amqp.annotation.x-opt-offset`,\n sequenceNumberAnnotation: `amqp.annotation.x-opt-sequence-number`,\n guidSize: 16,\n message: \"message\",\n error: \"error\",\n statusCode: \"status-code\",\n statusDescription: \"status-description\",\n errorCondition: \"error-condition\",\n management: \"$management\",\n partition: \"partition\",\n partitionId: \"partitionId\",\n readOperation: \"READ\",\n TLS: \"tls\",\n establishConnection: \"establishConnection\",\n defaultConsumerGroup: \"$default\",\n eventHub: \"eventhub\",\n cbsEndpoint: \"$cbs\",\n cbsReplyTo: \"cbs\",\n operationPutToken: \"put-token\",\n aadEventHubsAudience: \"https://eventhubs.azure.net/\",\n aadEventHubsScope: \"https://eventhubs.azure.net//.default\",\n aadServiceBusAudience: \"https://servicebus.azure.net/\",\n aadServiceBusScope: \"https://servicebus.azure.net//.default\",\n maxUserAgentLength: 512,\n vendorString: \"com.microsoft\",\n attachEpoch: `com.microsoft:epoch`,\n receiverIdentifierName: `com.microsoft:receiver-name`,\n enableReceiverRuntimeMetricName: `com.microsoft:enable-receiver-runtime-metric`,\n timespan: `com.microsoft:timespan`,\n uri: `com.microsoft:uri`,\n dateTimeOffset: `com.microsoft:datetime-offset`,\n sessionFilterName: `com.microsoft:session-filter`,\n receiverError: \"receiver_error\",\n senderError: \"sender_error\",\n sessionError: \"session_error\",\n connectionError: \"connection_error\",\n defaultOperationTimeoutInMs: 60000,\n defaultConnectionIdleTimeoutInMs: 60000,\n managementRequestKey: \"managementRequest\",\n negotiateCbsKey: \"negotiateCbs\",\n negotiateClaim: \"negotiateClaim\",\n ensureContainerAndBlob: \"ensureContainerAndBlob\",\n defaultPrefetchCount: 1000,\n reconnectLimit: 100,\n maxMessageIdLength: 128,\n maxPartitionKeyLength: 128,\n maxSessionIdLength: 128,\n pathDelimiter: \"/\",\n ruleNameMaximumLength: 50,\n maximumSqlFilterStatementLength: 1024,\n maximumSqlRuleActionStatementLength: 1024,\n maxDeadLetterReasonLength: 4096,\n // https://stackoverflow.com/questions/11526504/minimum-and-maximum-date for js\n // However we are setting this to the TimeSpan.MaxValue of C#.\n maxDurationValue: 922337203685477,\n minDurationValue: -922337203685477,\n // https://github.com/Azure/azure-amqp/blob/master/Microsoft.Azure.Amqp/Amqp/AmqpConstants.cs#L47\n maxAbsoluteExpiryTime: new Date(\"9999-12-31T07:59:59.000Z\").getTime(),\n aadTokenValidityMarginInMs: 5000,\n connectionReconnectDelay: 300,\n defaultMaxRetries: 3,\n defaultMaxRetriesForConnection: 150,\n defaultDelayBetweenOperationRetriesInMs: 30000,\n defaultMaxDelayForExponentialRetryInMs: 90000,\n receiverSettleMode: \"receiver-settle-mode\",\n dispositionStatus: \"disposition-status\",\n fromSequenceNumber: \"from-sequence-number\",\n messageCount: \"message-count\",\n lockTokens: \"lock-tokens\",\n messageIdMapKey: \"message-id\",\n sequenceNumberMapKey: \"sequence-number\",\n lockTokenMapKey: \"lock-token\",\n sessionIdMapKey: \"session-id\",\n sequenceNumbers: \"sequence-numbers\",\n deadLetterReason: \"deadletter-reason\",\n deadLetterDescription: \"deadletter-description\",\n propertiesToModify: \"properties-to-modify\",\n deadLetterName: \"com.microsoft:dead-letter\",\n trackingId: \"com.microsoft:tracking-id\",\n serverTimeout: \"com.microsoft:server-timeout\",\n operations: {\n putToken: \"put-token\",\n read: \"READ\",\n cancelScheduledMessage: \"com.microsoft:cancel-scheduled-message\",\n scheduleMessage: \"com.microsoft:schedule-message\",\n renewLock: \"com.microsoft:renew-lock\",\n peekMessage: \"com.microsoft:peek-message\",\n receiveBySequenceNumber: \"com.microsoft:receive-by-sequence-number\",\n updateDisposition: \"com.microsoft:update-disposition\",\n renewSessionLock: \"com.microsoft:renew-session-lock\",\n setSessionState: \"com.microsoft:set-session-state\",\n getSessionState: \"com.microsoft:get-session-state\",\n enumerateSessions: \"com.microsoft:get-message-sessions\",\n addRule: \"com.microsoft:add-rule\",\n removeRule: \"com.microsoft:remove-rule\",\n enumerateRules: \"com.microsoft:enumerate-rules\",\n },\n descriptorCodes: {\n ruleDescriptionList: 1335734829060,\n sqlFilterList: 83483426822,\n correlationFilterList: 83483426825,\n sqlRuleActionList: 1335734829062,\n trueFilterList: 83483426823,\n falseFilterList: 83483426824,\n },\n} as const;\n\n/**\n * The standard error message accompanying an AbortError.\n * @hidden\n */\nexport const StandardAbortMessage = \"The operation was aborted.\";\n"]}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/util/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,kBAAkB,EAAE,sBAAsB;IAC1C,YAAY,EAAE,qBAAqB;IACnC,cAAc,EAAE,uBAAuB;IACvC,qBAAqB,EAAE,+BAA+B;IACtD,YAAY,EAAE,qBAAqB;IACnC,oBAAoB,EAAE,8BAA8B;IACpD,MAAM,EAAE,cAAc;IACtB,WAAW,EAAE,oBAAoB;IACjC,eAAe,EAAE,oBAAoB;IACrC,SAAS,EAAE,sBAAsB;IACjC,eAAe,EAAE,yBAAyB;IAC1C,gBAAgB,EAAE,yBAAyB;IAC3C,YAAY,EAAE,qBAAqB;IACnC,sBAAsB,EAAE,qCAAqC;IAC7D,gBAAgB,EAAE,8BAA8B;IAChD,wBAAwB,EAAE,uCAAuC;IACjE,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,aAAa;IACzB,iBAAiB,EAAE,oBAAoB;IACvC,cAAc,EAAE,iBAAiB;IACjC,UAAU,EAAE,aAAa;IACzB,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,aAAa;IAC1B,aAAa,EAAE,MAAM;IACrB,GAAG,EAAE,KAAK;IACV,mBAAmB,EAAE,qBAAqB;IAC1C,oBAAoB,EAAE,UAAU;IAChC,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,MAAM;IACnB,UAAU,EAAE,KAAK;IACjB,iBAAiB,EAAE,WAAW;IAC9B,oBAAoB,EAAE,8BAA8B;IACpD,iBAAiB,EAAE,uCAAuC;IAC1D,qBAAqB,EAAE,+BAA+B;IACtD,kBAAkB,EAAE,wCAAwC;IAC5D,kBAAkB,EAAE,GAAG;IACvB,YAAY,EAAE,eAAe;IAC7B,WAAW,EAAE,qBAAqB;IAClC,sBAAsB,EAAE,6BAA6B;IACrD,+BAA+B,EAAE,8CAA8C;IAC/E,QAAQ,EAAE,wBAAwB;IAClC,GAAG,EAAE,mBAAmB;IACxB,cAAc,EAAE,+BAA+B;IAC/C,iBAAiB,EAAE,8BAA8B;IACjD,aAAa,EAAE,gBAAgB;IAC/B,WAAW,EAAE,cAAc;IAC3B,YAAY,EAAE,eAAe;IAC7B,eAAe,EAAE,kBAAkB;IACnC,2BAA2B,EAAE,KAAK;IAClC,gCAAgC,EAAE,KAAK;IACvC,oBAAoB,EAAE,mBAAmB;IACzC,eAAe,EAAE,cAAc;IAC/B,cAAc,EAAE,gBAAgB;IAChC,sBAAsB,EAAE,wBAAwB;IAChD,oBAAoB,EAAE,IAAI;IAC1B,cAAc,EAAE,GAAG;IACnB,kBAAkB,EAAE,GAAG;IACvB,qBAAqB,EAAE,GAAG;IAC1B,kBAAkB,EAAE,GAAG;IACvB,aAAa,EAAE,GAAG;IAClB,qBAAqB,EAAE,EAAE;IACzB,+BAA+B,EAAE,IAAI;IACrC,mCAAmC,EAAE,IAAI;IACzC,yBAAyB,EAAE,IAAI;IAC/B,+EAA+E;IAC/E,8DAA8D;IAC9D,gBAAgB,EAAE,eAAe;IACjC,gBAAgB,EAAE,CAAC,eAAe;IAClC,iGAAiG;IACjG,qBAAqB,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC,CAAC,OAAO,EAAE;IACrE,cAAc,EAAE,UAAU;IAC1B,0BAA0B,EAAE,IAAI;IAChC,wBAAwB,EAAE,GAAG;IAC7B,iBAAiB,EAAE,CAAC;IACpB,8BAA8B,EAAE,GAAG;IACnC,uCAAuC,EAAE,KAAK;IAC9C,sCAAsC,EAAE,KAAK;IAC7C,kBAAkB,EAAE,sBAAsB;IAC1C,iBAAiB,EAAE,oBAAoB;IACvC,kBAAkB,EAAE,sBAAsB;IAC1C,YAAY,EAAE,eAAe;IAC7B,UAAU,EAAE,aAAa;IACzB,eAAe,EAAE,YAAY;IAC7B,oBAAoB,EAAE,iBAAiB;IACvC,eAAe,EAAE,YAAY;IAC7B,eAAe,EAAE,YAAY;IAC7B,eAAe,EAAE,kBAAkB;IACnC,gBAAgB,EAAE,mBAAmB;IACrC,qBAAqB,EAAE,wBAAwB;IAC/C,kBAAkB,EAAE,sBAAsB;IAC1C,cAAc,EAAE,2BAA2B;IAC3C,UAAU,EAAE,2BAA2B;IACvC,aAAa,EAAE,8BAA8B;IAC7C,UAAU,EAAE;QACV,QAAQ,EAAE,WAAW;QACrB,IAAI,EAAE,MAAM;QACZ,sBAAsB,EAAE,wCAAwC;QAChE,eAAe,EAAE,gCAAgC;QACjD,SAAS,EAAE,0BAA0B;QACrC,WAAW,EAAE,4BAA4B;QACzC,uBAAuB,EAAE,0CAA0C;QACnE,iBAAiB,EAAE,kCAAkC;QACrD,gBAAgB,EAAE,kCAAkC;QACpD,eAAe,EAAE,iCAAiC;QAClD,eAAe,EAAE,iCAAiC;QAClD,iBAAiB,EAAE,oCAAoC;QACvD,OAAO,EAAE,wBAAwB;QACjC,UAAU,EAAE,2BAA2B;QACvC,cAAc,EAAE,+BAA+B;KAChD;IACD,eAAe,EAAE;QACf,mBAAmB,EAAE,aAAa;QAClC,aAAa,EAAE,WAAW;QAC1B,qBAAqB,EAAE,WAAW;QAClC,iBAAiB,EAAE,aAAa;QAChC,cAAc,EAAE,WAAW;QAC3B,eAAe,EAAE,WAAW;KAC7B;CACO,CAAC;AAEX;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,4BAA4B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport const Constants = {\n associatedLinkName: \"associated-link-name\",\n partitionKey: \"x-opt-partition-key\",\n sequenceNumber: \"x-opt-sequence-number\",\n enqueueSequenceNumber: \"x-opt-enqueue-sequence-number\",\n enqueuedTime: \"x-opt-enqueued-time\",\n scheduledEnqueueTime: \"x-opt-scheduled-enqueue-time\",\n offset: \"x-opt-offset\",\n lockedUntil: \"x-opt-locked-until\",\n partitionIdName: \"x-opt-partition-id\",\n publisher: \"x-opt-publisher-name\",\n viaPartitionKey: \"x-opt-via-partition-key\",\n deadLetterSource: \"x-opt-deadletter-source\",\n messageState: \"x-opt-message-state\",\n enqueuedTimeAnnotation: `amqp.annotation.x-opt-enqueued-time`,\n offsetAnnotation: `amqp.annotation.x-opt-offset`,\n sequenceNumberAnnotation: `amqp.annotation.x-opt-sequence-number`,\n guidSize: 16,\n message: \"message\",\n error: \"error\",\n statusCode: \"status-code\",\n statusDescription: \"status-description\",\n errorCondition: \"error-condition\",\n management: \"$management\",\n partition: \"partition\",\n partitionId: \"partitionId\",\n readOperation: \"READ\",\n TLS: \"tls\",\n establishConnection: \"establishConnection\",\n defaultConsumerGroup: \"$default\",\n eventHub: \"eventhub\",\n cbsEndpoint: \"$cbs\",\n cbsReplyTo: \"cbs\",\n operationPutToken: \"put-token\",\n aadEventHubsAudience: \"https://eventhubs.azure.net/\",\n aadEventHubsScope: \"https://eventhubs.azure.net//.default\",\n aadServiceBusAudience: \"https://servicebus.azure.net/\",\n aadServiceBusScope: \"https://servicebus.azure.net//.default\",\n maxUserAgentLength: 512,\n vendorString: \"com.microsoft\",\n attachEpoch: `com.microsoft:epoch`,\n receiverIdentifierName: `com.microsoft:receiver-name`,\n enableReceiverRuntimeMetricName: `com.microsoft:enable-receiver-runtime-metric`,\n timespan: `com.microsoft:timespan`,\n uri: `com.microsoft:uri`,\n dateTimeOffset: `com.microsoft:datetime-offset`,\n sessionFilterName: `com.microsoft:session-filter`,\n receiverError: \"receiver_error\",\n senderError: \"sender_error\",\n sessionError: \"session_error\",\n connectionError: \"connection_error\",\n defaultOperationTimeoutInMs: 60000,\n defaultConnectionIdleTimeoutInMs: 60000,\n managementRequestKey: \"managementRequest\",\n negotiateCbsKey: \"negotiateCbs\",\n negotiateClaim: \"negotiateClaim\",\n ensureContainerAndBlob: \"ensureContainerAndBlob\",\n defaultPrefetchCount: 1000,\n reconnectLimit: 100,\n maxMessageIdLength: 128,\n maxPartitionKeyLength: 128,\n maxSessionIdLength: 128,\n pathDelimiter: \"/\",\n ruleNameMaximumLength: 50,\n maximumSqlFilterStatementLength: 1024,\n maximumSqlRuleActionStatementLength: 1024,\n maxDeadLetterReasonLength: 4096,\n // https://stackoverflow.com/questions/11526504/minimum-and-maximum-date for js\n // However we are setting this to the TimeSpan.MaxValue of C#.\n maxDurationValue: 922337203685477,\n minDurationValue: -922337203685477,\n // https://github.com/Azure/azure-amqp/blob/master/Microsoft.Azure.Amqp/Amqp/AmqpConstants.cs#L47\n maxAbsoluteExpiryTime: new Date(\"9999-12-31T07:59:59.000Z\").getTime(),\n maxUint32Value: 4294967295,\n aadTokenValidityMarginInMs: 5000,\n connectionReconnectDelay: 300,\n defaultMaxRetries: 3,\n defaultMaxRetriesForConnection: 150,\n defaultDelayBetweenOperationRetriesInMs: 30000,\n defaultMaxDelayForExponentialRetryInMs: 90000,\n receiverSettleMode: \"receiver-settle-mode\",\n dispositionStatus: \"disposition-status\",\n fromSequenceNumber: \"from-sequence-number\",\n messageCount: \"message-count\",\n lockTokens: \"lock-tokens\",\n messageIdMapKey: \"message-id\",\n sequenceNumberMapKey: \"sequence-number\",\n lockTokenMapKey: \"lock-token\",\n sessionIdMapKey: \"session-id\",\n sequenceNumbers: \"sequence-numbers\",\n deadLetterReason: \"deadletter-reason\",\n deadLetterDescription: \"deadletter-description\",\n propertiesToModify: \"properties-to-modify\",\n deadLetterName: \"com.microsoft:dead-letter\",\n trackingId: \"com.microsoft:tracking-id\",\n serverTimeout: \"com.microsoft:server-timeout\",\n operations: {\n putToken: \"put-token\",\n read: \"READ\",\n cancelScheduledMessage: \"com.microsoft:cancel-scheduled-message\",\n scheduleMessage: \"com.microsoft:schedule-message\",\n renewLock: \"com.microsoft:renew-lock\",\n peekMessage: \"com.microsoft:peek-message\",\n receiveBySequenceNumber: \"com.microsoft:receive-by-sequence-number\",\n updateDisposition: \"com.microsoft:update-disposition\",\n renewSessionLock: \"com.microsoft:renew-session-lock\",\n setSessionState: \"com.microsoft:set-session-state\",\n getSessionState: \"com.microsoft:get-session-state\",\n enumerateSessions: \"com.microsoft:get-message-sessions\",\n addRule: \"com.microsoft:add-rule\",\n removeRule: \"com.microsoft:remove-rule\",\n enumerateRules: \"com.microsoft:enumerate-rules\",\n },\n descriptorCodes: {\n ruleDescriptionList: 1335734829060,\n sqlFilterList: 83483426822,\n correlationFilterList: 83483426825,\n sqlRuleActionList: 1335734829062,\n trueFilterList: 83483426823,\n falseFilterList: 83483426824,\n },\n} as const;\n\n/**\n * The standard error message accompanying an AbortError.\n * @hidden\n */\nexport const StandardAbortMessage = \"The operation was aborted.\";\n"]}
package/dist-esm/src/util/lock.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"lock.js","sourceRoot":"","sources":["../../../src/util/lock.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAmB,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAkEhC;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IAArC;QACU,YAAO,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC3C,yBAAoB,GAAG,IAAI,GAAG,EAAU,CAAC;IA8InD,CAAC;IA7IC;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CACL,GAAW,EACX,IAAoC,EACpC,UAAiC;;QAEjC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;QAChD,mDAAmD;QACnD,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,EAAE;YACxB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC;SAC7D;QAED,mDAAmD;QACnD,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,EAAE,CAAC;QAC9C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAEjC,kFAAkF;QAClF,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,eAAe,EAAE,CAAC;QAE1D,MAAM,WAAW,GAAgB;YAC/B,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,QAAQ;YACjB,IAAI;SACL,CAAC;QAEF,gEAAgE;QAChE,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;YACnC,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC1B,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;gBAC1C,QAAQ,CACN,IAAI,qBAAqB,CAAC,oDAAoD,GAAG,EAAE,CAAC,CACrF,CAAC;YACJ,CAAC,EAAE,WAAW,CAAC,CAAC;YAChB,WAAW,CAAC,GAAG,GAAG,GAAG,CAAC;SACvB;QAED,0EAA0E;QAC1E,IAAI,WAAW,EAAE;YACf,MAAM,aAAa,GAAG,GAAS,EAAE;gBAC/B,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;gBAC1C,QAAQ,CAAC,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC;YACjD,CAAC,CAAC;YACF,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;YACrD,WAAW,CAAC,WAAW,GAAG,WAAW,CAAC;YACtC,WAAW,CAAC,aAAa,GAAG,aAAa,CAAC;SAC3C;QAED,oBAAoB;QACpB,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5B,MAAM,CAAC,OAAO,CACZ,8BAA8B,GAAG,YAAY,GAAG,SAAS,SAAS,CAAC,MAAM,iBAAiB,CAC3F,CAAC;QAEF,+CAA+C;QAC/C,+CAA+C;QAC/C,sDAAsD;QACtD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAEnB,OAAO,OAAqB,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,QAAQ,CAAC,GAAW;QAChC,0DAA0D;QAC1D,qCAAqC;QACrC,IAAI,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACtC,OAAO;SACR;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxC,qCAAqC;QACrC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;YACnC,OAAO;SACR;QAED,4CAA4C;QAC5C,yCAAyC;QACzC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnC,OAAO,SAAS,CAAC,MAAM,EAAE;YACvB,4CAA4C;YAC5C,iBAAiB;YACjB,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;YACtC,IAAI,CAAC,WAAW,EAAE;gBAChB,SAAS;aACV;YAED,IAAI;gBACF,MAAM,CAAC,OAAO,CAAC,sBAAsB,GAAG,mBAAmB,CAAC,CAAC;gBAC7D,kBAAkB,CAAC,WAAW,CAAC,CAAC;gBAChC,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC;gBACvC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC5B;YAAC,OAAO,GAAQ,EAAE;gBACjB,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aACzB;YACD,MAAM,CAAC,OAAO,CACZ,4BAA4B,GAAG,YAAY,GAAG,SAAS,SAAS,CAAC,MAAM,iBAAiB,CACzF,CAAC;SACH;QAED,oDAAoD;QACpD,gCAAgC;QAChC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACtC,uBAAuB;QACvB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEO,kBAAkB,CAAC,GAAW,EAAE,WAAwB;QAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;YACnC,qEAAqE;YACrE,OAAO;SACR;QAED,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC7C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YAChB,MAAM,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC7C,yCAAyC;YACzC,kBAAkB,CAAC,OAAO,CAAC,CAAC;SAC7B;IACH,CAAC;CACF;AAED;;;GAGG;AACH,SAAS,eAAe;IAKtB,IAAI,QAAkC,CAAC;IACvC,IAAI,QAAiC,CAAC;IAEtC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACvD,QAAQ,GAAG,OAAO,CAAC;QACnB,QAAQ,GAAG,MAAM,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO;QACP,QAAQ,EAAE,QAAS;QACnB,QAAQ,EAAE,QAAS;KACpB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CAAC,WAAwB;IAClD,yCAAyC;IACzC,IAAI,WAAW,CAAC,GAAG;QAAE,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACnD,IAAI,WAAW,CAAC,WAAW,IAAI,WAAW,CAAC,aAAa,EAAE;QACxD,WAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;KACjF;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AbortError, AbortSignalLike } from \"@azure/abort-controller\";\nimport { OperationTimeoutError } from \"rhea-promise\";\nimport { StandardAbortMessage } from \"./constants\";\nimport { logger } from \"../log\";\n\n/**\n * Describes the properties that must be provided while acquiring a lock.\n */\nexport interface AcquireLockProperties {\n /**\n * An implementation of the `AbortSignalLike` interface to signal the request to cancel lock acquisition.\n * This only applies to the acquisition of a lock. Once the lock is acquired, the task is invoked and `acquire`\n * can no longer be cancelled.\n * This does not cancel running the task passed to `acquire()` if the lock has been acquired,\n * but will prevent it from running if cancelled before the task is invoked.\n */\n abortSignal: AbortSignalLike | undefined;\n /**\n * The allowed amount of time in milliseconds to acquire a lock.\n * If a lock isn't acquired within this time, the promise returned\n * by `acquire()` will be rejected with an Error.\n */\n timeoutInMs: number | undefined;\n}\n\n/**\n * Describes the components related to a specific task.\n * @internal\n */\ninterface TaskDetails {\n abortListener?: () => void;\n abortSignal?: AbortSignalLike;\n resolve: (value: unknown) => void;\n reject: (reason: Error) => void;\n task: (...args: any[]) => Promise<unknown>;\n tid?: ReturnType<typeof setTimeout>;\n}\n\n/**\n * CancellableAsyncLock provides a mechanism for forcing tasks using the same\n * 'key' to be executed serially.\n *\n * Pending tasks can be manually cancelled via an abortSignal or automatically\n * cancelled by reach a provided timeout value.\n */\nexport interface CancellableAsyncLock {\n /**\n * Returns a promise that resolves to the value returned by the provided task function.\n * Only 1 task can be invoked at a time for a given `key` value.\n *\n * An acquire call can be cancelled via an `abortSignal`.\n * If cancelled, the promise will be rejected with an `AbortError`.\n *\n * `acquireTimeoutInMs` can also be provided to properties.\n * If the timeout is reached before the provided `task` is invoked,\n * then the promise will be rejected with an Error stating the task\n * timed out waiting to acquire a lock.\n *\n * @param key - All `acquire` calls are grouped by the provided `key`.\n * @param task - The function to invoke once the lock has been acquired.\n * @param properties - Additional properties to control the behavior of `acquire`.\n */\n acquire<T = void>(\n key: string,\n task: (...args: any[]) => Promise<T>,\n properties: AcquireLockProperties,\n ): Promise<T>;\n}\n\n/**\n * This class is used to coordinate executing tasks that should not be run in parallel.\n * @internal\n */\nexport class CancellableAsyncLockImpl {\n private _keyMap = new Map<string, TaskDetails[]>();\n private _executionRunningSet = new Set<string>();\n /**\n * Returns a promise that resolves to the value returned by the provided task function.\n * Only 1 task can be invoked at a time for a given `key` value.\n *\n * An acquire call can be cancelled via an `abortSignal`.\n * If cancelled, the promise will be rejected with an `AbortError`.\n *\n * `acquireTimeoutInMs` can also be provided to properties.\n * If the timeout is reached before the provided `task` is invoked,\n * then the promise will be rejected with an Error stating the task\n * timed out waiting to acquire a lock.\n *\n * @param key - All `acquire` calls are grouped by the provided `key`.\n * @param task - The function to invoke once the lock has been acquired.\n * @param properties - Additional properties to control the behavior of `acquire`.\n */\n acquire<T = void>(\n key: string,\n task: (...args: any[]) => Promise<T>,\n properties: AcquireLockProperties,\n ): Promise<T> {\n const { abortSignal, timeoutInMs } = properties;\n // Fast exit if the operation is already cancelled.\n if (abortSignal?.aborted) {\n return Promise.reject(new AbortError(StandardAbortMessage));\n }\n\n // Ensure we've got a task queue for the given key.\n const taskQueue = this._keyMap.get(key) ?? [];\n this._keyMap.set(key, taskQueue);\n\n // This method will return a promise that will be fulfilled outside this function.\n const { promise, rejecter, resolver } = getPromiseParts();\n\n const taskDetails: TaskDetails = {\n reject: rejecter,\n resolve: resolver,\n task,\n };\n\n // Handle timeouts by removing the task from the queue when hit.\n if (typeof timeoutInMs === \"number\") {\n const tid = setTimeout(() => {\n this._removeTaskDetails(key, taskDetails);\n rejecter(\n new OperationTimeoutError(`The task timed out waiting to acquire a lock for ${key}`),\n );\n }, timeoutInMs);\n taskDetails.tid = tid;\n }\n\n // Handle cancellation by removing the task from the queue when cancelled.\n if (abortSignal) {\n const abortListener = (): void => {\n this._removeTaskDetails(key, taskDetails);\n rejecter(new AbortError(StandardAbortMessage));\n };\n abortSignal.addEventListener(\"abort\", abortListener);\n taskDetails.abortSignal = abortSignal;\n taskDetails.abortListener = abortListener;\n }\n\n // Enqueue the task!\n taskQueue.push(taskDetails);\n logger.verbose(\n `Called acquire() for lock \"${key}\". Lock \"${key}\" has ${taskQueue.length} pending tasks.`,\n );\n\n // Start a loop to iterate over the task queue.\n // This will run asynchronously and won't allow\n // more than 1 concurrent execution per key at a time.\n this._execute(key);\n\n return promise as Promise<T>;\n }\n\n /**\n * Iterates over all the pending tasks for a given `key` serially.\n *\n * Note: If the pending tasks are already being iterated by an early\n * _execute invocation, this returns immediately.\n * @returns\n */\n private async _execute(key: string): Promise<void> {\n // If the key already exists in the set, then exit because\n // tasks are already being processed.\n if (this._executionRunningSet.has(key)) {\n return;\n }\n\n const taskQueue = this._keyMap.get(key);\n // If the queue is empty, exit early!\n if (!taskQueue || !taskQueue.length) {\n return;\n }\n\n // Add the key to the set so we can tell the\n // task queue is already being processed.\n this._executionRunningSet.add(key);\n while (taskQueue.length) {\n // Remove tasks from the front of the queue.\n // Order matters!\n const taskDetails = taskQueue.shift();\n if (!taskDetails) {\n continue;\n }\n\n try {\n logger.verbose(`Acquired lock for \"${key}\", invoking task.`);\n cleanupTaskDetails(taskDetails);\n const value = await taskDetails.task();\n taskDetails.resolve(value);\n } catch (err: any) {\n taskDetails.reject(err);\n }\n logger.verbose(\n `Task completed for lock \"${key}\". Lock \"${key}\" has ${taskQueue.length} pending tasks.`,\n );\n }\n\n // Indicate that the task queue for the key is empty\n // and we're done processing it.\n this._executionRunningSet.delete(key);\n // clean up the key map\n this._keyMap.delete(key);\n }\n\n private _removeTaskDetails(key: string, taskDetails: TaskDetails): void {\n const taskQueue = this._keyMap.get(key);\n if (!taskQueue || !taskQueue.length) {\n // The task is already gone from the queue, so our work here is done!\n return;\n }\n\n const index = taskQueue.indexOf(taskDetails);\n if (index !== -1) {\n const [details] = taskQueue.splice(index, 1);\n // Cleanup the task rejection code paths.\n cleanupTaskDetails(details);\n }\n }\n}\n\n/**\n * @internal\n * Returns a promise and the promise's resolve and reject methods.\n */\nfunction getPromiseParts(): {\n promise: Promise<unknown>;\n resolver: (value: unknown) => void;\n rejecter: (reason: Error) => void;\n} {\n let resolver: (value: unknown) => void;\n let rejecter: (reason: Error) => void;\n\n const promise = new Promise<unknown>((resolve, reject) => {\n resolver = resolve;\n rejecter = reject;\n });\n\n return {\n promise,\n resolver: resolver!,\n rejecter: rejecter!,\n };\n}\n\n/**\n * @internal\n * Removes any abort listener or pending timeout from a task.\n */\nfunction cleanupTaskDetails(taskDetails: TaskDetails): void {\n // Cleanup the task rejection code paths.\n if (taskDetails.tid) clearTimeout(taskDetails.tid);\n if (taskDetails.abortSignal && taskDetails.abortListener) {\n taskDetails.abortSignal.removeEventListener(\"abort\", taskDetails.abortListener);\n }\n}\n"]}
1
+ {"version":3,"file":"lock.js","sourceRoot":"","sources":["../../../src/util/lock.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAmB,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAkEhC;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IAArC;QACU,YAAO,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC3C,yBAAoB,GAAG,IAAI,GAAG,EAAU,CAAC;IA8InD,CAAC;IA7IC;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CACL,GAAW,EACX,IAAoC,EACpC,UAAiC;;QAEjC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;QAChD,mDAAmD;QACnD,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,EAAE,CAAC;YACzB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC9D,CAAC;QAED,mDAAmD;QACnD,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,EAAE,CAAC;QAC9C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAEjC,kFAAkF;QAClF,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,eAAe,EAAE,CAAC;QAE1D,MAAM,WAAW,GAAgB;YAC/B,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,QAAQ;YACjB,IAAI;SACL,CAAC;QAEF,gEAAgE;QAChE,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC1B,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;gBAC1C,QAAQ,CACN,IAAI,qBAAqB,CAAC,oDAAoD,GAAG,EAAE,CAAC,CACrF,CAAC;YACJ,CAAC,EAAE,WAAW,CAAC,CAAC;YAChB,WAAW,CAAC,GAAG,GAAG,GAAG,CAAC;QACxB,CAAC;QAED,0EAA0E;QAC1E,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,aAAa,GAAG,GAAS,EAAE;gBAC/B,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;gBAC1C,QAAQ,CAAC,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC;YACjD,CAAC,CAAC;YACF,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;YACrD,WAAW,CAAC,WAAW,GAAG,WAAW,CAAC;YACtC,WAAW,CAAC,aAAa,GAAG,aAAa,CAAC;QAC5C,CAAC;QAED,oBAAoB;QACpB,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5B,MAAM,CAAC,OAAO,CACZ,8BAA8B,GAAG,YAAY,GAAG,SAAS,SAAS,CAAC,MAAM,iBAAiB,CAC3F,CAAC;QAEF,+CAA+C;QAC/C,+CAA+C;QAC/C,sDAAsD;QACtD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAEnB,OAAO,OAAqB,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,QAAQ,CAAC,GAAW;QAChC,0DAA0D;QAC1D,qCAAqC;QACrC,IAAI,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxC,qCAAqC;QACrC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YACpC,OAAO;QACT,CAAC;QAED,4CAA4C;QAC5C,yCAAyC;QACzC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnC,OAAO,SAAS,CAAC,MAAM,EAAE,CAAC;YACxB,4CAA4C;YAC5C,iBAAiB;YACjB,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;YACtC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,SAAS;YACX,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,CAAC,OAAO,CAAC,sBAAsB,GAAG,mBAAmB,CAAC,CAAC;gBAC7D,kBAAkB,CAAC,WAAW,CAAC,CAAC;gBAChC,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC;gBACvC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,CAAC;YACD,MAAM,CAAC,OAAO,CACZ,4BAA4B,GAAG,YAAY,GAAG,SAAS,SAAS,CAAC,MAAM,iBAAiB,CACzF,CAAC;QACJ,CAAC;QAED,oDAAoD;QACpD,gCAAgC;QAChC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACtC,uBAAuB;QACvB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEO,kBAAkB,CAAC,GAAW,EAAE,WAAwB;QAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YACpC,qEAAqE;YACrE,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC7C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC7C,yCAAyC;YACzC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;CACF;AAED;;;GAGG;AACH,SAAS,eAAe;IAKtB,IAAI,QAAkC,CAAC;IACvC,IAAI,QAAiC,CAAC;IAEtC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAU,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACvD,QAAQ,GAAG,OAAO,CAAC;QACnB,QAAQ,GAAG,MAAM,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO;QACP,QAAQ,EAAE,QAAS;QACnB,QAAQ,EAAE,QAAS;KACpB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CAAC,WAAwB;IAClD,yCAAyC;IACzC,IAAI,WAAW,CAAC,GAAG;QAAE,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACnD,IAAI,WAAW,CAAC,WAAW,IAAI,WAAW,CAAC,aAAa,EAAE,CAAC;QACzD,WAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IAClF,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AbortError, AbortSignalLike } from \"@azure/abort-controller\";\nimport { OperationTimeoutError } from \"rhea-promise\";\nimport { StandardAbortMessage } from \"./constants\";\nimport { logger } from \"../log\";\n\n/**\n * Describes the properties that must be provided while acquiring a lock.\n */\nexport interface AcquireLockProperties {\n /**\n * An implementation of the `AbortSignalLike` interface to signal the request to cancel lock acquisition.\n * This only applies to the acquisition of a lock. Once the lock is acquired, the task is invoked and `acquire`\n * can no longer be cancelled.\n * This does not cancel running the task passed to `acquire()` if the lock has been acquired,\n * but will prevent it from running if cancelled before the task is invoked.\n */\n abortSignal: AbortSignalLike | undefined;\n /**\n * The allowed amount of time in milliseconds to acquire a lock.\n * If a lock isn't acquired within this time, the promise returned\n * by `acquire()` will be rejected with an Error.\n */\n timeoutInMs: number | undefined;\n}\n\n/**\n * Describes the components related to a specific task.\n * @internal\n */\ninterface TaskDetails {\n abortListener?: () => void;\n abortSignal?: AbortSignalLike;\n resolve: (value: unknown) => void;\n reject: (reason: Error) => void;\n task: (...args: any[]) => Promise<unknown>;\n tid?: ReturnType<typeof setTimeout>;\n}\n\n/**\n * CancellableAsyncLock provides a mechanism for forcing tasks using the same\n * 'key' to be executed serially.\n *\n * Pending tasks can be manually cancelled via an abortSignal or automatically\n * cancelled by reach a provided timeout value.\n */\nexport interface CancellableAsyncLock {\n /**\n * Returns a promise that resolves to the value returned by the provided task function.\n * Only 1 task can be invoked at a time for a given `key` value.\n *\n * An acquire call can be cancelled via an `abortSignal`.\n * If cancelled, the promise will be rejected with an `AbortError`.\n *\n * `acquireTimeoutInMs` can also be provided to properties.\n * If the timeout is reached before the provided `task` is invoked,\n * then the promise will be rejected with an Error stating the task\n * timed out waiting to acquire a lock.\n *\n * @param key - All `acquire` calls are grouped by the provided `key`.\n * @param task - The function to invoke once the lock has been acquired.\n * @param properties - Additional properties to control the behavior of `acquire`.\n */\n acquire<T = void>(\n key: string,\n task: (...args: any[]) => Promise<T>,\n properties: AcquireLockProperties,\n ): Promise<T>;\n}\n\n/**\n * This class is used to coordinate executing tasks that should not be run in parallel.\n * @internal\n */\nexport class CancellableAsyncLockImpl {\n private _keyMap = new Map<string, TaskDetails[]>();\n private _executionRunningSet = new Set<string>();\n /**\n * Returns a promise that resolves to the value returned by the provided task function.\n * Only 1 task can be invoked at a time for a given `key` value.\n *\n * An acquire call can be cancelled via an `abortSignal`.\n * If cancelled, the promise will be rejected with an `AbortError`.\n *\n * `acquireTimeoutInMs` can also be provided to properties.\n * If the timeout is reached before the provided `task` is invoked,\n * then the promise will be rejected with an Error stating the task\n * timed out waiting to acquire a lock.\n *\n * @param key - All `acquire` calls are grouped by the provided `key`.\n * @param task - The function to invoke once the lock has been acquired.\n * @param properties - Additional properties to control the behavior of `acquire`.\n */\n acquire<T = void>(\n key: string,\n task: (...args: any[]) => Promise<T>,\n properties: AcquireLockProperties,\n ): Promise<T> {\n const { abortSignal, timeoutInMs } = properties;\n // Fast exit if the operation is already cancelled.\n if (abortSignal?.aborted) {\n return Promise.reject(new AbortError(StandardAbortMessage));\n }\n\n // Ensure we've got a task queue for the given key.\n const taskQueue = this._keyMap.get(key) ?? [];\n this._keyMap.set(key, taskQueue);\n\n // This method will return a promise that will be fulfilled outside this function.\n const { promise, rejecter, resolver } = getPromiseParts();\n\n const taskDetails: TaskDetails = {\n reject: rejecter,\n resolve: resolver,\n task,\n };\n\n // Handle timeouts by removing the task from the queue when hit.\n if (typeof timeoutInMs === \"number\") {\n const tid = setTimeout(() => {\n this._removeTaskDetails(key, taskDetails);\n rejecter(\n new OperationTimeoutError(`The task timed out waiting to acquire a lock for ${key}`),\n );\n }, timeoutInMs);\n taskDetails.tid = tid;\n }\n\n // Handle cancellation by removing the task from the queue when cancelled.\n if (abortSignal) {\n const abortListener = (): void => {\n this._removeTaskDetails(key, taskDetails);\n rejecter(new AbortError(StandardAbortMessage));\n };\n abortSignal.addEventListener(\"abort\", abortListener);\n taskDetails.abortSignal = abortSignal;\n taskDetails.abortListener = abortListener;\n }\n\n // Enqueue the task!\n taskQueue.push(taskDetails);\n logger.verbose(\n `Called acquire() for lock \"${key}\". Lock \"${key}\" has ${taskQueue.length} pending tasks.`,\n );\n\n // Start a loop to iterate over the task queue.\n // This will run asynchronously and won't allow\n // more than 1 concurrent execution per key at a time.\n this._execute(key);\n\n return promise as Promise<T>;\n }\n\n /**\n * Iterates over all the pending tasks for a given `key` serially.\n *\n * Note: If the pending tasks are already being iterated by an early\n * _execute invocation, this returns immediately.\n * @returns\n */\n private async _execute(key: string): Promise<void> {\n // If the key already exists in the set, then exit because\n // tasks are already being processed.\n if (this._executionRunningSet.has(key)) {\n return;\n }\n\n const taskQueue = this._keyMap.get(key);\n // If the queue is empty, exit early!\n if (!taskQueue || !taskQueue.length) {\n return;\n }\n\n // Add the key to the set so we can tell the\n // task queue is already being processed.\n this._executionRunningSet.add(key);\n while (taskQueue.length) {\n // Remove tasks from the front of the queue.\n // Order matters!\n const taskDetails = taskQueue.shift();\n if (!taskDetails) {\n continue;\n }\n\n try {\n logger.verbose(`Acquired lock for \"${key}\", invoking task.`);\n cleanupTaskDetails(taskDetails);\n const value = await taskDetails.task();\n taskDetails.resolve(value);\n } catch (err: any) {\n taskDetails.reject(err);\n }\n logger.verbose(\n `Task completed for lock \"${key}\". Lock \"${key}\" has ${taskQueue.length} pending tasks.`,\n );\n }\n\n // Indicate that the task queue for the key is empty\n // and we're done processing it.\n this._executionRunningSet.delete(key);\n // clean up the key map\n this._keyMap.delete(key);\n }\n\n private _removeTaskDetails(key: string, taskDetails: TaskDetails): void {\n const taskQueue = this._keyMap.get(key);\n if (!taskQueue || !taskQueue.length) {\n // The task is already gone from the queue, so our work here is done!\n return;\n }\n\n const index = taskQueue.indexOf(taskDetails);\n if (index !== -1) {\n const [details] = taskQueue.splice(index, 1);\n // Cleanup the task rejection code paths.\n cleanupTaskDetails(details);\n }\n }\n}\n\n/**\n * @internal\n * Returns a promise and the promise's resolve and reject methods.\n */\nfunction getPromiseParts(): {\n promise: Promise<unknown>;\n resolver: (value: unknown) => void;\n rejecter: (reason: Error) => void;\n} {\n let resolver: (value: unknown) => void;\n let rejecter: (reason: Error) => void;\n\n const promise = new Promise<unknown>((resolve, reject) => {\n resolver = resolve;\n rejecter = reject;\n });\n\n return {\n promise,\n resolver: resolver!,\n rejecter: rejecter!,\n };\n}\n\n/**\n * @internal\n * Removes any abort listener or pending timeout from a task.\n */\nfunction cleanupTaskDetails(taskDetails: TaskDetails): void {\n // Cleanup the task rejection code paths.\n if (taskDetails.tid) clearTimeout(taskDetails.tid);\n if (taskDetails.abortSignal && taskDetails.abortListener) {\n taskDetails.abortSignal.removeEventListener(\"abort\", taskDetails.abortListener);\n }\n}\n"]}
package/dist-esm/src/util/runtimeInfo.browser.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"runtimeInfo.browser.js","sourceRoot":"","sources":["../../../src/util/runtimeInfo.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAsBlC;;;GAGG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,uBAAuB,cAAc,EAAE,GAAG,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO,WAAW,cAAc,EAAE,EAAE,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc;IACrB,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QAC/B,OAAO,EAAE,CAAC;KACX;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;IACjC,OAAO,SAAS,CAAC,UAAU,CAAC;AAC9B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * @internal\n */\ninterface Window {}\n\n/**\n * @internal\n */\ndeclare let self: Window & typeof globalThis & { navigator: Navigator };\n\n/**\n * @internal\n */\ninterface Navigator {\n /**\n * Returns a string representing the browser version info.\n */\n appVersion: string;\n}\n\n/**\n * Returns information about the platform this function is being run on.\n * @internal\n */\nexport function getPlatformInfo(): string {\n return `(javascript-Browser-${getReleaseInfo()})`;\n}\n\n/**\n * Returns information about Node.js this function is being run on.\n * @internal\n */\nexport function getFrameworkInfo(): string {\n return `Browser/${getReleaseInfo()}`;\n}\n\n/**\n * @internal\n *\n * @returns\n */\nfunction getReleaseInfo(): string {\n if (typeof self === \"undefined\") {\n return \"\";\n }\n\n const navigator = self.navigator;\n return navigator.appVersion;\n}\n"]}
1
+ {"version":3,"file":"runtimeInfo.browser.js","sourceRoot":"","sources":["../../../src/util/runtimeInfo.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAsBlC;;;GAGG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,uBAAuB,cAAc,EAAE,GAAG,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO,WAAW,cAAc,EAAE,EAAE,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc;IACrB,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE,CAAC;QAChC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;IACjC,OAAO,SAAS,CAAC,UAAU,CAAC;AAC9B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * @internal\n */\ninterface Window {}\n\n/**\n * @internal\n */\ndeclare let self: Window & typeof globalThis & { navigator: Navigator };\n\n/**\n * @internal\n */\ninterface Navigator {\n /**\n * Returns a string representing the browser version info.\n */\n appVersion: string;\n}\n\n/**\n * Returns information about the platform this function is being run on.\n * @internal\n */\nexport function getPlatformInfo(): string {\n return `(javascript-Browser-${getReleaseInfo()})`;\n}\n\n/**\n * Returns information about Node.js this function is being run on.\n * @internal\n */\nexport function getFrameworkInfo(): string {\n return `Browser/${getReleaseInfo()}`;\n}\n\n/**\n * @internal\n *\n * @returns\n */\nfunction getReleaseInfo(): string {\n if (typeof self === \"undefined\") {\n return \"\";\n }\n\n const navigator = self.navigator;\n return navigator.appVersion;\n}\n"]}
package/dist-esm/src/util/utils.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/util/utils.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,OAAO,EAAwB,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAGxE,OAAO,EAAE,KAAK,IAAI,YAAY,EAAE,MAAM,kBAAkB,CAAC;AA+CzD;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GACjB,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAA,OAAO,CAAC,QAAQ,0CAAE,IAAI,CAAC,CAAC;AAOhG;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,qBAAqB,CAAI,gBAAwB;IAC/D,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEjD,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE;QACtB,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAEnB,IAAI,IAAI,KAAK,EAAE,EAAE;YACf,qBAAqB;YACrB,SAAS;SACV;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE;YACrB,MAAM,IAAI,KAAK,CACb,8FAA8F,CAC/F,CAAC;SACH;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;QACjD,IAAI,GAAG,KAAK,EAAE,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;SAC5E;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAEpD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;KACrB;IAED,OAAO,MAAa,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAyB,IAAI,wBAAwB,EAAE,CAAC;AAE3F;;;;;GAKG;AACH,MAAM,OAAO,OAAO;IAGlB,GAAG,CAAI,CAAS,EAAE,KAAS;QACzB,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,MAAM,QAAQ,GAAwB,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAC5F,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC3B;IACH,CAAC;IAED,IAAI,CAAI,OAAmB,EAAE,CAAS,EAAE,KAAS;QAC/C,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QACzE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACjC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC;IAC/C,CAAC;IAEO,eAAe,CAAI,OAAmB,EAAE,EAA4B;QAC1E,MAAM,OAAO,GAAG,CAAC,MAAS,EAAK,EAAE;YAC/B,EAAE,EAAE,CAAC;YACL,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,CAAC,CAAQ,EAAkB,EAAE;YACzC,EAAE,EAAE,CAAC;YACL,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC,CAAC;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,GAAG,CAAI,CAAS,EAAE,KAAS;QAChC,OAAO,IAAI,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,CAAC,IAAI,CAAI,OAAmB,EAAE,CAAS,EAAE,KAAS;QACtD,OAAO,IAAI,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,SAAiB,EACjB,WAA6B,EAC7B,aAAsB,EACtB,KAAS;IAET,MAAM,YAAY,CAAC,SAAS,EAAE;QAC5B,WAAW,EAAE,WAAW;QACxB,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IACH,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,GAAW,EAAE,GAAW;IAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;AAC3D,CAAC;AAUD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,2BAA2B,CACzC,gBAA4B,EAC5B,SAAmB;IAEnB,IAAI,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACxC,gBAAgB,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;QAC1C,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,gBAAwB;IAC/D,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAE5C,IAAI,MAAM,GAAY,KAAK,CAAC;IAC5B,MAAM,KAAK,GAAQ,qBAAqB,CAAM,gBAAgB,CAAC,CAAC;IAChE,IAAI,KAAK,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,eAAe,IAAI,KAAK,CAAC,mBAAmB,EAAE;QACjF,MAAM,GAAG,IAAI,CAAC;KACf;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC;AAC/B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { CancellableAsyncLock, CancellableAsyncLockImpl } from \"./lock\";\nimport { AbortSignalLike } from \"@azure/abort-controller\";\nimport { WebSocketImpl } from \"rhea-promise\";\nimport { delay as wrapperDelay } from \"@azure/core-util\";\n\n/**\n * @internal\n *\n * Describes the options that can be provided to create an async lock.\n */\nexport interface AsyncLockOptions {\n /**\n * The max timeout. Default is: 0 (never timeout).\n */\n timeout?: number;\n /**\n * Maximum pending tasks. Default is: 1000.\n */\n maxPending?: number;\n /**\n * Whether lock can reenter in the same domain.\n * Default is: false.\n */\n domainReentrant?: boolean;\n /**\n * Your implementation of the promise. Default is: global promise.\n */\n Promise?: any;\n}\n\n/**\n * Options to configure the channelling of the AMQP connection over Web Sockets.\n */\nexport interface WebSocketOptions {\n /**\n * The WebSocket constructor used to create an AMQP connection over a WebSocket.\n * This option should be provided in the below scenarios:\n * - The TCP port 5671 which is that is used by the AMQP connection to Event Hubs is blocked in your environment.\n * - Your application needs to be run behind a proxy server.\n * - Your application needs to run in the browser and you want to provide your own choice of Websocket implementation\n * instead of the built-in WebSocket in the browser.\n */\n webSocket?: WebSocketImpl;\n /**\n * Options to be passed to the WebSocket constructor when the underlying `rhea` library instantiates\n * the WebSocket.\n */\n webSocketConstructorOptions?: any;\n}\n\n/**\n * @internal\n *\n * A constant that indicates whether the environment is node.js or browser based.\n */\nexport const isNode =\n typeof process !== \"undefined\" && Boolean(process.version) && Boolean(process.versions?.node);\n\n/**\n * Defines an object with possible properties defined in T.\n */\nexport type ParsedOutput<T> = { [P in keyof T]: T[P] };\n\n/**\n * Parses the connection string and returns an object of type T.\n *\n * Connection strings have the following syntax:\n *\n * ConnectionString ::= `Part { \";\" Part } [ \";\" ] [ WhiteSpace ]`\n * Part ::= [ PartLiteral [ \"=\" PartLiteral ] ]\n * PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ]\n * Literal ::= ? any sequence of characters except ; or = or WhiteSpace ?\n * WhiteSpace ::= ? all whitespace characters including `\\r` and `\\n` ?\n *\n * @param connectionString - The connection string to be parsed.\n * @returns ParsedOutput<T>.\n */\nexport function parseConnectionString<T>(connectionString: string): ParsedOutput<T> {\n const output: { [k: string]: string } = {};\n const parts = connectionString.trim().split(\";\");\n\n for (let part of parts) {\n part = part.trim();\n\n if (part === \"\") {\n // parts can be empty\n continue;\n }\n\n const splitIndex = part.indexOf(\"=\");\n if (splitIndex === -1) {\n throw new Error(\n \"Connection string malformed: each part of the connection string must have an `=` assignment.\",\n );\n }\n\n const key = part.substring(0, splitIndex).trim();\n if (key === \"\") {\n throw new Error(\"Connection string malformed: missing key for assignment\");\n }\n\n const value = part.substring(splitIndex + 1).trim();\n\n output[key] = value;\n }\n\n return output as any;\n}\n\n/**\n * The cancellable async lock instance.\n */\nexport const defaultCancellableLock: CancellableAsyncLock = new CancellableAsyncLockImpl();\n\n/**\n * @internal\n *\n * Describes a Timeout class that can wait for the specified amount of time and then resolve/reject\n * the promise with the given value.\n */\nexport class Timeout {\n private _timer?: ReturnType<typeof setTimeout>;\n\n set<T>(t: number, value?: T): Promise<T> {\n return new Promise<T>((resolve, reject) => {\n this.clear();\n const callback: (args: any) => void = value ? () => reject(new Error(`${value}`)) : resolve;\n this._timer = setTimeout(callback, t);\n });\n }\n\n clear(): void {\n if (this._timer) {\n clearTimeout(this._timer);\n }\n }\n\n wrap<T>(promise: Promise<T>, t: number, value?: T): Promise<T> {\n const wrappedPromise = this._promiseFinally(promise, () => this.clear());\n const timer = this.set(t, value);\n return Promise.race([wrappedPromise, timer]);\n }\n\n private _promiseFinally<T>(promise: Promise<T>, fn: (...args: any[]) => void): Promise<T> {\n const success = (result: T): T => {\n fn();\n return result;\n };\n const error = (e: Error): Promise<never> => {\n fn();\n return Promise.reject(e);\n };\n return Promise.resolve(promise).then(success, error);\n }\n\n static set<T>(t: number, value?: T): Promise<T> {\n return new Timeout().set(t, value);\n }\n\n static wrap<T>(promise: Promise<T>, t: number, value?: T): Promise<T> {\n return new Timeout().wrap(promise, t, value);\n }\n}\n\n/**\n * A wrapper for setTimeout that resolves a promise after t milliseconds.\n * @param delayInMs - The number of milliseconds to be delayed.\n * @param abortSignal - The abortSignal associated with containing operation.\n * @param abortErrorMsg - The abort error message associated with containing operation.\n * @param value - The value to be resolved with after a timeout of t milliseconds.\n * @returns - Resolved promise\n */\nexport async function delay<T>(\n delayInMs: number,\n abortSignal?: AbortSignalLike,\n abortErrorMsg?: string,\n value?: T,\n): Promise<T | void> {\n await wrapperDelay(delayInMs, {\n abortSignal: abortSignal,\n abortErrorMsg: abortErrorMsg,\n });\n if (value !== undefined) {\n return value;\n }\n}\n\n/**\n * @internal\n *\n * Generates a random number between the given interval\n * @param min - Min number of the range (inclusive).\n * @param max - Max number of the range (inclusive).\n */\nexport function randomNumberFromInterval(min: number, max: number): number {\n return Math.floor(Math.random() * (max - min + 1) + min);\n}\n\n/**\n * @internal\n *\n * Type declaration for a Function type where T is the input to the function and V is the output\n * of the function.\n */\nexport type Func<T, V> = (a: T) => V;\n\n/**\n * @internal\n *\n * Executes an array of promises sequentially. Inspiration of this method is here:\n * https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. An awesome blog on promises!\n *\n * @param promiseFactories - An array of promise factories(A function that return a promise)\n *\n * @param kickstart - Input to the first promise that is used to kickstart the promise chain.\n * If not provided then the promise chain starts with undefined.\n *\n * @returns A chain of resolved or rejected promises\n */\nexport function executePromisesSequentially(\n promiseFactories: Array<any>,\n kickstart?: unknown,\n): Promise<any> {\n let result = Promise.resolve(kickstart);\n promiseFactories.forEach((promiseFactory) => {\n result = result.then(promiseFactory);\n });\n return result;\n}\n\n/**\n * @internal\n *\n * Determines whether the given connection string is an iothub connection string.\n * @param connectionString - The connection string.\n * @returns boolean.\n */\nexport function isIotHubConnectionString(connectionString: string): boolean {\n connectionString = String(connectionString);\n\n let result: boolean = false;\n const model: any = parseConnectionString<any>(connectionString);\n if (model && model.HostName && model.SharedAccessKey && model.SharedAccessKeyName) {\n result = true;\n }\n return result;\n}\n\n/**\n * @internal\n */\nexport function isString(s: unknown): s is string {\n return typeof s === \"string\";\n}\n\n/**\n * @internal\n */\nexport function isNumber(n: unknown): n is number {\n return typeof n === \"number\";\n}\n"]}
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/util/utils.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,OAAO,EAAwB,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAGxE,OAAO,EAAE,KAAK,IAAI,YAAY,EAAE,MAAM,kBAAkB,CAAC;AA+CzD;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GACjB,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAA,OAAO,CAAC,QAAQ,0CAAE,IAAI,CAAC,CAAC;AAOhG;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,qBAAqB,CAAI,gBAAwB;IAC/D,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEjD,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAEnB,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAChB,qBAAqB;YACrB,SAAS;QACX,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,8FAA8F,CAC/F,CAAC;QACJ,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;QACjD,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAC7E,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAEpD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,OAAO,MAAa,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAyB,IAAI,wBAAwB,EAAE,CAAC;AAE3F;;;;;GAKG;AACH,MAAM,OAAO,OAAO;IAGlB,GAAG,CAAI,CAAS,EAAE,KAAS;QACzB,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,MAAM,QAAQ,GAAwB,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAC5F,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,IAAI,CAAI,OAAmB,EAAE,CAAS,EAAE,KAAS;QAC/C,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QACzE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACjC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC;IAC/C,CAAC;IAEO,eAAe,CAAI,OAAmB,EAAE,EAA4B;QAC1E,MAAM,OAAO,GAAG,CAAC,MAAS,EAAK,EAAE;YAC/B,EAAE,EAAE,CAAC;YACL,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,CAAC,CAAQ,EAAkB,EAAE;YACzC,EAAE,EAAE,CAAC;YACL,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC,CAAC;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,GAAG,CAAI,CAAS,EAAE,KAAS;QAChC,OAAO,IAAI,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,CAAC,IAAI,CAAI,OAAmB,EAAE,CAAS,EAAE,KAAS;QACtD,OAAO,IAAI,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,SAAiB,EACjB,WAA6B,EAC7B,aAAsB,EACtB,KAAS;IAET,MAAM,YAAY,CAAC,SAAS,EAAE;QAC5B,WAAW,EAAE,WAAW;QACxB,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IACH,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,GAAW,EAAE,GAAW;IAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;AAC3D,CAAC;AAUD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,2BAA2B,CACzC,gBAA4B,EAC5B,SAAmB;IAEnB,IAAI,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACxC,gBAAgB,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;QAC1C,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CAAC,gBAAwB;IAC/D,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAE5C,IAAI,MAAM,GAAY,KAAK,CAAC;IAC5B,MAAM,KAAK,GAAQ,qBAAqB,CAAM,gBAAgB,CAAC,CAAC;IAChE,IAAI,KAAK,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,eAAe,IAAI,KAAK,CAAC,mBAAmB,EAAE,CAAC;QAClF,MAAM,GAAG,IAAI,CAAC;IAChB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,CAAU;IACjC,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC;AAC/B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { CancellableAsyncLock, CancellableAsyncLockImpl } from \"./lock\";\nimport { AbortSignalLike } from \"@azure/abort-controller\";\nimport { WebSocketImpl } from \"rhea-promise\";\nimport { delay as wrapperDelay } from \"@azure/core-util\";\n\n/**\n * @internal\n *\n * Describes the options that can be provided to create an async lock.\n */\nexport interface AsyncLockOptions {\n /**\n * The max timeout. Default is: 0 (never timeout).\n */\n timeout?: number;\n /**\n * Maximum pending tasks. Default is: 1000.\n */\n maxPending?: number;\n /**\n * Whether lock can reenter in the same domain.\n * Default is: false.\n */\n domainReentrant?: boolean;\n /**\n * Your implementation of the promise. Default is: global promise.\n */\n Promise?: any;\n}\n\n/**\n * Options to configure the channelling of the AMQP connection over Web Sockets.\n */\nexport interface WebSocketOptions {\n /**\n * The WebSocket constructor used to create an AMQP connection over a WebSocket.\n * This option should be provided in the below scenarios:\n * - The TCP port 5671 which is that is used by the AMQP connection to Event Hubs is blocked in your environment.\n * - Your application needs to be run behind a proxy server.\n * - Your application needs to run in the browser and you want to provide your own choice of Websocket implementation\n * instead of the built-in WebSocket in the browser.\n */\n webSocket?: WebSocketImpl;\n /**\n * Options to be passed to the WebSocket constructor when the underlying `rhea` library instantiates\n * the WebSocket.\n */\n webSocketConstructorOptions?: any;\n}\n\n/**\n * @internal\n *\n * A constant that indicates whether the environment is node.js or browser based.\n */\nexport const isNode =\n typeof process !== \"undefined\" && Boolean(process.version) && Boolean(process.versions?.node);\n\n/**\n * Defines an object with possible properties defined in T.\n */\nexport type ParsedOutput<T> = { [P in keyof T]: T[P] };\n\n/**\n * Parses the connection string and returns an object of type T.\n *\n * Connection strings have the following syntax:\n *\n * ConnectionString ::= `Part { \";\" Part } [ \";\" ] [ WhiteSpace ]`\n * Part ::= [ PartLiteral [ \"=\" PartLiteral ] ]\n * PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ]\n * Literal ::= ? any sequence of characters except ; or = or WhiteSpace ?\n * WhiteSpace ::= ? all whitespace characters including `\\r` and `\\n` ?\n *\n * @param connectionString - The connection string to be parsed.\n * @returns ParsedOutput<T>.\n */\nexport function parseConnectionString<T>(connectionString: string): ParsedOutput<T> {\n const output: { [k: string]: string } = {};\n const parts = connectionString.trim().split(\";\");\n\n for (let part of parts) {\n part = part.trim();\n\n if (part === \"\") {\n // parts can be empty\n continue;\n }\n\n const splitIndex = part.indexOf(\"=\");\n if (splitIndex === -1) {\n throw new Error(\n \"Connection string malformed: each part of the connection string must have an `=` assignment.\",\n );\n }\n\n const key = part.substring(0, splitIndex).trim();\n if (key === \"\") {\n throw new Error(\"Connection string malformed: missing key for assignment\");\n }\n\n const value = part.substring(splitIndex + 1).trim();\n\n output[key] = value;\n }\n\n return output as any;\n}\n\n/**\n * The cancellable async lock instance.\n */\nexport const defaultCancellableLock: CancellableAsyncLock = new CancellableAsyncLockImpl();\n\n/**\n * @internal\n *\n * Describes a Timeout class that can wait for the specified amount of time and then resolve/reject\n * the promise with the given value.\n */\nexport class Timeout {\n private _timer?: ReturnType<typeof setTimeout>;\n\n set<T>(t: number, value?: T): Promise<T> {\n return new Promise<T>((resolve, reject) => {\n this.clear();\n const callback: (args: any) => void = value ? () => reject(new Error(`${value}`)) : resolve;\n this._timer = setTimeout(callback, t);\n });\n }\n\n clear(): void {\n if (this._timer) {\n clearTimeout(this._timer);\n }\n }\n\n wrap<T>(promise: Promise<T>, t: number, value?: T): Promise<T> {\n const wrappedPromise = this._promiseFinally(promise, () => this.clear());\n const timer = this.set(t, value);\n return Promise.race([wrappedPromise, timer]);\n }\n\n private _promiseFinally<T>(promise: Promise<T>, fn: (...args: any[]) => void): Promise<T> {\n const success = (result: T): T => {\n fn();\n return result;\n };\n const error = (e: Error): Promise<never> => {\n fn();\n return Promise.reject(e);\n };\n return Promise.resolve(promise).then(success, error);\n }\n\n static set<T>(t: number, value?: T): Promise<T> {\n return new Timeout().set(t, value);\n }\n\n static wrap<T>(promise: Promise<T>, t: number, value?: T): Promise<T> {\n return new Timeout().wrap(promise, t, value);\n }\n}\n\n/**\n * A wrapper for setTimeout that resolves a promise after t milliseconds.\n * @param delayInMs - The number of milliseconds to be delayed.\n * @param abortSignal - The abortSignal associated with containing operation.\n * @param abortErrorMsg - The abort error message associated with containing operation.\n * @param value - The value to be resolved with after a timeout of t milliseconds.\n * @returns - Resolved promise\n */\nexport async function delay<T>(\n delayInMs: number,\n abortSignal?: AbortSignalLike,\n abortErrorMsg?: string,\n value?: T,\n): Promise<T | void> {\n await wrapperDelay(delayInMs, {\n abortSignal: abortSignal,\n abortErrorMsg: abortErrorMsg,\n });\n if (value !== undefined) {\n return value;\n }\n}\n\n/**\n * @internal\n *\n * Generates a random number between the given interval\n * @param min - Min number of the range (inclusive).\n * @param max - Max number of the range (inclusive).\n */\nexport function randomNumberFromInterval(min: number, max: number): number {\n return Math.floor(Math.random() * (max - min + 1) + min);\n}\n\n/**\n * @internal\n *\n * Type declaration for a Function type where T is the input to the function and V is the output\n * of the function.\n */\nexport type Func<T, V> = (a: T) => V;\n\n/**\n * @internal\n *\n * Executes an array of promises sequentially. Inspiration of this method is here:\n * https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. An awesome blog on promises!\n *\n * @param promiseFactories - An array of promise factories(A function that return a promise)\n *\n * @param kickstart - Input to the first promise that is used to kickstart the promise chain.\n * If not provided then the promise chain starts with undefined.\n *\n * @returns A chain of resolved or rejected promises\n */\nexport function executePromisesSequentially(\n promiseFactories: Array<any>,\n kickstart?: unknown,\n): Promise<any> {\n let result = Promise.resolve(kickstart);\n promiseFactories.forEach((promiseFactory) => {\n result = result.then(promiseFactory);\n });\n return result;\n}\n\n/**\n * @internal\n *\n * Determines whether the given connection string is an iothub connection string.\n * @param connectionString - The connection string.\n * @returns boolean.\n */\nexport function isIotHubConnectionString(connectionString: string): boolean {\n connectionString = String(connectionString);\n\n let result: boolean = false;\n const model: any = parseConnectionString<any>(connectionString);\n if (model && model.HostName && model.SharedAccessKey && model.SharedAccessKeyName) {\n result = true;\n }\n return result;\n}\n\n/**\n * @internal\n */\nexport function isString(s: unknown): s is string {\n return typeof s === \"string\";\n}\n\n/**\n * @internal\n */\nexport function isNumber(n: unknown): n is number {\n return typeof n === \"number\";\n}\n"]}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@azure/core-amqp",
3
3
  "sdk-type": "client",
4
- "version": "4.1.1-alpha.20240108.2",
4
+ "version": "4.2.0",
5
5
  "description": "Common library for amqp based azure sdks like @azure/event-hubs.",
6
6
  "author": "Microsoft Corporation",
7
7
  "license": "MIT",
@@ -76,8 +76,8 @@
76
76
  "util": "^0.12.1"
77
77
  },
78
78
  "devDependencies": {
79
- "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
80
- "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
79
+ "@azure/dev-tool": "^1.0.0",
80
+ "@azure/eslint-plugin-azure-sdk": "^3.0.0",
81
81
  "@microsoft/api-extractor": "^7.31.1",
82
82
  "@types/chai": "^4.1.6",
83
83
  "@types/debug": "^4.1.4",
@@ -98,7 +98,7 @@
98
98
  "rimraf": "^3.0.0",
99
99
  "sinon": "^17.0.0",
100
100
  "ts-node": "^10.0.0",
101
- "typescript": "~5.2.0",
101
+ "typescript": "~5.3.3",
102
102
  "ws": "^8.2.0"
103
103
  },
104
104
  "//metadata": {
package/types/latest/core-amqp.d.ts CHANGED
@@ -410,7 +410,7 @@ export declare enum ConditionErrorNameMapper {
410
410
  /**
411
411
  * Error is thrown when an internal server error occurred. You may have found a bug?
412
412
  */
413
- "amqp:internal-error" = "InternalServerError",
413
+ "amqp:internal-error" = "InternalServerError",// Retryable
414
414
  /**
415
415
  * Error for signaling general communication errors related to messaging operations.
416
416
  */
@@ -450,7 +450,7 @@ export declare enum ConditionErrorNameMapper {
450
450
  /**
451
451
  * Error is thrown when the service is unavailable. The operation should be retried.
452
452
  */
453
- "com.microsoft:timeout" = "ServiceUnavailableError",
453
+ "com.microsoft:timeout" = "ServiceUnavailableError",// Retryable
454
454
  /**
455
455
  * Error is thrown when no new messages are received for the specified time.
456
456
  */
@@ -497,11 +497,11 @@ export declare enum ConditionErrorNameMapper {
497
497
  /**
498
498
  * Error is thrown when an operator intervened to detach for some reason.
499
499
  */
500
- "amqp:link:detach-forced" = "DetachForcedError",
500
+ "amqp:link:detach-forced" = "DetachForcedError",// Retryable
501
501
  /**
502
502
  * Error is thrown when the peer sent more message transfers than currently allowed on the link.
503
503
  */
504
- "amqp:link:transfer-limit-exceeded" = "TransferLimitExceededError",
504
+ "amqp:link:transfer-limit-exceeded" = "TransferLimitExceededError",// Retryable
505
505
  /**
506
506
  * Error is thrown when the message sent is too large: the maximum size is 256Kb.
507
507
  */
@@ -535,7 +535,7 @@ export declare enum ConditionErrorNameMapper {
535
535
  /**
536
536
  * Error is thrown when an operator intervened to close the connection for some reason.
537
537
  */
538
- "amqp:connection:forced" = "ConnectionForcedError",
538
+ "amqp:connection:forced" = "ConnectionForcedError",// Retryable
539
539
  /**
540
540
  * Error is thrown when a valid frame header cannot be formed from the incoming byte stream.
541
541
  */
@@ -547,7 +547,7 @@ export declare enum ConditionErrorNameMapper {
547
547
  /**
548
548
  * Error is thrown when the server is busy. Callers should wait a while and retry the operation.
549
549
  */
550
- "com.microsoft:server-busy" = "ServerBusyError",
550
+ "com.microsoft:server-busy" = "ServerBusyError",// Retryable
551
551
  /**
552
552
  * Error is thrown when an incorrect argument was received.
553
553
  */
@@ -555,15 +555,15 @@ export declare enum ConditionErrorNameMapper {
555
555
  /**
556
556
  * Error is thrown when server cancels the operation due to an internal issue.
557
557
  */
558
- "com.microsoft:operation-cancelled" = "OperationCancelledError",
558
+ "com.microsoft:operation-cancelled" = "OperationCancelledError",// Retryable
559
559
  /**
560
560
  * Error is thrown when the client sender does not have enough link credits to send the message.
561
561
  */
562
- "client.sender:not-enough-link-credit" = "SenderBusyError",
562
+ "client.sender:not-enough-link-credit" = "SenderBusyError",// Retryable
563
563
  /**
564
564
  * Error is thrown when the client sender's link isn't ready
565
565
  */
566
- "client.sender:link-not-ready" = "SenderNotReadyError",
566
+ "client.sender:link-not-ready" = "SenderNotReadyError",// Retryable
567
567
  /**
568
568
  * Error is thrown when a low level system error is thrown by node.js.
569
569
  * {@link https://nodejs.org/dist/latest-v8.x/docs/api/all.html#errors_class_system_error}
@@ -809,6 +809,7 @@ export declare const Constants: {
809
809
  readonly maxDurationValue: 922337203685477;
810
810
  readonly minDurationValue: -922337203685477;
811
811
  readonly maxAbsoluteExpiryTime: number;
812
+ readonly maxUint32Value: 4294967295;
812
813
  readonly aadTokenValidityMarginInMs: 5000;
813
814
  readonly connectionReconnectDelay: 300;
814
815
  readonly defaultMaxRetries: 3;
@@ -960,7 +961,7 @@ export declare enum ErrorNameConditionMapper {
960
961
  /**
961
962
  * Error is thrown when an internal server error occurred. You may have found a bug?
962
963
  */
963
- InternalServerError = "amqp:internal-error",
964
+ InternalServerError = "amqp:internal-error",// Retryable
964
965
  /**
965
966
  * Error for signaling general communication errors related to messaging operations.
966
967
  */
@@ -996,7 +997,7 @@ export declare enum ErrorNameConditionMapper {
996
997
  /**
997
998
  * Error is thrown when the service is unavailable. The operation should be retried.
998
999
  */
999
- ServiceUnavailableError = "com.microsoft:timeout",
1000
+ ServiceUnavailableError = "com.microsoft:timeout",// Retryable
1000
1001
  /**
1001
1002
  * Error is thrown when no new messages are received for the specified time.
1002
1003
  */
@@ -1039,11 +1040,11 @@ export declare enum ErrorNameConditionMapper {
1039
1040
  /**
1040
1041
  * Error is thrown when an operator intervened to detach for some reason.
1041
1042
  */
1042
- DetachForcedError = "amqp:link:detach-forced",
1043
+ DetachForcedError = "amqp:link:detach-forced",// Retryable
1043
1044
  /**
1044
1045
  * Error is thrown when the peer sent more message transfers than currently allowed on the link.
1045
1046
  */
1046
- TransferLimitExceededError = "amqp:link:transfer-limit-exceeded",
1047
+ TransferLimitExceededError = "amqp:link:transfer-limit-exceeded",// Retryable
1047
1048
  /**
1048
1049
  * Error is thrown when the message sent is too large: the maximum size is 256Kb.
1049
1050
  */
@@ -1077,7 +1078,7 @@ export declare enum ErrorNameConditionMapper {
1077
1078
  /**
1078
1079
  * Error is thrown when an operator intervened to close the connection for some reason.
1079
1080
  */
1080
- ConnectionForcedError = "amqp:connection:forced",
1081
+ ConnectionForcedError = "amqp:connection:forced",// Retryable
1081
1082
  /**
1082
1083
  * Error is thrown when a valid frame header cannot be formed from the incoming byte stream.
1083
1084
  */
@@ -1089,7 +1090,7 @@ export declare enum ErrorNameConditionMapper {
1089
1090
  /**
1090
1091
  * Error is thrown when the server is busy. Callers should wait a while and retry the operation.
1091
1092
  */
1092
- ServerBusyError = "com.microsoft:server-busy",
1093
+ ServerBusyError = "com.microsoft:server-busy",// Retryable
1093
1094
  /**
1094
1095
  * Error is thrown when an incorrect argument was received.
1095
1096
  */
@@ -1097,15 +1098,15 @@ export declare enum ErrorNameConditionMapper {
1097
1098
  /**
1098
1099
  * Error is thrown when server cancels the operation due to an internal issue.
1099
1100
  */
1100
- OperationCancelledError = "com.microsoft:operation-cancelled",
1101
+ OperationCancelledError = "com.microsoft:operation-cancelled",// Retryable
1101
1102
  /**
1102
1103
  * Error is thrown when the client sender does not have enough link credits to send the message.
1103
1104
  */
1104
- SenderBusyError = "client.sender:not-enough-link-credit",
1105
+ SenderBusyError = "client.sender:not-enough-link-credit",// Retryable
1105
1106
  /**
1106
1107
  * Error is thrown when the client sender's link isn't ready
1107
1108
  */
1108
- SenderNotReadyError = "client.sender:link-not-ready",
1109
+ SenderNotReadyError = "client.sender:link-not-ready",// Retryable
1109
1110
  /**
1110
1111
  * Error is thrown when a low level system error is thrown by node.js.
1111
1112
  * {@link https://nodejs.org/api/errors.html#errors_class_systemerror}