fix: useContractRead & useContractReads data instability
#659
Conversation
🦋 Changeset detectedLatest commit: ea47b48 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| queryKey_, | ||
| watch, | ||
| ]) | ||
| useInvalidateOnBlock({ enabled: watch && !cacheOnBlock, queryKey: queryKey_ }) |
There was a problem hiding this comment.
The old implementation was refetching on provider changes (as well as block number changes), but we are already checking for provider changes in our query key (via chainId), so it was double fetching. We still want to watch on block number, so I have refactored this to "invalidate on block" if watch & !cacheOnBlock is truthy.
|
I'm not super familair with changesets yet, I've been meaning to dig into it a bit more for our own use, but I've seen when changesets are added that pre-release versions are immediately published. I wonder if you'd be able to set that up for wagmi. Would be super useful. Example in-case you're interested in digging: |
|
Great idea! We can set up Snapshot Releases to do this. There's some work in progress that will make this even easier to set up. Looks like it's moving quickly so can prepare a PR for setting this up. |
| React.useEffect(() => { | ||
| if (!enabled) return | ||
| if (blockNumber === startBlock.current) return | ||
| if (!startBlock.current) { | ||
| startBlock.current = blockNumber | ||
| return | ||
| } | ||
|
|
||
| queryClient.invalidateQueries(queryKey) | ||
| }, [blockNumber, enabled, queryClient, queryKey]) |
There was a problem hiding this comment.
If useBlockNumbers implementation was updated slightly, we could use the onSuccess callback instead of a separate effect here.
There was a problem hiding this comment.
Good idea! Updated, and now the implementation is more basic 👌
|
|
||
| import { useBlockNumber } from '../network-status' | ||
|
|
||
| export function useInvalidateOnBlock({ |
There was a problem hiding this comment.
Think it's useful to have a basic test that checks the query cache between new blocks?
Not easy to do with our current testing setup, but maybe at least we should add a test.todo.
| @@ -11,6 +11,8 @@ import { useProvider, useWebSocketProvider } from '../providers' | |||
| import { useChainId, useQuery } from '../utils' | |||
|
|
|||
| type UseBlockNumberArgs = Partial<FetchBlockNumberArgs> & { | |||
| /** Function fires when a new block is created */ | |||
| onBlock?: (blockNumber: number) => void | |||
Description
Fixes #648.