Evaluate signed-zero equality for QueryObserver snapshots

Open
#12,567 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
react, typescript
Domain
frontend, testing

Research direction

Start with the signed-zero regression case in packages/query-core/src/__tests__/queryObserver.test.tsx, then read the result comparison in packages/query-core/src/queryObserver.ts and shallowEqualObjects in packages/query-core/src/utils.ts. This issue asks maintainers to decide the intended equality semantics, including effects on notifications, NaN, and snapshot caching; it is design work rather than a scoped first contribution. Done means the behavior is documented and, if changed, regression tests cover the optimistic result, current snapshot, and affected equality and notification behavior.

Written by the indexing model from the issue text.

Description

Summary

Evaluate whether QueryObserver snapshots should distinguish -0 from 0 when selected placeholder data changes. This is a follow-up for maintainers to decide the desired equality semantics; it does not assume that a global equality change is required.

Reproduction and current behavior

In the signed-zero regression case in packages/query-core/src/__tests__/queryObserver.test.tsx, create an observer with enabled: false, placeholderData: 1, structuralSharing: false, and a selector returning -0. Update the options to use a selector returning 0, then call getOptimisticResult with the updated options.

The PR author verified that the optimistic result contains 0, while getCurrentResult().data still contains -0. The shallow comparison treats these values as equal and preserves the current snapshot. The useQuery render in this case uses the optimistic result.

Decision and affected areas

Review the observer result comparison and update behavior in packages/query-core/src/queryObserver.ts and shallowEqualObjects in packages/query-core/src/utils.ts. Consider whether signed zeros should count as different, and whether any change should be local to observer results or use Object.is semantics more broadly. Assess effects on notifications, render optimizations, other equality cases such as NaN, and the useSyncExternalStore snapshot caching contract.

Acceptance criteria

  • Maintainers decide and document the intended signed-zero behavior for observer snapshots.
  • If a change is warranted, implement the chosen behavior without breaking snapshot stability or notification semantics.
  • If a change is made, add regression coverage for the chosen behavior, including the optimistic result and current snapshot, and cover any affected equality and notification behavior.

Context

Dominant language
TypeScript
Stars
50.6k
Forks
4.2k
Avg merge
8h 37m
Merged PRs (30d)
450

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from TanStack/query

All issues in TanStack/query

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.