react-doctor/query-mutation-missing-invalidation
Add `onSuccess: () => queryClient.invalidateQueries({ queryKey: ['...'] })` so cached data stays in sync after the mutation
- Status
- Active
- Category
- TanStack Query
- Assessment
- Evidence-required risk
- Required evidence
- source code
- Default configuration
- Enabled
- Default severity
- warn
Show technical metadata
- Scope
- TanStack Query
- Active when
- framework=tanstack-query and capabilities=tanstack-query
- Requirements
- tanstack-query
- Tags
- test-noise
- Priority
- 58 (P2)
- Source
- oxlint-plugin-react-doctor
- Rule set
- oxlint-plugin-react-doctor 0.9.3 (prompt schema 2)
Validation prompt
Confirm the detector match and collect the required evidence before deciding whether an edit is warranted.
Fires on useMutation({ mutationFn: ..., ... }) when the options object contains no recognized cache operation. That absence does not prove stale data: the mutation may affect no cached query, return data used directly, update elsewhere, use a global callback/router refresh, or intentionally defer synchronization. Identify the affected query keys and cache owner before confirming.
Evidence boundary
The diagnostic proves only that the detector’s modeled source pattern matched. It does not prove runtime impact, product intent, rendered failure, or that one remediation is correct.
Establish the environment, repository policy, exceptions, and required rendered or runtime evidence before deciding the occurrence.
Record one outcome:
- Confirmed failure: The required evidence establishes the violation.
- Rejected: A documented exception or false-positive predicate applies.
- Needs evidence: Named evidence can still be collected.
- Unavailable: Required evidence cannot be collected in this run.
- Waived with evidence: An authorized, scoped exception applies to an established failure.
- Observation: The review records an optional tradeoff without claiming a defect.
A waiver records its scope, authority, evidence, and review condition. It is not a pass or false positive.
Default severity is registry metadata. Use the occurrence’s JSON severity after repository configuration when ordering real findings.
Fix prompt
Apply this candidate correction only after the required evidence confirms the risk.
When the mutation makes a known cached query stale, synchronize that exact cache in onSuccess/onSettled: invalidate the affected object-form queryKey, or use setQueryData when the response already contains the authoritative replacement. Keep the mutation unchanged when no query cache is affected or synchronization is deliberately owned elsewhere, and document that ownership rather than adding a broad invalidation. https://tanstack.com/query/latest/docs/framework/react/guides/invalidations-from-mutations
Repository-wide copy prompt
Use this repository-wide prompt only after validating each occurrence. For one occurrence, use the guidance above.
Show repository-wide prompt
Fix every confirmed react-doctor/query-mutation-missing-invalidation diagnostic in the current repository.
Required change:
- When the mutation makes a known cached query stale, synchronize that exact cache in onSuccess/onSettled: invalidate the affected object-form queryKey, or use setQueryData when the response already contains the authoritative replacement. Keep the mutation unchanged when no query cache is affected or synchronization is deliberately owned elsewhere, and document that ownership rather than adding a broad invalidation. https://tanstack.com/query/latest/docs/framework/react/guides/invalidations-from-mutations.
Validation before editing:
Fires on useMutation({ mutationFn: ..., ... }) when the options object contains no recognized cache operation. That absence does not prove stale data: the mutation may affect no cached query, return data used directly, update elsewhere, use a global callback/router refresh, or intentionally defer synchronization. Identify the affected query keys and cache owner before confirming.
Constraints:
- Make the smallest change that fixes the root cause.
- Preserve behavior and interfaces unrelated to this diagnostic.
- Reuse existing project components, utilities, and conventions.
- Do not introduce render-phase side effects, render-phase state updates, or Hooks rule violations.
- Adapt identifiers and framework details instead of copying blindly.
- Do not disable the rule or suppress matching code.
- Confirm this rule is enabled for the project:
framework=tanstack-query and capabilities=tanstack-query.
Assessment:
- Record detector evidence, applicability facts, assumptions, missing evidence, and the rule class for this occurrence.
- Return one outcome: Confirmed failure, Rejected, Needs evidence, Unavailable, Waived with evidence, or Observation.
- A waiver records the established failure, scope, authority, evidence, and review or expiry condition. It is not a pass or false positive.
Verification:
- Run focused tests for the changed behavior.
- Run React Doctor and confirm this diagnostic no longer appears from changed code.
- Run an unfiltered scan of the affected scope before claiming no cross-category regression.
- Report the files changed and any checks you could not run.