Skip to content

Support deferStream when loading queries #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
XiNiHa merged 2 commits into from
Sep 4, 2025
Merged

Support deferStream when loading queries #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46738f1
Support `deferStream` when loading queries
sairion Sep 4, 2025
2853583
make `deferStream` option non-reactive
sairion Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion src/primitives/createFragment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,25 @@ type FragmentResult<T> =
export function createFragment<TKey extends KeyType>(
fragment: GraphQLTaggedNode,
key: Accessor<TKey>,
options?: {
deferStream?: boolean;
},
): DataStore<KeyTypeData<TKey>>;
export function createFragment<TKey extends KeyType>(
fragment: GraphQLTaggedNode,
key: Accessor<TKey | null | undefined>,
options?: {
deferStream?: boolean;
},
): DataStore<KeyTypeData<TKey> | null | undefined>;
export function createFragment<TKey extends KeyType>(
fragment: GraphQLTaggedNode,
key: Accessor<TKey | null | undefined>,
options?: {
deferStream?: boolean;
},
): DataStore<KeyTypeData<TKey> | null | undefined> {
return createFragmentInternal(fragment, key);
return createFragmentInternal(fragment, key, undefined, options);
}

export function createFragmentInternal<TKey extends KeyType>(
Expand All @@ -51,6 +60,9 @@ export function createFragmentInternal<TKey extends KeyType>(
options?: Accessor<{
parentOperation: Subscribable<GraphQLResponse> | null | undefined;
}>,
createResourceOptions?: {
deferStream?: boolean;
},
): DataStore<KeyTypeData<TKey> | null | undefined> {
const environment = useRelayEnvironment();

Expand Down Expand Up @@ -141,6 +153,7 @@ export function createFragmentInternal<TKey extends KeyType>(
});
},
{
deferStream: createResourceOptions?.deferStream,
onHydrated(source) {
if (!source) return;
setSubscription(
Expand Down
4 changes: 4 additions & 0 deletions src/primitives/createLazyLoadQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export function createLazyLoadQuery<TQuery extends OperationType>(
options?: {
fetchPolicy?: MaybeAccessor<FetchPolicy | undefined>;
networkCacheConfig?: MaybeAccessor<CacheConfig | undefined>;
deferStream?: boolean;
},
): DataStore<TQuery["response"]> {
const environment = useRelayEnvironment();
Expand All @@ -73,6 +74,7 @@ export function createLazyLoadQuery<TQuery extends OperationType>(
fragment: () => getRequest(access(gqlQuery)).fragment,
fetchObservable,
fetchPolicy: () => access(options?.fetchPolicy),
deferStream: options?.deferStream,
});
}

Expand All @@ -84,6 +86,7 @@ export function createLazyLoadQueryInternal<
fetchObservable: Accessor<Observable<GraphQLResponse> | null | undefined>;
fetchKey?: Accessor<string | number | null | undefined>;
fetchPolicy?: Accessor<FetchPolicy | undefined>;
deferStream?: boolean;
}): DataStore<TQuery["response"]> {
const environment = useRelayEnvironment();
const queryCache = createMemo(() => getQueryCache(environment()));
Expand Down Expand Up @@ -163,6 +166,7 @@ export function createLazyLoadQueryInternal<
return stream;
},
{
deferStream: params.deferStream,
onHydrated(operation, { value }) {
if (!operation || !value) return;

Expand Down
15 changes: 15 additions & 0 deletions src/primitives/createRefetchableFragment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,19 @@ export function createRefetchableFragment<
>(
fragment: GraphQLTaggedNode,
key: Accessor<TKey>,
options?: {
deferStream?: boolean;
},
): [DataStore<KeyTypeData<TKey>>, RefetchFnDynamic<TQuery, TKey>];
export function createRefetchableFragment<
TQuery extends OperationType,
TKey extends KeyType,
>(
fragment: GraphQLTaggedNode,
key: Accessor<TKey | null | undefined>,
options?: {
deferStream?: boolean;
},
): [
DataStore<KeyTypeData<TKey> | null | undefined>,
RefetchFnDynamic<TQuery, TKey>,
Expand All @@ -104,13 +110,18 @@ export function createRefetchableFragment<
>(
fragment: GraphQLTaggedNode,
key: Accessor<TKey | null | undefined>,
options?: {
deferStream?: boolean;
},
): [
DataStore<KeyTypeData<TKey> | null | undefined>,
RefetchFnDynamic<TQuery, TKey>,
] {
const { fragmentData, refetch } = createRefetchableFragmentInternal(
fragment,
key,
"createRefetchableFragment()",
options,
);
return [fragmentData, refetch];
}
Expand All @@ -122,6 +133,9 @@ export function createRefetchableFragmentInternal<
fragment: GraphQLTaggedNode,
key: Accessor<TKey | null | undefined>,
componentDisplayName = "createRefetchableFragment()",
options?: {
deferStream?: boolean;
},
): {
fragmentData: DataStore<KeyTypeData<TKey> | null | undefined>;
fragmentRef: Accessor<TKey | null | undefined>;
Expand Down Expand Up @@ -274,6 +288,7 @@ export function createRefetchableFragmentInternal<
() => ({
parentOperation: refetchObservable(),
}),
options,
);

return {
Expand Down
Loading