UNPKG

graphql

Version:

A Query Language and Runtime which can target any service.

1 lines • 8.21 kB
{"version":3,"file":"DeferStreamDirectiveOnRootFieldRule.mjs","sourceRoot":"","sources":["../../../src/validation/rules/DeferStreamDirectiveOnRootFieldRule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,qCAAoC;AAY3D,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,kCAAiC;AAuClC,MAAM,UAAU,mCAAmC,CACjD,OAA0B;IAE1B,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC3C,OAAO;QACL,mBAAmB,CAAC,IAA6B;YAC/C,IAAI,IAAI,CAAC,SAAS,KAAK,cAAc,IAAI,IAAI,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;gBACvE,OAAO;YACT,CAAC;YACD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;YACnC,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACpD,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;gBAC3C,IACE,iBAAiB,CAAC;oBAChB,OAAO;oBACP,aAAa,EAAE,IAAI,CAAC,SAAS;oBAC7B,QAAQ;oBACR,gBAAgB;oBAChB,YAAY,EAAE,IAAI,CAAC,YAAY;oBAC/B,gBAAgB;iBACjB,CAAC,EACF,CAAC;oBACD,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;wBACpC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBAC7B,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,EACzB,OAAO,EACP,aAAa,EACb,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,GAQjB;IACC,IAAI,KAAK,GAAG,IAAI,CAAC;IACjB,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;QAChD,IAAI,SAAS,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,EAAE,IAAI,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,sBAAsB,CAAC,IAAI,CACpD,CAAC;YACF,IAAI,MAAM,EAAE,CAAC;gBACX,KAAK,GAAG,KAAK,CAAC;gBACd,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,2CAA2C,aAAa,UAAU,QAAQ,IAAI,EAC9E,EAAE,KAAK,EAAE,MAAM,EAAE,CAClB,CACF,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,IAAI,SAAS,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;YAC/C,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1C,IAAI,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;gBACvC,SAAS;YACX,CAAC;YACD,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACnD,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,KAAK,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;gBAC3C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,KAAK,GAAG,KAAK,CAAC;oBACd,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,0CAA0C,aAAa,UAAU,QAAQ,IAAI,EAC7E,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;oBACxC,KAAK;wBACH,iBAAiB,CAAC;4BAChB,OAAO;4BACP,aAAa;4BACb,QAAQ;4BACR,gBAAgB;4BAChB,YAAY,EAAE,QAAQ,CAAC,YAAY;4BACnC,gBAAgB;yBACjB,CAAC,IAAI,KAAK,CAAC;gBAChB,CAAC;YACH,CAAC;QACH,CAAC;aAAM,IAAI,SAAS,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,KAAK,GAAG,KAAK,CAAC;gBACd,OAAO,CAAC,WAAW,CACjB,IAAI,YAAY,CACd,0CAA0C,aAAa,UAAU,QAAQ,IAAI,EAC7E,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CACF,CAAC;YACJ,CAAC;YACD,KAAK;gBACH,iBAAiB,CAAC;oBAChB,OAAO;oBACP,aAAa;oBACb,QAAQ;oBACR,gBAAgB;oBAChB,YAAY,EAAE,SAAS,CAAC,YAAY;oBACpC,gBAAgB;iBACjB,CAAC,IAAI,KAAK,CAAC;QAChB,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAiD;IAC1E,OAAO,QAAQ,CAAC,UAAU,EAAE,IAAI,CAC9B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,KAAK,qBAAqB,CAAC,IAAI,CACnD,CAAC;AACJ,CAAC","sourcesContent":["/** @category Validation Rules */\n\nimport { GraphQLError } from '../../error/GraphQLError.ts';\n\nimport type {\n FragmentSpreadNode,\n InlineFragmentNode,\n OperationDefinitionNode,\n OperationTypeNode,\n SelectionSetNode,\n} from '../../language/ast.ts';\nimport type { ASTVisitor } from '../../language/visitor.ts';\n\nimport type { GraphQLObjectType } from '../../type/definition.ts';\nimport {\n GraphQLDeferDirective,\n GraphQLStreamDirective,\n} from '../../type/directives.ts';\n\nimport type { ValidationContext } from '../ValidationContext.ts';\n\n/**\n * Defer and stream directives are used on valid root field\n *\n * A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.\n * @param context - The validation context used while checking the document.\n * @returns A visitor that reports validation errors for this rule.\n * @example\n * ```ts\n * import { parse } from 'graphql/language';\n * import { buildSchema } from 'graphql/utilities';\n * import {\n * validate,\n * DeferStreamDirectiveOnRootFieldRule,\n * } from 'graphql/validation';\n *\n * const schema = buildSchema(`\n * type Query {\n * message: String\n * }\n *\n * type Mutation {\n * updateMessage: String\n * }\n * `);\n * const invalidDocument = parse(`\n * mutation { ... @defer { updateMessage } }\n * `);\n * const validDocument = parse(`\n * { ... @defer { message } }\n * `);\n *\n * validate(schema, invalidDocument, [DeferStreamDirectiveOnRootFieldRule]).length; // => 1\n * validate(schema, validDocument, [DeferStreamDirectiveOnRootFieldRule]); // => []\n * ```\n */\nexport function DeferStreamDirectiveOnRootFieldRule(\n context: ValidationContext,\n): ASTVisitor {\n const checkedFragments = new Set<string>();\n return {\n OperationDefinition(node: OperationDefinitionNode) {\n if (node.operation !== 'subscription' && node.operation !== 'mutation') {\n return;\n }\n const schema = context.getSchema();\n const rootType = schema.getRootType(node.operation);\n if (rootType) {\n const visitedFragments = new Set<string>();\n if (\n forbidDeferStream({\n context,\n operationType: node.operation,\n rootType,\n checkedFragments,\n selectionSet: node.selectionSet,\n visitedFragments,\n })\n ) {\n for (const name of visitedFragments) {\n checkedFragments.add(name);\n }\n }\n }\n },\n };\n}\n\nfunction forbidDeferStream({\n context,\n operationType,\n rootType,\n checkedFragments,\n selectionSet,\n visitedFragments,\n}: {\n context: ValidationContext;\n operationType: OperationTypeNode;\n rootType: GraphQLObjectType;\n checkedFragments: Set<string>;\n selectionSet: SelectionSetNode;\n visitedFragments: Set<string>;\n}): boolean {\n let valid = true;\n for (const selection of selectionSet.selections) {\n if (selection.kind === 'Field') {\n const stream = selection.directives?.find(\n (d) => d.name.value === GraphQLStreamDirective.name,\n );\n if (stream) {\n valid = false;\n context.reportError(\n new GraphQLError(\n `Stream directive cannot be used on root ${operationType} type \"${rootType}\".`,\n { nodes: stream },\n ),\n );\n }\n } else if (selection.kind === 'FragmentSpread') {\n const fragmentName = selection.name.value;\n if (visitedFragments.has(fragmentName)) {\n continue;\n }\n visitedFragments.add(fragmentName);\n const fragment = context.getFragment(fragmentName);\n if (fragment) {\n const defer = getDeferDirective(selection);\n if (defer !== undefined) {\n valid = false;\n context.reportError(\n new GraphQLError(\n `Defer directive cannot be used on root ${operationType} type \"${rootType}\".`,\n { nodes: defer },\n ),\n );\n }\n if (!checkedFragments.has(fragmentName)) {\n valid =\n forbidDeferStream({\n context,\n operationType,\n rootType,\n checkedFragments,\n selectionSet: fragment.selectionSet,\n visitedFragments,\n }) && valid;\n }\n }\n } else if (selection.kind === 'InlineFragment') {\n const defer = getDeferDirective(selection);\n if (defer !== undefined) {\n valid = false;\n context.reportError(\n new GraphQLError(\n `Defer directive cannot be used on root ${operationType} type \"${rootType}\".`,\n { nodes: defer },\n ),\n );\n }\n valid =\n forbidDeferStream({\n context,\n operationType,\n rootType,\n checkedFragments,\n selectionSet: selection.selectionSet,\n visitedFragments,\n }) && valid;\n }\n }\n return valid;\n}\n\nfunction getDeferDirective(fragment: FragmentSpreadNode | InlineFragmentNode) {\n return fragment.directives?.find(\n (d) => d.name.value === GraphQLDeferDirective.name,\n );\n}\n"]}