react-doctor/effect-listener-cleanup-reference-mismatch
Effect cleanup removes the wrong listener reference
- Category: Bugs
- Severity: error
- Source:
oxlint-plugin-react-doctor - Framework: global
- Enabled when: react
- Default: Enabled
Validate the diagnostic
Confirm the reported code matches this rule before you edit it.
Confirm the reported code matches react-doctor/effect-listener-cleanup-reference-mismatch. Compare it with the Before example and verify the same API, framework, and execution context. Treat it as a false positive only when one of those conditions differs.
Compare the code
The corrected pattern shows a focused way to address the diagnostic.
Reported pattern
useEffect(() => {
source["subscribe"](() => onValue());
return () => source[`unsubscribe`](() => onValue());
}, []);Corrected pattern
useEffect(() => {
const handleValue = () => onValue();
source["subscribe"](handleValue);
return () => source[`unsubscribe`](handleValue);
}, []);How to fix
Use the corrected pattern as a reference. Preserve behavior that the rule does not require you to change.
Copyable fix prompt
Copy this self-contained prompt into your coding agent after you confirm the diagnostic.
Fix every confirmed
Reference transformation:Before:react-doctor/effect-listener-cleanup-reference-mismatch diagnostic in the current repository.
Required change:
- Store the listener in one named constant. Pass that same reference to both subscription and cleanup calls. Use useCallback only when the handler must remain stable across renders.useEffect(() => {
source["subscribe"](() => onValue());
return () => source[`unsubscribe`](() => onValue());
}, []);useEffect(() => {
const handleValue = () => onValue();
source["subscribe"](handleValue);
return () => source[`unsubscribe`](handleValue);
}, []);Constraints:
- Confirm the reported code matches the Before pattern.
- 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.
Verification:
- Run focused tests for the changed behavior.
- Run React Doctor and confirm this diagnostic no longer appears.
- Report the files changed and any checks you could not run.Related rules
More Bugs rules from the rules reference:
react-doctor/effect-needs-cleanup: Return a cleanup function that releases the subscription / timer: `return () => target.removeEventListener(name, handler)` for listeners, `return () => clearInterval(id)` / `clearTimeout(id)` for timers, or `return unsubscribe` if the subscribe call already returned onereact-doctor/effect-observer-needs-disconnect: Observer created in an effect never disconnectedreact-doctor/effect-raf-loop-needs-cancel: requestAnimationFrame loop never cancelledreact-doctor/effect-remove-listener-inline-handler: removeEventListener called with a fresh inline handlerreact-doctor/exhaustive-deps: Match the deps array to what the hook callback actually captures, or stabilize/move recreated values instead of blindly adding them.