Block `QueryClient` API surface in UI

Open
  • Is something wrong?
#8,530 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
api, frontend

Research direction

Start in packages/react-data-query/src/createUIQueryClient.ts, reading the existing invalidateQueries and defaultMutationOptions shadows and the wrapper hooks. Decide how per-call queryFn and mutationFn overrides should behave, then add guards for the listed QueryClient methods while preserving non-data-service keys. Add per-method unit tests for throwing and pass-through behavior, plus the named Option C regression tests.

Written by the indexing model from the issue text.

Description

File: packages/react-data-query/src/createUIQueryClient.ts
Size: M | Hours: 6–10

Problem

Under ADR 0020 Option A, two messenger-routed proxies and the OmitKeyof wrapper hooks enforce that the background owns data-service-keyed cache entries: the proxy queryFn, and since #9324 (Update BaseDataService to accommodate mutations) the defaultMutationOptions shadow that injects a mutationFn. None of them covers the QueryClient instance surface. UI code with a handle on queryClient (via ui/contexts/query-client.ts or useQueryClient()) can call instance methods that bypass the proxy or cross the ownership boundary without warning.

No longer dormant. DATA_SERVICES on metamask-extension main holds MoneyAccountBalanceService and MoneyAccountApiDataService, so the guards below are on a live path rather than a preemptive one.

The options-resolution path is a second surface

Every method below is a QueryClient instance method. A shadow on the instance cannot reach a bypass supplied through per-call options, and both proxies can be overridden that way:

  • queryFn — the proxy is a client default, so an explicit queryFn on a useQuery call wins. OmitKeyof strips it from the wrapper's type, which is a compile-time strip with no runtime check.
  • mutationFn — defaultedOptions.mutationFn ??= is a nullish-assign, so a caller-supplied mutationFn on a data-service mutationKey wins and the write never reaches the service.

Whether that override is intended is an open design question rather than a settled hole: the query-side escape hatch was deliberate, and the mutation side mirrors it. Either way it is not closed by shadowing instance methods, so it needs its own decision and its own guard.

Solution

Mirror the existing invalidateQueries shadow. For each method below, shadow on the returned client and throw a descriptive error if the query key matches a registered data-service prefix. Non-data-service keys pass through unchanged. Note there are now two shadows on the returned client, invalidateQueries and defaultMutationOptions, so the guards compose with them rather than replacing them.

Methods to guard:

  • setQueryDefaults — per-key cache-policy override; ADR 0020 moves cache policy to the service layer
  • setMutationDefaults — data-service mutations exist as of #9324 (mutations in BaseDataService), so this is now live rather than preemptive
  • setDefaultOptions — block only when options.queries.queryFn or options.mutations.mutationFn is set
  • prefetchQuery / prefetchInfiniteQuery — pending policy decision on whether UI-side prefetch is in scope; block until decided
  • fetchQuery / fetchInfiniteQuery — same
  • setQueryData / setQueriesData — block; replacement implementation tracked separately (see Dependencies)
  • ensureQueryData / ensureInfiniteQueryData — block; replacement implementation tracked separately (see Dependencies)
  • getMutationCache / resumePausedMutations / isMutating — mutation-side twins, needed since #9324 (mutations in BaseDataService)

Acceptance Criteria

  • All methods above throw on data-service keys with a descriptive error citing the data service as cache owner and referencing ADR 0020
  • A caller-supplied queryFn or mutationFn on a data-service key is decided one way or the other, and whichever way it goes is enforced at runtime rather than only in the wrapper's types
  • setDefaultOptions only throws when options.queries.queryFn or options.mutations.mutationFn is set; other client-wide tuning unaffected
  • Non-data-service keys pass through for all methods (Option C hooks unaffected)
  • invalidateQueries and defaultMutationOptions shadows, wrapper hooks, and hydrate-based cache-sync continue to work
  • Unit tests per method: data-service key throws, non-data-service key passes, error message correct
  • Regression tests for Option C consumers (useHistoricalPrices, activity-v2/hooks, useMerklRewards) still pass

Dependencies

Depends on: MetaMask/metamask-extension#41183 (merged)
Dependents: MetaMask/metamask-extension#41977
Follow-up epic (Layer 2 + replacements): #8531 (Expose replacement implementations of QueryClient APIs in UI)
Widened by: #9324 (Update BaseDataService to accommodate mutations) — adds the mutation proxy and the mutation-side instance methods

Dominant language
TypeScript
Stars
422
Forks
313
Avg merge
1d 8h
Merged PRs (30d)
414

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MetaMask/core

All issues in MetaMask/core

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.