fix(adapters): make shallow equality handle Temporal value objects#272
Open
mfrancis107 wants to merge 3 commits intoTanStack:mainfrom
Open
fix(adapters): make shallow equality handle Temporal value objects#272mfrancis107 wants to merge 3 commits intoTanStack:mainfrom
mfrancis107 wants to merge 3 commits intoTanStack:mainfrom
Conversation
The adapters’ default `shallow` equality treated any two “keyless” objects as equal (no enumerable keys => no comparisons), which caused Temporal objects to be considered unchanged and skip UI updates. Adjust `shallow` so keyless values are only equal for plain objects/arrays, and use `.equals()` when available (e.g. Temporal) to preserve value semantics. Add Temporal regression coverage across React/Preact/Solid/Vue/Svelte, plus an Angular integration test to ensure Temporal updates trigger re-render.
Enhanced the `shallow` equality function across multiple adapters (React, Preact, Solid, Vue, Svelte, Angular) to correctly handle Temporal value objects. Introduced a method to check for Temporal branding using `Symbol.toStringTag`, ensuring accurate comparisons and triggering UI updates when necessary. Added tests for Temporal support in the relevant frameworks.
Author
|
Updated PR Temporal types (native or polyfill) define So we can combine check Symbol.ToStringTag starts with Temporal. and that the object has .equals method. |
Refactored the `shallow` equality function in Angular, Preact, React, Solid, Svelte, and Vue to improve handling of Temporal objects. The implementation now ensures accurate comparisons by checking `Symbol.toStringTag` for Temporal branding and simplifies the logic for keyless values. Removed redundant checks for plain objects and arrays, enhancing code clarity. Updated tests to reflect these changes and maintain coverage for Temporal support.
Author
|
a bit more cleanup. some of the original work wasn't necessary after change to use string tag check. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎯 Changes
shallowequality to avoid treating all “keyless” objects as equal (Temporal objects expose no enumerable keys)..equals()when available (e.g. Temporal).Why
The adapters default to
shallowequality. Previously,shallowcould returntruefor two different object instances if both had zero enumerable keys, because there were no keys to compare. Temporal types fromtemporal-polyfillare keyless, so updates to Temporal values could be incorrectly treated as “unchanged” and skip UI updates.Behavioral notes
{}vs[]is now treated as not equal (previously could be considered equal due to both being “keyless”).Object.is), or.equals()(Temporal), in which case.equals()is used.Consumers can still provide
options.equalfor custom semantics.Related issues
Fixes:
TanStack/form#1628
#218
Verification in downstream
✅ Checklist
pnpm test:pr.🚀 Release Impact