Skip to content

Added support for new incremental delivery format #7736

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added support for new incremental delivery format #7736

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
259232a
Added support for new revision of incremental delivery format
nathan-knight Sep 26, 2023
31f0747
Added additional field from new format
nathan-knight Sep 27, 2023
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
13 changes: 13 additions & 0 deletions packages/server/src/externalTypes/incrementalDeliveryPolyfill.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,18 @@ export interface GraphQLExperimentalFormattedInitialIncrementalExecutionResult<
incremental?: ReadonlyArray<
GraphQLExperimentalFormattedIncrementalResult<TData, TExtensions>
>;
pending?: ReadonlyArray<GraphQLExperimentalFormattedPendingIncrementalResult>;
extensions?: TExtensions;
}

// This was introduced in a revision of the incremental delivery format:
// https://github.com/graphql/defer-stream-wg/discussions/69
export interface GraphQLExperimentalFormattedPendingIncrementalResult {
path?: ReadonlyArray<string | number>;
id?: string;
label?: string;
}

export interface GraphQLExperimentalFormattedSubsequentIncrementalExecutionResult<
TData = ObjMap<unknown>,
TExtensions = ObjMap<unknown>,
Expand All @@ -31,6 +40,7 @@ export interface GraphQLExperimentalFormattedSubsequentIncrementalExecutionResul
GraphQLExperimentalFormattedIncrementalResult<TData, TExtensions>
>;
extensions?: TExtensions;
completed?: ReadonlyArray<{ id: string }>;
}

export type GraphQLExperimentalFormattedIncrementalResult<
Expand All @@ -45,6 +55,8 @@ export interface GraphQLExperimentalFormattedIncrementalDeferResult<
TExtensions = ObjMap<unknown>,
> extends FormattedExecutionResult<TData, TExtensions> {
path?: ReadonlyArray<string | number>;
subPath?: ReadonlyArray<string | number>;
id?: string;
label?: string;
}

Expand All @@ -55,6 +67,7 @@ export interface GraphQLExperimentalFormattedIncrementalStreamResult<
errors?: ReadonlyArray<GraphQLFormattedError>;
items?: TData | null;
path?: ReadonlyArray<string | number>;
id?: string;
label?: string;
extensions?: TExtensions;
}
4 changes: 4 additions & 0 deletions packages/server/src/runHttpQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ function orderInitialIncrementalExecutionResultFields(
hasNext: result.hasNext,
errors: result.errors,
data: result.data,
pending: result.pending,
incremental: orderIncrementalResultFields(result.incremental),
extensions: result.extensions,
};
Expand All @@ -368,6 +369,7 @@ function orderSubsequentIncrementalExecutionResultFields(
hasNext: result.hasNext,
incremental: orderIncrementalResultFields(result.incremental),
extensions: result.extensions,
completed: result.completed,
};
}

Expand All @@ -378,6 +380,8 @@ function orderIncrementalResultFields(
hasNext: i.hasNext,
errors: i.errors,
path: i.path,
id: i.id,
subPath: i.subPath,
label: i.label,
data: i.data,
items: i.items,
Expand Down