Conversation
This branch has not been deployed
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
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.
Root cause
preload()never checks the serialized key. With a falsy key (null,false, an empty array, or a key function that throws because its dependencies are not ready),serialize()returns''andpreloadstill callsfetcher(fnArg), so the fetcher runs with that falsy value (for examplefetch('')requests the current page). The result is also stored inPRELOAD[''], so every laterpreload()with a falsy key returns that same stale promise, even with a different fetcher.useSWRtreats a falsy key as "not ready" and never calls the fetcher, sopreload(user ? `/api/user/${user.id}` : null, fetcher)behaves differently from the hook it is meant to warm up.Fix
Return early from
preloadwhen the serialized key is empty, the same way it already returnsundefinedon the server.Test
Added
should not call the fetcher when the key is falsytotest/use-swr-preload.test.tsx. It callspreload(null, fetcher)andpreload(() => { throw ... }, fetcher)and expects the fetcher not to be called. Before the fix it fails withReceived number of calls: 1(called withnull); after the fix the whole preload suite passes.