@wundergraph/protographic 0.19.0 → 0.19.2

package/dist/src/selection-set-validation-visitor.js

@@ -0,0 +1,148 @@
+import { Kind, visit, } from 'graphql';
+import { AbstractSelectionRewriter } from './abstract-selection-rewriter.js';
+/**
+ * Validates selection sets within @requires directive field sets.
+ *
+ * This visitor traverses a parsed field set document and ensures that inline
+ * fragments on composite types (interfaces, unions) include `__typename` for
+ * type discrimination in protobuf. The `__typename` field can appear either
+ * in the parent field's selection set or within each inline fragment's
+ * selection set — at least one of these locations must contain it.
+ *
+ * Before validation, the selection set is normalized by the
+ * {@link AbstractSelectionRewriter}, which distributes parent-level fields
+ * (including `__typename`) into each inline fragment.
+ */
+export class SelectionSetValidationVisitor {
+    /**
+     * Creates a new SelectionSetValidationVisitor.
+     *
+     * @param operationDocument - The parsed GraphQL document representing the field set
+     * @param objectType - The root GraphQL object type to validate against
+     * @param schema - The full GraphQL schema, used for normalization of abstract type selections
+     */
+    constructor(operationDocument, objectType, schema) {
+        this.fieldSelectionSetStack = [];
+        this.validationResult = {
+            errors: [],
+            warnings: [],
+        };
+        this.operationDocument = operationDocument;
+        this.objectType = objectType;
+        this.schema = schema;
+        this.normalizeSelectionSet();
+    }
+    /**
+     * Executes the validation by traversing the operation document.
+     * After calling this method, use `getValidationResult()` to retrieve any errors or warnings.
+     */
+    visit() {
+        visit(this.operationDocument, this.createASTVisitor());
+    }
+    /**
+     * Returns the validation result containing any errors and warnings found during traversal.
+     *
+     * @returns The validation result with errors and warnings arrays
+     */
+    getValidationResult() {
+        return this.validationResult;
+    }
+    /**
+     * Normalizes the parsed field set operation by rewriting abstract selections.
+     * This ensures consistent handling of interface and union type selections.
+     */
+    normalizeSelectionSet() {
+        const visitor = new AbstractSelectionRewriter(this.operationDocument, this.schema, this.objectType);
+        visitor.normalize();
+    }
+    /**
+     * Creates the AST visitor configuration for traversing the document.
+     *
+     * @returns An ASTVisitor object with enter/leave handlers for SelectionSet nodes
+     */
+    createASTVisitor() {
+        return {
+            SelectionSet: {
+                enter: (node, key, parent, path, ancestors) => {
+                    return this.onEnterSelectionSet({ node, key, parent, path, ancestors });
+                },
+                leave: (node, key, parent, path, ancestors) => {
+                    this.onLeaveSelectionSet({ node, key, parent, path, ancestors });
+                },
+            },
+        };
+    }
+    /**
+     * Handles entering a selection set node during traversal.
+     *
+     * @param ctx - The visit context containing the selection set node and its parent
+     */
+    onEnterSelectionSet(ctx) {
+        var _a;
+        // When we have no parent, we are at the root of the selection set.
+        if (!ctx.parent) {
+            return;
+        }
+        // We store the ancestor field selection sets on the stack so we can restore them when leaving a nested field.
+        if (this.isFieldNode(ctx.parent)) {
+            if (this.currentFieldSelectionSet) {
+                this.fieldSelectionSetStack.push(this.currentFieldSelectionSet);
+            }
+            this.currentFieldSelectionSet = ctx.node;
+            return;
+        }
+        // We currently only check for inline fragments.
+        if (!this.isInlineFragment(ctx.parent)) {
+            return;
+        }
+        // either the selection set of the inline fragment or the parent selection set must contain __typename.
+        if (!this.selectionSetContainsTypename(ctx.node) &&
+            !this.selectionSetContainsTypename(this.currentFieldSelectionSet)) {
+            const fieldPath = this.getFieldPath(ctx.ancestors);
+            const pathSuffix = fieldPath ? ` in "${fieldPath}"` : '';
+            this.validationResult.errors.push(`Selection set must contain __typename for inline fragment ${(_a = ctx.parent.typeCondition) === null || _a === void 0 ? void 0 : _a.name.value}${pathSuffix}`);
+        }
+    }
+    selectionSetContainsTypename(selectionSet) {
+        if (!selectionSet) {
+            return false;
+        }
+        return selectionSet.selections.some((selection) => selection.kind === Kind.FIELD && selection.name.value === '__typename');
+    }
+    /**
+     * Handles leaving a selection set node during traversal.
+     * Restores the previous field selection set from the stack when leaving a field's selection set.
+     *
+     * @param ctx - The visit context containing the selection set node and its parent
+     */
+    onLeaveSelectionSet(ctx) {
+        if (!ctx.parent) {
+            return;
+        }
+        if (this.isFieldNode(ctx.parent)) {
+            this.currentFieldSelectionSet = this.fieldSelectionSetStack.pop();
+        }
+    }
+    getFieldPath(ancestors) {
+        if (!ancestors) {
+            return '';
+        }
+        return ancestors
+            .filter((a) => this.isFieldNode(a))
+            .map((f) => f.name.value)
+            .join('.');
+    }
+    isInlineFragment(node) {
+        if (Array.isArray(node)) {
+            return false;
+        }
+        return node.kind === Kind.INLINE_FRAGMENT;
+    }
+    isFieldNode(node) {
+        if (Array.isArray(node)) {
+            return false;
+        }
+        return node.kind === Kind.FIELD;
+    }
+}
+//# sourceMappingURL=selection-set-validation-visitor.js.map

