react-doctor/effect-raf-loop-needs-cancel
requestAnimationFrame loop never cancelled
- Status
- Active
- Category
- Bugs
- Assessment
- Evidence-required risk
- Required evidence
- source code
- Default configuration
- Enabled
- Default severity
- warn
Show technical metadata
- Scope
- All supported frameworks
- Active when
- react
- Requirements
- react
- Priority
- Unranked; sorts as P3
- Source
- oxlint-plugin-react-doctor
- Rule set
- oxlint-plugin-react-doctor 0.9.3 (prompt schema 2)
On this page
Validation prompt
Confirm the detector match and collect the required evidence before deciding whether an edit is warranted.
Confirm the detector conditions for react-doctor/effect-raf-loop-needs-cancel in the reported code. The Before example is representative, not exhaustive. Verify the same API, framework, execution context, and any documented exceptions before editing.
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.
Review a candidate correction
Apply this candidate correction only after the required evidence confirms the risk.
Reported pattern
useEffect(() => {
const frame = () => {
draw();
requestAnimationFrame(frame);
};
requestAnimationFrame(frame);
}, []);Candidate corrected pattern
useEffect(() => {
let frameId = 0;
const frame = () => {
draw();
frameId = requestAnimationFrame(frame);
};
frameId = requestAnimationFrame(frame);
return () => cancelAnimationFrame(frameId);
}, [draw]);Fix prompt
Apply this candidate correction only after the required evidence confirms the risk.
Store the frame id and return a cleanup that calls cancelAnimationFrame(id) so self-scheduling work cannot continue after unmount.
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/effect-raf-loop-needs-cancel diagnostic in the current repository.
Required change:
- Store the frame id and return a cleanup that calls
cancelAnimationFrame(id)so self-scheduling work cannot continue after unmount.
Validation before editing:
Confirm the detector conditions for react-doctor/effect-raf-loop-needs-cancel in the reported code. The Before example is representative, not exhaustive. Verify the same API, framework, execution context, and any documented exceptions before editing.
Reference transformation:
Before
useEffect(() => {
const frame = () => {
draw();
requestAnimationFrame(frame);
};
requestAnimationFrame(frame);
}, []);After
useEffect(() => {
let frameId = 0;
const frame = () => {
draw();
frameId = requestAnimationFrame(frame);
};
frameId = requestAnimationFrame(frame);
return () => cancelAnimationFrame(frameId);
}, [draw]);Constraints:
- Treat the Before example as representative. Confirm the detector conditions, not an exact text match.
- 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:
react.
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.