Skip to content

validation suggestions #12

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.

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

Merged
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
5 changes: 4 additions & 1 deletion src/type/definition.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import type {
import { Kind } from '../language/kinds.js';
import { print } from '../language/printer.js';

import type { GraphQLVariableSignature } from '../utilities/getVariableSignature.js';
import { valueFromASTUntyped } from '../utilities/valueFromASTUntyped.js';

import { assertEnumValueName, assertName } from './assertName.js';
Expand Down Expand Up @@ -977,7 +978,9 @@ export interface GraphQLArgument {
astNode: Maybe<InputValueDefinitionNode>;
}

export function isRequiredArgument(arg: GraphQLArgument): boolean {
export function isRequiredArgument(
arg: GraphQLArgument | GraphQLVariableSignature,
): boolean {
return isNonNullType(arg.type) && arg.defaultValue === undefined;
}

Expand Down
136 changes: 78 additions & 58 deletions src/utilities/TypeInfo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ import type { Maybe } from '../jsutils/Maybe.js';

import type {
ASTNode,
DocumentNode,
FieldNode,
FragmentDefinitionNode,
FragmentSpreadNode,
} from '../language/ast.js';
import { isNode } from '../language/ast.js';
import { Kind } from '../language/kinds.js';
Expand Down Expand Up @@ -35,8 +35,14 @@ import {
import type { GraphQLDirective } from '../type/directives.js';
import type { GraphQLSchema } from '../type/schema.js';

import type { GraphQLVariableSignature } from './getVariableSignature.js';
import { getVariableSignature } from './getVariableSignature.js';
import { typeFromAST } from './typeFromAST.js';
import { valueFromAST } from './valueFromAST.js';

export interface FragmentSignature {
readonly definition: FragmentDefinitionNode;
readonly variableSignatures: Map<string, GraphQLVariableSignature>;
}

/**
* TypeInfo is a utility class which, given a GraphQL schema, can keep track
Expand All @@ -53,8 +59,12 @@ export class TypeInfo {
private _directive: Maybe<GraphQLDirective>;
private _argument: Maybe<GraphQLArgument>;
private _enumValue: Maybe<GraphQLEnumValue>;
private _fragmentSpread: Maybe<FragmentSpreadNode>;
private _fragmentDefinitions: Map<string, FragmentDefinitionNode>;
private _fragmentSignaturesByName: (
fragmentName: string,
) => Maybe<FragmentSignature>;

private _fragmentSignature: Maybe<FragmentSignature>;
private _fragmentArgument: Maybe<GraphQLVariableSignature>;
private _getFieldDef: GetFieldDefFn;

constructor(
Expand All @@ -66,7 +76,10 @@ export class TypeInfo {
initialType?: Maybe<GraphQLType>,

/** @deprecated will be removed in 17.0.0 */
getFieldDefFn?: GetFieldDefFn,
getFieldDefFn?: Maybe<GetFieldDefFn>,
fragmentSignatures?: Maybe<
(fragmentName: string) => Maybe<FragmentSignature>
>,
) {
this._schema = schema;
this._typeStack = [];
Expand All @@ -77,8 +90,9 @@ export class TypeInfo {
this._directive = null;
this._argument = null;
this._enumValue = null;
this._fragmentSpread = null;
this._fragmentDefinitions = new Map();
this._fragmentSignaturesByName = fragmentSignatures ?? (() => null);
this._fragmentSignature = null;
this._fragmentArgument = null;
this._getFieldDef = getFieldDefFn ?? getFieldDef;
if (initialType) {
if (isInputType(initialType)) {
Expand Down Expand Up @@ -129,6 +143,20 @@ export class TypeInfo {
return this._argument;
}

getFragmentSignature(): Maybe<FragmentSignature> {
return this._fragmentSignature;
}

getFragmentSignatureByName(): (
fragmentName: string,
) => Maybe<FragmentSignature> {
return this._fragmentSignaturesByName;
}

getFragmentArgument(): Maybe<GraphQLVariableSignature> {
return this._fragmentArgument;
}

getEnumValue(): Maybe<GraphQLEnumValue> {
return this._enumValue;
}
Expand All @@ -141,14 +169,9 @@ export class TypeInfo {
// which occurs before guarantees of schema and document validity.
switch (node.kind) {
case Kind.DOCUMENT: {
// A document's fragment definitions are type signatures
// referenced via fragment spreads. Ensure we can use definitions
// before visiting their call sites.
for (const astNode of node.definitions) {
if (astNode.kind === Kind.FRAGMENT_DEFINITION) {
this._fragmentDefinitions.set(astNode.name.value, astNode);
}
}
const fragmentSignatures = getFragmentSignatures(schema, node);
this._fragmentSignaturesByName = (fragmentName: string) =>
fragmentSignatures.get(fragmentName);
break;
}
case Kind.SELECTION_SET: {
Expand Down Expand Up @@ -181,7 +204,9 @@ export class TypeInfo {
break;
}
case Kind.FRAGMENT_SPREAD: {
this._fragmentSpread = node;
this._fragmentSignature = this.getFragmentSignatureByName()(
node.name.value,
);
break;
}
case Kind.INLINE_FRAGMENT:
Expand All @@ -203,52 +228,24 @@ export class TypeInfo {
case Kind.ARGUMENT: {
let argDef;
let argType: unknown;
const directive = this.getDirective();
const fragmentSpread = this._fragmentSpread;
const fieldDef = this.getFieldDef();
if (directive) {
argDef = directive.args.find((arg) => arg.name === node.name.value);
} else if (fragmentSpread) {
const fragmentDef = this._fragmentDefinitions.get(
fragmentSpread.name.value,
);
const fragVarDef = fragmentDef?.variableDefinitions?.find(
(varDef) => varDef.variable.name.value === node.name.value,
);
if (fragVarDef) {
const fragVarType = typeFromAST(schema, fragVarDef.type);
if (isInputType(fragVarType)) {
const fragVarDefault = fragVarDef.defaultValue
? valueFromAST(fragVarDef.defaultValue, fragVarType)
: undefined;

// Minor hack: transform the FragmentArgDef
// into a schema Argument definition, to
// enable visiting identically to field/directive args
const schemaArgDef: GraphQLArgument = {
name: fragVarDef.variable.name.value,
type: fragVarType,
defaultValue: fragVarDefault,
description: undefined,
deprecationReason: undefined,
extensions: {},
astNode: {
...fragVarDef,
kind: Kind.INPUT_VALUE_DEFINITION,
name: fragVarDef.variable.name,
},
};
argDef = schemaArgDef;
}
const fragmentSignature = this.getFragmentSignature();
if (fragmentSignature) {
argDef = fragmentSignature?.variableSignatures.get(node.name.value);
this._fragmentArgument = argDef;
} else {
const fieldOrDirective = this.getDirective() ?? this.getFieldDef();
if (fieldOrDirective) {
argDef = fieldOrDirective.args.find(
(arg) => arg.name === node.name.value,
);
this._argument = argDef;
}
} else if (fieldDef) {
argDef = fieldDef.args.find((arg) => arg.name === node.name.value);
}

if (argDef) {
argType = argDef.type;
}

this._argument = argDef;
this._defaultValueStack.push(argDef ? argDef.defaultValue : undefined);
this._inputTypeStack.push(isInputType(argType) ? argType : undefined);
break;
Expand Down Expand Up @@ -298,7 +295,8 @@ export class TypeInfo {
leave(node: ASTNode) {
switch (node.kind) {
case Kind.DOCUMENT:
this._fragmentDefinitions = new Map();
this._fragmentSignaturesByName = /* c8 ignore start */ () =>
null /* c8 ignore end */;
break;
case Kind.SELECTION_SET:
this._parentTypeStack.pop();
Expand All @@ -311,7 +309,7 @@ export class TypeInfo {
this._directive = null;
break;
case Kind.FRAGMENT_SPREAD:
this._fragmentSpread = null;
this._fragmentSignature = null;
break;
case Kind.OPERATION_DEFINITION:
case Kind.INLINE_FRAGMENT:
Expand All @@ -323,6 +321,7 @@ export class TypeInfo {
break;
case Kind.ARGUMENT:
this._argument = null;
this._fragmentArgument = null;
this._defaultValueStack.pop();
this._inputTypeStack.pop();
break;
Expand Down Expand Up @@ -354,6 +353,27 @@ function getFieldDef(
return schema.getField(parentType, fieldNode.name.value);
}

function getFragmentSignatures(
schema: GraphQLSchema,
document: DocumentNode,
): Map<string, FragmentSignature> {
const fragmentSignatures = new Map<string, FragmentSignature>();
for (const definition of document.definitions) {
if (definition.kind === Kind.FRAGMENT_DEFINITION) {
const variableSignatures = new Map<string, GraphQLVariableSignature>();
if (definition.variableDefinitions) {
for (const variableNode of definition.variableDefinitions) {
const signature = getVariableSignature(schema, variableNode);
variableSignatures.set(signature.name, signature);
}
}
const signature = { definition, variableSignatures };
fragmentSignatures.set(definition.name.value, signature);
}
}
return fragmentSignatures;
}

/**
* Creates a new visitor instance which maintains a provided TypeInfo instance
* along with visiting visitor.
Expand Down
3 changes: 3 additions & 0 deletions src/utilities/__tests__/TypeInfo-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ describe('TypeInfo', () => {
expect(typeInfo.getFieldDef()).to.equal(undefined);
expect(typeInfo.getDefaultValue()).to.equal(undefined);
expect(typeInfo.getDirective()).to.equal(null);
expect(typeInfo.getFragmentSignature()).to.equal(null);
expect(typeInfo.getFragmentSignatureByName()('')).to.equal(null);
expect(typeInfo.getFragmentArgument()).to.equal(null);
expect(typeInfo.getArgument()).to.equal(null);
expect(typeInfo.getEnumValue()).to.equal(null);
});
Expand Down
32 changes: 32 additions & 0 deletions src/utilities/getVariableSignature.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import type { VariableDefinitionNode } from '../language/ast.js';

import type { GraphQLType } from '../type/definition.js';
import { isInputType } from '../type/definition.js';
import type { GraphQLSchema } from '../type/schema.js';

import { typeFromAST } from './typeFromAST.js';
import { valueFromAST } from './valueFromAST.js';

export interface GraphQLVariableSignature {
readonly name: string;
readonly type: GraphQLType | undefined;
readonly defaultValue: unknown;
readonly definition: VariableDefinitionNode;
}

export function getVariableSignature(
schema: GraphQLSchema,
varDefNode: VariableDefinitionNode,
): GraphQLVariableSignature {
const varName = varDefNode.variable.name.value;
const varType = typeFromAST(schema, varDefNode.type);

return {
name: varName,
type: varType,
defaultValue: isInputType(varType)
? valueFromAST(varDefNode.defaultValue, varType)
: undefined,
definition: varDefNode,
};
}
Loading
Loading