Migrate SampleGasPriceService to BaseDataService#8343
Merged
Conversation
With the release of `@metamask/base-data-service`, the `SampleGasPricesService` class needs to be updated so that new data services that other engineers create follow the standards we want them to follow.
mcmire
force-pushed
the
update-sample-gas-price-service
branch
from
186aee8 to
896f3cc
Compare
mcmire
commented
Mar 30, 2026
| * @returns The root messenger. | ||
| */ | ||
| function getRootMessenger(): RootMessenger { | ||
| function createRootMessenger(): RootMessenger { |
Contributor
Author
There was a problem hiding this comment.
get* did not seem like an appropriate prefix for a factory function. The choice of prefix for factory functions was brought up in the past (by Erik I believe) and if I remember correctly we settled on create*.
| * {@link CockatielEvent}. | ||
| * @see {@link createServicePolicy} | ||
| */ | ||
| onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable { |
Contributor
Author
There was a problem hiding this comment.
We probably should add these methods (or something like them) to BaseDataService, but regardless, I don't want to ask that engineers add them to their data service classes unless they really need to.
| ) { | ||
| return { low, average, high }; | ||
| } | ||
| if (!is(jsonResponse, GasPricesResponseStruct)) { |
Contributor
Author
There was a problem hiding this comment.
We might as well switch to using Superstruct for response validation. Most teams are shifting to using this anyway.
|
|
||
| ### Changed | ||
|
|
||
| - **BREAKING:** `SampleGasPricesService` now inherits from `BaseDataService` from `@metamask/base-data-service` ([#8343](https://github.com/MetaMask/core/pull/8343)) |
Contributor
Author
There was a problem hiding this comment.
This very well may not be breaking. I'll have to take a closer look at this, but I wanted to call it out in case it was.
| }, | ||
| ); | ||
|
|
||
| it('calls onDegraded listeners if the request takes longer than 5 seconds to resolve', async () => { |
Contributor
Author
There was a problem hiding this comment.
I removed these methods from the class so these tests are no longer necessary.
cryptodev-2s
approved these changes
Apr 1, 2026
micaelae
pushed a commit
that referenced
this pull request
Apr 7, 2026
## Explanation <!-- Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes: * What is the current state of things and why does it need to change? * What is the solution your changes offer and how does it work? * Are there any changes whose purpose might not obvious to those unfamiliar with the domain? * If your primary goal was to update one package but you found you had to update another one along the way, why did you do so? * If you had to upgrade a dependency, why did you do so? --> With the release of `@metamask/base-data-service`, the `SampleGasPricesService` class needs to be updated so that new data services follow our best practices. ## References <!-- Are there any issues that this pull request is tied to? Are there other links that reviewers should consult to understand these changes better? Are there client or consumer pull requests to adopt any breaking changes? For example: * Fixes #12345 * Related to #67890 --> https://consensyssoftware.atlassian.net/browse/WPC-942 ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/processes/updating-changelogs.md) - [ ] I've introduced [breaking changes](https://github.com/MetaMask/core/tree/main/docs/processes/breaking-changes.md) in this PR and have prepared draft pull requests for clients and consumer packages to resolve them <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Medium Risk** > Introduces breaking API changes (service inheritance and removed `onRetry`/`onBreak`/`onDegraded`) and changes request behavior to be query-cached/deduplicated, which could affect consumers and error/retry semantics. > > **Overview** > Migrates `SampleGasPricesService` to extend `@metamask/base-data-service`’s `BaseDataService`, switching `fetchGasPrices` to use `fetchQuery` (TanStack Query) so API calls are **cached and deduplicated** and adding optional `queryClientConfig` for cache/client tuning. > > Adds new messenger surface area for cache management/observability (`:invalidateQueries` action plus `cacheUpdated` events), exports the new types from `src/index.ts`, and updates tests accordingly while removing the previous `onRetry`/`onBreak`/`onDegraded` hooks. Dependency and TS project references are updated to include `@metamask/base-data-service`, `@tanstack/query-core`, and `@metamask/superstruct` (used for response validation). > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 3a60272. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation
With the release of
@metamask/base-data-service, theSampleGasPricesServiceclass needs to be updated so that new data services follow our best practices.References
https://consensyssoftware.atlassian.net/browse/WPC-942
Checklist
Note
Medium Risk
Introduces breaking API changes (service inheritance and removed
onRetry/onBreak/onDegraded) and changes request behavior to be query-cached/deduplicated, which could affect consumers and error/retry semantics.Overview
Migrates
SampleGasPricesServiceto extend@metamask/base-data-service’sBaseDataService, switchingfetchGasPricesto usefetchQuery(TanStack Query) so API calls are cached and deduplicated and adding optionalqueryClientConfigfor cache/client tuning.Adds new messenger surface area for cache management/observability (
:invalidateQueriesaction pluscacheUpdatedevents), exports the new types fromsrc/index.ts, and updates tests accordingly while removing the previousonRetry/onBreak/onDegradedhooks. Dependency and TS project references are updated to include@metamask/base-data-service,@tanstack/query-core, and@metamask/superstruct(used for response validation).Written by Cursor Bugbot for commit 3a60272. This will update automatically on new commits. Configure here.