import { AccumulatorMap } from '../jsutils/AccumulatorMap.js';
import { invariant } from '../jsutils/invariant.js';
import type { ObjMap } from '../jsutils/ObjMap.js';
import type {
FieldNode,
FragmentDefinitionNode,
FragmentSpreadNode,
InlineFragmentNode,
OperationDefinitionNode,
SelectionSetNode,
} from '../language/ast.js';
import { OperationTypeNode } from '../language/ast.js';
import { Kind } from '../language/kinds.js';
import type { GraphQLObjectType } from '../type/definition.js';
import { isAbstractType } from '../type/definition.js';
import {
GraphQLDeferDirective,
GraphQLIncludeDirective,
GraphQLSkipDirective,
} from '../type/directives.js';
import type { GraphQLSchema } from '../type/schema.js';
import { typeFromAST } from '../utilities/typeFromAST.js';
import { getDirectiveValues } from './values.js';
export interface PatchFields {
label: string | undefined;
fields: Map<string, ReadonlyArray<FieldNode>>;
}
export interface FieldsAndPatches {
fields: Map<string, ReadonlyArray<FieldNode>>;
patches: Array<PatchFields>;
}
export function collectFields(
schema: GraphQLSchema,
fragments: ObjMap<FragmentDefinitionNode>,
variableValues: { [variable: string]: unknown },
runtimeType: GraphQLObjectType,
operation: OperationDefinitionNode,
): FieldsAndPatches {
const fields = new AccumulatorMap<string, FieldNode>();
const patches: Array<PatchFields> = [];
collectFieldsImpl(
schema,
fragments,
variableValues,
operation,
runtimeType,
operation.selectionSet,
fields,
patches,
new Set(),
);
return { fields, patches };
}
export function collectSubfields(
schema: GraphQLSchema,
fragments: ObjMap<FragmentDefinitionNode>,
variableValues: { [variable: string]: unknown },
operation: OperationDefinitionNode,
returnType: GraphQLObjectType,
fieldNodes: ReadonlyArray<FieldNode>,
): FieldsAndPatches {
const subFieldNodes = new AccumulatorMap<string, FieldNode>();
const visitedFragmentNames = new Set<string>();
const subPatches: Array<PatchFields> = [];
const subFieldsAndPatches = {
fields: subFieldNodes,
patches: subPatches,
};
for (const node of fieldNodes) {
if (node.selectionSet) {
collectFieldsImpl(
schema,
fragments,
variableValues,
operation,
returnType,
node.selectionSet,
subFieldNodes,
subPatches,
visitedFragmentNames,
);
}
}
return subFieldsAndPatches;
}
function collectFieldsImpl(
schema: GraphQLSchema,
fragments: ObjMap<FragmentDefinitionNode>,
variableValues: { [variable: string]: unknown },
operation: OperationDefinitionNode,
runtimeType: GraphQLObjectType,
selectionSet: SelectionSetNode,
fields: AccumulatorMap<string, FieldNode>,
patches: Array<PatchFields>,
visitedFragmentNames: Set<string>,
): void {
for (const selection of selectionSet.selections) {
switch (selection.kind) {
case Kind.FIELD: {
if (!shouldIncludeNode(variableValues, selection)) {
continue;
}
fields.add(getFieldEntryKey(selection), selection);
break;
}
case Kind.INLINE_FRAGMENT: {
if (
!shouldIncludeNode(variableValues, selection) ||
!doesFragmentConditionMatch(schema, selection, runtimeType)
) {
continue;
}
const defer = getDeferValues(operation, variableValues, selection);
if (defer) {
const patchFields = new AccumulatorMap<string, FieldNode>();
collectFieldsImpl(
schema,
fragments,
variableValues,
operation,
runtimeType,
selection.selectionSet,
patchFields,
patches,
visitedFragmentNames,
);
patches.push({
label: defer.label,
fields: patchFields,
});
} else {
collectFieldsImpl(
schema,
fragments,
variableValues,
operation,
runtimeType,
selection.selectionSet,
fields,
patches,
visitedFragmentNames,
);
}
break;
}
case Kind.FRAGMENT_SPREAD: {
const fragName = selection.name.value;
if (!shouldIncludeNode(variableValues, selection)) {
continue;
}
const defer = getDeferValues(operation, variableValues, selection);
if (visitedFragmentNames.has(fragName) && !defer) {
continue;
}
const fragment = fragments[fragName];
if (
!fragment ||
!doesFragmentConditionMatch(schema, fragment, runtimeType)
) {
continue;
}
if (!defer) {
visitedFragmentNames.add(fragName);
}
if (defer) {
const patchFields = new AccumulatorMap<string, FieldNode>();
collectFieldsImpl(
schema,
fragments,
variableValues,
operation,
runtimeType,
fragment.selectionSet,
patchFields,
patches,
visitedFragmentNames,
);
patches.push({
label: defer.label,
fields: patchFields,
});
} else {
collectFieldsImpl(
schema,
fragments,
variableValues,
operation,
runtimeType,
fragment.selectionSet,
fields,
patches,
visitedFragmentNames,
);
}
break;
}
}
}
}
function getDeferValues(
operation: OperationDefinitionNode,
variableValues: { [variable: string]: unknown },
node: FragmentSpreadNode | InlineFragmentNode,
): undefined | { label: string | undefined } {
const defer = getDirectiveValues(GraphQLDeferDirective, node, variableValues);
if (!defer) {
return;
}
if (defer.if === false) {
return;
}
invariant(
operation.operation !== OperationTypeNode.SUBSCRIPTION,
'`@defer` directive not supported on subscription operations. Disable `@defer` by setting the `if` argument to `false`.',
);
return {
label: typeof defer.label === 'string' ? defer.label : undefined,
};
}
function shouldIncludeNode(
variableValues: { [variable: string]: unknown },
node: FragmentSpreadNode | FieldNode | InlineFragmentNode,
): boolean {
const skip = getDirectiveValues(GraphQLSkipDirective, node, variableValues);
if (skip?.if === true) {
return false;
}
const include = getDirectiveValues(
GraphQLIncludeDirective,
node,
variableValues,
);
if (include?.if === false) {
return false;
}
return true;
}
function doesFragmentConditionMatch(
schema: GraphQLSchema,
fragment: FragmentDefinitionNode | InlineFragmentNode,
type: GraphQLObjectType,
): boolean {
const typeConditionNode = fragment.typeCondition;
if (!typeConditionNode) {
return true;
}
const conditionalType = typeFromAST(schema, typeConditionNode);
if (conditionalType === type) {
return true;
}
if (isAbstractType(conditionalType)) {
return schema.isSubType(conditionalType, type);
}
return false;
}
function getFieldEntryKey(node: FieldNode): string {
return node.alias ? node.alias.value : node.name.value;
}