@metamask-previews/shield-controller 0.3.2-preview-332b0b7a → 0.3.2-preview-8504447

package/dist/polling-with-timeout-abort.mjs

@@ -1,148 +0,0 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _PollingWithTimeoutAndAbort_instances, _PollingWithTimeoutAndAbort_requestEntries, _PollingWithTimeoutAndAbort_timeout, _PollingWithTimeoutAndAbort_pollInterval, _PollingWithTimeoutAndAbort_insertRequestEntry, _PollingWithTimeoutAndAbort_cleanUpOnFinished, _PollingWithTimeoutAndAbort_cleanUpRequestEntryIfExists, _PollingWithTimeoutAndAbort_delayWithAbortSignal;
-export class PollingWithTimeoutAndAbort {
-    constructor(config) {
-        _PollingWithTimeoutAndAbort_instances.add(this);
-        this.ABORT_REASON_TIMEOUT = 'Request timed out';
-        this.ABORT_REASON_CANCELLED = 'Request cancelled';
-        // Map of request ID to request entry
-        _PollingWithTimeoutAndAbort_requestEntries.set(this, new Map());
-        _PollingWithTimeoutAndAbort_timeout.set(this, void 0);
-        _PollingWithTimeoutAndAbort_pollInterval.set(this, void 0);
-        __classPrivateFieldSet(this, _PollingWithTimeoutAndAbort_timeout, config.timeout, "f");
-        __classPrivateFieldSet(this, _PollingWithTimeoutAndAbort_pollInterval, config.pollInterval, "f");
-    }
-    /**
-     * Poll a request with a timeout and abort.
-     * This will poll the request until it succeeds or fails due to the timeout or the abort signal being triggered.
-     *
-     * @param requestId - The ID of the request to poll.
-     * @param requestFn - The function to poll the request.
-     * @param pollingOptions - The options for the polling.
-     * @param pollingOptions.timeout - The timeout for the request. Defaults to the constructor's timeout.
-     * @param pollingOptions.pollInterval - The interval for the polling. Defaults to the constructor's pollInterval.
-     * @param pollingOptions.fnName - The name of the function to poll the request. Defaults to an empty string.
-     * @returns The result of the request.
-     */
-    async pollRequest(requestId, requestFn, pollingOptions = {}) {
-        const timeout = pollingOptions.timeout ?? __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_timeout, "f");
-        const pollInterval = pollingOptions.pollInterval ?? __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_pollInterval, "f");
-        // clean up the request entry if it exists
-        this.abortPendingRequest(requestId);
-        // insert the request entry for the next polling cycle
-        const { abortController } = __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_instances, "m", _PollingWithTimeoutAndAbort_insertRequestEntry).call(this, requestId, timeout);
-        while (!abortController.signal.aborted) {
-            try {
-                const result = await requestFn(abortController.signal);
-                // polling success, we just need to clean up the request entry and return the result
-                __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_instances, "m", _PollingWithTimeoutAndAbort_cleanUpOnFinished).call(this, requestId);
-                return result;
-            }
-            catch {
-                if (abortController.signal.aborted) {
-                    // request failed due to the abort signal being triggered,
-                    // then we will break out of the polling loop
-                    break;
-                }
-                // otherwise, we will wait for the next polling cycle
-                // and continue the polling loop
-                await __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_instances, "m", _PollingWithTimeoutAndAbort_delayWithAbortSignal).call(this, pollInterval, abortController.signal);
-                continue;
-            }
-        }
-        // At this point, the polling loop has exited and abortController is aborted
-        const abortReason = abortController.signal.reason;
-        const errorMessage = pollingOptions.fnName
-            ? `${pollingOptions.fnName}: ${abortReason}`
-            : abortReason;
-        throw new Error(errorMessage);
-    }
-    /**
-     * Abort the pending requests.
-     * This will clean up the request entry if it exists, and abort the pending request if it exists.
-     *
-     * @param requestId - The ID of the request to abort.
-     */
-    abortPendingRequest(requestId) {
-        // firstly clean up the request entry if it exists
-        // note: this does not abort the request, it only cleans up the request entry for the next polling cycle
-        const existingEntry = __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_instances, "m", _PollingWithTimeoutAndAbort_cleanUpRequestEntryIfExists).call(this, requestId);
-        // then abort the request if it exists
-        // note: this does abort the request, but it will not trigger the abort handler (hence, {@link cleanUpRequestEntryIfExists} will not be called)
-        // coz the AbortHandler event listener is already removed from the AbortSignal
-        existingEntry?.abortController.abort(this.ABORT_REASON_CANCELLED);
-    }
-}
-_PollingWithTimeoutAndAbort_requestEntries = new WeakMap(), _PollingWithTimeoutAndAbort_timeout = new WeakMap(), _PollingWithTimeoutAndAbort_pollInterval = new WeakMap(), _PollingWithTimeoutAndAbort_instances = new WeakSet(), _PollingWithTimeoutAndAbort_insertRequestEntry = function _PollingWithTimeoutAndAbort_insertRequestEntry(requestId, timeout) {
-    const abortController = new AbortController();
-    // Set a timeout to abort the request if it takes too long
-    const timerId = setTimeout(() => {
-        abortController.abort(this.ABORT_REASON_TIMEOUT);
-    }, timeout);
-    // Set the abort handler and listen to the `abort` event
-    const abortHandler = () => {
-        __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_instances, "m", _PollingWithTimeoutAndAbort_cleanUpOnFinished).call(this, requestId);
-    };
-    abortController.signal.addEventListener('abort', abortHandler);
-    const requestEntry = {
-        abortController,
-        abortHandler,
-        timerId,
-    };
-    // Insert the request entry
-    __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_requestEntries, "f").set(requestId, requestEntry);
-    return requestEntry;
-}, _PollingWithTimeoutAndAbort_cleanUpOnFinished = function _PollingWithTimeoutAndAbort_cleanUpOnFinished(requestId) {
-    const requestEntry = __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_instances, "m", _PollingWithTimeoutAndAbort_cleanUpRequestEntryIfExists).call(this, requestId);
-    if (requestEntry) {
-        requestEntry.abortController.signal.removeEventListener('abort', requestEntry.abortHandler);
-    }
-    return requestEntry;
-}, _PollingWithTimeoutAndAbort_cleanUpRequestEntryIfExists = function _PollingWithTimeoutAndAbort_cleanUpRequestEntryIfExists(requestId) {
-    const requestEntry = __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_requestEntries, "f").get(requestId);
-    if (requestEntry) {
-        clearTimeout(requestEntry.timerId); // Clear the timeout
-        __classPrivateFieldGet(this, _PollingWithTimeoutAndAbort_requestEntries, "f").delete(requestId); // Remove the request entry
-    }
-    return requestEntry;
-}, _PollingWithTimeoutAndAbort_delayWithAbortSignal = 
-/**
- * Delay with an abort signal.
- * This will delay the execution of the code until the abort signal is triggered.
- *
- * @param ms - The number of milliseconds to delay.
- * @param abortSignal - The abort signal to listen to.
- * @returns A promise that resolves when the delay is complete.
- */
-async function _PollingWithTimeoutAndAbort_delayWithAbortSignal(ms, abortSignal) {
-    return new Promise((resolve) => {
-        let timer = null;
-        const abortHandlerForDelay = () => {
-            // clear the timeout and resolve the promise
-            // Note: we don't reject the promise as this is only a dummy delay
-            if (timer) {
-                clearTimeout(timer);
-            }
-            resolve(undefined);
-        };
-        timer = setTimeout(() => {
-            abortSignal.removeEventListener('abort', abortHandlerForDelay);
-            resolve(undefined);
-        }, ms);
-        // set the abort handler to clear the timeout and resolve the promise
-        abortSignal.addEventListener('abort', abortHandlerForDelay, {
-            once: true, // only listen to the abort event once
-        });
-    });
-};
-//# sourceMappingURL=polling-with-timeout-abort.mjs.map

