Skip to content

Commit

Permalink
Fix re-rendering when another component reuses the same query (#3195)
Browse files Browse the repository at this point in the history
Co-authored-by: Phil Pluckthun <[email protected]>
  • Loading branch information
nathan-knight and kitten authored Apr 28, 2023
1 parent 9d793b2 commit b665828
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 6 deletions.
5 changes: 5 additions & 0 deletions .changeset/fifty-sheep-battle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'urql': patch
---

Avoid unnecessary re-render when two components use the same query but receive unchanging results, due to differing operations
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ There are multiple commands you can run in the root folder to test your changes:

```sh
# TypeScript checks:
pnpnm run check
pnpm run check

# Linting (prettier & eslint):
pnpm run lint
Expand Down
29 changes: 24 additions & 5 deletions packages/react-urql/src/hooks/state.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,29 @@ export const initialState = {
operation: undefined,
};

const isShallowDifferent = (a: any, b: any) => {
if (typeof a != 'object' || typeof b != 'object') return a !== b;
for (const x in a) if (!(x in b)) return true;
for (const x in b) if (a[x] !== b[x]) return true;
// Two operations are considered equal if they have the same key
const areOperationsEqual = (
a: { key: number } | undefined,
b: { key: number } | undefined
) => {
return a === b || !!(a && b && a.key === b.key);
};

/**
* Checks if two objects are shallowly different with a special case for
* 'operation' where it compares the key if they are not the otherwise equal
*/
const isShallowDifferent = <T extends Record<string, any>>(a: T, b: T) => {
for (const key in a) if (!(key in b)) return true;
for (const key in b) {
if (
key === 'operation'
? !areOperationsEqual(a[key], b[key])
: a[key] !== b[key]
) {
return true;
}
}
return false;
};

Expand All @@ -27,7 +46,7 @@ export const computeNextState = <T extends Stateish>(
prevState: T,
result: Partial<T>
): T => {
const newState = {
const newState: T = {
...prevState,
...result,
data:
Expand Down

0 comments on commit b665828

Please sign in to comment.