query-db-collection (on-demand): a second live query on an identical stale subset reuses the observer and never refetches

Offen
  • Stimmt etwas nicht?
#2,352 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
68/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
typescript
Bereich
database

Rechercherichtung

Start in packages/query-db-collection/src/query and trace loadSubset when it reuses an observer for an existing hashedQueryKey. Add the provided failing test under packages/query-db-collection/tests/, then compare reuse behavior with Query Core’s refetchOnMount rules. Done when the test confirms stale subsets refetch for a second identical live query and the false, 'always', and staleTime: null cases behave as described.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

  • I've validated the bug against the latest version of DB packages

Describe the bug

With syncMode: "on-demand" and staleTime: 0, a second live query with the same predicate as an already-loaded subset never refetches. It reuses the existing observer, so rows the server added after the first load never appear, in either live query.

When state.observers already has the subset's hashedQueryKey, loadSubset bumps the refcount and returns on the observer's current success result without consulting isStale. Exact-request reuse is intended (#1657 / #1797; #1935: "Live queries that ask for the same subset share its Query"). The gap is that refetchOnMount (#1665) is only forwarded when an observer is created. A reused observer never mounts, so staleTime / refetchOnMount are skipped for the second consumer. Focus and reconnect refetches still work, so this only shows up while navigating in-session. #998 covered the empty-result case; a populated stale subset still short-circuits.

Versions: @tanstack/[email protected], @tanstack/[email protected], @tanstack/[email protected]. Also reproduced on 0.15.2 / 1.4.8 and on 0.8.7 / 1.2.12.

To Reproduce

  1. Create an on-demand query collection with staleTime: 0.
  2. Mount live query A with where customerId = 'u1'. queryFn runs and the subset loads.
  3. The server gains a new matching row.
  4. Mount live query B with the identical predicate.
  5. See that queryFn does not run again and that neither A nor B contains the new row.

Failing test (vitest, for packages/query-db-collection/tests/):

import { describe, expect, it, vi } from 'vitest'
import { QueryClient } from '@tanstack/query-core'
import {
  compileSingleRowExpression,
  createCollection,
  createLiveQueryCollection,
  eq,
  toBooleanPredicate,
} from '@tanstack/db'
import { queryCollectionOptions } from '../src/query'

type Row = { id: string; customerId: string }

const flush = async () => {
  for (let i = 0; i < 15; i++) await new Promise((r) => setTimeout(r, 0))
}

describe(`on-demand subset reuse`, () => {
  it(`refetches a stale subset when a second live query acquires the same predicate`, async () => {
    const queryClient = new QueryClient({
      defaultOptions: { queries: { retry: false } },
    })
    const serverRows: Array<Row> = [{ id: `x1`, customerId: `u1` }]
    const queryFn = vi.fn(async (ctx: any) => {
      const where = ctx.meta?.loadSubsetOptions?.where
      if (!where) return []
      const predicate = compileSingleRowExpression(where)
      return serverRows.filter((row) =>
        toBooleanPredicate(predicate({ ...row })),
      )
    })
    const collection = createCollection(
      queryCollectionOptions<Row>({
        id: `stale-subset-reuse`,
        getKey: (row) => row.id,
        queryKey: [`rows`],
        queryClient,
        syncMode: `on-demand`,
        staleTime: 0,
        queryFn,
      }),
    )
    const window = () => {
      const live = createLiveQueryCollection((q) =>
        q.from({ row: collection }).where(({ row }) => eq(row.customerId, `u1`)),
      )
      live.subscribeChanges(() => {})
      return live
    }
    const ids = (live: { values: () => Iterable<Row> }) =>
      [...live.values()].map((row) => row.id).sort()

    const a = window()
    await flush()
    expect(queryFn).toHaveBeenCalledTimes(1)
    expect(ids(a)).toEqual([`x1`])

    serverRows.push({ id: `x2`, customerId: `u1` })

    const b = window()
    await flush()

    // Fails: queryFn stays at 1 call and both windows stay at [`x1`].
    expect(queryFn).toHaveBeenCalledTimes(2)
    expect(ids(a)).toEqual([`x1`, `x2`])
    expect(ids(b)).toEqual([`x1`, `x2`])
  })
})

Actual on 1.5.1: queryFn is called once, and both windows are ["x1"].

Expected behavior

Acquiring an existing subset applies the same freshness rule as mounting a new QueryObserver. It refetches when refetchOnMount allows it (true with a stale result, or 'always'), and does nothing for false or a fresh result. After step 4, queryFn has run twice and both live queries contain x1 and x2.

Additional context

Not platform-specific: it reproduces in plain Node with the test above. We hit it in a React Native app (Hermes), where two screens filter the same subset.

A local patch fixes it for us. When loadSubset reuses an existing observer, it evaluates the rule Query Core applies on mount: enabled, then refetchOnMount (a value or a function), against the current result's isStale / isFetching. If that calls for a refetch, it returns refetchAndWaitForApplication(observer, hashedQueryKey) and deduplicates concurrent acquisitions of the same key. With it, this test and the refetchOnMount: 'always' / false and staleTime: null variants behave as with a fresh observer. Happy to open a PR.

Vorherrschende Sprache
TypeScript
Sterne
4k
Forks
277
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
148

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TanStack/db

Alle Issues in TanStack/db

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.