-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
refactor(query-core): improve replaceEqualDeep performance #9604
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Sheraff
wants to merge
7
commits into
TanStack:main
from
Sheraff:refactor-query-core-replace-equal-deep-performance
+37
−30
Open
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
e6029db
refactor(query-core): improve replaceEqualDeep performance
Sheraff 5e527f3
try object.prototype that broke eslint in router
Sheraff 1007495
no object flag
Sheraff 25b5bbd
improved version w/ more code
Sheraff 3c69c31
ci: apply automated fixes
autofix-ci[bot] d225d24
Merge branch 'main' into refactor-query-core-replace-equal-deep-perfo...
TkDodo 91494ca
less code, but still 2x faster
Sheraff File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -245,50 +245,104 @@ export function partialMatchKey(a: any, b: any): boolean { | |
| return false | ||
| } | ||
|
|
||
| const hasOwn = Object.prototype.hasOwnProperty | ||
|
|
||
| /** | ||
| * This function returns `a` if `b` is deeply equal. | ||
| * If not, it will replace any deeply equal children of `b` with those of `a`. | ||
| * This can be used for structural sharing between JSON values for example. | ||
| */ | ||
| export function replaceEqualDeep<T>(a: unknown, b: T): T | ||
| export function replaceEqualDeep(a: any, b: any): any { | ||
| export function replaceEqualDeep(a: unknown, b: unknown): any { | ||
| if (a === b) { | ||
| return a | ||
| } | ||
|
|
||
| const array = isPlainArray(a) && isPlainArray(b) | ||
|
|
||
| if (array || (isPlainObject(a) && isPlainObject(b))) { | ||
| const aItems = array ? a : Object.keys(a) | ||
| const aSize = aItems.length | ||
| const bItems = array ? b : Object.keys(b) | ||
| const bSize = bItems.length | ||
| const copy: any = array ? [] : {} | ||
| const aItemsSet = new Set(aItems) | ||
| const aIsArr = isPlainArray(a) | ||
| const bIsArr = isPlainArray(b) | ||
|
|
||
| // both are arrays | ||
| if (aIsArr && bIsArr) { | ||
| const aSize = a.length | ||
| const bSize = b.length | ||
| const copy: Array<unknown> = new Array(bSize) | ||
| let equalItems = 0 | ||
|
|
||
| for (let i = 0; i < bSize; i++) { | ||
| const key = array ? i : bItems[i] | ||
| const aItem = a[i] | ||
| const bItem = b[i] | ||
|
|
||
| // most common case (strict equality) | ||
| if (aItem === bItem) { | ||
| copy[i] = aItem | ||
| if (i < aSize) equalItems++ | ||
| continue | ||
| } | ||
|
|
||
| // either item is not an array or object | ||
| if ( | ||
| ((!array && aItemsSet.has(key)) || array) && | ||
| a[key] === undefined && | ||
| b[key] === undefined | ||
| aItem === null || | ||
| bItem === null || | ||
| typeof aItem !== 'object' || | ||
| typeof bItem !== 'object' | ||
| ) { | ||
| copy[key] = undefined | ||
| equalItems++ | ||
| } else { | ||
| copy[key] = replaceEqualDeep(a[key], b[key]) | ||
| if (copy[key] === a[key] && a[key] !== undefined) { | ||
| equalItems++ | ||
| } | ||
| copy[i] = bItem | ||
| continue | ||
| } | ||
|
|
||
| const v = replaceEqualDeep(aItem, bItem) | ||
| copy[i] = v | ||
| if (v === aItem) equalItems++ | ||
| } | ||
|
|
||
| return aSize === bSize && equalItems === aSize ? a : copy | ||
| } | ||
|
|
||
| return b | ||
| // only 1 is an array | ||
| if (aIsArr || bIsArr) { | ||
| return b | ||
| } | ||
|
|
||
| // at least 1 is not an object | ||
| if (!isPlainObject(a) || !isPlainObject(b)) { | ||
| return b | ||
| } | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. could the "only 1 is an array" case not be removed because we would also go into the "at least 1 is not an object" case and also all tests still pass if I just remove that check, and we could then also inline There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yeah it could, it's just less expensive since we already have the booleans, and |
||
|
|
||
| const aSize = Object.keys(a).length | ||
| const copy: Record<PropertyKey, unknown> = {} | ||
| let equalItems = 0 | ||
| let bSize = 0 | ||
|
|
||
| for (const k in b) { | ||
| bSize++ | ||
|
|
||
| const aItem = a[k] | ||
| const bItem = b[k] | ||
|
|
||
| // most common case (strict equality) | ||
| if (aItem === bItem) { | ||
| copy[k] = aItem | ||
| if (hasOwn.call(a, k)) equalItems++ | ||
| continue | ||
| } | ||
|
|
||
| // either item is not an array or object | ||
| if ( | ||
| aItem === null || | ||
| bItem === null || | ||
| typeof aItem !== 'object' || | ||
| typeof bItem !== 'object' | ||
| ) { | ||
| copy[k] = bItem | ||
| continue | ||
| } | ||
|
|
||
| const v = replaceEqualDeep(aItem, bItem) | ||
| copy[k] = v | ||
| if (v === aItem) equalItems++ | ||
| } | ||
|
|
||
| return aSize === bSize && equalItems === aSize ? a : copy | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -311,13 +365,12 @@ export function shallowEqualObjects<T extends Record<string, any>>( | |
| return true | ||
| } | ||
|
|
||
| export function isPlainArray(value: unknown) { | ||
| export function isPlainArray(value: unknown): value is Array<unknown> { | ||
| return Array.isArray(value) && value.length === Object.keys(value).length | ||
| } | ||
|
|
||
| // Copied from: https://github.com/jonschlinkert/is-plain-object | ||
| // eslint-disable-next-line @typescript-eslint/no-wrapper-object-types | ||
| export function isPlainObject(o: any): o is Object { | ||
| export function isPlainObject(o: any): o is Record<PropertyKey, unknown> { | ||
| if (!hasObjectPrototype(o)) { | ||
| return false | ||
| } | ||
|
|
||
Oops, something went wrong.
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.