Add mixins for using polling in data services

The `polling-controller` package contains mixins for integrating the
polling pattern into a class. Using these mixins on their own is
somewhat cumbersome, so the package also contains utility functions
which can be used in place of a superclass.

Currently, there are variants of these utility functions for controllers
and non-controllers, but no variant for data services. That means if
engineers want to integrate polling into data services, they are out of
luck. This commit corrects that by adding two new mixins:
`BlockTrackerPollingDataService` (which subscribes to the block tracker)
and `StaticIntervalPollingDataService` (which runs on a cadence).

Author: mcmire

packages/polling-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `BlockTrackerPollingDataService` and `StaticIntervalPollingDataService` mixins for integrating the polling pattern in data services ([#9352](https://github.com/MetaMask/core/pull/9352))
+
 ## [16.0.8]
 
 ### Changed

packages/polling-controller/package.json

@@ -52,6 +52,7 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^9.1.0",
+    "@metamask/base-data-service": "^0.1.3",
     "@metamask/network-controller": "^34.0.0",
     "@metamask/utils": "^11.11.0",
     "@types/uuid": "^8.3.0",

packages/polling-controller/src/BlockTrackerPollingController.ts

@@ -1,4 +1,5 @@
 import { BaseController } from '@metamask/base-controller';
+import { BaseDataService } from '@metamask/base-data-service';
 import type {
   NetworkClientId,
   NetworkClient,
@@ -103,3 +104,13 @@ export const BlockTrackerPollingController = <
   BlockTrackerPollingControllerMixin<typeof BaseController, PollingInput>(
     BaseController,
   );
+
+export const BlockTrackerPollingDataService = <
+  PollingInput extends BlockTrackerPollingInput,
+  // The return type is inferred from the class defined inside the function
+  // scope, so this can't be easily typed.
+  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+>() =>
+  BlockTrackerPollingControllerMixin<typeof BaseDataService, PollingInput>(
+    BaseDataService,
+  );

packages/polling-controller/src/StaticIntervalPollingController.ts

@@ -1,4 +1,5 @@
 import { BaseController } from '@metamask/base-controller';
+import { BaseDataService } from '@metamask/base-data-service';
 import type { Json } from '@metamask/utils';
 
 import {
@@ -96,3 +97,11 @@ export const StaticIntervalPollingController = <PollingInput extends Json>() =>
   StaticIntervalPollingControllerMixin<typeof BaseController, PollingInput>(
     BaseController,
   );
+
+// The return type is inferred from the class defined inside the function
+// scope, so this can't be easily typed.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+export const StaticIntervalPollingDataService = <PollingInput extends Json>() =>
+  StaticIntervalPollingControllerMixin<typeof BaseDataService, PollingInput>(
+    BaseDataService,
+  );

packages/polling-controller/src/index.ts

@@ -1,11 +1,13 @@
 export {
   BlockTrackerPollingControllerOnly,
   BlockTrackerPollingController,
+  BlockTrackerPollingDataService,
 } from './BlockTrackerPollingController';
 
 export {
   StaticIntervalPollingControllerOnly,
   StaticIntervalPollingController,
+  StaticIntervalPollingDataService,
 } from './StaticIntervalPollingController';
 
 export type { IPollingController } from './types';

packages/polling-controller/tsconfig.build.json

@@ -7,6 +7,7 @@
   },
   "references": [
     { "path": "../base-controller/tsconfig.build.json" },
+    { "path": "../base-data-service/tsconfig.build.json" },
     { "path": "../controller-utils/tsconfig.build.json" },
     { "path": "../network-controller/tsconfig.build.json" },
     { "path": "../messenger/tsconfig.build.json" }

packages/polling-controller/tsconfig.json

@@ -6,6 +6,7 @@
   },
   "references": [
     { "path": "../base-controller" },
+    { "path": "../base-data-service" },
     { "path": "../controller-utils" },
     { "path": "../network-controller" },
     { "path": "../messenger" }

yarn.lock

@@ -8029,6 +8029,7 @@ __metadata:
   dependencies:
     "@metamask/auto-changelog": "npm:^6.1.0"
     "@metamask/base-controller": "npm:^9.1.0"
+    "@metamask/base-data-service": "npm:^0.1.3"
     "@metamask/messenger": "npm:^1.2.0"
     "@metamask/network-controller": "npm:^34.0.0"
     "@metamask/utils": "npm:^11.11.0"