[Experimental] Support promises as fallback data #2891
Merged
Conversation
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
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
promer94
reviewed
Feb 16, 2024
There was a problem hiding this comment.
I think we should avoid upgrading react to a specific version here?
we currently have a spearte testing workflow for react@canary at https://github.com/vercel/swr/actions/workflows/test-canary.yml
so i guess we could create a sperate jest config for this and only test it in react canary ?
promer94
reviewed
Feb 16, 2024
shuding
commented
Feb 16, 2024
huozhi
approved these changes
Feb 16, 2024
|
@shuding I think this broke something with our types. We modify the type of // We can be confident that data will be nonnull even if the request fails,
// if we defined fallbackData in the config.
data: SWRConfig extends { fallbackData: Response }
? Response
: Response | undefined;This is part of the bigger hook: import { AxiosError } from "axios";
import { useCallback } from "react";
import useSWR, { KeyedMutator, SWRConfiguration } from "swr";
export type Refresh = () => Promise<unknown>;
type GetApi = any;
export const useZmClient = <
Path extends keyof GetApi,
Request extends GetApi[Path]["request"],
Response extends GetApi[Path]["response"],
SWRConfig extends SWRConfiguration<Response>,
>({
path,
pause,
args,
swrConfig,
additionalKey,
}: {
path: Path;
pause?: boolean;
args?: Request;
swrConfig?: SWRConfig;
additionalKey?: string;
}): {
// We can be confident that data will be nonnull even if the request fails,
// if we defined fallbackData in the config.
data: SWRConfig extends { fallbackData: Response }
? Response
: Response | undefined;
error: AxiosError<{ code?: string }> | undefined;
mutate: KeyedMutator<Response>;
refresh: Refresh;
} => {
const swrKey = [path, JSON.stringify(args)];
if (additionalKey) {
swrKey.push(additionalKey);
}
const { data, error, mutate } = useSWR(
pause ? null : swrKey,
() => null as any,
swrConfig,
);
const refresh = useCallback(async () => {
await mutate();
}, [mutate]);
return { data: data!, error, mutate, refresh };
};This will now give a type error: I think it would be nice to either:
Or maybe I'm doing something else wrong. If you'd like me to open an issue or try to fix something, please let me know! |
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.
This PR introduces the ability to accept promises as fallback data for SWR read hooks. The behavior is that the resolved value of the promise will be used as fallback instead of the promise itself.
The resolution of the promise is implemented via
usewhich means that it will suspend the upper boundary.