New
Introducing React Bench, see how different models perform on React code

react-doctor/advanced-event-handler-refs

Store the handler in a ref and have the listener read `handlerRef.current()`: the subscription stays put while the latest handler is always called

Status
Active
Category
Performance
Assessment
Evidence-required risk
Required evidence
source code, runtime behavior, measurement
Default configuration
Enabled
Default severity
warn
Show technical metadata
Scope
All supported frameworks
Active when
React 19.2+ when useEffectEvent is available, or older React after subscription timing is reviewed
Requirements
react
Tags
test-noise
Priority
46 (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.

Fires when a useEffect has an identifier in its deps array AND that same identifier is passed as the second argument of a subscription-shaped call inside the body: addEventListener, subscribe, addListener, on, watch, listen, or sub from SUBSCRIPTION_METHOD_NAMES. The rule names the registered handler in the message.

Suppress when: the listener genuinely must re-bind every render because it captures a different DOM target each time.

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.

On React 19.2+, use useEffectEvent for a non-reactive callback that is declared and called by the Effect. Otherwise either keep the honest resubscription or use a stable wrapper backed by a ref whose current value is updated with timing appropriate to the source (often a layout effect for browser events). Remove only the handler dependency: retain target, options, and every other value that controls subscription setup, so the Effect still re-subscribes when those change. See https://react.dev/learn/separating-events-from-effects

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/advanced-event-handler-refs diagnostic in the current repository.

Required change:

  • On React 19.2+, use useEffectEvent for a non-reactive callback that is declared and called by the Effect. Otherwise either keep the honest resubscription or use a stable wrapper backed by a ref whose current value is updated with timing appropriate to the source (often a layout effect for browser events). Remove only the handler dependency: retain target, options, and every other value that controls subscription setup, so the Effect still re-subscribes when those change. See https://react.dev/learn/separating-events-from-effects.

Validation before editing:

Fires when a useEffect has an identifier in its deps array AND that same identifier is passed as the second argument of a subscription-shaped call inside the body: addEventListener, subscribe, addListener, on, watch, listen, or sub from SUBSCRIPTION_METHOD_NAMES. The rule names the registered handler in the message.

Suppress when: the listener genuinely must re-bind every render because it captures a different DOM target each time.

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.
  • Preserve resource ownership and cleanup. Do not move work into a hotter render or frame path.
  • If syntax proves only a candidate cost, require a relevant trace, bundle report, payload measurement, or metric before editing.
  • Without evidence, record Needs evidence. Compare the same scenario before and after; keep the change only when its target metric improves without regression.
  • 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 19.2+ when useEffectEvent is available, or older React after subscription timing is reviewed.

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.