Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions src/execution/__tests__/collectFields-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,26 @@ describe('collectFields', () => {

expect(fieldDetailsList).to.have.lengthOf(1);
});

it('prevents infinite loop when deferred fragment is used with same label', () => {
const { newDeferUsages } = collectRootFields(`
query {
...FragmentOne @defer(label: "Foo")
}
fragment FragmentOne on Query {
...FragmentTwo @defer(label: "Bar")
field
}
fragment FragmentTwo on Query {
...FragmentThree @defer(label: "Baz")
}
fragment FragmentThree on Query {
...FragmentOne @defer(label: "Qux")
field
}
`);

expect(newDeferUsages).to.have.lengthOf(4);
});
});
});
57 changes: 41 additions & 16 deletions src/execution/collectFields.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,19 @@ export interface FragmentDetails {
variableSignatures?: ObjMap<GraphQLVariableSignature> | undefined;
}

interface VisitedFragmentNames {
// Fragments that have been visited without @defer.
immediateFragments: Set<string>;
// Map of fragment name to a set of labels that have been visited with @defer.
deferredFragments: Map<string, Set<string | null>>;
}

interface CollectFieldsContext {
schema: GraphQLSchema;
fragments: ObjMap<FragmentDetails>;
variableValues: VariableValues;
runtimeType: GraphQLObjectType;
visitedFragmentNames: Map<string, boolean>;
visitedFragmentNames: VisitedFragmentNames;
hideSuggestions: boolean;
forbiddenDirectiveInstances: Array<DirectiveNode>;
forbidSkipAndInclude: boolean;
Expand Down Expand Up @@ -110,7 +117,10 @@ export function collectFields(
fragments,
variableValues,
runtimeType,
visitedFragmentNames: new Map(),
visitedFragmentNames: {
immediateFragments: new Set(),
deferredFragments: new Map(),
},
hideSuggestions,
forbiddenDirectiveInstances: [],
forbidSkipAndInclude,
Expand Down Expand Up @@ -151,7 +161,10 @@ export function collectSubfields(
fragments,
variableValues,
runtimeType: returnType,
visitedFragmentNames: new Map(),
visitedFragmentNames: {
immediateFragments: new Set(),
deferredFragments: new Map(),
},
hideSuggestions,
forbiddenDirectiveInstances: [],
forbidSkipAndInclude: false,
Expand Down Expand Up @@ -291,26 +304,38 @@ function collectFieldsImpl(
deferUsage,
);

const visitedAsDeferred = visitedFragmentNames.get(fragName);
const visitedAsImmediate =
visitedFragmentNames.immediateFragments.has(fragName);

if (visitedAsImmediate) {
// Even if the fragment is deferred, we don't need to
// collect it again if it has already been visited without @defer.
continue;
}

let maybeNewDeferUsage: DeferUsage | undefined;
if (!newDeferUsage) {
// If this spread is not deferred, it may be skipped when already visited
// as a non-deferred spread. If it was previously visited as a deferred spread,
// it must be revisited.
if (visitedAsDeferred === false) {
continue;

if (newDeferUsage) {
let visitedAsDeferredByLabelSet =
visitedFragmentNames.deferredFragments.get(fragName);
if (!visitedAsDeferredByLabelSet) {
visitedAsDeferredByLabelSet = new Set();
visitedFragmentNames.deferredFragments.set(
fragName,
visitedAsDeferredByLabelSet,
);
}
visitedFragmentNames.set(fragName, false);
maybeNewDeferUsage = deferUsage;
} else {
// If this spread is deferred, it can be skipped if it has already been visited.
if (visitedAsDeferred !== undefined) {
if (visitedAsDeferredByLabelSet.has(newDeferUsage.label ?? null)) {
// If the fragment has already been visited as deferred by the same
// label, skip it.
continue;
}
visitedFragmentNames.set(fragName, true);
newDeferUsages.push(newDeferUsage);
maybeNewDeferUsage = newDeferUsage;
visitedAsDeferredByLabelSet.add(newDeferUsage.label ?? null);
} else {
maybeNewDeferUsage = deferUsage;
visitedFragmentNames.immediateFragments.add(fragName);
}

const fragmentVariableSignatures = fragment.variableSignatures;
Expand Down
84 changes: 84 additions & 0 deletions src/execution/incremental/__tests__/defer-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,90 @@ describe('Execute: defer directive', () => {
});
});

it('Can defer same fragment with different labels', async () => {
const document = parse(`
query HeroNameQuery {
hero {
...TopFragment @defer(label: "DeferTop1")
...TopFragment @defer(label: "DeferTop2")
}
}
fragment TopFragment on Hero {
name
}
`);
const result = await complete(document);
expectJSON(result).toDeepEqual([
{
data: { hero: {} },
pending: [
{ id: '0', path: ['hero'], label: 'DeferTop1' },
{ id: '1', path: ['hero'], label: 'DeferTop2' },
],
hasNext: true,
},
{
hasNext: false,
incremental: [{ id: '0', data: { name: 'Luke' } }],
completed: [{ id: '0' }, { id: '1' }],
},
]);
});

it('Can skip deferred fragment if same label is used', async () => {
const document = parse(`
query HeroNameQuery {
hero {
...TopFragment @defer(label: "DeferTop")
...TopFragment @defer(label: "DeferTop")
}
}
fragment TopFragment on Hero {
name
}
`);
const result = await complete(document);
expectJSON(result).toDeepEqual([
{
data: { hero: {} },
pending: [{ id: '0', path: ['hero'], label: 'DeferTop' }],
hasNext: true,
},
{
hasNext: false,
incremental: [{ id: '0', data: { name: 'Luke' } }],
completed: [{ id: '0' }],
},
]);
});

it('Can skip deferred fragment if no label is used', async () => {
const document = parse(`
query HeroNameQuery {
hero {
...TopFragment @defer
...TopFragment @defer
}
}
fragment TopFragment on Hero {
name
}
`);
const result = await complete(document);
expectJSON(result).toDeepEqual([
{
data: { hero: {} },
pending: [{ id: '0', path: ['hero'] }],
hasNext: true,
},
{
hasNext: false,
incremental: [{ id: '0', data: { name: 'Luke' } }],
completed: [{ id: '0' }],
},
]);
});

it('Can defer an inline fragment', async () => {
const document = parse(`
query HeroNameQuery {
Expand Down
Loading