package/dist/polling-with-timeout-abort.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"polling-with-timeout-abort.mjs","sourceRoot":"","sources":["../src/polling-with-timeout-abort.ts"],"names":[],"mappings":";;;;;;;;;;;;AAUA,MAAM,OAAO,0BAA0B;IAYrC,YAAY,MAAiD;;QAXpD,yBAAoB,GAAG,mBAAmB,CAAC;QAE3C,2BAAsB,GAAG,mBAAmB,CAAC;QAEtD,qCAAqC;QAC5B,qDAA6C,IAAI,GAAG,EAAE,EAAC;QAEvD,sDAAiB;QAEjB,2DAAsB;QAG7B,uBAAA,IAAI,uCAAY,MAAM,CAAC,OAAO,MAAA,CAAC;QAC/B,uBAAA,IAAI,4CAAiB,MAAM,CAAC,YAAY,MAAA,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,WAAW,CACf,SAAiB,EACjB,SAAgC,EAChC,iBAII,EAAE;QAEN,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,IAAI,uBAAA,IAAI,2CAAS,CAAC;QACxD,MAAM,YAAY,GAAG,cAAc,CAAC,YAAY,IAAI,uBAAA,IAAI,gDAAc,CAAC;QAEvE,0CAA0C;QAC1C,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAEpC,sDAAsD;QACtD,MAAM,EAAE,eAAe,EAAE,GAAG,uBAAA,IAAI,6FAAoB,MAAxB,IAAI,EAAqB,SAAS,EAAE,OAAO,CAAC,CAAC;QAEzE,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE;YACtC,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;gBACvD,oFAAoF;gBACpF,uBAAA,IAAI,4FAAmB,MAAvB,IAAI,EAAoB,SAAS,CAAC,CAAC;gBACnC,OAAO,MAAM,CAAC;aACf;YAAC,MAAM;gBACN,IAAI,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE;oBAClC,0DAA0D;oBAC1D,6CAA6C;oBAC7C,MAAM;iBACP;gBACD,qDAAqD;gBACrD,gCAAgC;gBAChC,MAAM,uBAAA,IAAI,+FAAsB,MAA1B,IAAI,EAAuB,YAAY,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;gBACvE,SAAS;aACV;SACF;QACD,4EAA4E;QAC5E,MAAM,WAAW,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC;QAClD,MAAM,YAAY,GAAG,cAAc,CAAC,MAAM;YACxC,CAAC,CAAC,GAAG,cAAc,CAAC,MAAM,KAAK,WAAW,EAAE;YAC5C,CAAC,CAAC,WAAW,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,SAAiB;QACnC,kDAAkD;QAClD,wGAAwG;QACxG,MAAM,aAAa,GAAG,uBAAA,IAAI,sGAA6B,MAAjC,IAAI,EAA8B,SAAS,CAAC,CAAC;QACnE,sCAAsC;QACtC,+IAA+I;QAC/I,8EAA8E;QAC9E,aAAa,EAAE,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACpE,CAAC;CAsGF;2UA5FqB,SAAiB,EAAE,OAAe;IACpD,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAE9C,0DAA0D;IAC1D,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;QAC9B,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACnD,CAAC,EAAE,OAAO,CAAC,CAAC;IAEZ,wDAAwD;IACxD,MAAM,YAAY,GAAG,GAAG,EAAE;QACxB,uBAAA,IAAI,4FAAmB,MAAvB,IAAI,EAAoB,SAAS,CAAC,CAAC;IACrC,CAAC,CAAC;IACF,eAAe,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAE/D,MAAM,YAAY,GAAiB;QACjC,eAAe;QACf,YAAY;QACZ,OAAO;KACR,CAAC;IAEF,2BAA2B;IAC3B,uBAAA,IAAI,kDAAgB,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAElD,OAAO,YAAY,CAAC;AACtB,CAAC,yGASkB,SAAiB;IAClC,MAAM,YAAY,GAAG,uBAAA,IAAI,sGAA6B,MAAjC,IAAI,EAA8B,SAAS,CAAC,CAAC;IAClE,IAAI,YAAY,EAAE;QAChB,YAAY,CAAC,eAAe,CAAC,MAAM,CAAC,mBAAmB,CACrD,OAAO,EACP,YAAY,CAAC,YAAY,CAC1B,CAAC;KACH;IACD,OAAO,YAAY,CAAC;AACtB,CAAC,6HAS4B,SAAiB;IAC5C,MAAM,YAAY,GAAG,uBAAA,IAAI,kDAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACzD,IAAI,YAAY,EAAE;QAChB,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,oBAAoB;QACxD,uBAAA,IAAI,kDAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,2BAA2B;KACpE;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,2DAAuB,EAAU,EAAE,WAAwB;IAC9D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,KAAK,GAA0B,IAAI,CAAC;QAExC,MAAM,oBAAoB,GAAG,GAAG,EAAE;YAChC,4CAA4C;YAC5C,kEAAkE;YAClE,IAAI,KAAK,EAAE;gBACT,YAAY,CAAC,KAAK,CAAC,CAAC;aACrB;YACD,OAAO,CAAC,SAAS,CAAC,CAAC;QACrB,CAAC,CAAC;QAEF,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YACtB,WAAW,CAAC,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;YAC/D,OAAO,CAAC,SAAS,CAAC,CAAC;QACrB,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,qEAAqE;QACrE,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,oBAAoB,EAAE;YAC1D,IAAI,EAAE,IAAI,EAAE,sCAAsC;SACnD,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["export type RequestEntry = {\n  abortController: AbortController; // The abort controller for the request\n  abortHandler: (ev: Event) => void; // The abort handler for the request\n  timerId: NodeJS.Timeout; // The timer ID for the request timeout\n};\n\nexport type RequestFn<ReturnType> = (\n  signal: AbortSignal,\n) => Promise<ReturnType>;\n\nexport class PollingWithTimeoutAndAbort {\n  readonly ABORT_REASON_TIMEOUT = 'Request timed out';\n\n  readonly ABORT_REASON_CANCELLED = 'Request cancelled';\n\n  // Map of request ID to request entry\n  readonly #requestEntries: Map<string, RequestEntry> = new Map();\n\n  readonly #timeout: number;\n\n  readonly #pollInterval: number;\n\n  constructor(config: { timeout: number; pollInterval: number }) {\n    this.#timeout = config.timeout;\n    this.#pollInterval = config.pollInterval;\n  }\n\n  /**\n   * Poll a request with a timeout and abort.\n   * This will poll the request until it succeeds or fails due to the timeout or the abort signal being triggered.\n   *\n   * @param requestId - The ID of the request to poll.\n   * @param requestFn - The function to poll the request.\n   * @param pollingOptions - The options for the polling.\n   * @param pollingOptions.timeout - The timeout for the request. Defaults to the constructor's timeout.\n   * @param pollingOptions.pollInterval - The interval for the polling. Defaults to the constructor's pollInterval.\n   * @param pollingOptions.fnName - The name of the function to poll the request. Defaults to an empty string.\n   * @returns The result of the request.\n   */\n  async pollRequest<ReturnType>(\n    requestId: string,\n    requestFn: RequestFn<ReturnType>,\n    pollingOptions: {\n      timeout?: number;\n      pollInterval?: number;\n      fnName?: string;\n    } = {},\n  ) {\n    const timeout = pollingOptions.timeout ?? this.#timeout;\n    const pollInterval = pollingOptions.pollInterval ?? this.#pollInterval;\n\n    // clean up the request entry if it exists\n    this.abortPendingRequest(requestId);\n\n    // insert the request entry for the next polling cycle\n    const { abortController } = this.#insertRequestEntry(requestId, timeout);\n\n    while (!abortController.signal.aborted) {\n      try {\n        const result = await requestFn(abortController.signal);\n        // polling success, we just need to clean up the request entry and return the result\n        this.#cleanUpOnFinished(requestId);\n        return result;\n      } catch {\n        if (abortController.signal.aborted) {\n          // request failed due to the abort signal being triggered,\n          // then we will break out of the polling loop\n          break;\n        }\n        // otherwise, we will wait for the next polling cycle\n        // and continue the polling loop\n        await this.#delayWithAbortSignal(pollInterval, abortController.signal);\n        continue;\n      }\n    }\n    // At this point, the polling loop has exited and abortController is aborted\n    const abortReason = abortController.signal.reason;\n    const errorMessage = pollingOptions.fnName\n      ? `${pollingOptions.fnName}: ${abortReason}`\n      : abortReason;\n    throw new Error(errorMessage);\n  }\n\n  /**\n   * Abort the pending requests.\n   * This will clean up the request entry if it exists, and abort the pending request if it exists.\n   *\n   * @param requestId - The ID of the request to abort.\n   */\n  abortPendingRequest(requestId: string) {\n    // firstly clean up the request entry if it exists\n    // note: this does not abort the request, it only cleans up the request entry for the next polling cycle\n    const existingEntry = this.#cleanUpRequestEntryIfExists(requestId);\n    // then abort the request if it exists\n    // note: this does abort the request, but it will not trigger the abort handler (hence, {@link cleanUpRequestEntryIfExists} will not be called)\n    // coz the AbortHandler event listener is already removed from the AbortSignal\n    existingEntry?.abortController.abort(this.ABORT_REASON_CANCELLED);\n  }\n\n  /**\n   * Insert a new request entry.\n   * This will create a new abort controller, set a timeout to abort the request if it takes too long, and set the abort handler.\n   *\n   * @param requestId - The ID of the request to insert the entry for.\n   * @param timeout - The timeout for the request.\n   * @returns The request entry that was inserted.\n   */\n  #insertRequestEntry(requestId: string, timeout: number) {\n    const abortController = new AbortController();\n\n    // Set a timeout to abort the request if it takes too long\n    const timerId = setTimeout(() => {\n      abortController.abort(this.ABORT_REASON_TIMEOUT);\n    }, timeout);\n\n    // Set the abort handler and listen to the `abort` event\n    const abortHandler = () => {\n      this.#cleanUpOnFinished(requestId);\n    };\n    abortController.signal.addEventListener('abort', abortHandler);\n\n    const requestEntry: RequestEntry = {\n      abortController,\n      abortHandler,\n      timerId,\n    };\n\n    // Insert the request entry\n    this.#requestEntries.set(requestId, requestEntry);\n\n    return requestEntry;\n  }\n\n  /**\n   * Clean up the request entry upon finished (success or failure).\n   * This will remove the abort handler from the AbortSignal, clear the timeout, and remove the request entry.\n   *\n   * @param requestId - The ID of the request to clean up for.\n   * @returns The request entry that was cleaned up, if it exists.\n   */\n  #cleanUpOnFinished(requestId: string): RequestEntry | undefined {\n    const requestEntry = this.#cleanUpRequestEntryIfExists(requestId);\n    if (requestEntry) {\n      requestEntry.abortController.signal.removeEventListener(\n        'abort',\n        requestEntry.abortHandler,\n      );\n    }\n    return requestEntry;\n  }\n\n  /**\n   * Clean up the request entry if it exists.\n   * This will clear the pending timeout, remove the event listener from the AbortSignal, and remove the request entry.\n   *\n   * @param requestId - The ID of the request to handle the abort for.\n   * @returns The request entry that was aborted, if it exists.\n   */\n  #cleanUpRequestEntryIfExists(requestId: string): RequestEntry | undefined {\n    const requestEntry = this.#requestEntries.get(requestId);\n    if (requestEntry) {\n      clearTimeout(requestEntry.timerId); // Clear the timeout\n      this.#requestEntries.delete(requestId); // Remove the request entry\n    }\n    return requestEntry;\n  }\n\n  /**\n   * Delay with an abort signal.\n   * This will delay the execution of the code until the abort signal is triggered.\n   *\n   * @param ms - The number of milliseconds to delay.\n   * @param abortSignal - The abort signal to listen to.\n   * @returns A promise that resolves when the delay is complete.\n   */\n  async #delayWithAbortSignal(ms: number, abortSignal: AbortSignal) {\n    return new Promise((resolve) => {\n      let timer: NodeJS.Timeout | null = null;\n\n      const abortHandlerForDelay = () => {\n        // clear the timeout and resolve the promise\n        // Note: we don't reject the promise as this is only a dummy delay\n        if (timer) {\n          clearTimeout(timer);\n        }\n        resolve(undefined);\n      };\n\n      timer = setTimeout(() => {\n        abortSignal.removeEventListener('abort', abortHandlerForDelay);\n        resolve(undefined);\n      }, ms);\n\n      // set the abort handler to clear the timeout and resolve the promise\n      abortSignal.addEventListener('abort', abortHandlerForDelay, {\n        once: true, // only listen to the abort event once\n      });\n    });\n  }\n}\n"]}