@metamask/polling-controller 0.1.0 → 1.0.0

package/CHANGELOG.md

@@ -6,9 +6,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0]
+### Added
+- Add `PollingControllerOnly` to extend from an empty class. This will allow classes that previously are just classes that don't extend from BaseV1 or V2 to extend from this new `PollingControllerOnly`. ([#1873](https://github.com/MetaMask/core/pull/1873))
+
+### Changed
+- **BREAKING:** `_executePoll()` is called immediately on start if no polling interval is already active for the networkClientId + options combination ([#1874](https://github.com/MetaMask/core/pull/1874))
+- Bump dependency and peer dependency on `@metamask/network-controller` to ^15.1.0
+
+## [0.2.0]
+### Added
+- Add way to start and stop different polling sessions for the same network client ID by providing extra scoping data ([#1776](https://github.com/MetaMask/core/pull/1776))
+  - Add optional second argument to `stopPollingByPollingToken` (formerly `stopPollingByNetworkClientId`)
+  - Add optional second argument to `onPollingCompleteByNetworkClientId`
+
+### Changed
+- **BREAKING:** Bump dependency and peer dependency on `@metamask/network-controller` to ^15.0.0
+- **BREAKING:** Polling controllers are expected to override `_executePoll` instead of `executePoll` ([#1810](https://github.com/MetaMask/core/pull/1810))
+- **BREAKING:** Rename `stopPollingByNetworkClientId` to `stopPollingByPollingToken` ([#1810](https://github.com/MetaMask/core/pull/1810))
+- Add dependency on `fast-json-stable-stringify` ^2.1.0
+
 ## [0.1.0]
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@0.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@0.2.0...@metamask/polling-controller@1.0.0
+[0.2.0]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@0.1.0...@metamask/polling-controller@0.2.0
 [0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/polling-controller@0.1.0

package/dist/PollingController.d.ts

@@ -5,11 +5,69 @@
 /// <reference types="node" />
 import { BaseController, BaseControllerV2 } from '@metamask/base-controller';
 import type { NetworkClientId } from '@metamask/network-controller';
+import type { Json } from '@metamask/utils';
+/**
+ * Returns a unique key for a networkClientId and options. This is used to group networkClientId polls with the same options
+ * @param networkClientId - The networkClientId to get a key for
+ * @param options - The options used to group the polling events
+ * @returns The unique key
+ */
+export declare const getKey: (networkClientId: NetworkClientId, options: Json) => PollingTokenSetId;
+declare type PollingTokenSetId = `${NetworkClientId}:${string}`;
+declare class Empty {
+}
+export declare const PollingControllerOnly: (abstract new (...args: any[]) => {
+    readonly "__#88103@#pollingTokenSets": Map<PollingTokenSetId, Set<string>>;
+    readonly "__#88103@#intervalIds": Record<PollingTokenSetId, NodeJS.Timeout>;
+    "__#88103@#callbacks": Map<string, Set<(networkClientId: NetworkClientId) => void>>;
+    "__#88103@#intervalLength": number;
+    getIntervalLength(): number;
+    /**
+     * Sets the length of the polling interval
+     *
+     * @param length - The length of the polling interval in milliseconds
+     */
+    setIntervalLength(length: number): void;
+    /**
+     * Starts polling for a networkClientId
+     *
+     * @param networkClientId - The networkClientId to start polling for
+     * @param options - The options used to group the polling events
+     * @returns void
+     */
+    startPollingByNetworkClientId(networkClientId: NetworkClientId, options?: Json): string;
+    /**
+     * Stops polling for all networkClientIds
+     */
+    stopAllPolling(): void;
+    /**
+     * Stops polling for a networkClientId
+     *
+     * @param pollingToken - The polling token to stop polling for
+     */
+    stopPollingByPollingToken(pollingToken: string): void;
+    /**
+     * Executes the poll for a networkClientId
+     *
+     * @param networkClientId - The networkClientId to execute the poll for
+     * @param options - The options passed to startPollingByNetworkClientId
+     */
+    _executePoll(networkClientId: NetworkClientId, options: Json): Promise<void>;
+    "__#88103@#poll"(networkClientId: NetworkClientId, options: Json): void;
+    /**
+     * Adds a callback to execute when polling is complete
+     *
+     * @param networkClientId - The networkClientId to listen for polling complete events
+     * @param callback - The callback to execute when polling is complete
+     * @param options - The options used to group the polling events
+     */
+    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void, options?: Json): void;
+}) & typeof Empty;
 export declare const PollingController: (abstract new (...args: any[]) => {
-    readonly "__#112124@#networkClientIdTokensMap": Map<NetworkClientId, Set<string>>;
-    readonly "__#112124@#intervalIds": Record<NetworkClientId, NodeJS.Timeout>;
-    "__#112124@#callbacks": Map<string, Set<(networkClientId: NetworkClientId) => void>>;
-    "__#112124@#intervalLength": number;
+    readonly "__#88103@#pollingTokenSets": Map<PollingTokenSetId, Set<string>>;
+    readonly "__#88103@#intervalIds": Record<PollingTokenSetId, NodeJS.Timeout>;
+    "__#88103@#callbacks": Map<string, Set<(networkClientId: NetworkClientId) => void>>;
+    "__#88103@#intervalLength": number;
     getIntervalLength(): number;
     /**
      * Sets the length of the polling interval
@@ -21,9 +79,10 @@ export declare const PollingController: (abstract new (...args: any[]) => {
      * Starts polling for a networkClientId
      *
      * @param networkClientId - The networkClientId to start polling for
+     * @param options - The options used to group the polling events
      * @returns void
      */
-    startPollingByNetworkClientId(networkClientId: NetworkClientId): string;
+    startPollingByNetworkClientId(networkClientId: NetworkClientId, options?: Json): string;
     /**
      * Stops polling for all networkClientIds
      */
@@ -33,27 +92,29 @@ export declare const PollingController: (abstract new (...args: any[]) => {
      *
      * @param pollingToken - The polling token to stop polling for
      */
-    stopPollingByNetworkClientId(pollingToken: string): void;
+    stopPollingByPollingToken(pollingToken: string): void;
     /**
      * Executes the poll for a networkClientId
      *
      * @param networkClientId - The networkClientId to execute the poll for
+     * @param options - The options passed to startPollingByNetworkClientId
      */
-    executePoll(networkClientId: NetworkClientId): Promise<void>;
-    "__#112124@#poll"(networkClientId: NetworkClientId): void;
+    _executePoll(networkClientId: NetworkClientId, options: Json): Promise<void>;
+    "__#88103@#poll"(networkClientId: NetworkClientId, options: Json): void;
     /**
      * Adds a callback to execute when polling is complete
      *
      * @param networkClientId - The networkClientId to listen for polling complete events
      * @param callback - The callback to execute when polling is complete
+     * @param options - The options used to group the polling events
      */
-    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void): void;
+    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void, options?: Json): void;
 }) & typeof BaseControllerV2;
 export declare const PollingControllerV1: (abstract new (...args: any[]) => {
-    readonly "__#112124@#networkClientIdTokensMap": Map<NetworkClientId, Set<string>>;
-    readonly "__#112124@#intervalIds": Record<NetworkClientId, NodeJS.Timeout>;
-    "__#112124@#callbacks": Map<string, Set<(networkClientId: NetworkClientId) => void>>;
-    "__#112124@#intervalLength": number;
+    readonly "__#88103@#pollingTokenSets": Map<PollingTokenSetId, Set<string>>;
+    readonly "__#88103@#intervalIds": Record<PollingTokenSetId, NodeJS.Timeout>;
+    "__#88103@#callbacks": Map<string, Set<(networkClientId: NetworkClientId) => void>>;
+    "__#88103@#intervalLength": number;
     getIntervalLength(): number;
     /**
      * Sets the length of the polling interval
@@ -65,9 +126,10 @@ export declare const PollingControllerV1: (abstract new (...args: any[]) => {
      * Starts polling for a networkClientId
      *
      * @param networkClientId - The networkClientId to start polling for
+     * @param options - The options used to group the polling events
      * @returns void
      */
-    startPollingByNetworkClientId(networkClientId: NetworkClientId): string;
+    startPollingByNetworkClientId(networkClientId: NetworkClientId, options?: Json): string;
     /**
      * Stops polling for all networkClientIds
      */
@@ -77,20 +139,23 @@ export declare const PollingControllerV1: (abstract new (...args: any[]) => {
      *
      * @param pollingToken - The polling token to stop polling for
      */
-    stopPollingByNetworkClientId(pollingToken: string): void;
+    stopPollingByPollingToken(pollingToken: string): void;
     /**
      * Executes the poll for a networkClientId
      *
      * @param networkClientId - The networkClientId to execute the poll for
+     * @param options - The options passed to startPollingByNetworkClientId
      */
-    executePoll(networkClientId: NetworkClientId): Promise<void>;
-    "__#112124@#poll"(networkClientId: NetworkClientId): void;
+    _executePoll(networkClientId: NetworkClientId, options: Json): Promise<void>;
+    "__#88103@#poll"(networkClientId: NetworkClientId, options: Json): void;
     /**
      * Adds a callback to execute when polling is complete
      *
      * @param networkClientId - The networkClientId to listen for polling complete events
      * @param callback - The callback to execute when polling is complete
+     * @param options - The options used to group the polling events
      */
-    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void): void;
+    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void, options?: Json): void;
 }) & typeof BaseController;
+export {};
 //# sourceMappingURL=PollingController.d.ts.map

package/dist/PollingController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PollingController.d.ts","sourceRoot":"","sources":["../src/PollingController.ts"],"names":[],"mappings":";;;;;AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AA4JpE,eAAO,MAAM,iBAAiB,0BAvJG,GAAG,EAAE;oDAgBE,IAAI,eAAe,EAAE,IAAI,MAAM,CAAC,CAAC;uCAG9C,OAAO,eAAe,EAAE,OAAO,OAAO,CAAC;8DAItC,eAAe,KAAK,IAAI;;;IAShD;;;;OAIG;8BACuB,MAAM;IAIhC;;;;;OAKG;mDAC4C,eAAe;IAc9D;;OAEG;;IASH;;;;OAIG;+CACwC,MAAM;IA2BjD;;;;OAIG;iCACmC,eAAe,GAAG,QAAQ,IAAI,CAAC;uCAE9C,eAAe;IAkBtC;;;;;OAKG;wDAEgB,eAAe,8BACJ,eAAe,KAAK,IAAI;4BAce,CAAC;AAC1E,eAAO,MAAM,mBAAmB,0BAxJC,GAAG,EAAE;oDAgBE,IAAI,eAAe,EAAE,IAAI,MAAM,CAAC,CAAC;uCAG9C,OAAO,eAAe,EAAE,OAAO,OAAO,CAAC;8DAItC,eAAe,KAAK,IAAI;;;IAShD;;;;OAIG;8BACuB,MAAM;IAIhC;;;;;OAKG;mDAC4C,eAAe;IAc9D;;OAEG;;IASH;;;;OAIG;+CACwC,MAAM;IA2BjD;;;;OAIG;iCACmC,eAAe,GAAG,QAAQ,IAAI,CAAC;uCAE9C,eAAe;IAkBtC;;;;;OAKG;wDAEgB,eAAe,8BACJ,eAAe,KAAK,IAAI;0BAee,CAAC"}
+{"version":3,"file":"PollingController.d.ts","sourceRoot":"","sources":["../src/PollingController.ts"],"names":[],"mappings":";;;;;AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAQ5C;;;;;GAKG;AACH,eAAO,MAAM,MAAM,oBACA,eAAe,WACvB,IAAI,KACZ,iBAA+D,CAAC;AAEnE,aAAK,iBAAiB,GAAG,GAAG,eAAe,IAAI,MAAM,EAAE,CAAC;AAwKxD,cAAM,KAAK;CAAG;AAEd,eAAO,MAAM,qBAAqB,0BAvLD,GAAG,EAAE;2CA4BN,IAAI,iBAAiB,EAAE,IAAI,MAAM,CAAC,CAAC;sCAExC,OAAO,iBAAiB,EAAE,OAAO,OAAO,CAAC;6DAIxC,eAAe,KAAK,IAAI;;;IAShD;;;;OAIG;8BACuB,MAAM;IAIhC;;;;;;OAMG;mDAEgB,eAAe,YACvB,IAAI;IAkBf;;OAEG;;IASH;;;;OAIG;4CACqC,MAAM;IAyB9C;;;;;OAKG;kCAEgB,eAAe,WACvB,IAAI,GACZ,QAAQ,IAAI,CAAC;sCAEO,eAAe,WAAW,IAAI;IAuBrD;;;;;;OAMG;wDAEgB,eAAe,8BACJ,eAAe,KAAK,IAAI,YAC3C,IAAI;iBAmB+C,CAAC;AACnE,eAAO,MAAM,iBAAiB,0BAxLG,GAAG,EAAE;2CA4BN,IAAI,iBAAiB,EAAE,IAAI,MAAM,CAAC,CAAC;sCAExC,OAAO,iBAAiB,EAAE,OAAO,OAAO,CAAC;6DAIxC,eAAe,KAAK,IAAI;;;IAShD;;;;OAIG;8BACuB,MAAM;IAIhC;;;;;;OAMG;mDAEgB,eAAe,YACvB,IAAI;IAkBf;;OAEG;;IASH;;;;OAIG;4CACqC,MAAM;IAyB9C;;;;;OAKG;kCAEgB,eAAe,WACvB,IAAI,GACZ,QAAQ,IAAI,CAAC;sCAEO,eAAe,WAAW,IAAI;IAuBrD;;;;;;OAMG;wDAEgB,eAAe,8BACJ,eAAe,KAAK,IAAI,YAC3C,IAAI;4BAoBsD,CAAC;AAC1E,eAAO,MAAM,mBAAmB,0BAzLC,GAAG,EAAE;2CA4BN,IAAI,iBAAiB,EAAE,IAAI,MAAM,CAAC,CAAC;sCAExC,OAAO,iBAAiB,EAAE,OAAO,OAAO,CAAC;6DAIxC,eAAe,KAAK,IAAI;;;IAShD;;;;OAIG;8BACuB,MAAM;IAIhC;;;;;;OAMG;mDAEgB,eAAe,YACvB,IAAI;IAkBf;;OAEG;;IASH;;;;OAIG;4CACqC,MAAM;IAyB9C;;;;;OAKG;kCAEgB,eAAe,WACvB,IAAI,GACZ,QAAQ,IAAI,CAAC;sCAEO,eAAe,WAAW,IAAI;IAuBrD;;;;;;OAMG;wDAEgB,eAAe,8BACJ,eAAe,KAAK,IAAI,YAC3C,IAAI;0BAqBsD,CAAC"}

package/dist/PollingController.js

@@ -19,10 +19,22 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PollingControllerV1 = exports.PollingController = void 0;
+exports.PollingControllerV1 = exports.PollingController = exports.PollingControllerOnly = exports.getKey = void 0;
 const base_controller_1 = require("@metamask/base-controller");
+const fast_json_stable_stringify_1 = __importDefault(require("fast-json-stable-stringify"));
 const uuid_1 = require("uuid");
+/**
+ * Returns a unique key for a networkClientId and options. This is used to group networkClientId polls with the same options
+ * @param networkClientId - The networkClientId to get a key for
+ * @param options - The options used to group the polling events
+ * @returns The unique key
+ */
+const getKey = (networkClientId, options) => `${networkClientId}:${(0, fast_json_stable_stringify_1.default)(options)}`;
+exports.getKey = getKey;
 /**
  * PollingControllerMixin
  *
@@ -30,7 +42,7 @@ const uuid_1 = require("uuid");
  * @returns The composed class.
  */
 function PollingControllerMixin(Base) {
-    var _PollingControllerBase_instances, _PollingControllerBase_networkClientIdTokensMap, _PollingControllerBase_intervalIds, _PollingControllerBase_callbacks, _PollingControllerBase_intervalLength, _PollingControllerBase_poll;
+    var _PollingControllerBase_instances, _PollingControllerBase_pollingTokenSets, _PollingControllerBase_intervalIds, _PollingControllerBase_callbacks, _PollingControllerBase_intervalLength, _PollingControllerBase_poll;
     /**
      * PollingController is an abstract class that implements the polling
      * functionality for a controller. It is meant to be extended by a controller
@@ -41,7 +53,7 @@ function PollingControllerMixin(Base) {
         constructor() {
             super(...arguments);
             _PollingControllerBase_instances.add(this);
-            _PollingControllerBase_networkClientIdTokensMap.set(this, new Map());
+            _PollingControllerBase_pollingTokenSets.set(this, new Map());
             _PollingControllerBase_intervalIds.set(this, {});
             _PollingControllerBase_callbacks.set(this, new Map());
             _PollingControllerBase_intervalLength.set(this, 1000);
@@ -61,29 +73,31 @@ function PollingControllerMixin(Base) {
          * Starts polling for a networkClientId
          *
          * @param networkClientId - The networkClientId to start polling for
+         * @param options - The options used to group the polling events
          * @returns void
          */
-        startPollingByNetworkClientId(networkClientId) {
-            const innerPollToken = (0, uuid_1.v4)();
-            if (__classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").has(networkClientId)) {
-                const set = __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").get(networkClientId);
-                set === null || set === void 0 ? void 0 : set.add(innerPollToken);
+        startPollingByNetworkClientId(networkClientId, options = {}) {
+            const pollToken = (0, uuid_1.v4)();
+            const key = (0, exports.getKey)(networkClientId, options);
+            const pollingTokenSet = __classPrivateFieldGet(this, _PollingControllerBase_pollingTokenSets, "f").get(key);
+            if (pollingTokenSet) {
+                pollingTokenSet.add(pollToken);
             }
             else {
                 const set = new Set();
-                set.add(innerPollToken);
-                __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").set(networkClientId, set);
+                set.add(pollToken);
+                __classPrivateFieldGet(this, _PollingControllerBase_pollingTokenSets, "f").set(key, set);
             }
-            __classPrivateFieldGet(this, _PollingControllerBase_instances, "m", _PollingControllerBase_poll).call(this, networkClientId);
-            return innerPollToken;
+            __classPrivateFieldGet(this, _PollingControllerBase_instances, "m", _PollingControllerBase_poll).call(this, networkClientId, options);
+            return pollToken;
         }
         /**
          * Stops polling for all networkClientIds
          */
         stopAllPolling() {
-            __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").forEach((tokens, _networkClientId) => {
-                tokens.forEach((token) => {
-                    this.stopPollingByNetworkClientId(token);
+            __classPrivateFieldGet(this, _PollingControllerBase_pollingTokenSets, "f").forEach((tokenSet, _networkClientId) => {
+                tokenSet.forEach((token) => {
+                    this.stopPollingByPollingToken(token);
                 });
             });
         }
@@ -92,25 +106,24 @@ function PollingControllerMixin(Base) {
          *
          * @param pollingToken - The polling token to stop polling for
          */
-        stopPollingByNetworkClientId(pollingToken) {
+        stopPollingByPollingToken(pollingToken) {
             if (!pollingToken) {
                 throw new Error('pollingToken required');
             }
             let found = false;
-            __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").forEach((tokens, networkClientId) => {
-                var _a, _b, _c, _d;
-                if (tokens.has(pollingToken)) {
+            __classPrivateFieldGet(this, _PollingControllerBase_pollingTokenSets, "f").forEach((tokenSet, key) => {
+                var _a, _b;
+                if (tokenSet.has(pollingToken)) {
                     found = true;
-                    (_a = __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f")
-                        .get(networkClientId)) === null || _a === void 0 ? void 0 : _a.delete(pollingToken);
-                    if (((_b = __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").get(networkClientId)) === null || _b === void 0 ? void 0 : _b.size) === 0) {
-                        clearTimeout(__classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId]);
-                        delete __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId];
-                        __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").delete(networkClientId);
-                        (_c = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(networkClientId)) === null || _c === void 0 ? void 0 : _c.forEach((callback) => {
-                            callback(networkClientId);
+                    tokenSet.delete(pollingToken);
+                    if (tokenSet.size === 0) {
+                        clearTimeout(__classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[key]);
+                        delete __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[key];
+                        __classPrivateFieldGet(this, _PollingControllerBase_pollingTokenSets, "f").delete(key);
+                        (_a = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(key)) === null || _a === void 0 ? void 0 : _a.forEach((callback) => {
+                            callback(key);
                         });
-                        (_d = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(networkClientId)) === null || _d === void 0 ? void 0 : _d.clear();
+                        (_b = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(key)) === null || _b === void 0 ? void 0 : _b.clear();
                     }
                 }
             });
@@ -123,39 +136,46 @@ function PollingControllerMixin(Base) {
          *
          * @param networkClientId - The networkClientId to listen for polling complete events
          * @param callback - The callback to execute when polling is complete
+         * @param options - The options used to group the polling events
          */
-        onPollingCompleteByNetworkClientId(networkClientId, callback) {
-            var _a;
-            if (__classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").has(networkClientId)) {
-                (_a = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(networkClientId)) === null || _a === void 0 ? void 0 : _a.add(callback);
-            }
-            else {
+        onPollingCompleteByNetworkClientId(networkClientId, callback, options = {}) {
+            const key = (0, exports.getKey)(networkClientId, options);
+            const callbacks = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(key);
+            if (callbacks === undefined) {
                 const set = new Set();
                 set.add(callback);
-                __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").set(networkClientId, set);
+                __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").set(key, set);
+            }
+            else {
+                callbacks.add(callback);
             }
         }
     }
-    _PollingControllerBase_networkClientIdTokensMap = new WeakMap(), _PollingControllerBase_intervalIds = new WeakMap(), _PollingControllerBase_callbacks = new WeakMap(), _PollingControllerBase_intervalLength = new WeakMap(), _PollingControllerBase_instances = new WeakSet(), _PollingControllerBase_poll = function _PollingControllerBase_poll(networkClientId) {
-        if (__classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId]) {
-            clearTimeout(__classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId]);
-            delete __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId];
+    _PollingControllerBase_pollingTokenSets = new WeakMap(), _PollingControllerBase_intervalIds = new WeakMap(), _PollingControllerBase_callbacks = new WeakMap(), _PollingControllerBase_intervalLength = new WeakMap(), _PollingControllerBase_instances = new WeakSet(), _PollingControllerBase_poll = function _PollingControllerBase_poll(networkClientId, options) {
+        const key = (0, exports.getKey)(networkClientId, options);
+        const interval = __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[key];
+        if (interval) {
+            clearTimeout(interval);
+            delete __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[key];
         }
         // setTimeout is not `await`ing this async function, which is expected
         // We're just using async here for improved stack traces
         // eslint-disable-next-line @typescript-eslint/no-misused-promises
-        __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId] = setTimeout(() => __awaiter(this, void 0, void 0, function* () {
+        __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[key] = setTimeout(() => __awaiter(this, void 0, void 0, function* () {
             try {
-                yield this.executePoll(networkClientId);
+                yield this._executePoll(networkClientId, options);
             }
             catch (error) {
                 console.error(error);
             }
-            __classPrivateFieldGet(this, _PollingControllerBase_instances, "m", _PollingControllerBase_poll).call(this, networkClientId);
-        }), __classPrivateFieldGet(this, _PollingControllerBase_intervalLength, "f"));
+            __classPrivateFieldGet(this, _PollingControllerBase_instances, "m", _PollingControllerBase_poll).call(this, networkClientId, options);
+        }), interval ? __classPrivateFieldGet(this, _PollingControllerBase_intervalLength, "f") : 0);
     };
     return PollingControllerBase;
 }
+class Empty {
+}
+exports.PollingControllerOnly = PollingControllerMixin(Empty);
 exports.PollingController = PollingControllerMixin(base_controller_1.BaseControllerV2);
 exports.PollingControllerV1 = PollingControllerMixin(base_controller_1.BaseController);
 //# sourceMappingURL=PollingController.js.map

package/dist/PollingController.js.map

@@ -1 +1 @@
-{"version":3,"file":"PollingController.js","sourceRoot":"","sources":["../src/PollingController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAA6E;AAE7E,+BAAoC;AAMpC;;;;;GAKG;AACH,SAAS,sBAAsB,CAA4B,IAAW;;IACpE;;;;;OAKG;IACH,MAAe,qBAAsB,SAAQ,IAAI;QAAjD;;;YACE,0DACE,IAAI,GAAG,EAAE,EAAC;YAEZ,6CAAiE,EAAE,EAAC;YAEpE,2CAGI,IAAI,GAAG,EAAE,EAAC;YAEd,gDAAkB,IAAI,EAAC;QAyHzB,CAAC;QAvHC,iBAAiB;YACf,OAAO,uBAAA,IAAI,6CAAgB,CAAC;QAC9B,CAAC;QAED;;;;WAIG;QACH,iBAAiB,CAAC,MAAc;YAC9B,uBAAA,IAAI,yCAAmB,MAAM,MAAA,CAAC;QAChC,CAAC;QAED;;;;;WAKG;QACH,6BAA6B,CAAC,eAAgC;YAC5D,MAAM,cAAc,GAAG,IAAA,SAAM,GAAE,CAAC;YAChC,IAAI,uBAAA,IAAI,uDAA0B,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE;gBACvD,MAAM,GAAG,GAAG,uBAAA,IAAI,uDAA0B,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBAChE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,GAAG,CAAC,cAAc,CAAC,CAAC;aAC1B;iBAAM;gBACL,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;gBAC9B,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBACxB,uBAAA,IAAI,uDAA0B,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;aAC1D;YACD,uBAAA,IAAI,qEAAM,MAAV,IAAI,EAAO,eAAe,CAAC,CAAC;YAC5B,OAAO,cAAc,CAAC;QACxB,CAAC;QAED;;WAEG;QACH,cAAc;YACZ,uBAAA,IAAI,uDAA0B,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,gBAAgB,EAAE,EAAE;gBAClE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBACvB,IAAI,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;gBAC3C,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED;;;;WAIG;QACH,4BAA4B,CAAC,YAAoB;YAC/C,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;aAC1C;YACD,IAAI,KAAK,GAAG,KAAK,CAAC;YAClB,uBAAA,IAAI,uDAA0B,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,eAAe,EAAE,EAAE;;gBACjE,IAAI,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE;oBAC5B,KAAK,GAAG,IAAI,CAAC;oBACb,MAAA,uBAAA,IAAI,uDAA0B;yBAC3B,GAAG,CAAC,eAAe,CAAC,0CACnB,MAAM,CAAC,YAAY,CAAC,CAAC;oBACzB,IAAI,CAAA,MAAA,uBAAA,IAAI,uDAA0B,CAAC,GAAG,CAAC,eAAe,CAAC,0CAAE,IAAI,MAAK,CAAC,EAAE;wBACnE,YAAY,CAAC,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,CAAC,CAAC;wBACjD,OAAO,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,CAAC;wBAC1C,uBAAA,IAAI,uDAA0B,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;wBACvD,MAAA,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,eAAe,CAAC,0CAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;4BACzD,QAAQ,CAAC,eAAe,CAAC,CAAC;wBAC5B,CAAC,CAAC,CAAC;wBACH,MAAA,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,eAAe,CAAC,0CAAE,KAAK,EAAE,CAAC;qBAC/C;iBACF;YACH,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;aAC3C;QACH,CAAC;QA2BD;;;;;WAKG;QACH,kCAAkC,CAChC,eAAgC,EAChC,QAAoD;;YAEpD,IAAI,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE;gBACxC,MAAA,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,eAAe,CAAC,0CAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;aACrD;iBAAM;gBACL,MAAM,GAAG,GAAG,IAAI,GAAG,EAAmB,CAAC;gBACvC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAClB,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;aAC3C;QACH,CAAC;KACF;uVApCO,eAAgC;QACpC,IAAI,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,EAAE;YACtC,YAAY,CAAC,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,CAAC,CAAC;YACjD,OAAO,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,CAAC;SAC3C;QACD,sEAAsE;QACtE,wDAAwD;QACxD,kEAAkE;QAClE,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,GAAG,UAAU,CAAC,GAAS,EAAE;YACzD,IAAI;gBACF,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACtB;YACD,uBAAA,IAAI,qEAAM,MAAV,IAAI,EAAO,eAAe,CAAC,CAAC;QAC9B,CAAC,CAAA,EAAE,uBAAA,IAAI,6CAAgB,CAAC,CAAC;IAC3B,CAAC;IAqBH,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAEY,QAAA,iBAAiB,GAAG,sBAAsB,CAAC,kCAAgB,CAAC,CAAC;AAC7D,QAAA,mBAAmB,GAAG,sBAAsB,CAAC,gCAAc,CAAC,CAAC","sourcesContent":["import { BaseController, BaseControllerV2 } from '@metamask/base-controller';\nimport type { NetworkClientId } from '@metamask/network-controller';\nimport { v4 as random } from 'uuid';\n\n// Mixin classes require a constructor with an `...any[]` parameter\n// See TS2545\ntype Constructor = new (...args: any[]) => object;\n\n/**\n * PollingControllerMixin\n *\n * @param Base - The base class to mix onto.\n * @returns The composed class.\n */\nfunction PollingControllerMixin<TBase extends Constructor>(Base: TBase) {\n  /**\n   * PollingController is an abstract class that implements the polling\n   * functionality for a controller. It is meant to be extended by a controller\n   * that needs to poll for data by networkClientId.\n   *\n   */\n  abstract class PollingControllerBase extends Base {\n    readonly #networkClientIdTokensMap: Map<NetworkClientId, Set<string>> =\n      new Map();\n\n    readonly #intervalIds: Record<NetworkClientId, NodeJS.Timeout> = {};\n\n    #callbacks: Map<\n      NetworkClientId,\n      Set<(networkClientId: NetworkClientId) => void>\n    > = new Map();\n\n    #intervalLength = 1000;\n\n    getIntervalLength() {\n      return this.#intervalLength;\n    }\n\n    /**\n     * Sets the length of the polling interval\n     *\n     * @param length - The length of the polling interval in milliseconds\n     */\n    setIntervalLength(length: number) {\n      this.#intervalLength = length;\n    }\n\n    /**\n     * Starts polling for a networkClientId\n     *\n     * @param networkClientId - The networkClientId to start polling for\n     * @returns void\n     */\n    startPollingByNetworkClientId(networkClientId: NetworkClientId) {\n      const innerPollToken = random();\n      if (this.#networkClientIdTokensMap.has(networkClientId)) {\n        const set = this.#networkClientIdTokensMap.get(networkClientId);\n        set?.add(innerPollToken);\n      } else {\n        const set = new Set<string>();\n        set.add(innerPollToken);\n        this.#networkClientIdTokensMap.set(networkClientId, set);\n      }\n      this.#poll(networkClientId);\n      return innerPollToken;\n    }\n\n    /**\n     * Stops polling for all networkClientIds\n     */\n    stopAllPolling() {\n      this.#networkClientIdTokensMap.forEach((tokens, _networkClientId) => {\n        tokens.forEach((token) => {\n          this.stopPollingByNetworkClientId(token);\n        });\n      });\n    }\n\n    /**\n     * Stops polling for a networkClientId\n     *\n     * @param pollingToken - The polling token to stop polling for\n     */\n    stopPollingByNetworkClientId(pollingToken: string) {\n      if (!pollingToken) {\n        throw new Error('pollingToken required');\n      }\n      let found = false;\n      this.#networkClientIdTokensMap.forEach((tokens, networkClientId) => {\n        if (tokens.has(pollingToken)) {\n          found = true;\n          this.#networkClientIdTokensMap\n            .get(networkClientId)\n            ?.delete(pollingToken);\n          if (this.#networkClientIdTokensMap.get(networkClientId)?.size === 0) {\n            clearTimeout(this.#intervalIds[networkClientId]);\n            delete this.#intervalIds[networkClientId];\n            this.#networkClientIdTokensMap.delete(networkClientId);\n            this.#callbacks.get(networkClientId)?.forEach((callback) => {\n              callback(networkClientId);\n            });\n            this.#callbacks.get(networkClientId)?.clear();\n          }\n        }\n      });\n      if (!found) {\n        throw new Error('pollingToken not found');\n      }\n    }\n\n    /**\n     * Executes the poll for a networkClientId\n     *\n     * @param networkClientId - The networkClientId to execute the poll for\n     */\n    abstract executePoll(networkClientId: NetworkClientId): Promise<void>;\n\n    #poll(networkClientId: NetworkClientId) {\n      if (this.#intervalIds[networkClientId]) {\n        clearTimeout(this.#intervalIds[networkClientId]);\n        delete this.#intervalIds[networkClientId];\n      }\n      // setTimeout is not `await`ing this async function, which is expected\n      // We're just using async here for improved stack traces\n      // eslint-disable-next-line @typescript-eslint/no-misused-promises\n      this.#intervalIds[networkClientId] = setTimeout(async () => {\n        try {\n          await this.executePoll(networkClientId);\n        } catch (error) {\n          console.error(error);\n        }\n        this.#poll(networkClientId);\n      }, this.#intervalLength);\n    }\n\n    /**\n     * Adds a callback to execute when polling is complete\n     *\n     * @param networkClientId - The networkClientId to listen for polling complete events\n     * @param callback - The callback to execute when polling is complete\n     */\n    onPollingCompleteByNetworkClientId(\n      networkClientId: NetworkClientId,\n      callback: (networkClientId: NetworkClientId) => void,\n    ) {\n      if (this.#callbacks.has(networkClientId)) {\n        this.#callbacks.get(networkClientId)?.add(callback);\n      } else {\n        const set = new Set<typeof callback>();\n        set.add(callback);\n        this.#callbacks.set(networkClientId, set);\n      }\n    }\n  }\n  return PollingControllerBase;\n}\n\nexport const PollingController = PollingControllerMixin(BaseControllerV2);\nexport const PollingControllerV1 = PollingControllerMixin(BaseController);\n"]}
+{"version":3,"file":"PollingController.js","sourceRoot":"","sources":["../src/PollingController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAA6E;AAG7E,4FAAmD;AACnD,+BAAoC;AAMpC;;;;;GAKG;AACI,MAAM,MAAM,GAAG,CACpB,eAAgC,EAChC,OAAa,EACM,EAAE,CAAC,GAAG,eAAe,IAAI,IAAA,oCAAS,EAAC,OAAO,CAAC,EAAE,CAAC;AAHtD,QAAA,MAAM,UAGgD;AAGnE;;;;;GAKG;AACH,SAAS,sBAAsB,CAA4B,IAAW;;IACpE;;;;;OAKG;IACH,MAAe,qBAAsB,SAAQ,IAAI;QAAjD;;;YACE,kDAAkE,IAAI,GAAG,EAAE,EAAC;YAE5E,6CAAmE,EAAE,EAAC;YAEtE,2CAGI,IAAI,GAAG,EAAE,EAAC;YAEd,gDAAkB,IAAI,EAAC;QA4IzB,CAAC;QA1IC,iBAAiB;YACf,OAAO,uBAAA,IAAI,6CAAgB,CAAC;QAC9B,CAAC;QAED;;;;WAIG;QACH,iBAAiB,CAAC,MAAc;YAC9B,uBAAA,IAAI,yCAAmB,MAAM,MAAA,CAAC;QAChC,CAAC;QAED;;;;;;WAMG;QACH,6BAA6B,CAC3B,eAAgC,EAChC,UAAgB,EAAE;YAElB,MAAM,SAAS,GAAG,IAAA,SAAM,GAAE,CAAC;YAE3B,MAAM,GAAG,GAAG,IAAA,cAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAE7C,MAAM,eAAe,GAAG,uBAAA,IAAI,+CAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACxD,IAAI,eAAe,EAAE;gBACnB,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;aAChC;iBAAM;gBACL,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;gBAC9B,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACnB,uBAAA,IAAI,+CAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aACtC;YACD,uBAAA,IAAI,qEAAM,MAAV,IAAI,EAAO,eAAe,EAAE,OAAO,CAAC,CAAC;YACrC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED;;WAEG;QACH,cAAc;YACZ,uBAAA,IAAI,+CAAkB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,gBAAgB,EAAE,EAAE;gBAC5D,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBACzB,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;gBACxC,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED;;;;WAIG;QACH,yBAAyB,CAAC,YAAoB;YAC5C,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;aAC1C;YACD,IAAI,KAAK,GAAG,KAAK,CAAC;YAClB,uBAAA,IAAI,+CAAkB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE;;gBAC/C,IAAI,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE;oBAC9B,KAAK,GAAG,IAAI,CAAC;oBACb,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;oBAC9B,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE;wBACvB,YAAY,CAAC,uBAAA,IAAI,0CAAa,CAAC,GAAG,CAAC,CAAC,CAAC;wBACrC,OAAO,uBAAA,IAAI,0CAAa,CAAC,GAAG,CAAC,CAAC;wBAC9B,uBAAA,IAAI,+CAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBACnC,MAAA,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;4BAC7C,QAAQ,CAAC,GAAG,CAAC,CAAC;wBAChB,CAAC,CAAC,CAAC;wBACH,MAAA,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAE,KAAK,EAAE,CAAC;qBACnC;iBACF;YACH,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;aAC3C;QACH,CAAC;QAoCD;;;;;;WAMG;QACH,kCAAkC,CAChC,eAAgC,EAChC,QAAoD,EACpD,UAAgB,EAAE;YAElB,MAAM,GAAG,GAAG,IAAA,cAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAC7C,MAAM,SAAS,GAAG,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAE3C,IAAI,SAAS,KAAK,SAAS,EAAE;gBAC3B,MAAM,GAAG,GAAG,IAAI,GAAG,EAAmB,CAAC;gBACvC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAClB,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aAC/B;iBAAM;gBACL,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;aACzB;QACH,CAAC;KACF;+UA9CO,eAAgC,EAAE,OAAa;QACnD,MAAM,GAAG,GAAG,IAAA,cAAM,EAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,uBAAA,IAAI,0CAAa,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,QAAQ,EAAE;YACZ,YAAY,CAAC,QAAQ,CAAC,CAAC;YACvB,OAAO,uBAAA,IAAI,0CAAa,CAAC,GAAG,CAAC,CAAC;SAC/B;QACD,sEAAsE;QACtE,wDAAwD;QACxD,kEAAkE;QAClE,uBAAA,IAAI,0CAAa,CAAC,GAAG,CAAC,GAAG,UAAU,CACjC,GAAS,EAAE;YACT,IAAI;gBACF,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;aACnD;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACtB;YACD,uBAAA,IAAI,qEAAM,MAAV,IAAI,EAAO,eAAe,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC,CAAA,EACD,QAAQ,CAAC,CAAC,CAAC,uBAAA,IAAI,6CAAgB,CAAC,CAAC,CAAC,CAAC,CACpC,CAAC;IACJ,CAAC;IA0BH,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAED,MAAM,KAAK;CAAG;AAED,QAAA,qBAAqB,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC;AACtD,QAAA,iBAAiB,GAAG,sBAAsB,CAAC,kCAAgB,CAAC,CAAC;AAC7D,QAAA,mBAAmB,GAAG,sBAAsB,CAAC,gCAAc,CAAC,CAAC","sourcesContent":["import { BaseController, BaseControllerV2 } from '@metamask/base-controller';\nimport type { NetworkClientId } from '@metamask/network-controller';\nimport type { Json } from '@metamask/utils';\nimport stringify from 'fast-json-stable-stringify';\nimport { v4 as random } from 'uuid';\n\n// Mixin classes require a constructor with an `...any[]` parameter\n// See TS2545\ntype Constructor = new (...args: any[]) => object;\n\n/**\n * Returns a unique key for a networkClientId and options. This is used to group networkClientId polls with the same options\n * @param networkClientId - The networkClientId to get a key for\n * @param options - The options used to group the polling events\n * @returns The unique key\n */\nexport const getKey = (\n  networkClientId: NetworkClientId,\n  options: Json,\n): PollingTokenSetId => `${networkClientId}:${stringify(options)}`;\n\ntype PollingTokenSetId = `${NetworkClientId}:${string}`;\n/**\n * PollingControllerMixin\n *\n * @param Base - The base class to mix onto.\n * @returns The composed class.\n */\nfunction PollingControllerMixin<TBase extends Constructor>(Base: TBase) {\n  /**\n   * PollingController is an abstract class that implements the polling\n   * functionality for a controller. It is meant to be extended by a controller\n   * that needs to poll for data by networkClientId.\n   *\n   */\n  abstract class PollingControllerBase extends Base {\n    readonly #pollingTokenSets: Map<PollingTokenSetId, Set<string>> = new Map();\n\n    readonly #intervalIds: Record<PollingTokenSetId, NodeJS.Timeout> = {};\n\n    #callbacks: Map<\n      NetworkClientId,\n      Set<(networkClientId: NetworkClientId) => void>\n    > = new Map();\n\n    #intervalLength = 1000;\n\n    getIntervalLength() {\n      return this.#intervalLength;\n    }\n\n    /**\n     * Sets the length of the polling interval\n     *\n     * @param length - The length of the polling interval in milliseconds\n     */\n    setIntervalLength(length: number) {\n      this.#intervalLength = length;\n    }\n\n    /**\n     * Starts polling for a networkClientId\n     *\n     * @param networkClientId - The networkClientId to start polling for\n     * @param options - The options used to group the polling events\n     * @returns void\n     */\n    startPollingByNetworkClientId(\n      networkClientId: NetworkClientId,\n      options: Json = {},\n    ) {\n      const pollToken = random();\n\n      const key = getKey(networkClientId, options);\n\n      const pollingTokenSet = this.#pollingTokenSets.get(key);\n      if (pollingTokenSet) {\n        pollingTokenSet.add(pollToken);\n      } else {\n        const set = new Set<string>();\n        set.add(pollToken);\n        this.#pollingTokenSets.set(key, set);\n      }\n      this.#poll(networkClientId, options);\n      return pollToken;\n    }\n\n    /**\n     * Stops polling for all networkClientIds\n     */\n    stopAllPolling() {\n      this.#pollingTokenSets.forEach((tokenSet, _networkClientId) => {\n        tokenSet.forEach((token) => {\n          this.stopPollingByPollingToken(token);\n        });\n      });\n    }\n\n    /**\n     * Stops polling for a networkClientId\n     *\n     * @param pollingToken - The polling token to stop polling for\n     */\n    stopPollingByPollingToken(pollingToken: string) {\n      if (!pollingToken) {\n        throw new Error('pollingToken required');\n      }\n      let found = false;\n      this.#pollingTokenSets.forEach((tokenSet, key) => {\n        if (tokenSet.has(pollingToken)) {\n          found = true;\n          tokenSet.delete(pollingToken);\n          if (tokenSet.size === 0) {\n            clearTimeout(this.#intervalIds[key]);\n            delete this.#intervalIds[key];\n            this.#pollingTokenSets.delete(key);\n            this.#callbacks.get(key)?.forEach((callback) => {\n              callback(key);\n            });\n            this.#callbacks.get(key)?.clear();\n          }\n        }\n      });\n      if (!found) {\n        throw new Error('pollingToken not found');\n      }\n    }\n\n    /**\n     * Executes the poll for a networkClientId\n     *\n     * @param networkClientId - The networkClientId to execute the poll for\n     * @param options - The options passed to startPollingByNetworkClientId\n     */\n    abstract _executePoll(\n      networkClientId: NetworkClientId,\n      options: Json,\n    ): Promise<void>;\n\n    #poll(networkClientId: NetworkClientId, options: Json) {\n      const key = getKey(networkClientId, options);\n      const interval = this.#intervalIds[key];\n      if (interval) {\n        clearTimeout(interval);\n        delete this.#intervalIds[key];\n      }\n      // setTimeout is not `await`ing this async function, which is expected\n      // We're just using async here for improved stack traces\n      // eslint-disable-next-line @typescript-eslint/no-misused-promises\n      this.#intervalIds[key] = setTimeout(\n        async () => {\n          try {\n            await this._executePoll(networkClientId, options);\n          } catch (error) {\n            console.error(error);\n          }\n          this.#poll(networkClientId, options);\n        },\n        interval ? this.#intervalLength : 0,\n      );\n    }\n\n    /**\n     * Adds a callback to execute when polling is complete\n     *\n     * @param networkClientId - The networkClientId to listen for polling complete events\n     * @param callback - The callback to execute when polling is complete\n     * @param options - The options used to group the polling events\n     */\n    onPollingCompleteByNetworkClientId(\n      networkClientId: NetworkClientId,\n      callback: (networkClientId: NetworkClientId) => void,\n      options: Json = {},\n    ) {\n      const key = getKey(networkClientId, options);\n      const callbacks = this.#callbacks.get(key);\n\n      if (callbacks === undefined) {\n        const set = new Set<typeof callback>();\n        set.add(callback);\n        this.#callbacks.set(key, set);\n      } else {\n        callbacks.add(callback);\n      }\n    }\n  }\n  return PollingControllerBase;\n}\n\nclass Empty {}\n\nexport const PollingControllerOnly = PollingControllerMixin(Empty);\nexport const PollingController = PollingControllerMixin(BaseControllerV2);\nexport const PollingControllerV1 = PollingControllerMixin(BaseController);\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/polling-controller",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Polling Controller is the base for controllers that polling by networkClientId",
   "keywords": [
     "MetaMask",
@@ -31,13 +31,14 @@
   "dependencies": {
     "@metamask/base-controller": "^3.2.3",
     "@metamask/controller-utils": "^5.0.2",
-    "@metamask/network-controller": "^14.0.0",
+    "@metamask/network-controller": "^15.1.0",
     "@metamask/utils": "^8.1.0",
     "@types/uuid": "^8.3.0",
+    "fast-json-stable-stringify": "^2.1.0",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@metamask/auto-changelog": "^3.1.0",
+    "@metamask/auto-changelog": "^3.4.2",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
@@ -47,7 +48,7 @@
     "typescript": "~4.8.4"
   },
   "peerDependencies": {
-    "@metamask/network-controller": "^14.0.0"
+    "@metamask/network-controller": "^15.1.0"
   },
   "engines": {
     "node": ">=16.0.0"