package/dist/src/selection-set-validation-visitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"selection-set-validation-visitor.js","sourceRoot":"","sources":["../../src/selection-set-validation-visitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,IAAI,EAEJ,KAAK,GACN,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAE7E;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,6BAA6B;IAYxC;;;;;;OAMG;IACH,YAAY,iBAA+B,EAAE,UAA6B,EAAE,MAAqB;QAjBzF,2BAAsB,GAAuB,EAAE,CAAC;QAKhD,qBAAgB,GAAqB;YAC3C,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,EAAE;SACb,CAAC;QAUA,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,CAAC,qBAAqB,EAAE,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,KAAK,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,mBAAmB;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACK,qBAAqB;QAC3B,MAAM,OAAO,GAAG,IAAI,yBAAyB,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACpG,OAAO,CAAC,SAAS,EAAE,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACK,gBAAgB;QACtB,OAAO;YACL,YAAY,EAAE;gBACZ,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;oBAC5C,OAAO,IAAI,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC1E,CAAC;gBACD,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;oBAC5C,IAAI,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBACnE,CAAC;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,mBAAmB,CAAC,GAAmC;;QAC7D,mEAAmE;QACnE,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QAED,8GAA8G;QAC9G,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,wBAAwB,EAAE,CAAC;gBAClC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAClE,CAAC;YACD,IAAI,CAAC,wBAAwB,GAAG,GAAG,CAAC,IAAI,CAAC;YACzC,OAAO;QACT,CAAC;QAED,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QAED,uGAAuG;QACvG,IACE,CAAC,IAAI,CAAC,4BAA4B,CAAC,GAAG,CAAC,IAAI,CAAC;YAC5C,CAAC,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,wBAAwB,CAAC,EACjE,CAAC;YACD,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACnD,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,QAAQ,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACzD,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAC/B,6DAA6D,MAAA,GAAG,CAAC,MAAM,CAAC,aAAa,0CAAE,IAAI,CAAC,KAAK,GAAG,UAAU,EAAE,CACjH,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,4BAA4B,CAAC,YAA0C;QAC7E,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,YAAY,CAAC,UAAU,CAAC,IAAI,CACjC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,KAAK,YAAY,CACtF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,mBAAmB,CAAC,GAAmC;QAC7D,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC;QACpE,CAAC;IACH,CAAC;IAEO,YAAY,CAAC,SAAsE;QACzF,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO,SAAS;aACb,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;aAClC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;aACxB,IAAI,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAEO,gBAAgB,CAAC,IAAkC;QACzD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAQ,IAAgB,CAAC,IAAI,KAAK,IAAI,CAAC,eAAe,CAAC;IACzD,CAAC;IAEO,WAAW,CAAC,IAAsC;QACxD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAQ,IAAgB,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC;IAC/C,CAAC;CACF"}