bugfix: avoid returning stale data in useDocument and useHandle #347
Conversation
This file contains 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
useDocument and useHandle had a footgun where after the input url changed, they would continue returning the old doc/handle for the previous input for 1 or more renders. This behavior could cause problems in downstream computations or useEffect hooks which did not account for this brief inconsistency. This patch fixes the problem by checking whether the input and output match before returning out of the hook. In useHandle we can just check the handle URL directly; in useDocument we need to store some additional state to remember the URL associated with a given doc.
geoffreylitt
commented
May 6, 2024
| @@ -31,6 +31,7 @@ export { | |||
| isValidAutomergeUrl, | |||
| parseAutomergeUrl, | |||
| stringifyAutomergeUrl, | |||
| interpretAsDocumentId, | |||
There was a problem hiding this comment.
any reason not to export this? felt useful
|
I took a stab at simplifying this patch a bit @geoffreylitt -- useHandle it turns out could be mostly deleted and I wanted to at least take a stab at simplifying useDocument. This is where I wound up. On the whole I'm increasingly convinced that we should be using some kind of state management library instead of this but hey, here we are. Tests pass, but note that enabling or disabling the setDoc(v) on line 53 has no effect on the success of the tests. |
|
@pvh I simplified the code further based on your idea, and I also improved the tests to ensure that URL changes lead to immediately updated data on first render. |
|
Merged & shipped in 1.1.10. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
useDocument and useHandle had a footgun where after the input url changed, they would continue returning the old doc/handle for the previous input for 1 or more renders.
This behavior could cause problems in downstream computations or useEffect hooks which did not account for this brief inconsistency.
This patch fixes the problem by checking whether the input and output match before returning out of the hook. In useHandle we can just check the handle URL directly; in useDocument we need to store some additional state to remember the URL associated with a given doc.
tests