Skip to content
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

(graphcache) - Increase structural (deep) equality in normalized query results #1859

Merged
merged 12 commits into from
Aug 16, 2021

Conversation

kitten
Copy link
Member

@kitten kitten commented Aug 16, 2021

Resolve #1860

Summary

This change enables Graphcache to compare new query results (from its normalized cache) with previous query results. While we previously had some remaining logic to reuse field values for mutations, we now extended the concept to queries as well. Graphcache will query each field and check whether it has changed, only creating new objects when a selection set has actually changed. This creates structural / deep referential equality in more parts of the query as it changes and potentially helps UI frameworks (e.g. React with useMemo and React.memo) to avoid more work.

In testing, I've noticed that currently (this isn't super optimized yet) this sacrifices about -10% of performance compared to the main branch. However, given that rendering may be much more expensive than querying our normalized cache we currently even deem this worth it. For typical queries we'd expect to see performance drop from an order of 20K operations per second to 18K, which means this won't be noticeable in typical use, but help development a lot.

I've checked the minzipped change of sizes ($ cat exchanges/graphcache/dist/*.min.mjs | gzip-size) and am seeing a change from 9.38kB to 9.61kB, a delta of 230B.

⚠️ Limitation: We're still focusing on UI update performance here, and not strict structural equality. This means that two different queries requesting the same entity with the same selection set will not be referentially equal.

Set of changes

  • Store references to previously queried results in cacheExchange
  • Pass previous references to query operations
  • Refactor query operations (e.g. readSelection) to reuse references as much as possible

@kitten kitten requested a review from JoviDeCroock August 16, 2021 12:32
@changeset-bot
Copy link

changeset-bot bot commented Aug 16, 2021

🦋 Changeset detected

Latest commit: 10feac2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@urql/exchange-graphcache Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

We can reduce the overhead of copying the original piece of
data, which when a previous result is passed happens at least
once, by eagerly writing the data to the object and swapping
it out once it's needed
@kitten
Copy link
Member Author

kitten commented Aug 16, 2021

We've released initial prerelease versions:

Package Version
@urql/exchange-graphcache@deepeql 4.3.0-deepeql.0

This will automatically enable this PR's patch.

@kitten kitten merged commit 37d7e79 into main Aug 16, 2021
@kitten kitten deleted the refactor/graphcache-ref-eql branch August 16, 2021 22:48
@urql-ci urql-ci mentioned this pull request Aug 16, 2021
kitten added a commit that referenced this pull request Aug 17, 2021
kitten added a commit that referenced this pull request Aug 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RFC: Graphcache's query results to maintain structural equality
2 participants