Render loop since v5.105.2 when placeholderData, or its select result, is not referentially stable

Abierto
#12,639 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
54/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
react, typescript

Línea de trabajo

Start with QueryObserver.createResult in queryObserver.ts, especially the placeholder data and select handling; the report points to the result notification path and compares behavior between v5.105.1 and v5.105.2. Reproduce with the linked example or add a regression test covering the listed useQuery and useQueries cases. Done when the results settle without repeated notifications while preserving the expected placeholder result.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Describe the bug

Since v5.105.2, a query that shows placeholderData can re-render in a loop until React throws "Maximum update depth exceeded". This happens when the placeholder result is a new reference each time the observer computes it, and the component renders again after mount (for example, because its parent re-renders). In v5.105.1, every case below settles.

Case (the query never resolves) useQuery useQueries
placeholderData is a class instance created on every render settles loops
placeholderData is plain data whose content changes on every render settles loops
placeholderData is equal plain data created on every render, with a stable select that returns a Set loops loops
placeholderData is a stable object, with a stable select that throws for it loops loops

This looks like the same missing fixed point in QueryObserver.createResult as #12574, reached through placeholderData instead of keepPreviousData. The last row is not #12532: the select function is stable, and useQuery loops too.

Your minimal, reproducible example

https://stackblitz.com/github/jakubdrozdek/tanstack-query-placeholder-repro?file=src%2Fissue1.jsx

Steps to reproduce
  1. Open the example. Under "Issue 1", pick a case marked "loops".
  2. Click "re-render" once. The case shows "Maximum update depth exceeded".
  3. Set @tanstack/react-query to 5.105.1 in package.json. Every case settles.

The first case, for example:

class Row {
  constructor(name) {
    this.name = name
  }
}

function Example() {
  const [result] = useQueries({
    queries: [{ queryKey: ['row'], queryFn: () => new Promise(() => {}), placeholderData: new Row('row') }],
  })
  return <p>{String(result.isPlaceholderData)}</p>
}
Expected behavior

The result settles, as in v5.105.1. A placeholder result that has not changed in meaning should not notify again only because its reference changed.

How often does this bug happen?

Every time

Platform

Not platform specific. Reproduced with React 19.2.8 in tests (Bun with happy-dom) and in the Vite example above.

Tanstack Query adapter

react-query

TanStack Query version

v5.108.1 (also v5.105.2 and v5.107.1; v5.105.1 is fine)

Additional context

On every render, useQuery and useQueries compute an optimistic result and then set the options again (#12230). replaceData cannot keep the previous reference for a class instance, a Set, or changed content, so each computation returns a new result and the observer notifies again. A select that throws creates a new error each time, with the same effect (queryObserver.ts:710 in v5.108.1).

Lenguaje dominante
TypeScript
Estrellas
50.6k
Forks
4.2k
Merge medio
9 h 50 min
PR fusionados (30 d)
310

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TanStack/query

Todos los issues de TanStack/query

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.