Skip to content
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

incremental: utilize id and subPath rather than path and label #3960

Merged
merged 3 commits into from
Aug 28, 2023
Merged

incremental: utilize id and subPath rather than path and label #3960

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26c1d78
incremental: add `id`
yaacovCR Aug 25, 2023
6955592
add id and subPath to incremental results
yaacovCR Aug 28, 2023
50cf1e6
add comments
yaacovCR Aug 28, 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
76 changes: 60 additions & 16 deletions src/execution/IncrementalPublisher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ export interface IncrementalDeferResult<
> {
errors?: ReadonlyArray<GraphQLError>;
data: TData;
path: ReadonlyArray<string | number>;
id: string;
subPath?: ReadonlyArray<string | number>;
extensions?: TExtensions;
}

Expand All @@ -110,7 +111,8 @@ export interface FormattedIncrementalDeferResult<
> {
errors?: ReadonlyArray<GraphQLFormattedError>;
data: TData;
path: ReadonlyArray<string | number>;
id: string;
subPath?: ReadonlyArray<string | number>;
extensions?: TExtensions;
}

Expand All @@ -120,7 +122,8 @@ export interface IncrementalStreamResult<
> {
errors?: ReadonlyArray<GraphQLError>;
items: TData;
path: ReadonlyArray<string | number>;
id: string;
subPath?: ReadonlyArray<string | number>;
extensions?: TExtensions;
}

Expand All @@ -130,7 +133,8 @@ export interface FormattedIncrementalStreamResult<
> {
errors?: ReadonlyArray<GraphQLFormattedError>;
items: TData;
path: ReadonlyArray<string | number>;
id: string;
subPath?: ReadonlyArray<string | number>;
extensions?: TExtensions;
}

Expand All @@ -146,13 +150,13 @@ export type FormattedIncrementalResult<
| FormattedIncrementalStreamResult<TData, TExtensions>;

export interface PendingResult {
id: string;
path: ReadonlyArray<string | number>;
label?: string;
}

export interface CompletedResult {
path: ReadonlyArray<string | number>;
label?: string;
id: string;
errors?: ReadonlyArray<GraphQLError>;
}

Expand All @@ -178,6 +182,7 @@ export interface FormattedCompletedResult {
* @internal
*/
export class IncrementalPublisher {
private _nextId = 0;
private _released: Set<SubsequentResultRecord>;
private _pending: Set<SubsequentResultRecord>;

Expand Down Expand Up @@ -372,7 +377,10 @@ export class IncrementalPublisher {
const pendingResults: Array<PendingResult> = [];
for (const pendingSource of pendingSources) {
pendingSource.pendingSent = true;
const id = this._getNextId();
pendingSource.id = id;
const pendingResult: PendingResult = {
id,
path: pendingSource.path,
};
if (pendingSource.label !== undefined) {
Expand All @@ -383,6 +391,10 @@ export class IncrementalPublisher {
return pendingResults;
}

private _getNextId(): string {
return String(this._nextId++);
}

private _subscribe(): AsyncGenerator<
SubsequentIncrementalExecutionResult,
void,
Expand Down Expand Up @@ -554,7 +566,8 @@ export class IncrementalPublisher {
}
const incrementalResult: IncrementalStreamResult = {
items: subsequentResultRecord.items,
path: subsequentResultRecord.streamRecord.path,
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
id: subsequentResultRecord.streamRecord.id!,
robrichard marked this conversation as resolved.
Show resolved Hide resolved
};
if (subsequentResultRecord.errors.length > 0) {
incrementalResult.errors = subsequentResultRecord.errors;
Expand All @@ -571,11 +584,8 @@ export class IncrementalPublisher {
for (const deferredGroupedFieldSetRecord of subsequentResultRecord.deferredGroupedFieldSetRecords) {
if (!deferredGroupedFieldSetRecord.sent) {
deferredGroupedFieldSetRecord.sent = true;
const incrementalResult: IncrementalDeferResult = {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
data: deferredGroupedFieldSetRecord.data!,
path: deferredGroupedFieldSetRecord.path,
};
const incrementalResult: IncrementalDeferResult =
this._getIncrementalDeferResult(deferredGroupedFieldSetRecord);
if (deferredGroupedFieldSetRecord.errors.length > 0) {
incrementalResult.errors = deferredGroupedFieldSetRecord.errors;
}
Expand All @@ -592,15 +602,47 @@ export class IncrementalPublisher {
};
}

private _getIncrementalDeferResult(
deferredGroupedFieldSetRecord: DeferredGroupedFieldSetRecord,
): IncrementalDeferResult {
const { data, deferredFragmentRecords } = deferredGroupedFieldSetRecord;
let maxLength = deferredFragmentRecords[0].path.length;
let maxIndex = 0;
for (let i = 1; i < deferredFragmentRecords.length; i++) {
const deferredFragmentRecord = deferredFragmentRecords[i];
const length = deferredFragmentRecord.path.length;
if (length > maxLength) {
maxLength = length;
maxIndex = i;
}
}
const recordWithLongestPath = deferredFragmentRecords[maxIndex];
const longestPath = recordWithLongestPath.path;
const subPath = deferredGroupedFieldSetRecord.path.slice(
longestPath.length,
);
const id = recordWithLongestPath.id;
const incrementalDeferResult: IncrementalDeferResult = {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
data: data!,
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
id: id!,
};

if (subPath.length > 0) {
incrementalDeferResult.subPath = subPath;
}

return incrementalDeferResult;
}

private _completedRecordToResult(
completedRecord: DeferredFragmentRecord | StreamRecord,
): CompletedResult {
const result: CompletedResult = {
path: completedRecord.path,
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
id: completedRecord.id!,
};
if (completedRecord.label !== undefined) {
result.label = completedRecord.label;
}
if (completedRecord.errors.length > 0) {
result.errors = completedRecord.errors;
}
Expand Down Expand Up @@ -736,6 +778,7 @@ export class DeferredGroupedFieldSetRecord {
export class DeferredFragmentRecord {
path: ReadonlyArray<string | number>;
label: string | undefined;
id: string | undefined;
children: Set<SubsequentResultRecord>;
deferredGroupedFieldSetRecords: Set<DeferredGroupedFieldSetRecord>;
errors: Array<GraphQLError>;
Expand All @@ -758,6 +801,7 @@ export class DeferredFragmentRecord {
export class StreamRecord {
label: string | undefined;
path: ReadonlyArray<string | number>;
id: string | undefined;
errors: Array<GraphQLError>;
earlyReturn?: (() => Promise<unknown>) | undefined;
pendingSent?: boolean;
Expand Down
Loading