facebook / react

The library for web and native user interfaces.
https://react.dev
MIT License
228.53k stars 46.77k forks source link

Bug: "Should have a queue. This is likely a bug in React" #30038

Closed Nantris closed 2 months ago

Nantris commented 4 months ago

React version: 18.2.0

(18.2.0 is required by Expo, but theoretically equivalent to 18.3.1 for this purpose)

Steps To Reproduce

  1. Unknown. No rules of hooks are being broken and the error stack is not helpful for diagnosis.

Code example:

I don't know how to reproduce this. Originally I faced #22049, supposedly caused by our "problem hook":

// Supposed problem hook
const linkableRef = useRef(linkable);
useEffect(() => {
  linkableRef.current = linkable; // linkable is an array of objects
  const { current: editor } = editorRef;
  if (editor) editor.commands.updateLinkable();
}, [linkable, editorRef]);

and removing the hook causes this instead: Error: Should have a queue. This is likely a bug in React. Please file an issue.

The current behavior

Using our simple hook causes #22049 - and removing our hook causes this issue instead

The expected behavior

Using React as specified in the docs causes no errors

Nantris commented 4 months ago

This occurs ONLY on the first instance of taking the "problematic action" that causes the bug, and only if take on the the first mount of the problem component.

Identical actions after this crash has occurred and the component is re-mounted via the ErrorBoundary will not produce any errors. Loading the component a second time (different props of the same sort) also prevents this issue from occurring.

This extremely strange circumstance is making debugging unrelated issues quite difficult.

Nantris commented 4 months ago

This is really plaguing us. I hope this can be resolved.

Nantris commented 3 months ago

Friendly bump. I know this seems like impatience but an unmitigatable bug in React is a big problem for us.

eps1lon commented 3 months ago

Calling hooks conditionally usually leads to these kind of bugs. If you want help fixing this issue, we need a minimal reproduction.

Nantris commented 3 months ago

Thanks for your reply @eps1lon. We're 100% not calling hooks conditionally. I manually reviewed the code three times, asked ChatGPT, and ESLint also agrees. Unfortunately I have no idea what code is really causing the problem because commenting out the "problem hook" is what leads to this error. How can I glean any clue about the underlying cause?

I can't share our private code and the error message provides not a single avenue to pursue. It would be a different thing if I knew commenting out some code resolved an issue - but in this case it causes the issue.

eps1lon commented 3 months ago

I'd start by removing surrounding code until it no longer reproduces. It might also be a sibling or parent component that calls hooks conditionally.

Nantris commented 3 months ago

Thanks for the advice @eps1lon! I'll see if I can uncover anything.

Nantris commented 3 months ago

@eps1lon:

Results in error: should have queue:

export const useEditExploreCapabilities = ({
  noEdits,
  isHashtag,
}) => {
  const [canEdit, setCanEdit] = useState(!noEdits && !isHashtag);
  const [canExplore, setCanExplore] = useState(canEdit);

  useEffect(() => {
    setCanEdit(noEdits && !isHashtag);
  }, [noEdits, isHashtag]);

  useEffect(() => {
    setCanExplore(canEdit || (isHashtag));
  }, [isHashtag, canEdit]);

  return [canEdit, canExplore];
};

Works fine:

export const useEditExploreCapabilities = ({
  noEdits,
  isHashtag
}) => {
  const [canEdit, setCanEdit] = useState(!noEdits && !isHashtag);
  const [canExplore, setCanExplore] = useState(canEdit);

  useEffect(() => {
    setCanEdit(!noEdits && !isHashtag);
    setCanExplore(canEdit || (isHashtag));
  }, [noEdits, isHashtag, canEdit]);

  return [canEdit, canExplore];
};

Is this expected? As far as I'm aware my original code didn't break any rules of hooks and seems, on the surface, more correct to me.

eps1lon commented 3 months ago

I can't repro this in isolation: https://codesandbox.io/p/sandbox/cranky-currying-gn777q-gn777q

Maybe another component in your tree is violating Rule of React? For minimal reproductions, try to remove as much as possible from the whole component tree.

Nantris commented 3 months ago

I am quite certain no rules of React (most especially rules of hooks) are being broken. ESLint agrees. I'm the only developer.

Since I have found a workaround I won't have time to work on this, but despite the inability to reproduce it in isolation, I feel confident this is a bug in React. The fact it was masked under other React errors further bolsters my belief.

Nantris commented 3 months ago

For what it's worth, this is inside StrictMode, but adding that to your repro didn't change anything.