From 7ca49b2e708bf8d6193b2de7c3dbcdc9774d5fff Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 18:16:40 -0700 Subject: [PATCH 01/31] New GraphQLSemanticNonNull type --- src/type/definition.ts | 111 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 104 insertions(+), 7 deletions(-) diff --git a/src/type/definition.ts b/src/type/definition.ts index 7eaac560dc..2afc002e2f 100644 --- a/src/type/definition.ts +++ b/src/type/definition.ts @@ -66,6 +66,15 @@ export type GraphQLType = | GraphQLEnumType | GraphQLInputObjectType | GraphQLList + > + | GraphQLSemanticNonNull< + | GraphQLScalarType + | GraphQLObjectType + | GraphQLInterfaceType + | GraphQLUnionType + | GraphQLEnumType + | GraphQLInputObjectType + | GraphQLList >; export function isType(type: unknown): type is GraphQLType { @@ -77,7 +86,8 @@ export function isType(type: unknown): type is GraphQLType { isEnumType(type) || isInputObjectType(type) || isListType(type) || - isNonNullType(type) + isNonNullType(type) || + isSemanticNonNullType(type) ); } @@ -203,6 +213,32 @@ export function assertNonNullType(type: unknown): GraphQLNonNull { return type; } +export function isSemanticNonNullType( + type: GraphQLInputType, +): type is GraphQLSemanticNonNull; +export function isSemanticNonNullType( + type: GraphQLOutputType, +): type is GraphQLSemanticNonNull; +export function isSemanticNonNullType( + type: unknown, +): type is GraphQLSemanticNonNull; +export function isSemanticNonNullType( + type: unknown, +): type is GraphQLSemanticNonNull { + return instanceOf(type, GraphQLSemanticNonNull); +} + +export function assertSemanticNonNullType( + type: unknown, +): GraphQLSemanticNonNull { + if (!isSemanticNonNullType(type)) { + throw new Error( + `Expected ${inspect(type)} to be a GraphQL Semantic-Non-Null type.`, + ); + } + return type; +} + /** * These types may be used as input types for arguments and directives. */ @@ -217,6 +253,7 @@ export type GraphQLInputType = | GraphQLInputObjectType | GraphQLList >; +// Note: GraphQLSemanticNonNull is currently not allowed for input types export function isInputType(type: unknown): type is GraphQLInputType { return ( @@ -251,6 +288,14 @@ export type GraphQLOutputType = | GraphQLUnionType | GraphQLEnumType | GraphQLList + > + | GraphQLSemanticNonNull< + | GraphQLScalarType + | GraphQLObjectType + | GraphQLInterfaceType + | GraphQLUnionType + | GraphQLEnumType + | GraphQLList >; export function isOutputType(type: unknown): type is GraphQLOutputType { @@ -414,16 +459,66 @@ export class GraphQLNonNull { } } +/** + * Semantic-Non-Null Type Wrapper + * + * A semantic-non-null is a wrapping type which points to another type. + * Semantic-non-null types enforce that their values are never null unless + * caused by an error being raised. It is useful for fields which you can make + * a guarantee on non-nullability in a no-error case, for example when you know + * that a related entity must exist (but acknowledge that retrieving it may + * produce an error). + * + * Example: + * + * ```ts + * const RowType = new GraphQLObjectType({ + * name: 'Row', + * fields: () => ({ + * email: { type: new GraphQLSemanticNonNull(GraphQLString) }, + * }) + * }) + * ``` + * Note: the enforcement of non-nullability occurs within the executor. + * + * @experimental + */ +export class GraphQLSemanticNonNull { + readonly ofType: T; + + constructor(ofType: T) { + devAssert( + isNullableType(ofType), + `Expected ${inspect(ofType)} to be a GraphQL nullable type.`, + ); + + this.ofType = ofType; + } + + get [Symbol.toStringTag]() { + return 'GraphQLSemanticNonNull'; + } + + toString(): string { + return String(this.ofType) + '*'; + } + + toJSON(): string { + return this.toString(); + } +} + /** * These types wrap and modify other types */ export type GraphQLWrappingType = | GraphQLList - | GraphQLNonNull; + | GraphQLNonNull + | GraphQLSemanticNonNull; export function isWrappingType(type: unknown): type is GraphQLWrappingType { - return isListType(type) || isNonNullType(type); + return isListType(type) || isNonNullType(type) || isSemanticNonNullType(type); } export function assertWrappingType(type: unknown): GraphQLWrappingType { @@ -446,7 +541,7 @@ export type GraphQLNullableType = | GraphQLList; export function isNullableType(type: unknown): type is GraphQLNullableType { - return isType(type) && !isNonNullType(type); + return isType(type) && !isNonNullType(type) && !isSemanticNonNullType(type); } export function assertNullableType(type: unknown): GraphQLNullableType { @@ -458,7 +553,7 @@ export function assertNullableType(type: unknown): GraphQLNullableType { export function getNullableType(type: undefined | null): void; export function getNullableType( - type: T | GraphQLNonNull, + type: T | GraphQLNonNull | GraphQLSemanticNonNull, ): T; export function getNullableType( type: Maybe, @@ -467,12 +562,14 @@ export function getNullableType( type: Maybe, ): GraphQLNullableType | undefined { if (type) { - return isNonNullType(type) ? type.ofType : type; + return isNonNullType(type) || isSemanticNonNullType(type) + ? type.ofType + : type; } } /** - * These named types do not include modifiers like List or NonNull. + * These named types do not include modifiers like List, NonNull, or SemanticNonNull */ export type GraphQLNamedType = GraphQLNamedInputType | GraphQLNamedOutputType; From 16a2114f3e203cef115aaf944d11ea37605fd6db Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 19:28:48 -0700 Subject: [PATCH 02/31] Handle isNonNullType --- src/execution/execute.ts | 23 +++++++++- src/index.ts | 5 +++ src/language/ast.ts | 6 +++ src/language/index.ts | 1 + src/language/kinds.ts | 1 + src/type/__tests__/predicate-test.ts | 42 +++++++++++++++++++ src/type/definition.ts | 6 ++- src/type/index.ts | 3 ++ src/type/introspection.ts | 7 +++- src/utilities/astFromValue.ts | 1 + src/utilities/extendSchema.ts | 5 +++ src/utilities/findBreakingChanges.ts | 20 ++++++++- src/utilities/getIntrospectionQuery.ts | 7 ++++ src/utilities/index.ts | 1 + src/utilities/lexicographicSortSchema.ts | 4 ++ src/utilities/typeComparators.ts | 17 +++++++- .../rules/OverlappingFieldsCanBeMergedRule.ts | 11 ++++- .../rules/ValuesOfCorrectTypeRule.ts | 1 + .../rules/VariablesInAllowedPositionRule.ts | 1 + 19 files changed, 155 insertions(+), 7 deletions(-) diff --git a/src/execution/execute.ts b/src/execution/execute.ts index 55c22ea9de..8d1af1e866 100644 --- a/src/execution/execute.ts +++ b/src/execution/execute.ts @@ -42,6 +42,7 @@ import { isLeafType, isListType, isNonNullType, + isSemanticNonNullType, isObjectType, } from '../type/definition'; import { @@ -115,6 +116,7 @@ export interface ExecutionContext { typeResolver: GraphQLTypeResolver; subscribeFieldResolver: GraphQLFieldResolver; errors: Array; + errorPropagation: boolean; } /** @@ -595,7 +597,7 @@ function handleFieldError( ): null { // If the field type is non-nullable, then it is resolved without any // protection from errors, however it still properly locates the error. - if (isNonNullType(returnType)) { + if (exeContext.errorPropagation && isNonNullType(returnType)) { throw error; } @@ -658,6 +660,25 @@ function completeValue( return completed; } + // If field type is SemanticNonNull, complete for inner type, and throw field error + // if result is null. + if (isSemanticNonNullType(returnType)) { + const completed = completeValue( + exeContext, + returnType.ofType, + fieldNodes, + info, + path, + result, + ); + if (completed === null) { + throw new Error( + `Cannot return null for semantic-non-nullable field ${info.parentType.name}.${info.fieldName}.`, + ); + } + return completed; + } + // If result value is null or undefined then return null. if (result == null) { return null; diff --git a/src/index.ts b/src/index.ts index 877939d879..e3896fbf05 100644 --- a/src/index.ts +++ b/src/index.ts @@ -48,6 +48,7 @@ export { GraphQLInputObjectType, GraphQLList, GraphQLNonNull, + GraphQLSemanticNonNull, // Standard GraphQL Scalars specifiedScalarTypes, GraphQLInt, @@ -95,6 +96,7 @@ export { isInputObjectType, isListType, isNonNullType, + isSemanticNonNullType, isInputType, isOutputType, isLeafType, @@ -120,6 +122,7 @@ export { assertInputObjectType, assertListType, assertNonNullType, + assertSemanticNonNullType, assertInputType, assertOutputType, assertLeafType, @@ -287,6 +290,7 @@ export type { NamedTypeNode, ListTypeNode, NonNullTypeNode, + SemanticNonNullTypeNode, TypeSystemDefinitionNode, SchemaDefinitionNode, OperationTypeDefinitionNode, @@ -480,6 +484,7 @@ export type { IntrospectionNamedTypeRef, IntrospectionListTypeRef, IntrospectionNonNullTypeRef, + IntrospectionSemanticNonNullTypeRef, IntrospectionField, IntrospectionInputValue, IntrospectionEnumValue, diff --git a/src/language/ast.ts b/src/language/ast.ts index 29029342a1..af5704ceae 100644 --- a/src/language/ast.ts +++ b/src/language/ast.ts @@ -540,6 +540,12 @@ export interface NonNullTypeNode { readonly type: NamedTypeNode | ListTypeNode; } +export interface SemanticNonNullTypeNode { + readonly kind: Kind.SEMANTIC_NON_NULL_TYPE; + readonly loc?: Location; + readonly type: NamedTypeNode | ListTypeNode; +} + /** Type System Definition */ export type TypeSystemDefinitionNode = diff --git a/src/language/index.ts b/src/language/index.ts index ec4d195e1a..a760fd21b3 100644 --- a/src/language/index.ts +++ b/src/language/index.ts @@ -67,6 +67,7 @@ export type { NamedTypeNode, ListTypeNode, NonNullTypeNode, + SemanticNonNullTypeNode, TypeSystemDefinitionNode, SchemaDefinitionNode, OperationTypeDefinitionNode, diff --git a/src/language/kinds.ts b/src/language/kinds.ts index cd05f66a3b..e91373746c 100644 --- a/src/language/kinds.ts +++ b/src/language/kinds.ts @@ -37,6 +37,7 @@ enum Kind { NAMED_TYPE = 'NamedType', LIST_TYPE = 'ListType', NON_NULL_TYPE = 'NonNullType', + SEMANTIC_NON_NULL_TYPE = 'SemanticNonNullType', /** Type System Definitions */ SCHEMA_DEFINITION = 'SchemaDefinition', diff --git a/src/type/__tests__/predicate-test.ts b/src/type/__tests__/predicate-test.ts index 81e721e7df..750897012e 100644 --- a/src/type/__tests__/predicate-test.ts +++ b/src/type/__tests__/predicate-test.ts @@ -19,6 +19,7 @@ import { assertListType, assertNamedType, assertNonNullType, + assertSemanticNonNullType, assertNullableType, assertObjectType, assertOutputType, @@ -33,6 +34,7 @@ import { GraphQLInterfaceType, GraphQLList, GraphQLNonNull, + GraphQLSemanticNonNull, GraphQLObjectType, GraphQLScalarType, GraphQLUnionType, @@ -46,6 +48,7 @@ import { isListType, isNamedType, isNonNullType, + isSemanticNonNullType, isNullableType, isObjectType, isOutputType, @@ -298,6 +301,45 @@ describe('Type predicates', () => { expect(() => assertNonNullType(new GraphQLList(new GraphQLNonNull(ObjectType))), ).to.throw(); + expect(isNonNullType(new GraphQLSemanticNonNull(ObjectType))).to.equal( + false, + ); + expect(() => + assertNonNullType(new GraphQLSemanticNonNull(ObjectType)), + ).to.throw(); + }); + }); + + describe('isSemanticNonNullType', () => { + it('returns true for a semantic-non-null wrapped type', () => { + expect( + isSemanticNonNullType(new GraphQLSemanticNonNull(ObjectType)), + ).to.equal(true); + expect(() => + assertSemanticNonNullType(new GraphQLSemanticNonNull(ObjectType)), + ).to.not.throw(); + }); + + it('returns false for an unwrapped type', () => { + expect(isSemanticNonNullType(ObjectType)).to.equal(false); + expect(() => assertSemanticNonNullType(ObjectType)).to.throw(); + }); + + it('returns false for a not non-null wrapped type', () => { + expect( + isSemanticNonNullType( + new GraphQLList(new GraphQLSemanticNonNull(ObjectType)), + ), + ).to.equal(false); + expect(() => + assertSemanticNonNullType( + new GraphQLList(new GraphQLSemanticNonNull(ObjectType)), + ), + ).to.throw(); + expect(isNonNullType(new GraphQLNonNull(ObjectType))).to.equal(false); + expect(() => + assertNonNullType(new GraphQLNonNull(ObjectType)), + ).to.throw(); }); }); diff --git a/src/type/definition.ts b/src/type/definition.ts index 2afc002e2f..f2c9892400 100644 --- a/src/type/definition.ts +++ b/src/type/definition.ts @@ -260,7 +260,9 @@ export function isInputType(type: unknown): type is GraphQLInputType { isScalarType(type) || isEnumType(type) || isInputObjectType(type) || - (isWrappingType(type) && isInputType(type.ofType)) + (!isSemanticNonNullType(type) && + isWrappingType(type) && + isInputType(type.ofType)) ); } @@ -1167,6 +1169,7 @@ export interface GraphQLArgument { } export function isRequiredArgument(arg: GraphQLArgument): boolean { + // Note: input types cannot be SemanticNonNull return isNonNullType(arg.type) && arg.defaultValue === undefined; } @@ -1858,6 +1861,7 @@ export interface GraphQLInputField { } export function isRequiredInputField(field: GraphQLInputField): boolean { + // Note: input types cannot be SemanticNonNull return isNonNullType(field.type) && field.defaultValue === undefined; } diff --git a/src/type/index.ts b/src/type/index.ts index cf276d1e02..0729b840e7 100644 --- a/src/type/index.ts +++ b/src/type/index.ts @@ -23,6 +23,7 @@ export { isInputObjectType, isListType, isNonNullType, + isSemanticNonNullType, isInputType, isOutputType, isLeafType, @@ -43,6 +44,7 @@ export { assertInputObjectType, assertListType, assertNonNullType, + assertSemanticNonNullType, assertInputType, assertOutputType, assertLeafType, @@ -64,6 +66,7 @@ export { // Type Wrappers GraphQLList, GraphQLNonNull, + GraphQLSemanticNonNull, } from './definition'; export type { diff --git a/src/type/introspection.ts b/src/type/introspection.ts index 2c66ca5098..12f7261c1d 100644 --- a/src/type/introspection.ts +++ b/src/type/introspection.ts @@ -6,13 +6,14 @@ import { print } from '../language/printer'; import { astFromValue } from '../utilities/astFromValue'; -import type { +import { GraphQLEnumValue, GraphQLField, GraphQLFieldConfigMap, GraphQLInputField, GraphQLNamedType, GraphQLType, + isSemanticNonNullType, } from './definition'; import { GraphQLEnumType, @@ -237,6 +238,9 @@ export const __Type: GraphQLObjectType = new GraphQLObjectType({ if (isNonNullType(type)) { return TypeKind.NON_NULL; } + if (isSemanticNonNullType(type)) { + return TypeKind.SEMANTIC_NON_NULL; + } /* c8 ignore next 3 */ // Not reachable, all possible types have been considered) invariant(false, `Unexpected type: "${inspect(type)}".`); @@ -452,6 +456,7 @@ enum TypeKind { INPUT_OBJECT = 'INPUT_OBJECT', LIST = 'LIST', NON_NULL = 'NON_NULL', + SEMANTIC_NON_NULL = 'SEMANTIC_NON_NULL', } export { TypeKind }; diff --git a/src/utilities/astFromValue.ts b/src/utilities/astFromValue.ts index 1a880449c8..c605025035 100644 --- a/src/utilities/astFromValue.ts +++ b/src/utilities/astFromValue.ts @@ -42,6 +42,7 @@ export function astFromValue( value: unknown, type: GraphQLInputType, ): Maybe { + // Note: input types cannot be SemanticNonNull if (isNonNullType(type)) { const astValue = astFromValue(value, type.ofType); if (astValue?.kind === Kind.NULL) { diff --git a/src/utilities/extendSchema.ts b/src/utilities/extendSchema.ts index d53752d919..e81917d312 100644 --- a/src/utilities/extendSchema.ts +++ b/src/utilities/extendSchema.ts @@ -59,6 +59,7 @@ import { isInterfaceType, isListType, isNonNullType, + isSemanticNonNullType, isObjectType, isScalarType, isUnionType, @@ -225,6 +226,10 @@ export function extendSchemaImpl( // @ts-expect-error return new GraphQLNonNull(replaceType(type.ofType)); } + if (isSemanticNonNullType(type)) { + // @ts-expect-error + return new GraphQLSemanticNonNull(replaceType(type.ofType)); + } // @ts-expect-error FIXME return replaceNamedType(type); } diff --git a/src/utilities/findBreakingChanges.ts b/src/utilities/findBreakingChanges.ts index 2489af9d62..c7ab88504f 100644 --- a/src/utilities/findBreakingChanges.ts +++ b/src/utilities/findBreakingChanges.ts @@ -22,6 +22,7 @@ import { isListType, isNamedType, isNonNullType, + isSemanticNonNullType, isObjectType, isRequiredArgument, isRequiredInputField, @@ -458,7 +459,10 @@ function isChangeSafeForObjectOrInterfaceField( )) || // moving from nullable to non-null of the same underlying type is safe (isNonNullType(newType) && - isChangeSafeForObjectOrInterfaceField(oldType, newType.ofType)) + isChangeSafeForObjectOrInterfaceField(oldType, newType.ofType)) || + // moving from nullable to semantic-non-null of the same underlying type is safe + (isSemanticNonNullType(newType) && + isChangeSafeForObjectOrInterfaceField(oldType, newType.ofType)) || ); } @@ -470,11 +474,25 @@ function isChangeSafeForObjectOrInterfaceField( ); } + if (isSemanticNonNullType(oldType)) { + return ( + // if they're both semantic-non-null, make sure the underlying types are compatible + (isSemanticNonNullType(newType) && + isChangeSafeForObjectOrInterfaceField(oldType.ofType, newType.ofType)) || + // moving from semantic-non-null to non-null of the same underlying type is safe + isNonNullType(newType) && + isChangeSafeForObjectOrInterfaceField(oldType.ofType, newType.ofType) + ); + } + return ( // if they're both named types, see if their names are equivalent (isNamedType(newType) && oldType.name === newType.name) || // moving from nullable to non-null of the same underlying type is safe (isNonNullType(newType) && + isChangeSafeForObjectOrInterfaceField(oldType, newType.ofType)) || + // moving from nullable to semantic-non-null of the same underlying type is safe + (isSemanticNonNullType(newType) && isChangeSafeForObjectOrInterfaceField(oldType, newType.ofType)) ); } diff --git a/src/utilities/getIntrospectionQuery.ts b/src/utilities/getIntrospectionQuery.ts index c502f0f7b4..e51551e807 100644 --- a/src/utilities/getIntrospectionQuery.ts +++ b/src/utilities/getIntrospectionQuery.ts @@ -285,6 +285,13 @@ export interface IntrospectionNonNullTypeRef< readonly ofType: T; } +export interface IntrospectionSemanticNonNullTypeRef< + T extends IntrospectionTypeRef = IntrospectionTypeRef, +> { + readonly kind: 'SEMANTIC_NON_NULL'; + readonly ofType: T; +} + export type IntrospectionTypeRef = | IntrospectionNamedTypeRef | IntrospectionListTypeRef diff --git a/src/utilities/index.ts b/src/utilities/index.ts index 452b975233..fa69583012 100644 --- a/src/utilities/index.ts +++ b/src/utilities/index.ts @@ -20,6 +20,7 @@ export type { IntrospectionNamedTypeRef, IntrospectionListTypeRef, IntrospectionNonNullTypeRef, + IntrospectionSemanticNonNullTypeRef, IntrospectionField, IntrospectionInputValue, IntrospectionEnumValue, diff --git a/src/utilities/lexicographicSortSchema.ts b/src/utilities/lexicographicSortSchema.ts index 26b6908c9f..728cf23380 100644 --- a/src/utilities/lexicographicSortSchema.ts +++ b/src/utilities/lexicographicSortSchema.ts @@ -25,6 +25,7 @@ import { isInterfaceType, isListType, isNonNullType, + isSemanticNonNullType, isObjectType, isScalarType, isUnionType, @@ -62,6 +63,9 @@ export function lexicographicSortSchema(schema: GraphQLSchema): GraphQLSchema { } else if (isNonNullType(type)) { // @ts-expect-error return new GraphQLNonNull(replaceType(type.ofType)); + } else if (isSemanticNonNullType(type)) { + // @ts-expect-error + return new GraphQLSemanticNonNull(replaceType(type.ofType)); } // @ts-expect-error FIXME: TS Conversion return replaceNamedType(type); diff --git a/src/utilities/typeComparators.ts b/src/utilities/typeComparators.ts index 287be40bfe..79116e482b 100644 --- a/src/utilities/typeComparators.ts +++ b/src/utilities/typeComparators.ts @@ -4,6 +4,7 @@ import { isInterfaceType, isListType, isNonNullType, + isSemanticNonNullType, isObjectType, } from '../type/definition'; import type { GraphQLSchema } from '../type/schema'; @@ -22,6 +23,11 @@ export function isEqualType(typeA: GraphQLType, typeB: GraphQLType): boolean { return isEqualType(typeA.ofType, typeB.ofType); } + // If either type is semantic-non-null, the other must also be semantic-non-null. + if (isSemanticNonNullType(typeA) && isSemanticNonNullType(typeB)) { + return isEqualType(typeA.ofType, typeB.ofType); + } + // If either type is a list, the other must also be a list. if (isListType(typeA) && isListType(typeB)) { return isEqualType(typeA.ofType, typeB.ofType); @@ -52,8 +58,15 @@ export function isTypeSubTypeOf( } return false; } - if (isNonNullType(maybeSubType)) { - // If superType is nullable, maybeSubType may be non-null or nullable. + // If superType is semantic-non-null, maybeSubType must be semantic-non-null or non-null. + if (isSemanticNonNullType(superType)) { + if (isNonNullType(maybeSubType) || isSemanticNonNullType(maybeSubType)) { + return isTypeSubTypeOf(schema, maybeSubType.ofType, superType.ofType); + } + return false; + } + if (isNonNullType(maybeSubType) || isSemanticNonNullType(maybeSubType)) { + // If superType is nullable, maybeSubType may be non-null, semantic-non-null, or nullable. return isTypeSubTypeOf(schema, maybeSubType.ofType, superType); } diff --git a/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts b/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts index 4305064a6f..cba8daf3c5 100644 --- a/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts +++ b/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts @@ -15,10 +15,11 @@ import { Kind } from '../../language/kinds'; import { print } from '../../language/printer'; import type { ASTVisitor } from '../../language/visitor'; -import type { +import { GraphQLField, GraphQLNamedType, GraphQLOutputType, + isSemanticNonNullType, } from '../../type/definition'; import { getNamedType, @@ -695,6 +696,14 @@ function doTypesConflict( if (isNonNullType(type2)) { return true; } + if (isSemanticNonNullType(type1)) { + return isSemanticNonNullType(type2) + ? doTypesConflict(type1.ofType, type2.ofType) + : true; + } + if (isSemanticNonNullType(type2)) { + return true; + } if (isLeafType(type1) || isLeafType(type2)) { return type1 !== type2; } diff --git a/src/validation/rules/ValuesOfCorrectTypeRule.ts b/src/validation/rules/ValuesOfCorrectTypeRule.ts index 3f284d7103..716135effd 100644 --- a/src/validation/rules/ValuesOfCorrectTypeRule.ts +++ b/src/validation/rules/ValuesOfCorrectTypeRule.ts @@ -118,6 +118,7 @@ export function ValuesOfCorrectTypeRule( ), ); } + // Note: SemanticNonNull cannot happen on input. }, EnumValue: (node) => isValidValueNode(context, node), IntValue: (node) => isValidValueNode(context, node), diff --git a/src/validation/rules/VariablesInAllowedPositionRule.ts b/src/validation/rules/VariablesInAllowedPositionRule.ts index a0b7e991a6..2871b49bba 100644 --- a/src/validation/rules/VariablesInAllowedPositionRule.ts +++ b/src/validation/rules/VariablesInAllowedPositionRule.ts @@ -88,6 +88,7 @@ function allowedVariableUsage( locationType: GraphQLType, locationDefaultValue: Maybe, ): boolean { + // Note: SemanticNonNull cannot occur on input. if (isNonNullType(locationType) && !isNonNullType(varType)) { const hasNonNullVariableDefaultValue = varDefaultValue != null && varDefaultValue.kind !== Kind.NULL; From 2b13389e27c4ecb6afbc453bc8fdac1f6aad06c9 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 19:32:11 -0700 Subject: [PATCH 03/31] More fixes --- src/type/__tests__/predicate-test.ts | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/src/type/__tests__/predicate-test.ts b/src/type/__tests__/predicate-test.ts index 750897012e..39cf159dd4 100644 --- a/src/type/__tests__/predicate-test.ts +++ b/src/type/__tests__/predicate-test.ts @@ -336,9 +336,11 @@ describe('Type predicates', () => { new GraphQLList(new GraphQLSemanticNonNull(ObjectType)), ), ).to.throw(); - expect(isNonNullType(new GraphQLNonNull(ObjectType))).to.equal(false); + expect(isSemanticNonNullType(new GraphQLNonNull(ObjectType))).to.equal( + false, + ); expect(() => - assertNonNullType(new GraphQLNonNull(ObjectType)), + assertSemanticNonNullType(new GraphQLNonNull(ObjectType)), ).to.throw(); }); }); @@ -539,6 +541,14 @@ describe('Type predicates', () => { expect(() => assertNullableType(new GraphQLList(new GraphQLNonNull(ObjectType))), ).to.not.throw(); + expect( + isNullableType(new GraphQLList(new GraphQLSemanticNonNull(ObjectType))), + ).to.equal(true); + expect(() => + assertNullableType( + new GraphQLList(new GraphQLSemanticNonNull(ObjectType)), + ), + ).to.not.throw(); }); it('returns false for non-null types', () => { @@ -546,6 +556,12 @@ describe('Type predicates', () => { expect(() => assertNullableType(new GraphQLNonNull(ObjectType)), ).to.throw(); + expect(isNullableType(new GraphQLSemanticNonNull(ObjectType))).to.equal( + false, + ); + expect(() => + assertNullableType(new GraphQLSemanticNonNull(ObjectType)), + ).to.throw(); }); }); From 04a8e91580ca4818ea8b092d54004785ef06f5d6 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 19:35:06 -0700 Subject: [PATCH 04/31] More fixes --- src/type/__tests__/predicate-test.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/type/__tests__/predicate-test.ts b/src/type/__tests__/predicate-test.ts index 39cf159dd4..e3395727bc 100644 --- a/src/type/__tests__/predicate-test.ts +++ b/src/type/__tests__/predicate-test.ts @@ -520,6 +520,12 @@ describe('Type predicates', () => { expect(() => assertWrappingType(new GraphQLNonNull(ObjectType)), ).to.not.throw(); + expect(isWrappingType(new GraphQLSemanticNonNull(ObjectType))).to.equal( + true, + ); + expect(() => + assertWrappingType(new GraphQLSemanticNonNull(ObjectType)), + ).to.not.throw(); }); it('returns false for unwrapped types', () => { From 076a735662059b1894f52e5640d438afaf516d24 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 19:45:32 -0700 Subject: [PATCH 05/31] Yet more updates --- src/language/__tests__/parser-test.ts | 17 +++++++++++++++++ src/language/ast.ts | 7 ++++++- src/language/parser.ts | 8 ++++++++ src/language/predicates.ts | 3 ++- src/language/tokenKind.ts | 1 + src/type/introspection.ts | 5 +++++ src/utilities/__tests__/printSchema-test.ts | 3 +++ src/utilities/buildClientSchema.ts | 9 +++++++++ src/utilities/extendSchema.ts | 4 ++++ src/utilities/getIntrospectionQuery.ts | 3 +++ src/utilities/typeFromAST.ts | 10 +++++++++- 11 files changed, 67 insertions(+), 3 deletions(-) diff --git a/src/language/__tests__/parser-test.ts b/src/language/__tests__/parser-test.ts index 87e7b92c34..596a6d60c7 100644 --- a/src/language/__tests__/parser-test.ts +++ b/src/language/__tests__/parser-test.ts @@ -631,6 +631,23 @@ describe('Parser', () => { }); }); + it('parses semantic-non-null types', () => { + const result = parseType('MyType*'); + expectJSON(result).toDeepEqual({ + kind: Kind.SEMANTIC_NON_NULL_TYPE, + loc: { start: 0, end: 7 }, + type: { + kind: Kind.NAMED_TYPE, + loc: { start: 0, end: 6 }, + name: { + kind: Kind.NAME, + loc: { start: 0, end: 6 }, + value: 'MyType', + }, + }, + }); + }); + it('parses nested types', () => { const result = parseType('[MyType!]'); expectJSON(result).toDeepEqual({ diff --git a/src/language/ast.ts b/src/language/ast.ts index af5704ceae..9ad68ea0c3 100644 --- a/src/language/ast.ts +++ b/src/language/ast.ts @@ -161,6 +161,7 @@ export type ASTNode = | NamedTypeNode | ListTypeNode | NonNullTypeNode + | SemanticNonNullTypeNode | SchemaDefinitionNode | OperationTypeDefinitionNode | ScalarTypeDefinitionNode @@ -520,7 +521,11 @@ export interface ConstDirectiveNode { /** Type Reference */ -export type TypeNode = NamedTypeNode | ListTypeNode | NonNullTypeNode; +export type TypeNode = + | NamedTypeNode + | ListTypeNode + | NonNullTypeNode + | SemanticNonNullTypeNode; export interface NamedTypeNode { readonly kind: Kind.NAMED_TYPE; diff --git a/src/language/parser.ts b/src/language/parser.ts index eb54a0376b..afe8ddbba8 100644 --- a/src/language/parser.ts +++ b/src/language/parser.ts @@ -37,6 +37,7 @@ import type { NamedTypeNode, NameNode, NonNullTypeNode, + SemanticNonNullTypeNode, NullValueNode, ObjectFieldNode, ObjectTypeDefinitionNode, @@ -740,6 +741,7 @@ export class Parser { * - NamedType * - ListType * - NonNullType + * - SemanticNonNullType */ parseTypeReference(): TypeNode { const start = this._lexer.token; @@ -761,6 +763,12 @@ export class Parser { type, }); } + if (this.expectOptionalToken(TokenKind.ASTERISK)) { + return this.node(start, { + kind: Kind.SEMANTIC_NON_NULL_TYPE, + type, + }); + } return type; } diff --git a/src/language/predicates.ts b/src/language/predicates.ts index a390f4ee55..3ddf52b94c 100644 --- a/src/language/predicates.ts +++ b/src/language/predicates.ts @@ -67,7 +67,8 @@ export function isTypeNode(node: ASTNode): node is TypeNode { return ( node.kind === Kind.NAMED_TYPE || node.kind === Kind.LIST_TYPE || - node.kind === Kind.NON_NULL_TYPE + node.kind === Kind.NON_NULL_TYPE || + node.kind === Kind.SEMANTIC_NON_NULL_TYPE ); } diff --git a/src/language/tokenKind.ts b/src/language/tokenKind.ts index 0c260df99e..fd53d6ebf3 100644 --- a/src/language/tokenKind.ts +++ b/src/language/tokenKind.ts @@ -6,6 +6,7 @@ enum TokenKind { SOF = '', EOF = '', BANG = '!', + ASTERISK = '*', DOLLAR = '$', AMP = '&', PAREN_L = '(', diff --git a/src/type/introspection.ts b/src/type/introspection.ts index 12f7261c1d..9affc21777 100644 --- a/src/type/introspection.ts +++ b/src/type/introspection.ts @@ -502,6 +502,11 @@ export const __TypeKind: GraphQLEnumType = new GraphQLEnumType({ description: 'Indicates this type is a non-null. `ofType` is a valid field.', }, + SEMANTIC_NON_NULL: { + value: TypeKind.SEMANTIC_NON_NULL, + description: + 'Indicates this type is a semantic-non-null. `ofType` is a valid field.', + }, }, }); diff --git a/src/utilities/__tests__/printSchema-test.ts b/src/utilities/__tests__/printSchema-test.ts index 37af4a60f7..ef6376e183 100644 --- a/src/utilities/__tests__/printSchema-test.ts +++ b/src/utilities/__tests__/printSchema-test.ts @@ -770,6 +770,9 @@ describe('Type System Printer', () => { """Indicates this type is a non-null. \`ofType\` is a valid field.""" NON_NULL + + """Indicates this type is a semantic-non-null. \`ofType\` is a valid field.""" + SEMANTIC_NON_NULL } """ diff --git a/src/utilities/buildClientSchema.ts b/src/utilities/buildClientSchema.ts index 83f6abada8..ceb0487e18 100644 --- a/src/utilities/buildClientSchema.ts +++ b/src/utilities/buildClientSchema.ts @@ -20,6 +20,7 @@ import { GraphQLInterfaceType, GraphQLList, GraphQLNonNull, + GraphQLSemanticNonNull, GraphQLObjectType, GraphQLScalarType, GraphQLUnionType, @@ -137,6 +138,14 @@ export function buildClientSchema( const nullableType = getType(nullableRef); return new GraphQLNonNull(assertNullableType(nullableType)); } + if (typeRef.kind === TypeKind.SEMANTIC_NON_NULL) { + const nullableRef = typeRef.ofType; + if (!nullableRef) { + throw new Error('Decorated type deeper than introspection query.'); + } + const nullableType = getType(nullableRef); + return new GraphQLSemanticNonNull(assertNullableType(nullableType)); + } return getNamedType(typeRef); } diff --git a/src/utilities/extendSchema.ts b/src/utilities/extendSchema.ts index e81917d312..c133ee851e 100644 --- a/src/utilities/extendSchema.ts +++ b/src/utilities/extendSchema.ts @@ -51,6 +51,7 @@ import { GraphQLInterfaceType, GraphQLList, GraphQLNonNull, + GraphQLSemanticNonNull, GraphQLObjectType, GraphQLScalarType, GraphQLUnionType, @@ -437,6 +438,9 @@ export function extendSchemaImpl( if (node.kind === Kind.NON_NULL_TYPE) { return new GraphQLNonNull(getWrappedType(node.type)); } + if (node.kind === Kind.SEMANTIC_NON_NULL_TYPE) { + return new GraphQLSemanticNonNull(getWrappedType(node.type)); + } return getNamedType(node); } diff --git a/src/utilities/getIntrospectionQuery.ts b/src/utilities/getIntrospectionQuery.ts index e51551e807..587b1588bd 100644 --- a/src/utilities/getIntrospectionQuery.ts +++ b/src/utilities/getIntrospectionQuery.ts @@ -297,6 +297,9 @@ export type IntrospectionTypeRef = | IntrospectionListTypeRef | IntrospectionNonNullTypeRef< IntrospectionNamedTypeRef | IntrospectionListTypeRef + > + | IntrospectionSemanticNonNullTypeRef< + IntrospectionNamedTypeRef | IntrospectionListTypeRef >; export type IntrospectionOutputTypeRef = diff --git a/src/utilities/typeFromAST.ts b/src/utilities/typeFromAST.ts index 7510df1046..c5d5f537a2 100644 --- a/src/utilities/typeFromAST.ts +++ b/src/utilities/typeFromAST.ts @@ -7,7 +7,11 @@ import type { import { Kind } from '../language/kinds'; import type { GraphQLNamedType, GraphQLType } from '../type/definition'; -import { GraphQLList, GraphQLNonNull } from '../type/definition'; +import { + GraphQLList, + GraphQLNonNull, + GraphQLSemanticNonNull, +} from '../type/definition'; import type { GraphQLSchema } from '../type/schema'; /** @@ -46,6 +50,10 @@ export function typeFromAST( const innerType = typeFromAST(schema, typeNode.type); return innerType && new GraphQLNonNull(innerType); } + case Kind.SEMANTIC_NON_NULL_TYPE: { + const innerType = typeFromAST(schema, typeNode.type); + return innerType && new GraphQLSemanticNonNull(innerType); + } case Kind.NAMED_TYPE: return schema.getType(typeNode.name.value); } From c2196a05711635d9a8d700849e3412c296503678 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:11:02 -0700 Subject: [PATCH 06/31] Recognize in introspection, enable disabling null bubbling --- src/execution/execute.ts | 8 ++++ src/type/definition.ts | 2 + src/type/introspection.ts | 89 ++++++++++++++++++++++++++++++++++++++- 3 files changed, 98 insertions(+), 1 deletion(-) diff --git a/src/execution/execute.ts b/src/execution/execute.ts index 8d1af1e866..20c1fa2016 100644 --- a/src/execution/execute.ts +++ b/src/execution/execute.ts @@ -154,6 +154,11 @@ export interface ExecutionArgs { fieldResolver?: Maybe>; typeResolver?: Maybe>; subscribeFieldResolver?: Maybe>; + /** + * @default {true} + * @experimental + */ + errorPropagation?: boolean; } /** @@ -288,6 +293,7 @@ export function buildExecutionContext( fieldResolver, typeResolver, subscribeFieldResolver, + errorPropagation, } = args; let operation: OperationDefinitionNode | undefined; @@ -349,6 +355,7 @@ export function buildExecutionContext( typeResolver: typeResolver ?? defaultTypeResolver, subscribeFieldResolver: subscribeFieldResolver ?? defaultFieldResolver, errors: [], + errorPropagation: errorPropagation ?? true, }; } @@ -587,6 +594,7 @@ export function buildResolveInfo( rootValue: exeContext.rootValue, operation: exeContext.operation, variableValues: exeContext.variableValues, + errorPropagation: exeContext.errorPropagation, }; } diff --git a/src/type/definition.ts b/src/type/definition.ts index f2c9892400..554ec0fe41 100644 --- a/src/type/definition.ts +++ b/src/type/definition.ts @@ -1087,6 +1087,8 @@ export interface GraphQLResolveInfo { readonly rootValue: unknown; readonly operation: OperationDefinitionNode; readonly variableValues: { [variable: string]: unknown }; + /** @experimental */ + readonly errorPropagation: boolean; } /** diff --git a/src/type/introspection.ts b/src/type/introspection.ts index 9affc21777..669cd60968 100644 --- a/src/type/introspection.ts +++ b/src/type/introspection.ts @@ -19,6 +19,7 @@ import { GraphQLEnumType, GraphQLList, GraphQLNonNull, + GraphQLSemanticNonNull, GraphQLObjectType, isAbstractType, isEnumType, @@ -205,6 +206,40 @@ export const __DirectiveLocation: GraphQLEnumType = new GraphQLEnumType({ }, }); +// TODO: rename enum and options +enum TypeNullability { + AUTO = 'AUTO', + TRADITIONAL = 'TRADITIONAL', + SEMANTIC = 'SEMANTIC', + FULL = 'FULL', +} + +// TODO: rename +export const __TypeNullability: GraphQLEnumType = new GraphQLEnumType({ + name: '__TypeNullability', + description: 'TODO', + values: { + AUTO: { + value: TypeNullability.AUTO, + description: + 'Determines nullability mode based on errorPropagation mode.', + }, + TRADITIONAL: { + value: TypeNullability.TRADITIONAL, + description: 'Turn semantic-non-null types into nullable types.', + }, + SEMANTIC: { + value: TypeNullability.SEMANTIC, + description: 'Turn non-null types into semantic-non-null types.', + }, + FULL: { + value: TypeNullability.FULL, + description: + 'Render the true nullability in the schema; be prepared for new types of nullability in future!', + }, + }, +}); + export const __Type: GraphQLObjectType = new GraphQLObjectType({ name: '__Type', description: @@ -370,7 +405,25 @@ export const __Field: GraphQLObjectType = new GraphQLObjectType({ }, type: { type: new GraphQLNonNull(__Type), - resolve: (field) => field.type, + args: { + nullability: { + type: __TypeNullability, + defaultValue: 'AUTO', + }, + }, + resolve: (field, { nullability }, _context, info) => { + if (nullability === TypeNullability.FULL) { + return field.type; + } else { + const mode = + nullability === TypeNullability.AUTO + ? info.errorPropagation + ? TypeNullability.TRADITIONAL + : TypeNullability.SEMANTIC + : nullability; + return convertOutputTypeToNullabilityMode(field.type, mode); + } + }, }, isDeprecated: { type: new GraphQLNonNull(GraphQLBoolean), @@ -383,6 +436,40 @@ export const __Field: GraphQLObjectType = new GraphQLObjectType({ } as GraphQLFieldConfigMap, unknown>), }); +// TODO: move this elsewhere, rename, memoize +function convertOutputTypeToNullabilityMode( + type: GraphQLType, + mode: TypeNullability.TRADITIONAL | TypeNullability.SEMANTIC, +): GraphQLType { + if (mode === TypeNullability.TRADITIONAL) { + if (isNonNullType(type)) { + return new GraphQLNonNull( + convertOutputTypeToNullabilityMode(type.ofType, mode), + ); + } else if (isSemanticNonNullType(type)) { + return convertOutputTypeToNullabilityMode(type.ofType, mode); + } else if (isListType(type)) { + return new GraphQLList( + convertOutputTypeToNullabilityMode(type.ofType, mode), + ); + } else { + return type; + } + } else { + if (isNonNullType(type) || isSemanticNonNullType(type)) { + return new GraphQLSemanticNonNull( + convertOutputTypeToNullabilityMode(type.ofType, mode), + ); + } else if (isListType(type)) { + return new GraphQLList( + convertOutputTypeToNullabilityMode(type.ofType, mode), + ); + } else { + return type; + } + } +} + export const __InputValue: GraphQLObjectType = new GraphQLObjectType({ name: '__InputValue', description: From f5880469f769b07dd74619497c9073a33187a23e Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:15:04 -0700 Subject: [PATCH 07/31] Lint fixes --- src/execution/execute.ts | 5 ++-- src/language/parser.ts | 2 +- src/type/__tests__/predicate-test.ts | 6 ++--- src/type/introspection.ts | 25 +++++++++---------- src/utilities/buildClientSchema.ts | 2 +- src/utilities/extendSchema.ts | 4 +-- src/utilities/findBreakingChanges.ts | 15 ++++++----- src/utilities/lexicographicSortSchema.ts | 3 ++- src/utilities/typeComparators.ts | 2 +- .../rules/OverlappingFieldsCanBeMergedRule.ts | 7 +++--- 10 files changed, 37 insertions(+), 34 deletions(-) diff --git a/src/execution/execute.ts b/src/execution/execute.ts index 20c1fa2016..b7cb7f4a02 100644 --- a/src/execution/execute.ts +++ b/src/execution/execute.ts @@ -42,8 +42,8 @@ import { isLeafType, isListType, isNonNullType, - isSemanticNonNullType, isObjectType, + isSemanticNonNullType, } from '../type/definition'; import { SchemaMetaFieldDef, @@ -155,7 +155,8 @@ export interface ExecutionArgs { typeResolver?: Maybe>; subscribeFieldResolver?: Maybe>; /** - * @default {true} + * Set to `false` to disable error propagation. Experimental. + * * @experimental */ errorPropagation?: boolean; diff --git a/src/language/parser.ts b/src/language/parser.ts index afe8ddbba8..129849d5e7 100644 --- a/src/language/parser.ts +++ b/src/language/parser.ts @@ -37,7 +37,6 @@ import type { NamedTypeNode, NameNode, NonNullTypeNode, - SemanticNonNullTypeNode, NullValueNode, ObjectFieldNode, ObjectTypeDefinitionNode, @@ -51,6 +50,7 @@ import type { SchemaExtensionNode, SelectionNode, SelectionSetNode, + SemanticNonNullTypeNode, StringValueNode, Token, TypeNode, diff --git a/src/type/__tests__/predicate-test.ts b/src/type/__tests__/predicate-test.ts index e3395727bc..1c576e8eaa 100644 --- a/src/type/__tests__/predicate-test.ts +++ b/src/type/__tests__/predicate-test.ts @@ -19,11 +19,11 @@ import { assertListType, assertNamedType, assertNonNullType, - assertSemanticNonNullType, assertNullableType, assertObjectType, assertOutputType, assertScalarType, + assertSemanticNonNullType, assertType, assertUnionType, assertWrappingType, @@ -34,9 +34,9 @@ import { GraphQLInterfaceType, GraphQLList, GraphQLNonNull, - GraphQLSemanticNonNull, GraphQLObjectType, GraphQLScalarType, + GraphQLSemanticNonNull, GraphQLUnionType, isAbstractType, isCompositeType, @@ -48,13 +48,13 @@ import { isListType, isNamedType, isNonNullType, - isSemanticNonNullType, isNullableType, isObjectType, isOutputType, isRequiredArgument, isRequiredInputField, isScalarType, + isSemanticNonNullType, isType, isUnionType, isWrappingType, diff --git a/src/type/introspection.ts b/src/type/introspection.ts index 669cd60968..66bad79b80 100644 --- a/src/type/introspection.ts +++ b/src/type/introspection.ts @@ -6,21 +6,19 @@ import { print } from '../language/printer'; import { astFromValue } from '../utilities/astFromValue'; -import { +import type { GraphQLEnumValue, GraphQLField, GraphQLFieldConfigMap, GraphQLInputField, GraphQLNamedType, - GraphQLType, - isSemanticNonNullType, -} from './definition'; + GraphQLType} from './definition'; import { GraphQLEnumType, GraphQLList, GraphQLNonNull, - GraphQLSemanticNonNull, GraphQLObjectType, + GraphQLSemanticNonNull, isAbstractType, isEnumType, isInputObjectType, @@ -29,6 +27,7 @@ import { isNonNullType, isObjectType, isScalarType, + isSemanticNonNullType, isUnionType, } from './definition'; import type { GraphQLDirective } from './directives'; @@ -414,7 +413,7 @@ export const __Field: GraphQLObjectType = new GraphQLObjectType({ resolve: (field, { nullability }, _context, info) => { if (nullability === TypeNullability.FULL) { return field.type; - } else { + } const mode = nullability === TypeNullability.AUTO ? info.errorPropagation @@ -422,7 +421,7 @@ export const __Field: GraphQLObjectType = new GraphQLObjectType({ : TypeNullability.SEMANTIC : nullability; return convertOutputTypeToNullabilityMode(field.type, mode); - } + }, }, isDeprecated: { @@ -452,10 +451,10 @@ function convertOutputTypeToNullabilityMode( return new GraphQLList( convertOutputTypeToNullabilityMode(type.ofType, mode), ); - } else { + } return type; - } - } else { + + } if (isNonNullType(type) || isSemanticNonNullType(type)) { return new GraphQLSemanticNonNull( convertOutputTypeToNullabilityMode(type.ofType, mode), @@ -464,10 +463,10 @@ function convertOutputTypeToNullabilityMode( return new GraphQLList( convertOutputTypeToNullabilityMode(type.ofType, mode), ); - } else { + } return type; - } - } + + } export const __InputValue: GraphQLObjectType = new GraphQLObjectType({ diff --git a/src/utilities/buildClientSchema.ts b/src/utilities/buildClientSchema.ts index ceb0487e18..9b0809adf5 100644 --- a/src/utilities/buildClientSchema.ts +++ b/src/utilities/buildClientSchema.ts @@ -20,9 +20,9 @@ import { GraphQLInterfaceType, GraphQLList, GraphQLNonNull, - GraphQLSemanticNonNull, GraphQLObjectType, GraphQLScalarType, + GraphQLSemanticNonNull, GraphQLUnionType, isInputType, isOutputType, diff --git a/src/utilities/extendSchema.ts b/src/utilities/extendSchema.ts index c133ee851e..876aae277f 100644 --- a/src/utilities/extendSchema.ts +++ b/src/utilities/extendSchema.ts @@ -51,18 +51,18 @@ import { GraphQLInterfaceType, GraphQLList, GraphQLNonNull, - GraphQLSemanticNonNull, GraphQLObjectType, GraphQLScalarType, + GraphQLSemanticNonNull, GraphQLUnionType, isEnumType, isInputObjectType, isInterfaceType, isListType, isNonNullType, - isSemanticNonNullType, isObjectType, isScalarType, + isSemanticNonNullType, isUnionType, } from '../type/definition'; import { diff --git a/src/utilities/findBreakingChanges.ts b/src/utilities/findBreakingChanges.ts index c7ab88504f..5ed0313ae3 100644 --- a/src/utilities/findBreakingChanges.ts +++ b/src/utilities/findBreakingChanges.ts @@ -22,11 +22,11 @@ import { isListType, isNamedType, isNonNullType, - isSemanticNonNullType, isObjectType, isRequiredArgument, isRequiredInputField, isScalarType, + isSemanticNonNullType, isUnionType, } from '../type/definition'; import { isSpecifiedScalarType } from '../type/scalars'; @@ -462,7 +462,7 @@ function isChangeSafeForObjectOrInterfaceField( isChangeSafeForObjectOrInterfaceField(oldType, newType.ofType)) || // moving from nullable to semantic-non-null of the same underlying type is safe (isSemanticNonNullType(newType) && - isChangeSafeForObjectOrInterfaceField(oldType, newType.ofType)) || + isChangeSafeForObjectOrInterfaceField(oldType, newType.ofType)) ); } @@ -477,11 +477,14 @@ function isChangeSafeForObjectOrInterfaceField( if (isSemanticNonNullType(oldType)) { return ( // if they're both semantic-non-null, make sure the underlying types are compatible - (isSemanticNonNullType(newType) && - isChangeSafeForObjectOrInterfaceField(oldType.ofType, newType.ofType)) || + (isSemanticNonNullType(newType) && + isChangeSafeForObjectOrInterfaceField( + oldType.ofType, + newType.ofType, + )) || // moving from semantic-non-null to non-null of the same underlying type is safe - isNonNullType(newType) && - isChangeSafeForObjectOrInterfaceField(oldType.ofType, newType.ofType) + (isNonNullType(newType) && + isChangeSafeForObjectOrInterfaceField(oldType.ofType, newType.ofType)) ); } diff --git a/src/utilities/lexicographicSortSchema.ts b/src/utilities/lexicographicSortSchema.ts index 728cf23380..5beb646859 100644 --- a/src/utilities/lexicographicSortSchema.ts +++ b/src/utilities/lexicographicSortSchema.ts @@ -19,15 +19,16 @@ import { GraphQLList, GraphQLNonNull, GraphQLObjectType, + GraphQLSemanticNonNull, GraphQLUnionType, isEnumType, isInputObjectType, isInterfaceType, isListType, isNonNullType, - isSemanticNonNullType, isObjectType, isScalarType, + isSemanticNonNullType, isUnionType, } from '../type/definition'; import { GraphQLDirective } from '../type/directives'; diff --git a/src/utilities/typeComparators.ts b/src/utilities/typeComparators.ts index 79116e482b..338ca24528 100644 --- a/src/utilities/typeComparators.ts +++ b/src/utilities/typeComparators.ts @@ -4,8 +4,8 @@ import { isInterfaceType, isListType, isNonNullType, - isSemanticNonNullType, isObjectType, + isSemanticNonNullType, } from '../type/definition'; import type { GraphQLSchema } from '../type/schema'; diff --git a/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts b/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts index cba8daf3c5..da56d827f1 100644 --- a/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts +++ b/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts @@ -15,12 +15,10 @@ import { Kind } from '../../language/kinds'; import { print } from '../../language/printer'; import type { ASTVisitor } from '../../language/visitor'; -import { +import type { GraphQLField, GraphQLNamedType, - GraphQLOutputType, - isSemanticNonNullType, -} from '../../type/definition'; + GraphQLOutputType} from '../../type/definition'; import { getNamedType, isInterfaceType, @@ -28,6 +26,7 @@ import { isListType, isNonNullType, isObjectType, + isSemanticNonNullType, } from '../../type/definition'; import { sortValueNode } from '../../utilities/sortValueNode'; From fa3f1778d8bbf9632bad7c95b2db12004070ea07 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:17:36 -0700 Subject: [PATCH 08/31] More missing pieces --- src/language/__tests__/predicates-test.ts | 1 + src/language/ast.ts | 1 + src/language/printer.ts | 1 + 3 files changed, 3 insertions(+) diff --git a/src/language/__tests__/predicates-test.ts b/src/language/__tests__/predicates-test.ts index 13477f8de9..32ef7d1fe1 100644 --- a/src/language/__tests__/predicates-test.ts +++ b/src/language/__tests__/predicates-test.ts @@ -92,6 +92,7 @@ describe('AST node predicates', () => { 'NamedType', 'ListType', 'NonNullType', + 'SemanticNonNullType', ]); }); diff --git a/src/language/ast.ts b/src/language/ast.ts index 9ad68ea0c3..f3fc60c3cb 100644 --- a/src/language/ast.ts +++ b/src/language/ast.ts @@ -236,6 +236,7 @@ export const QueryDocumentKeys: { NamedType: ['name'], ListType: ['type'], NonNullType: ['type'], + SemanticNonNullType: ['type'], SchemaDefinition: ['description', 'directives', 'operationTypes'], OperationTypeDefinition: ['type'], diff --git a/src/language/printer.ts b/src/language/printer.ts index e95c118d8b..f08ba54f56 100644 --- a/src/language/printer.ts +++ b/src/language/printer.ts @@ -131,6 +131,7 @@ const printDocASTReducer: ASTReducer = { NamedType: { leave: ({ name }) => name }, ListType: { leave: ({ type }) => '[' + type + ']' }, NonNullType: { leave: ({ type }) => type + '!' }, + SemanticNonNullType: { leave: ({ type }) => type + '*' }, // Type System Definitions From b5e81bdd5f96dcd705bb86cede9aaea4b865af61 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:26:12 -0700 Subject: [PATCH 09/31] More fixes --- src/__tests__/starWarsIntrospection-test.ts | 1 + src/index.ts | 1 + src/type/__tests__/introspection-test.ts | 47 +++++++++++++++++- src/type/__tests__/schema-test.ts | 1 + src/type/index.ts | 1 + src/type/introspection.ts | 54 ++++++++++----------- src/utilities/__tests__/printSchema-test.ts | 9 +++- 7 files changed, 84 insertions(+), 30 deletions(-) diff --git a/src/__tests__/starWarsIntrospection-test.ts b/src/__tests__/starWarsIntrospection-test.ts index d637787c4a..f72b04e855 100644 --- a/src/__tests__/starWarsIntrospection-test.ts +++ b/src/__tests__/starWarsIntrospection-test.ts @@ -45,6 +45,7 @@ describe('Star Wars Introspection Tests', () => { { name: '__EnumValue' }, { name: '__Directive' }, { name: '__DirectiveLocation' }, + { name: '__TypeNullability' }, ], }, }); diff --git a/src/index.ts b/src/index.ts index e3896fbf05..2940df03fc 100644 --- a/src/index.ts +++ b/src/index.ts @@ -75,6 +75,7 @@ export { __Schema, __Directive, __DirectiveLocation, + __TypeNullability, __Type, __Field, __InputValue, diff --git a/src/type/__tests__/introspection-test.ts b/src/type/__tests__/introspection-test.ts index 29994c76ed..1c3896cc23 100644 --- a/src/type/__tests__/introspection-test.ts +++ b/src/type/__tests__/introspection-test.ts @@ -506,7 +506,21 @@ describe('Introspection', () => { }, { name: 'type', - args: [], + args: [ + { + name: 'nullability', + type: { + kind: 'NON_NULL', + name: null, + ofType: { + kind: 'ENUM', + name: '__TypeNullability', + ofType: null, + }, + }, + defaultValue: 'AUTO', + }, + ], type: { kind: 'NON_NULL', name: null, @@ -917,6 +931,37 @@ describe('Introspection', () => { ], possibleTypes: null, }, + { + kind: 'ENUM', + name: '__TypeNullability', + specifiedByURL: null, + fields: null, + inputFields: null, + interfaces: null, + enumValues: [ + { + name: 'AUTO', + isDeprecated: false, + deprecationReason: null, + }, + { + name: 'TRADITIONAL', + isDeprecated: false, + deprecationReason: null, + }, + { + name: 'SEMANTIC', + isDeprecated: false, + deprecationReason: null, + }, + { + name: 'FULL', + isDeprecated: false, + deprecationReason: null, + }, + ], + possibleTypes: null, + }, ], directives: [ { diff --git a/src/type/__tests__/schema-test.ts b/src/type/__tests__/schema-test.ts index 8a31b50ada..357135bace 100644 --- a/src/type/__tests__/schema-test.ts +++ b/src/type/__tests__/schema-test.ts @@ -304,6 +304,7 @@ describe('Type System: Schema', () => { '__EnumValue', '__Directive', '__DirectiveLocation', + '__TypeNullability', ]); // Also check that this order is stable diff --git a/src/type/index.ts b/src/type/index.ts index 0729b840e7..e6cf627bd5 100644 --- a/src/type/index.ts +++ b/src/type/index.ts @@ -170,6 +170,7 @@ export { __Schema, __Directive, __DirectiveLocation, + __TypeNullability, __Type, __Field, __InputValue, diff --git a/src/type/introspection.ts b/src/type/introspection.ts index 66bad79b80..186a20f8d3 100644 --- a/src/type/introspection.ts +++ b/src/type/introspection.ts @@ -12,7 +12,8 @@ import type { GraphQLFieldConfigMap, GraphQLInputField, GraphQLNamedType, - GraphQLType} from './definition'; + GraphQLType, +} from './definition'; import { GraphQLEnumType, GraphQLList, @@ -406,22 +407,21 @@ export const __Field: GraphQLObjectType = new GraphQLObjectType({ type: new GraphQLNonNull(__Type), args: { nullability: { - type: __TypeNullability, - defaultValue: 'AUTO', + type: new GraphQLNonNull(__TypeNullability), + defaultValue: TypeNullability.AUTO, }, }, resolve: (field, { nullability }, _context, info) => { if (nullability === TypeNullability.FULL) { return field.type; - } - const mode = - nullability === TypeNullability.AUTO - ? info.errorPropagation - ? TypeNullability.TRADITIONAL - : TypeNullability.SEMANTIC - : nullability; - return convertOutputTypeToNullabilityMode(field.type, mode); - + } + const mode = + nullability === TypeNullability.AUTO + ? info.errorPropagation + ? TypeNullability.TRADITIONAL + : TypeNullability.SEMANTIC + : nullability; + return convertOutputTypeToNullabilityMode(field.type, mode); }, }, isDeprecated: { @@ -451,22 +451,19 @@ function convertOutputTypeToNullabilityMode( return new GraphQLList( convertOutputTypeToNullabilityMode(type.ofType, mode), ); - } - return type; - - } - if (isNonNullType(type) || isSemanticNonNullType(type)) { - return new GraphQLSemanticNonNull( - convertOutputTypeToNullabilityMode(type.ofType, mode), - ); - } else if (isListType(type)) { - return new GraphQLList( - convertOutputTypeToNullabilityMode(type.ofType, mode), - ); - } - return type; - - + } + return type; + } + if (isNonNullType(type) || isSemanticNonNullType(type)) { + return new GraphQLSemanticNonNull( + convertOutputTypeToNullabilityMode(type.ofType, mode), + ); + } else if (isListType(type)) { + return new GraphQLList( + convertOutputTypeToNullabilityMode(type.ofType, mode), + ); + } + return type; } export const __InputValue: GraphQLObjectType = new GraphQLObjectType({ @@ -649,6 +646,7 @@ export const introspectionTypes: ReadonlyArray = __Schema, __Directive, __DirectiveLocation, + __TypeNullability, __Type, __Field, __InputValue, diff --git a/src/utilities/__tests__/printSchema-test.ts b/src/utilities/__tests__/printSchema-test.ts index ef6376e183..33c3d2e3b1 100644 --- a/src/utilities/__tests__/printSchema-test.ts +++ b/src/utilities/__tests__/printSchema-test.ts @@ -782,7 +782,7 @@ describe('Type System Printer', () => { name: String! description: String args(includeDeprecated: Boolean = false): [__InputValue!]! - type: __Type! + type(nullability: __TypeNullability!): __Type! isDeprecated: Boolean! deprecationReason: String } @@ -887,6 +887,13 @@ describe('Type System Printer', () => { """Location adjacent to an input object field definition.""" INPUT_FIELD_DEFINITION } + + enum __TypeNullability { + AUTO + TRADITIONAL + SEMANTIC + FULL + } `); }); }); From 1f6a0197419a29d92de25f6dd97c2c56d8f223b2 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:28:38 -0700 Subject: [PATCH 10/31] Fix schema --- src/utilities/__tests__/printSchema-test.ts | 26 ++++++++++++++------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/src/utilities/__tests__/printSchema-test.ts b/src/utilities/__tests__/printSchema-test.ts index 33c3d2e3b1..b651bf16a8 100644 --- a/src/utilities/__tests__/printSchema-test.ts +++ b/src/utilities/__tests__/printSchema-test.ts @@ -782,7 +782,7 @@ describe('Type System Printer', () => { name: String! description: String args(includeDeprecated: Boolean = false): [__InputValue!]! - type(nullability: __TypeNullability!): __Type! + type(nullability: __TypeNullability! = AUTO): __Type! isDeprecated: Boolean! deprecationReason: String } @@ -803,6 +803,23 @@ describe('Type System Printer', () => { deprecationReason: String } + """TODO""" + enum __TypeNullability { + """Determines nullability mode based on errorPropagation mode.""" + AUTO + + """Turn semantic-non-null types into nullable types.""" + TRADITIONAL + + """Turn non-null types into semantic-non-null types.""" + SEMANTIC + + """ + Render the true nullability in the schema; be prepared for new types of nullability in future! + """ + FULL + } + """ One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string. """ @@ -887,13 +904,6 @@ describe('Type System Printer', () => { """Location adjacent to an input object field definition.""" INPUT_FIELD_DEFINITION } - - enum __TypeNullability { - AUTO - TRADITIONAL - SEMANTIC - FULL - } `); }); }); From 491f49b6cad487a60e79af70b8a112d4f2f0c7d1 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:31:03 -0700 Subject: [PATCH 11/31] Fix another test --- src/type/__tests__/schema-test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/type/__tests__/schema-test.ts b/src/type/__tests__/schema-test.ts index 357135bace..dc2c7c75c8 100644 --- a/src/type/__tests__/schema-test.ts +++ b/src/type/__tests__/schema-test.ts @@ -301,10 +301,10 @@ describe('Type System: Schema', () => { '__TypeKind', '__Field', '__InputValue', + '__TypeNullability', '__EnumValue', '__Directive', '__DirectiveLocation', - '__TypeNullability', ]); // Also check that this order is stable From 3a91590cc869bd0fde133e721a3369c9ea2559a8 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:34:59 -0700 Subject: [PATCH 12/31] More minor test fixes --- src/__tests__/starWarsIntrospection-test.ts | 2 +- src/execution/__tests__/executor-test.ts | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/__tests__/starWarsIntrospection-test.ts b/src/__tests__/starWarsIntrospection-test.ts index f72b04e855..0dc95f0a7e 100644 --- a/src/__tests__/starWarsIntrospection-test.ts +++ b/src/__tests__/starWarsIntrospection-test.ts @@ -42,10 +42,10 @@ describe('Star Wars Introspection Tests', () => { { name: '__TypeKind' }, { name: '__Field' }, { name: '__InputValue' }, + { name: '__TypeNullability' }, { name: '__EnumValue' }, { name: '__Directive' }, { name: '__DirectiveLocation' }, - { name: '__TypeNullability' }, ], }, }); diff --git a/src/execution/__tests__/executor-test.ts b/src/execution/__tests__/executor-test.ts index c758d3e426..a7bc1c8265 100644 --- a/src/execution/__tests__/executor-test.ts +++ b/src/execution/__tests__/executor-test.ts @@ -263,6 +263,7 @@ describe('Execute: Handles basic execution tasks', () => { 'rootValue', 'operation', 'variableValues', + 'errorPropagation', ); const operation = document.definitions[0]; @@ -275,6 +276,7 @@ describe('Execute: Handles basic execution tasks', () => { schema, rootValue, operation, + errorPropagation: true, }); const field = operation.selectionSet.selections[0]; From 56db880c072fe658dfad046e35f058c0974b6775 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:39:39 -0700 Subject: [PATCH 13/31] Fix introspection test --- src/type/__tests__/introspection-test.ts | 67 +++++++++++++----------- 1 file changed, 36 insertions(+), 31 deletions(-) diff --git a/src/type/__tests__/introspection-test.ts b/src/type/__tests__/introspection-test.ts index 1c3896cc23..08273f495f 100644 --- a/src/type/__tests__/introspection-test.ts +++ b/src/type/__tests__/introspection-test.ts @@ -437,6 +437,11 @@ describe('Introspection', () => { isDeprecated: false, deprecationReason: null, }, + { + name: 'SEMANTIC_NON_NULL', + isDeprecated: false, + deprecationReason: null, + }, ], possibleTypes: null, }, @@ -654,6 +659,37 @@ describe('Introspection', () => { enumValues: null, possibleTypes: null, }, + { + kind: 'ENUM', + name: '__TypeNullability', + specifiedByURL: null, + fields: null, + inputFields: null, + interfaces: null, + enumValues: [ + { + name: 'AUTO', + isDeprecated: false, + deprecationReason: null, + }, + { + name: 'TRADITIONAL', + isDeprecated: false, + deprecationReason: null, + }, + { + name: 'SEMANTIC', + isDeprecated: false, + deprecationReason: null, + }, + { + name: 'FULL', + isDeprecated: false, + deprecationReason: null, + }, + ], + possibleTypes: null, + }, { kind: 'OBJECT', name: '__EnumValue', @@ -931,37 +967,6 @@ describe('Introspection', () => { ], possibleTypes: null, }, - { - kind: 'ENUM', - name: '__TypeNullability', - specifiedByURL: null, - fields: null, - inputFields: null, - interfaces: null, - enumValues: [ - { - name: 'AUTO', - isDeprecated: false, - deprecationReason: null, - }, - { - name: 'TRADITIONAL', - isDeprecated: false, - deprecationReason: null, - }, - { - name: 'SEMANTIC', - isDeprecated: false, - deprecationReason: null, - }, - { - name: 'FULL', - isDeprecated: false, - deprecationReason: null, - }, - ], - possibleTypes: null, - }, ], directives: [ { From 593ce448b1f595bc83cf3d9854bab1cdb9090828 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:41:55 -0700 Subject: [PATCH 14/31] Add support for * to lexer --- src/language/lexer.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/language/lexer.ts b/src/language/lexer.ts index 818f81b286..8fccd4e709 100644 --- a/src/language/lexer.ts +++ b/src/language/lexer.ts @@ -91,6 +91,7 @@ export class Lexer { export function isPunctuatorTokenKind(kind: TokenKind): boolean { return ( kind === TokenKind.BANG || + kind === TokenKind.ASTERISK || kind === TokenKind.DOLLAR || kind === TokenKind.AMP || kind === TokenKind.PAREN_L || @@ -246,7 +247,7 @@ function readNextToken(lexer: Lexer, start: number): Token { // - FloatValue // - StringValue // - // Punctuator :: one of ! $ & ( ) ... : = @ [ ] { | } + // Punctuator :: one of ! $ & ( ) * ... : = @ [ ] { | } case 0x0021: // ! return createToken(lexer, TokenKind.BANG, position, position + 1); case 0x0024: // $ @@ -257,6 +258,8 @@ function readNextToken(lexer: Lexer, start: number): Token { return createToken(lexer, TokenKind.PAREN_L, position, position + 1); case 0x0029: // ) return createToken(lexer, TokenKind.PAREN_R, position, position + 1); + case 0x002a: // * + return createToken(lexer, TokenKind.ASTERISK, position, position + 1); case 0x002e: // . if ( body.charCodeAt(position + 1) === 0x002e && From 131190604e240b1bad55cab440d1afbded94bdd4 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:49:32 -0700 Subject: [PATCH 15/31] Allow specifying errorPropagation at top level --- src/graphql.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/graphql.ts b/src/graphql.ts index bc6fb9bb72..d3f05f991e 100644 --- a/src/graphql.ts +++ b/src/graphql.ts @@ -66,6 +66,12 @@ export interface GraphQLArgs { operationName?: Maybe; fieldResolver?: Maybe>; typeResolver?: Maybe>; + /** + * Set to `false` to disable error propagation. Experimental. + * + * @experimental + */ + errorPropagation?: boolean; } export function graphql(args: GraphQLArgs): Promise { @@ -106,6 +112,7 @@ function graphqlImpl(args: GraphQLArgs): PromiseOrValue { operationName, fieldResolver, typeResolver, + errorPropagation, } = args; // Validate Schema @@ -138,5 +145,6 @@ function graphqlImpl(args: GraphQLArgs): PromiseOrValue { operationName, fieldResolver, typeResolver, + errorPropagation, }); } From 9d706d2d6701ac32856e7d08aa004049e72fa8a5 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:58:03 -0700 Subject: [PATCH 16/31] Factor into getIntrospectionQuery --- src/utilities/getIntrospectionQuery.ts | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/src/utilities/getIntrospectionQuery.ts b/src/utilities/getIntrospectionQuery.ts index 587b1588bd..8c94ba8f79 100644 --- a/src/utilities/getIntrospectionQuery.ts +++ b/src/utilities/getIntrospectionQuery.ts @@ -38,6 +38,17 @@ export interface IntrospectionOptions { * Default: false */ oneOf?: boolean; + + /** + * Choose the type of nullability you would like to see. + * + * - AUTO: SEMANTIC if errorPropagation is set to false, otherwise TRADITIONAL + * - TRADITIONAL: all GraphQLSemanticNonNull will be unwrapped + * - SEMANTIC: all GraphQLNonNull will be converted to GraphQLSemanticNonNull + * - FULL: the true nullability will be returned + * + */ + nullability?: 'AUTO' | 'TRADITIONAL' | 'SEMANTIC' | 'FULL'; } /** @@ -52,6 +63,7 @@ export function getIntrospectionQuery(options?: IntrospectionOptions): string { schemaDescription: false, inputValueDeprecation: false, oneOf: false, + nullability: null, ...options, }; @@ -70,6 +82,7 @@ export function getIntrospectionQuery(options?: IntrospectionOptions): string { return optionsWithDefault.inputValueDeprecation ? str : ''; } const oneOf = optionsWithDefault.oneOf ? 'isOneOf' : ''; + const nullability = optionsWithDefault.nullability; return ` query IntrospectionQuery { @@ -105,7 +118,7 @@ export function getIntrospectionQuery(options?: IntrospectionOptions): string { args${inputDeprecation('(includeDeprecated: true)')} { ...InputValue } - type { + type${nullability ? `(nullability: ${nullability})` : ``} { ...TypeRef } isDeprecated From e9f9628a35f2dddc510bd030d7cb75618445c50e Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 20:59:15 -0700 Subject: [PATCH 17/31] Lint --- src/utilities/getIntrospectionQuery.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utilities/getIntrospectionQuery.ts b/src/utilities/getIntrospectionQuery.ts index 8c94ba8f79..26340991ce 100644 --- a/src/utilities/getIntrospectionQuery.ts +++ b/src/utilities/getIntrospectionQuery.ts @@ -118,7 +118,7 @@ export function getIntrospectionQuery(options?: IntrospectionOptions): string { args${inputDeprecation('(includeDeprecated: true)')} { ...InputValue } - type${nullability ? `(nullability: ${nullability})` : ``} { + type${nullability ? `(nullability: ${nullability})` : ''} { ...TypeRef } isDeprecated From eb9b6c8a77193fc5ed3685d1e95d32b99c9df9d9 Mon Sep 17 00:00:00 2001 From: Benjie Gillam Date: Fri, 13 Sep 2024 21:02:07 -0700 Subject: [PATCH 18/31] Prettier --- src/validation/rules/OverlappingFieldsCanBeMergedRule.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts b/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts index da56d827f1..8ecd96212f 100644 --- a/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts +++ b/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts @@ -18,7 +18,8 @@ import type { ASTVisitor } from '../../language/visitor'; import type { GraphQLField, GraphQLNamedType, - GraphQLOutputType} from '../../type/definition'; + GraphQLOutputType, +} from '../../type/definition'; import { getNamedType, isInterfaceType, From 3a900a9cf56d068271d65702ab19147f217804a7 Mon Sep 17 00:00:00 2001 From: twof Date: Tue, 29 Oct 2024 23:05:31 -0700 Subject: [PATCH 19/31] parser tests passing --- src/language/__tests__/parser-test.ts | 77 +++++++++++++++++++++------ src/language/lexer.ts | 8 +-- src/language/parser.ts | 46 +++++++++++----- src/language/tokenKind.ts | 2 +- 4 files changed, 99 insertions(+), 34 deletions(-) diff --git a/src/language/__tests__/parser-test.ts b/src/language/__tests__/parser-test.ts index 596a6d60c7..a9b0d13ebf 100644 --- a/src/language/__tests__/parser-test.ts +++ b/src/language/__tests__/parser-test.ts @@ -11,6 +11,7 @@ import { Kind } from '../kinds'; import { parse, parseConstValue, parseType, parseValue } from '../parser'; import { Source } from '../source'; import { TokenKind } from '../tokenKind'; +import { Console } from 'console'; function expectSyntaxError(text: string) { return expectToThrowJSON(() => parse(text)); @@ -631,11 +632,46 @@ describe('Parser', () => { }); }); + it('parses nested types', () => { + const result = parseType('[MyType!]'); + expectJSON(result).toDeepEqual({ + kind: Kind.LIST_TYPE, + loc: { start: 0, end: 9 }, + type: { + kind: Kind.NON_NULL_TYPE, + loc: { start: 1, end: 8 }, + type: { + kind: Kind.NAMED_TYPE, + loc: { start: 1, end: 7 }, + name: { + kind: Kind.NAME, + loc: { start: 1, end: 7 }, + value: 'MyType', + }, + }, + }, + }); + }); + }); + + describe('parseDocumentDirective', () => { + it('doesnt throw on document-level directive', () => { + parse(dedent` + @SemanticNullability + + type Query { + hello: String + world: String? + foo: String! + } + `); + }); + it('parses semantic-non-null types', () => { - const result = parseType('MyType*'); + const result = parseType('MyType', { useSemanticNullability: true }); expectJSON(result).toDeepEqual({ kind: Kind.SEMANTIC_NON_NULL_TYPE, - loc: { start: 0, end: 7 }, + loc: { start: 0, end: 6 }, type: { kind: Kind.NAMED_TYPE, loc: { start: 0, end: 6 }, @@ -648,22 +684,31 @@ describe('Parser', () => { }); }); - it('parses nested types', () => { - const result = parseType('[MyType!]'); + it('parses nullable types', () => { + const result = parseType('MyType?', { useSemanticNullability: true }); expectJSON(result).toDeepEqual({ - kind: Kind.LIST_TYPE, - loc: { start: 0, end: 9 }, + kind: Kind.NAMED_TYPE, + loc: { start: 0, end: 6 }, + name: { + kind: Kind.NAME, + loc: { start: 0, end: 6 }, + value: 'MyType', + }, + }); + }); + + it('parses non-nullable types', () => { + const result = parseType('MyType!', { useSemanticNullability: true }); + expectJSON(result).toDeepEqual({ + kind: Kind.NON_NULL_TYPE, + loc: { start: 0, end: 7 }, type: { - kind: Kind.NON_NULL_TYPE, - loc: { start: 1, end: 8 }, - type: { - kind: Kind.NAMED_TYPE, - loc: { start: 1, end: 7 }, - name: { - kind: Kind.NAME, - loc: { start: 1, end: 7 }, - value: 'MyType', - }, + kind: Kind.NAMED_TYPE, + loc: { start: 0, end: 6 }, + name: { + kind: Kind.NAME, + loc: { start: 0, end: 6 }, + value: 'MyType', }, }, }); diff --git a/src/language/lexer.ts b/src/language/lexer.ts index 8fccd4e709..bdaf8b9b25 100644 --- a/src/language/lexer.ts +++ b/src/language/lexer.ts @@ -91,7 +91,7 @@ export class Lexer { export function isPunctuatorTokenKind(kind: TokenKind): boolean { return ( kind === TokenKind.BANG || - kind === TokenKind.ASTERISK || + kind === TokenKind.QUESTION_MARK || kind === TokenKind.DOLLAR || kind === TokenKind.AMP || kind === TokenKind.PAREN_L || @@ -247,7 +247,7 @@ function readNextToken(lexer: Lexer, start: number): Token { // - FloatValue // - StringValue // - // Punctuator :: one of ! $ & ( ) * ... : = @ [ ] { | } + // Punctuator :: one of ! $ & ( ) ? ... : = @ [ ] { | } case 0x0021: // ! return createToken(lexer, TokenKind.BANG, position, position + 1); case 0x0024: // $ @@ -258,8 +258,8 @@ function readNextToken(lexer: Lexer, start: number): Token { return createToken(lexer, TokenKind.PAREN_L, position, position + 1); case 0x0029: // ) return createToken(lexer, TokenKind.PAREN_R, position, position + 1); - case 0x002a: // * - return createToken(lexer, TokenKind.ASTERISK, position, position + 1); + case 0x003f: // ? + return createToken(lexer, TokenKind.QUESTION_MARK, position, position + 1); case 0x002e: // . if ( body.charCodeAt(position + 1) === 0x002e && diff --git a/src/language/parser.ts b/src/language/parser.ts index 129849d5e7..57e6f123db 100644 --- a/src/language/parser.ts +++ b/src/language/parser.ts @@ -104,6 +104,8 @@ export interface ParseOptions { * ``` */ allowLegacyFragmentVariables?: boolean; + + useSemanticNullability?: boolean; } /** @@ -250,6 +252,14 @@ export class Parser { * - InputObjectTypeDefinition */ parseDefinition(): DefinitionNode { + // TODO: I don't know what isConst represents. Every other callsite has it false + let directives = this.parseDirectives(false); + for (let directive of directives) { + if (directive.name.value == "SemanticNullability") { + this._options.useSemanticNullability = true; + } + } + if (this.peek(TokenKind.BRACE_L)) { return this.parseOperationDefinition(); } @@ -757,20 +767,30 @@ export class Parser { type = this.parseNamedType(); } - if (this.expectOptionalToken(TokenKind.BANG)) { - return this.node(start, { - kind: Kind.NON_NULL_TYPE, - type, - }); - } - if (this.expectOptionalToken(TokenKind.ASTERISK)) { - return this.node(start, { - kind: Kind.SEMANTIC_NON_NULL_TYPE, - type, - }); - } + if (this._options.useSemanticNullability) { + if (this.expectOptionalToken(TokenKind.BANG)) { + return this.node(start, { + kind: Kind.NON_NULL_TYPE, + type, + }); + } else if (this.expectOptionalToken(TokenKind.QUESTION_MARK)) { + return type; + } else { + return this.node(start, { + kind: Kind.SEMANTIC_NON_NULL_TYPE, + type, + }); + } + } else { + if (this.expectOptionalToken(TokenKind.BANG)) { + return this.node(start, { + kind: Kind.NON_NULL_TYPE, + type, + }); + } - return type; + return type; + } } /** diff --git a/src/language/tokenKind.ts b/src/language/tokenKind.ts index fd53d6ebf3..0b651d36b0 100644 --- a/src/language/tokenKind.ts +++ b/src/language/tokenKind.ts @@ -6,7 +6,7 @@ enum TokenKind { SOF = '', EOF = '', BANG = '!', - ASTERISK = '*', + QUESTION_MARK = '?', DOLLAR = '$', AMP = '&', PAREN_L = '(', From 557a9866f2b178b85c2be1652bc73c152522da09 Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 09:17:05 -0800 Subject: [PATCH 20/31] Add semantic optional type --- src/language/ast.ts | 11 ++++++++++- src/language/kinds.ts | 1 + src/language/parser.ts | 6 +++++- src/language/printer.ts | 16 +++++++++++++--- 4 files changed, 29 insertions(+), 5 deletions(-) diff --git a/src/language/ast.ts b/src/language/ast.ts index f3fc60c3cb..55886f8e81 100644 --- a/src/language/ast.ts +++ b/src/language/ast.ts @@ -162,6 +162,7 @@ export type ASTNode = | ListTypeNode | NonNullTypeNode | SemanticNonNullTypeNode + | SemanticOptionalTypeNode | SchemaDefinitionNode | OperationTypeDefinitionNode | ScalarTypeDefinitionNode @@ -237,6 +238,7 @@ export const QueryDocumentKeys: { ListType: ['type'], NonNullType: ['type'], SemanticNonNullType: ['type'], + SemanticOptionalType: ['type'], SchemaDefinition: ['description', 'directives', 'operationTypes'], OperationTypeDefinition: ['type'], @@ -526,7 +528,8 @@ export type TypeNode = | NamedTypeNode | ListTypeNode | NonNullTypeNode - | SemanticNonNullTypeNode; + | SemanticNonNullTypeNode + | SemanticOptionalTypeNode; export interface NamedTypeNode { readonly kind: Kind.NAMED_TYPE; @@ -552,6 +555,12 @@ export interface SemanticNonNullTypeNode { readonly type: NamedTypeNode | ListTypeNode; } +export interface SemanticOptionalTypeNode { + readonly kind: Kind.SEMANTIC_OPTIONAL_TYPE; + readonly loc?: Location; + readonly type: NamedTypeNode | ListTypeNode; +} + /** Type System Definition */ export type TypeSystemDefinitionNode = diff --git a/src/language/kinds.ts b/src/language/kinds.ts index e91373746c..3b63882795 100644 --- a/src/language/kinds.ts +++ b/src/language/kinds.ts @@ -38,6 +38,7 @@ enum Kind { LIST_TYPE = 'ListType', NON_NULL_TYPE = 'NonNullType', SEMANTIC_NON_NULL_TYPE = 'SemanticNonNullType', + SEMANTIC_OPTIONAL_TYPE = 'SemanticOptionalType', /** Type System Definitions */ SCHEMA_DEFINITION = 'SchemaDefinition', diff --git a/src/language/parser.ts b/src/language/parser.ts index 57e6f123db..a7dec56163 100644 --- a/src/language/parser.ts +++ b/src/language/parser.ts @@ -51,6 +51,7 @@ import type { SelectionNode, SelectionSetNode, SemanticNonNullTypeNode, + SemanticOptionalTypeNode, StringValueNode, Token, TypeNode, @@ -774,7 +775,10 @@ export class Parser { type, }); } else if (this.expectOptionalToken(TokenKind.QUESTION_MARK)) { - return type; + return this.node(start, { + kind: Kind.SEMANTIC_OPTIONAL_TYPE, + type, + }); } else { return this.node(start, { kind: Kind.SEMANTIC_NON_NULL_TYPE, diff --git a/src/language/printer.ts b/src/language/printer.ts index f08ba54f56..6c6e6b2fe1 100644 --- a/src/language/printer.ts +++ b/src/language/printer.ts @@ -6,11 +6,18 @@ import { printString } from './printString'; import type { ASTReducer } from './visitor'; import { visit } from './visitor'; +/** + * Configuration options to control parser behavior + */ +export interface PrintOptions { + useSemanticNullability?: boolean; +} + /** * Converts an AST into a string, using one set of reasonable * formatting rules. */ -export function print(ast: ASTNode): string { +export function print(ast: ASTNode, options: PrintOptions = {}): string { return visit(ast, printDocASTReducer); } @@ -128,10 +135,13 @@ const printDocASTReducer: ASTReducer = { // Type - NamedType: { leave: ({ name }) => name }, + NamedType: { leave: ({ name }) => + name +}, ListType: { leave: ({ type }) => '[' + type + ']' }, NonNullType: { leave: ({ type }) => type + '!' }, - SemanticNonNullType: { leave: ({ type }) => type + '*' }, + SemanticNonNullType: { leave: ({ type }) => type }, + SemanticOptionalType: { leave: ({ type }) => type + '?' }, // Type System Definitions From 95484ba2bf79550ce44fce07c46382377130bd59 Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 09:38:25 -0800 Subject: [PATCH 21/31] printer and parser tests passing --- src/language/__tests__/parser-test.ts | 22 +++++++++++-------- src/language/__tests__/schema-printer-test.ts | 19 +++++++++++++++- 2 files changed, 31 insertions(+), 10 deletions(-) diff --git a/src/language/__tests__/parser-test.ts b/src/language/__tests__/parser-test.ts index a9b0d13ebf..aec2ceef8a 100644 --- a/src/language/__tests__/parser-test.ts +++ b/src/language/__tests__/parser-test.ts @@ -686,15 +686,19 @@ describe('Parser', () => { it('parses nullable types', () => { const result = parseType('MyType?', { useSemanticNullability: true }); - expectJSON(result).toDeepEqual({ - kind: Kind.NAMED_TYPE, - loc: { start: 0, end: 6 }, - name: { - kind: Kind.NAME, - loc: { start: 0, end: 6 }, - value: 'MyType', - }, - }); + expectJSON(result).toDeepEqual( + { kind: Kind.SEMANTIC_OPTIONAL_TYPE, + loc: { start: 0, end: 7 }, + type: { + kind: Kind.NAMED_TYPE, + loc: { start: 0, end: 6 }, + name: { + kind: Kind.NAME, + loc: { start: 0, end: 6 }, + value: 'MyType', + }, + } + }); }); it('parses non-nullable types', () => { diff --git a/src/language/__tests__/schema-printer-test.ts b/src/language/__tests__/schema-printer-test.ts index 41cf6c5419..7151c5dcef 100644 --- a/src/language/__tests__/schema-printer-test.ts +++ b/src/language/__tests__/schema-printer-test.ts @@ -5,7 +5,7 @@ import { dedent } from '../../__testUtils__/dedent'; import { kitchenSinkSDL } from '../../__testUtils__/kitchenSinkSDL'; import { Kind } from '../kinds'; -import { parse } from '../parser'; +import { parse, parseType } from '../parser'; import { print } from '../printer'; describe('Printer: SDL document', () => { @@ -180,4 +180,21 @@ describe('Printer: SDL document', () => { } `); }); + + it('prints NamedType', () => { + expect(print(parseType('MyType', { useSemanticNullability: false }))).to.equal(dedent`MyType`); + }); + + it('prints SemanticOptionalType', () => { + expect(print(parseType('MyType?', { useSemanticNullability: true }))).to.equal(dedent`MyType?`); + }); + + it('prints SemanticNonNullType', () => { + expect(print(parseType('MyType', { useSemanticNullability: true }))).to.equal(dedent`MyType`); + }); + + it('prints NonNullType', () => { + expect(print(parseType('MyType!', { useSemanticNullability: true }))).to.equal(dedent`MyType!`); + expect(print(parseType('MyType!', { useSemanticNullability: false }))).to.equal(dedent`MyType!`); + }); }); From 07e4646caa3b316d421708ff715f2dbb4b6ad8ed Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 21:57:10 -0800 Subject: [PATCH 22/31] some new semanticNullability execution tests --- package.json | 2 +- src/execution/__tests__/executor-test.ts | 153 +++++++++++++++++++++++ src/execution/execute.ts | 23 +++- src/type/definition.ts | 93 +++++++++++++- 4 files changed, 265 insertions(+), 6 deletions(-) diff --git a/package.json b/package.json index 85a6688a83..9a4f2909fa 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ "test": "npm run lint && npm run check && npm run testonly && npm run prettier:check && npm run check:spelling && npm run check:integrations", "lint": "eslint --cache --max-warnings 0 .", "check": "tsc --pretty", - "testonly": "mocha --full-trace src/**/__tests__/**/*-test.ts", + "testonly": "mocha --full-trace src/**/__tests__/**/*-test.ts -g 'SemanticNonNull halts null propagation'", "testonly:cover": "c8 npm run testonly", "prettier": "prettier --write --list-different .", "prettier:check": "prettier --check .", diff --git a/src/execution/__tests__/executor-test.ts b/src/execution/__tests__/executor-test.ts index a7bc1c8265..eff7b43bf4 100644 --- a/src/execution/__tests__/executor-test.ts +++ b/src/execution/__tests__/executor-test.ts @@ -16,12 +16,16 @@ import { GraphQLNonNull, GraphQLObjectType, GraphQLScalarType, + GraphQLSemanticNonNull, + GraphQLSemanticOptional, GraphQLUnionType, } from '../../type/definition'; import { GraphQLBoolean, GraphQLInt, GraphQLString } from '../../type/scalars'; import { GraphQLSchema } from '../../type/schema'; import { execute, executeSync } from '../execute'; +import { GraphQLError } from '../../error'; +import { ExecutableDefinitionNode, FieldNode, SelectionSetNode } from '../../language'; describe('Execute: Handles basic execution tasks', () => { it('throws if no document is provided', () => { @@ -1323,3 +1327,152 @@ describe('Execute: Handles basic execution tasks', () => { expect(possibleTypes).to.deep.equal([fooObject]); }); }); + +describe('Execute: Handles Semantic Nullability', () => { + const DeepDataType = new GraphQLObjectType({ + name: 'DeepDataType', + fields: { + f: { type: new GraphQLNonNull(GraphQLString) } + }, + }); + + const DataType: GraphQLObjectType = new GraphQLObjectType({ + name: 'DataType', + fields: () => ({ + a: { type: new GraphQLSemanticOptional(GraphQLString) }, + b: { type: new GraphQLSemanticNonNull(GraphQLString) }, + c: { type: new GraphQLNonNull(GraphQLString) }, + d: { type: new GraphQLSemanticNonNull(DeepDataType) } + }), + }); + + it('SemanticNonNull throws error on null without error', async () => { + const data = { + a: () => 'Apple', + b: () => null, + c: () => 'Cookie' + }; + + const document = parse(` + query { + b + } + `); + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; + let selectionSet = executable.selectionSet.selections.values().next().value; + + expect(result).to.deep.equal({ + data: { + b: null + }, + errors: [ + new GraphQLError( + 'Cannot return null for semantic-non-nullable field DataType.b.', + { + nodes: selectionSet, + path: ['b'] + } + ) + ] + }); + }); + + it('SemanticNonNull succeeds on null with error', async () => { + const data = { + a: () => 'Apple', + b: () => { throw new Error( + `Something went wrong`, + ); }, + c: () => 'Cookie' + }; + + const document = parse(` + query { + b + } + `); + + let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; + let selectionSet = executable.selectionSet.selections.values().next().value; + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + expect(result).to.deep.equal({ + data: { + b: null + }, + errors: [ + new GraphQLError( + 'Something went wrong', + { + nodes: selectionSet, + path: ['b'] + } + ) + ] + }); + }); + + it('SemanticNonNull halts null propagation', async () => { + const data = { + a: () => 'Apple', + b: () => null, + c: () => 'Cookie', + d: () => { + f: () => null + } + }; + + const document = parse(` + query { + d { + f + } + } + `); + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; + let dSelectionSet = executable.selectionSet.selections.values().next().value as FieldNode; + let fSelectionSet = dSelectionSet.selectionSet?.selections.values().next().value; + + expect(result).to.deep.equal({ + data: { + d: null + }, + errors: [ + new GraphQLError( + 'Cannot return null for non-nullable field DeepDataType.f.', + { + nodes: fSelectionSet, + path: ['d', 'f'] + } + ) + ] + }); + }); + + it('SemanticOptional allows null values', async () => { + + }); + + it('SemanticOptional allows non-null values', async () => { + + }); +}); diff --git a/src/execution/execute.ts b/src/execution/execute.ts index b7cb7f4a02..eab3ff210d 100644 --- a/src/execution/execute.ts +++ b/src/execution/execute.ts @@ -44,6 +44,7 @@ import { isNonNullType, isObjectType, isSemanticNonNullType, + isSemanticOptionalType, } from '../type/definition'; import { SchemaMetaFieldDef, @@ -650,9 +651,12 @@ function completeValue( throw result; } + console.log("anything", path); + // If field type is NonNull, complete for inner type, and throw field error // if result is null. if (isNonNullType(returnType)) { + console.log("is non null"); const completed = completeValue( exeContext, returnType.ofType, @@ -670,8 +674,9 @@ function completeValue( } // If field type is SemanticNonNull, complete for inner type, and throw field error - // if result is null. + // if result is null and an error doesn't exist. if (isSemanticNonNullType(returnType)) { + console.log("Is semantic non null") const completed = completeValue( exeContext, returnType.ofType, @@ -688,8 +693,21 @@ function completeValue( return completed; } + // If field type is SemanticOptional, complete for inner type + if (isSemanticOptionalType(returnType)) { + return completeValue( + exeContext, + returnType.ofType, + fieldNodes, + info, + path, + result, + ); + } + // If result value is null or undefined then return null. if (result == null) { + console.log("is null") return null; } @@ -708,12 +726,14 @@ function completeValue( // If field type is a leaf type, Scalar or Enum, serialize to a valid value, // returning null if serialization is not possible. if (isLeafType(returnType)) { + console.log("is leaf") return completeLeafValue(returnType, result); } // If field type is an abstract type, Interface or Union, determine the // runtime Object type and complete for that type. if (isAbstractType(returnType)) { + console.log("is abstract") return completeAbstractValue( exeContext, returnType, @@ -726,6 +746,7 @@ function completeValue( // If field type is Object, execute and complete all sub-selections. if (isObjectType(returnType)) { + console.log("is object") return completeObjectValue( exeContext, returnType, diff --git a/src/type/definition.ts b/src/type/definition.ts index 554ec0fe41..dcad08a501 100644 --- a/src/type/definition.ts +++ b/src/type/definition.ts @@ -75,7 +75,16 @@ export type GraphQLType = | GraphQLEnumType | GraphQLInputObjectType | GraphQLList - >; + > + | GraphQLSemanticOptional< + | GraphQLScalarType + | GraphQLObjectType + | GraphQLInterfaceType + | GraphQLUnionType + | GraphQLEnumType + | GraphQLInputObjectType + | GraphQLList + >; export function isType(type: unknown): type is GraphQLType { return ( @@ -239,6 +248,32 @@ export function assertSemanticNonNullType( return type; } +export function isSemanticOptionalType( + type: GraphQLInputType, +): type is GraphQLSemanticOptional; +export function isSemanticOptionalType( + type: GraphQLOutputType, +): type is GraphQLSemanticOptional; +export function isSemanticOptionalType( + type: unknown, +): type is GraphQLSemanticOptional; +export function isSemanticOptionalType( + type: unknown, +): type is GraphQLSemanticOptional { + return instanceOf(type, GraphQLSemanticOptional); +} + +export function assertSemanticOptionalType( + type: unknown, +): GraphQLSemanticOptional { + if (!isSemanticOptionalType(type)) { + throw new Error( + `Expected ${inspect(type)} to be a GraphQL Semantic-Non-Null type.`, + ); + } + return type; +} + /** * These types may be used as input types for arguments and directives. */ @@ -502,7 +537,56 @@ export class GraphQLSemanticNonNull { } toString(): string { - return String(this.ofType) + '*'; + return String(this.ofType); + } + + toJSON(): string { + return this.toString(); + } +} + +/** + * Semantic-Non-Null Type Wrapper + * + * A semantic-non-null is a wrapping type which points to another type. + * Semantic-non-null types enforce that their values are never null unless + * caused by an error being raised. It is useful for fields which you can make + * a guarantee on non-nullability in a no-error case, for example when you know + * that a related entity must exist (but acknowledge that retrieving it may + * produce an error). + * + * Example: + * + * ```ts + * const RowType = new GraphQLObjectType({ + * name: 'Row', + * fields: () => ({ + * email: { type: new GraphQLSemanticNonNull(GraphQLString) }, + * }) + * }) + * ``` + * Note: the enforcement of non-nullability occurs within the executor. + * + * @experimental + */ +export class GraphQLSemanticOptional { + readonly ofType: T; + + constructor(ofType: T) { + devAssert( + isNullableType(ofType), + `Expected ${inspect(ofType)} to be a GraphQL nullable type.`, + ); + + this.ofType = ofType; + } + + get [Symbol.toStringTag]() { + return 'GraphQLSemanticOptional'; + } + + toString(): string { + return String(this.ofType) + '?'; } toJSON(): string { @@ -517,10 +601,11 @@ export class GraphQLSemanticNonNull { export type GraphQLWrappingType = | GraphQLList | GraphQLNonNull - | GraphQLSemanticNonNull; + | GraphQLSemanticNonNull + | GraphQLSemanticOptional; export function isWrappingType(type: unknown): type is GraphQLWrappingType { - return isListType(type) || isNonNullType(type) || isSemanticNonNullType(type); + return isListType(type) || isNonNullType(type) || isSemanticNonNullType(type) || isSemanticOptionalType(type); } export function assertWrappingType(type: unknown): GraphQLWrappingType { From 6fac3b531d1a9ec0d5a3184854b3e53c4b91bee7 Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 22:05:35 -0800 Subject: [PATCH 23/31] SemanticNonNull halts null propagation --- src/execution/__tests__/executor-test.ts | 9 ++++++--- src/execution/execute.ts | 2 +- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/execution/__tests__/executor-test.ts b/src/execution/__tests__/executor-test.ts index eff7b43bf4..955a5417a9 100644 --- a/src/execution/__tests__/executor-test.ts +++ b/src/execution/__tests__/executor-test.ts @@ -1425,14 +1425,17 @@ describe('Execute: Handles Semantic Nullability', () => { }); it('SemanticNonNull halts null propagation', async () => { + const deepData = { + f: () => null + }; + const data = { a: () => 'Apple', b: () => null, c: () => 'Cookie', - d: () => { - f: () => null - } + d: () => deepData }; + const document = parse(` query { diff --git a/src/execution/execute.ts b/src/execution/execute.ts index eab3ff210d..d1c72b3ada 100644 --- a/src/execution/execute.ts +++ b/src/execution/execute.ts @@ -651,7 +651,7 @@ function completeValue( throw result; } - console.log("anything", path); + console.log("anything", path, result); // If field type is NonNull, complete for inner type, and throw field error // if result is null. From d11a647228c23b6bb6686c2e35ea05d6677d9d16 Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 22:08:47 -0800 Subject: [PATCH 24/31] SemanticOptional cleared --- package.json | 2 +- src/execution/__tests__/executor-test.ts | 44 ++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 9a4f2909fa..785f486d45 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ "test": "npm run lint && npm run check && npm run testonly && npm run prettier:check && npm run check:spelling && npm run check:integrations", "lint": "eslint --cache --max-warnings 0 .", "check": "tsc --pretty", - "testonly": "mocha --full-trace src/**/__tests__/**/*-test.ts -g 'SemanticNonNull halts null propagation'", + "testonly": "mocha --full-trace src/**/__tests__/**/*-test.ts -g 'SemanticOptional allows null values'", "testonly:cover": "c8 npm run testonly", "prettier": "prettier --write --list-different .", "prettier:check": "prettier --check .", diff --git a/src/execution/__tests__/executor-test.ts b/src/execution/__tests__/executor-test.ts index 955a5417a9..0be5c672b4 100644 --- a/src/execution/__tests__/executor-test.ts +++ b/src/execution/__tests__/executor-test.ts @@ -1472,10 +1472,54 @@ describe('Execute: Handles Semantic Nullability', () => { }); it('SemanticOptional allows null values', async () => { + const data = { + a: () => null, + b: () => null, + c: () => 'Cookie' + }; + + const document = parse(` + query { + a + } + `); + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + expect(result).to.deep.equal({ + data: { + a: null + } + }); }); it('SemanticOptional allows non-null values', async () => { + const data = { + a: () => 'Apple', + b: () => null, + c: () => 'Cookie' + }; + + const document = parse(` + query { + a + } + `); + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + expect(result).to.deep.equal({ + data: { + a: 'Apple' + } + }); }); }); From 0a8b68f022f768a5eb556b2a622f1c7fba45ac8d Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 22:09:46 -0800 Subject: [PATCH 25/31] logging cleanup --- src/execution/execute.ts | 8 -------- 1 file changed, 8 deletions(-) diff --git a/src/execution/execute.ts b/src/execution/execute.ts index d1c72b3ada..220621f98a 100644 --- a/src/execution/execute.ts +++ b/src/execution/execute.ts @@ -651,12 +651,9 @@ function completeValue( throw result; } - console.log("anything", path, result); - // If field type is NonNull, complete for inner type, and throw field error // if result is null. if (isNonNullType(returnType)) { - console.log("is non null"); const completed = completeValue( exeContext, returnType.ofType, @@ -676,7 +673,6 @@ function completeValue( // If field type is SemanticNonNull, complete for inner type, and throw field error // if result is null and an error doesn't exist. if (isSemanticNonNullType(returnType)) { - console.log("Is semantic non null") const completed = completeValue( exeContext, returnType.ofType, @@ -707,7 +703,6 @@ function completeValue( // If result value is null or undefined then return null. if (result == null) { - console.log("is null") return null; } @@ -726,14 +721,12 @@ function completeValue( // If field type is a leaf type, Scalar or Enum, serialize to a valid value, // returning null if serialization is not possible. if (isLeafType(returnType)) { - console.log("is leaf") return completeLeafValue(returnType, result); } // If field type is an abstract type, Interface or Union, determine the // runtime Object type and complete for that type. if (isAbstractType(returnType)) { - console.log("is abstract") return completeAbstractValue( exeContext, returnType, @@ -746,7 +739,6 @@ function completeValue( // If field type is Object, execute and complete all sub-selections. if (isObjectType(returnType)) { - console.log("is object") return completeObjectValue( exeContext, returnType, From 24474fa8425def840b799a1d2a0769107a3653ae Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 22:14:37 -0800 Subject: [PATCH 26/31] rename to SemanticNullable --- package.json | 2 +- src/execution/__tests__/executor-test.ts | 8 ++--- src/execution/execute.ts | 6 ++-- src/language/__tests__/parser-test.ts | 2 +- src/language/__tests__/schema-printer-test.ts | 2 +- src/language/ast.ts | 10 +++--- src/language/kinds.ts | 2 +- src/language/parser.ts | 6 ++-- src/language/printer.ts | 2 +- src/type/definition.ts | 36 +++++++++---------- 10 files changed, 38 insertions(+), 38 deletions(-) diff --git a/package.json b/package.json index 785f486d45..85a6688a83 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ "test": "npm run lint && npm run check && npm run testonly && npm run prettier:check && npm run check:spelling && npm run check:integrations", "lint": "eslint --cache --max-warnings 0 .", "check": "tsc --pretty", - "testonly": "mocha --full-trace src/**/__tests__/**/*-test.ts -g 'SemanticOptional allows null values'", + "testonly": "mocha --full-trace src/**/__tests__/**/*-test.ts", "testonly:cover": "c8 npm run testonly", "prettier": "prettier --write --list-different .", "prettier:check": "prettier --check .", diff --git a/src/execution/__tests__/executor-test.ts b/src/execution/__tests__/executor-test.ts index 0be5c672b4..4c0600285f 100644 --- a/src/execution/__tests__/executor-test.ts +++ b/src/execution/__tests__/executor-test.ts @@ -17,7 +17,7 @@ import { GraphQLObjectType, GraphQLScalarType, GraphQLSemanticNonNull, - GraphQLSemanticOptional, + GraphQLSemanticNullable, GraphQLUnionType, } from '../../type/definition'; import { GraphQLBoolean, GraphQLInt, GraphQLString } from '../../type/scalars'; @@ -1339,7 +1339,7 @@ describe('Execute: Handles Semantic Nullability', () => { const DataType: GraphQLObjectType = new GraphQLObjectType({ name: 'DataType', fields: () => ({ - a: { type: new GraphQLSemanticOptional(GraphQLString) }, + a: { type: new GraphQLSemanticNullable(GraphQLString) }, b: { type: new GraphQLSemanticNonNull(GraphQLString) }, c: { type: new GraphQLNonNull(GraphQLString) }, d: { type: new GraphQLSemanticNonNull(DeepDataType) } @@ -1471,7 +1471,7 @@ describe('Execute: Handles Semantic Nullability', () => { }); }); - it('SemanticOptional allows null values', async () => { + it('SemanticNullable allows null values', async () => { const data = { a: () => null, b: () => null, @@ -1497,7 +1497,7 @@ describe('Execute: Handles Semantic Nullability', () => { }); }); - it('SemanticOptional allows non-null values', async () => { + it('SemanticNullable allows non-null values', async () => { const data = { a: () => 'Apple', b: () => null, diff --git a/src/execution/execute.ts b/src/execution/execute.ts index 220621f98a..b50395d2e3 100644 --- a/src/execution/execute.ts +++ b/src/execution/execute.ts @@ -44,7 +44,7 @@ import { isNonNullType, isObjectType, isSemanticNonNullType, - isSemanticOptionalType, + isSemanticNullableType, } from '../type/definition'; import { SchemaMetaFieldDef, @@ -689,8 +689,8 @@ function completeValue( return completed; } - // If field type is SemanticOptional, complete for inner type - if (isSemanticOptionalType(returnType)) { + // If field type is SemanticNullable, complete for inner type + if (isSemanticNullableType(returnType)) { return completeValue( exeContext, returnType.ofType, diff --git a/src/language/__tests__/parser-test.ts b/src/language/__tests__/parser-test.ts index aec2ceef8a..14c87c1af3 100644 --- a/src/language/__tests__/parser-test.ts +++ b/src/language/__tests__/parser-test.ts @@ -687,7 +687,7 @@ describe('Parser', () => { it('parses nullable types', () => { const result = parseType('MyType?', { useSemanticNullability: true }); expectJSON(result).toDeepEqual( - { kind: Kind.SEMANTIC_OPTIONAL_TYPE, + { kind: Kind.SEMANTIC_NULLABLE_TYPE, loc: { start: 0, end: 7 }, type: { kind: Kind.NAMED_TYPE, diff --git a/src/language/__tests__/schema-printer-test.ts b/src/language/__tests__/schema-printer-test.ts index 7151c5dcef..f98d37e28f 100644 --- a/src/language/__tests__/schema-printer-test.ts +++ b/src/language/__tests__/schema-printer-test.ts @@ -185,7 +185,7 @@ describe('Printer: SDL document', () => { expect(print(parseType('MyType', { useSemanticNullability: false }))).to.equal(dedent`MyType`); }); - it('prints SemanticOptionalType', () => { + it('prints SemanticNullableType', () => { expect(print(parseType('MyType?', { useSemanticNullability: true }))).to.equal(dedent`MyType?`); }); diff --git a/src/language/ast.ts b/src/language/ast.ts index 55886f8e81..a17edbb9bc 100644 --- a/src/language/ast.ts +++ b/src/language/ast.ts @@ -162,7 +162,7 @@ export type ASTNode = | ListTypeNode | NonNullTypeNode | SemanticNonNullTypeNode - | SemanticOptionalTypeNode + | SemanticNullableTypeNode | SchemaDefinitionNode | OperationTypeDefinitionNode | ScalarTypeDefinitionNode @@ -238,7 +238,7 @@ export const QueryDocumentKeys: { ListType: ['type'], NonNullType: ['type'], SemanticNonNullType: ['type'], - SemanticOptionalType: ['type'], + SemanticNullableType: ['type'], SchemaDefinition: ['description', 'directives', 'operationTypes'], OperationTypeDefinition: ['type'], @@ -529,7 +529,7 @@ export type TypeNode = | ListTypeNode | NonNullTypeNode | SemanticNonNullTypeNode - | SemanticOptionalTypeNode; + | SemanticNullableTypeNode; export interface NamedTypeNode { readonly kind: Kind.NAMED_TYPE; @@ -555,8 +555,8 @@ export interface SemanticNonNullTypeNode { readonly type: NamedTypeNode | ListTypeNode; } -export interface SemanticOptionalTypeNode { - readonly kind: Kind.SEMANTIC_OPTIONAL_TYPE; +export interface SemanticNullableTypeNode { + readonly kind: Kind.SEMANTIC_NULLABLE_TYPE; readonly loc?: Location; readonly type: NamedTypeNode | ListTypeNode; } diff --git a/src/language/kinds.ts b/src/language/kinds.ts index 3b63882795..7111a94834 100644 --- a/src/language/kinds.ts +++ b/src/language/kinds.ts @@ -38,7 +38,7 @@ enum Kind { LIST_TYPE = 'ListType', NON_NULL_TYPE = 'NonNullType', SEMANTIC_NON_NULL_TYPE = 'SemanticNonNullType', - SEMANTIC_OPTIONAL_TYPE = 'SemanticOptionalType', + SEMANTIC_NULLABLE_TYPE = 'SemanticNullableType', /** Type System Definitions */ SCHEMA_DEFINITION = 'SchemaDefinition', diff --git a/src/language/parser.ts b/src/language/parser.ts index a7dec56163..8aa729ba72 100644 --- a/src/language/parser.ts +++ b/src/language/parser.ts @@ -51,7 +51,7 @@ import type { SelectionNode, SelectionSetNode, SemanticNonNullTypeNode, - SemanticOptionalTypeNode, + SemanticNullableTypeNode, StringValueNode, Token, TypeNode, @@ -775,8 +775,8 @@ export class Parser { type, }); } else if (this.expectOptionalToken(TokenKind.QUESTION_MARK)) { - return this.node(start, { - kind: Kind.SEMANTIC_OPTIONAL_TYPE, + return this.node(start, { + kind: Kind.SEMANTIC_NULLABLE_TYPE, type, }); } else { diff --git a/src/language/printer.ts b/src/language/printer.ts index 6c6e6b2fe1..a380b5c778 100644 --- a/src/language/printer.ts +++ b/src/language/printer.ts @@ -141,7 +141,7 @@ const printDocASTReducer: ASTReducer = { ListType: { leave: ({ type }) => '[' + type + ']' }, NonNullType: { leave: ({ type }) => type + '!' }, SemanticNonNullType: { leave: ({ type }) => type }, - SemanticOptionalType: { leave: ({ type }) => type + '?' }, + SemanticNullableType: { leave: ({ type }) => type + '?' }, // Type System Definitions diff --git a/src/type/definition.ts b/src/type/definition.ts index dcad08a501..3376e2a74d 100644 --- a/src/type/definition.ts +++ b/src/type/definition.ts @@ -76,7 +76,7 @@ export type GraphQLType = | GraphQLInputObjectType | GraphQLList > - | GraphQLSemanticOptional< + | GraphQLSemanticNullable< | GraphQLScalarType | GraphQLObjectType | GraphQLInterfaceType @@ -248,25 +248,25 @@ export function assertSemanticNonNullType( return type; } -export function isSemanticOptionalType( +export function isSemanticNullableType( type: GraphQLInputType, -): type is GraphQLSemanticOptional; -export function isSemanticOptionalType( +): type is GraphQLSemanticNullable; +export function isSemanticNullableType( type: GraphQLOutputType, -): type is GraphQLSemanticOptional; -export function isSemanticOptionalType( +): type is GraphQLSemanticNullable; +export function isSemanticNullableType( type: unknown, -): type is GraphQLSemanticOptional; -export function isSemanticOptionalType( +): type is GraphQLSemanticNullable; +export function isSemanticNullableType( type: unknown, -): type is GraphQLSemanticOptional { - return instanceOf(type, GraphQLSemanticOptional); +): type is GraphQLSemanticNullable { + return instanceOf(type, GraphQLSemanticNullable); } -export function assertSemanticOptionalType( +export function assertSemanticNullableType( type: unknown, -): GraphQLSemanticOptional { - if (!isSemanticOptionalType(type)) { +): GraphQLSemanticNullable { + if (!isSemanticNullableType(type)) { throw new Error( `Expected ${inspect(type)} to be a GraphQL Semantic-Non-Null type.`, ); @@ -546,7 +546,7 @@ export class GraphQLSemanticNonNull { } /** - * Semantic-Non-Null Type Wrapper + * Semantic-Nullable Type Wrapper * * A semantic-non-null is a wrapping type which points to another type. * Semantic-non-null types enforce that their values are never null unless @@ -569,7 +569,7 @@ export class GraphQLSemanticNonNull { * * @experimental */ -export class GraphQLSemanticOptional { +export class GraphQLSemanticNullable { readonly ofType: T; constructor(ofType: T) { @@ -582,7 +582,7 @@ export class GraphQLSemanticOptional { } get [Symbol.toStringTag]() { - return 'GraphQLSemanticOptional'; + return 'GraphQLSemanticNullable'; } toString(): string { @@ -602,10 +602,10 @@ export type GraphQLWrappingType = | GraphQLList | GraphQLNonNull | GraphQLSemanticNonNull - | GraphQLSemanticOptional; + | GraphQLSemanticNullable; export function isWrappingType(type: unknown): type is GraphQLWrappingType { - return isListType(type) || isNonNullType(type) || isSemanticNonNullType(type) || isSemanticOptionalType(type); + return isListType(type) || isNonNullType(type) || isSemanticNonNullType(type) || isSemanticNullableType(type); } export function assertWrappingType(type: unknown): GraphQLWrappingType { From af58560d930938370667544f599f4cdf54d2318a Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 22:20:09 -0800 Subject: [PATCH 27/31] better SemanticNullable docs --- src/type/definition.ts | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/src/type/definition.ts b/src/type/definition.ts index 3376e2a74d..a7d7d2cd0d 100644 --- a/src/type/definition.ts +++ b/src/type/definition.ts @@ -548,12 +548,8 @@ export class GraphQLSemanticNonNull { /** * Semantic-Nullable Type Wrapper * - * A semantic-non-null is a wrapping type which points to another type. - * Semantic-non-null types enforce that their values are never null unless - * caused by an error being raised. It is useful for fields which you can make - * a guarantee on non-nullability in a no-error case, for example when you know - * that a related entity must exist (but acknowledge that retrieving it may - * produce an error). + * A semantic-nullable is a wrapping type which points to another type. + * Semantic-nullable types allow their values to be null. * * Example: * @@ -561,11 +557,12 @@ export class GraphQLSemanticNonNull { * const RowType = new GraphQLObjectType({ * name: 'Row', * fields: () => ({ - * email: { type: new GraphQLSemanticNonNull(GraphQLString) }, + * email: { type: new GraphQLSemanticNullable(GraphQLString) }, * }) * }) * ``` - * Note: the enforcement of non-nullability occurs within the executor. + * Note: This is equivalent to the unadorned named type that is + * used by GraphQL when it is not operating in SemanticNullability mode. * * @experimental */ From 668f3dcb08cdbba27e8a4441e0ffe4065112c772 Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 22:29:42 -0800 Subject: [PATCH 28/31] move semantic nullability tests to their own file --- src/execution/__tests__/executor-test.ts | 199 ----------------- .../__tests__/semantic-nullability-test.ts | 206 ++++++++++++++++++ 2 files changed, 206 insertions(+), 199 deletions(-) create mode 100644 src/execution/__tests__/semantic-nullability-test.ts diff --git a/src/execution/__tests__/executor-test.ts b/src/execution/__tests__/executor-test.ts index 4c0600285f..04bab46d24 100644 --- a/src/execution/__tests__/executor-test.ts +++ b/src/execution/__tests__/executor-test.ts @@ -16,16 +16,12 @@ import { GraphQLNonNull, GraphQLObjectType, GraphQLScalarType, - GraphQLSemanticNonNull, - GraphQLSemanticNullable, GraphQLUnionType, } from '../../type/definition'; import { GraphQLBoolean, GraphQLInt, GraphQLString } from '../../type/scalars'; import { GraphQLSchema } from '../../type/schema'; import { execute, executeSync } from '../execute'; -import { GraphQLError } from '../../error'; -import { ExecutableDefinitionNode, FieldNode, SelectionSetNode } from '../../language'; describe('Execute: Handles basic execution tasks', () => { it('throws if no document is provided', () => { @@ -1328,198 +1324,3 @@ describe('Execute: Handles basic execution tasks', () => { }); }); -describe('Execute: Handles Semantic Nullability', () => { - const DeepDataType = new GraphQLObjectType({ - name: 'DeepDataType', - fields: { - f: { type: new GraphQLNonNull(GraphQLString) } - }, - }); - - const DataType: GraphQLObjectType = new GraphQLObjectType({ - name: 'DataType', - fields: () => ({ - a: { type: new GraphQLSemanticNullable(GraphQLString) }, - b: { type: new GraphQLSemanticNonNull(GraphQLString) }, - c: { type: new GraphQLNonNull(GraphQLString) }, - d: { type: new GraphQLSemanticNonNull(DeepDataType) } - }), - }); - - it('SemanticNonNull throws error on null without error', async () => { - const data = { - a: () => 'Apple', - b: () => null, - c: () => 'Cookie' - }; - - const document = parse(` - query { - b - } - `); - - const result = await execute({ - schema: new GraphQLSchema({ query: DataType }), - document, - rootValue: data, - }); - - let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; - let selectionSet = executable.selectionSet.selections.values().next().value; - - expect(result).to.deep.equal({ - data: { - b: null - }, - errors: [ - new GraphQLError( - 'Cannot return null for semantic-non-nullable field DataType.b.', - { - nodes: selectionSet, - path: ['b'] - } - ) - ] - }); - }); - - it('SemanticNonNull succeeds on null with error', async () => { - const data = { - a: () => 'Apple', - b: () => { throw new Error( - `Something went wrong`, - ); }, - c: () => 'Cookie' - }; - - const document = parse(` - query { - b - } - `); - - let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; - let selectionSet = executable.selectionSet.selections.values().next().value; - - const result = await execute({ - schema: new GraphQLSchema({ query: DataType }), - document, - rootValue: data, - }); - - expect(result).to.deep.equal({ - data: { - b: null - }, - errors: [ - new GraphQLError( - 'Something went wrong', - { - nodes: selectionSet, - path: ['b'] - } - ) - ] - }); - }); - - it('SemanticNonNull halts null propagation', async () => { - const deepData = { - f: () => null - }; - - const data = { - a: () => 'Apple', - b: () => null, - c: () => 'Cookie', - d: () => deepData - }; - - - const document = parse(` - query { - d { - f - } - } - `); - - const result = await execute({ - schema: new GraphQLSchema({ query: DataType }), - document, - rootValue: data, - }); - - let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; - let dSelectionSet = executable.selectionSet.selections.values().next().value as FieldNode; - let fSelectionSet = dSelectionSet.selectionSet?.selections.values().next().value; - - expect(result).to.deep.equal({ - data: { - d: null - }, - errors: [ - new GraphQLError( - 'Cannot return null for non-nullable field DeepDataType.f.', - { - nodes: fSelectionSet, - path: ['d', 'f'] - } - ) - ] - }); - }); - - it('SemanticNullable allows null values', async () => { - const data = { - a: () => null, - b: () => null, - c: () => 'Cookie' - }; - - const document = parse(` - query { - a - } - `); - - const result = await execute({ - schema: new GraphQLSchema({ query: DataType }), - document, - rootValue: data, - }); - - expect(result).to.deep.equal({ - data: { - a: null - } - }); - }); - - it('SemanticNullable allows non-null values', async () => { - const data = { - a: () => 'Apple', - b: () => null, - c: () => 'Cookie' - }; - - const document = parse(` - query { - a - } - `); - - const result = await execute({ - schema: new GraphQLSchema({ query: DataType }), - document, - rootValue: data, - }); - - expect(result).to.deep.equal({ - data: { - a: 'Apple' - } - }); - }); -}); diff --git a/src/execution/__tests__/semantic-nullability-test.ts b/src/execution/__tests__/semantic-nullability-test.ts new file mode 100644 index 0000000000..f3ae81dc67 --- /dev/null +++ b/src/execution/__tests__/semantic-nullability-test.ts @@ -0,0 +1,206 @@ +import { expect } from 'chai'; +import { describe, it } from 'mocha'; +import { parse } from '../../language/parser'; +import { GraphQLNonNull, GraphQLObjectType, GraphQLSemanticNonNull, GraphQLSemanticNullable } from '../../type/definition'; +import { execute } from '../execute'; +import { GraphQLSchema } from '../../type/schema'; +import { GraphQLString } from '../../type/scalars'; +import { ExecutableDefinitionNode, FieldNode } from '../../language'; +import { GraphQLError } from '../../error/GraphQLError'; + +describe('Execute: Handles Semantic Nullability', () => { + const DeepDataType = new GraphQLObjectType({ + name: 'DeepDataType', + fields: { + f: { type: new GraphQLNonNull(GraphQLString) } + }, + }); + + const DataType: GraphQLObjectType = new GraphQLObjectType({ + name: 'DataType', + fields: () => ({ + a: { type: new GraphQLSemanticNullable(GraphQLString) }, + b: { type: new GraphQLSemanticNonNull(GraphQLString) }, + c: { type: new GraphQLNonNull(GraphQLString) }, + d: { type: new GraphQLSemanticNonNull(DeepDataType) } + }), + }); + + it('SemanticNonNull throws error on null without error', async () => { + const data = { + a: () => 'Apple', + b: () => null, + c: () => 'Cookie' + }; + + const document = parse(` + query { + b + } + `); + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; + let selectionSet = executable.selectionSet.selections.values().next().value; + + expect(result).to.deep.equal({ + data: { + b: null + }, + errors: [ + new GraphQLError( + 'Cannot return null for semantic-non-nullable field DataType.b.', + { + nodes: selectionSet, + path: ['b'] + } + ) + ] + }); + }); + + it('SemanticNonNull succeeds on null with error', async () => { + const data = { + a: () => 'Apple', + b: () => { throw new Error( + `Something went wrong`, + ); }, + c: () => 'Cookie' + }; + + const document = parse(` + query { + b + } + `); + + let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; + let selectionSet = executable.selectionSet.selections.values().next().value; + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + expect(result).to.deep.equal({ + data: { + b: null + }, + errors: [ + new GraphQLError( + 'Something went wrong', + { + nodes: selectionSet, + path: ['b'] + } + ) + ] + }); + }); + + it('SemanticNonNull halts null propagation', async () => { + const deepData = { + f: () => null + }; + + const data = { + a: () => 'Apple', + b: () => null, + c: () => 'Cookie', + d: () => deepData + }; + + + const document = parse(` + query { + d { + f + } + } + `); + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; + let dSelectionSet = executable.selectionSet.selections.values().next().value as FieldNode; + let fSelectionSet = dSelectionSet.selectionSet?.selections.values().next().value; + + expect(result).to.deep.equal({ + data: { + d: null + }, + errors: [ + new GraphQLError( + 'Cannot return null for non-nullable field DeepDataType.f.', + { + nodes: fSelectionSet, + path: ['d', 'f'] + } + ) + ] + }); + }); + + it('SemanticNullable allows null values', async () => { + const data = { + a: () => null, + b: () => null, + c: () => 'Cookie' + }; + + const document = parse(` + query { + a + } + `); + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + expect(result).to.deep.equal({ + data: { + a: null + } + }); + }); + + it('SemanticNullable allows non-null values', async () => { + const data = { + a: () => 'Apple', + b: () => null, + c: () => 'Cookie' + }; + + const document = parse(` + query { + a + } + `); + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + expect(result).to.deep.equal({ + data: { + a: 'Apple' + } + }); + }); + }); + \ No newline at end of file From 63345dee904a846721e047dcda4df63d5e1aeae1 Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 22:39:06 -0800 Subject: [PATCH 29/31] fix git status --- .../__tests__/semantic-nullability-test.ts | 28 ++++++++------- src/language/__tests__/parser-test.ts | 1 - src/language/parser.ts | 34 +++++++++---------- src/language/printer.ts | 2 +- 4 files changed, 34 insertions(+), 31 deletions(-) diff --git a/src/execution/__tests__/semantic-nullability-test.ts b/src/execution/__tests__/semantic-nullability-test.ts index f3ae81dc67..73c7db65ad 100644 --- a/src/execution/__tests__/semantic-nullability-test.ts +++ b/src/execution/__tests__/semantic-nullability-test.ts @@ -1,12 +1,16 @@ import { expect } from 'chai'; import { describe, it } from 'mocha'; + +import { GraphQLError } from '../../error/GraphQLError'; + +import type { ExecutableDefinitionNode, FieldNode } from '../../language/ast'; import { parse } from '../../language/parser'; + import { GraphQLNonNull, GraphQLObjectType, GraphQLSemanticNonNull, GraphQLSemanticNullable } from '../../type/definition'; -import { execute } from '../execute'; -import { GraphQLSchema } from '../../type/schema'; import { GraphQLString } from '../../type/scalars'; -import { ExecutableDefinitionNode, FieldNode } from '../../language'; -import { GraphQLError } from '../../error/GraphQLError'; +import { GraphQLSchema } from '../../type/schema'; + +import { execute } from '../execute'; describe('Execute: Handles Semantic Nullability', () => { const DeepDataType = new GraphQLObjectType({ @@ -45,8 +49,8 @@ describe('Execute: Handles Semantic Nullability', () => { rootValue: data, }); - let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; - let selectionSet = executable.selectionSet.selections.values().next().value; + const executable = document.definitions?.values().next().value as ExecutableDefinitionNode; + const selectionSet = executable.selectionSet.selections.values().next().value; expect(result).to.deep.equal({ data: { @@ -68,7 +72,7 @@ describe('Execute: Handles Semantic Nullability', () => { const data = { a: () => 'Apple', b: () => { throw new Error( - `Something went wrong`, + 'Something went wrong', ); }, c: () => 'Cookie' }; @@ -79,8 +83,8 @@ describe('Execute: Handles Semantic Nullability', () => { } `); - let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; - let selectionSet = executable.selectionSet.selections.values().next().value; + const executable = document.definitions?.values().next().value as ExecutableDefinitionNode; + const selectionSet = executable.selectionSet.selections.values().next().value; const result = await execute({ schema: new GraphQLSchema({ query: DataType }), @@ -131,9 +135,9 @@ describe('Execute: Handles Semantic Nullability', () => { rootValue: data, }); - let executable = document.definitions?.values().next().value as ExecutableDefinitionNode; - let dSelectionSet = executable.selectionSet.selections.values().next().value as FieldNode; - let fSelectionSet = dSelectionSet.selectionSet?.selections.values().next().value; + const executable = document.definitions?.values().next().value as ExecutableDefinitionNode; + const dSelectionSet = executable.selectionSet.selections.values().next().value as FieldNode; + const fSelectionSet = dSelectionSet.selectionSet?.selections.values().next().value; expect(result).to.deep.equal({ data: { diff --git a/src/language/__tests__/parser-test.ts b/src/language/__tests__/parser-test.ts index 14c87c1af3..18011660ed 100644 --- a/src/language/__tests__/parser-test.ts +++ b/src/language/__tests__/parser-test.ts @@ -11,7 +11,6 @@ import { Kind } from '../kinds'; import { parse, parseConstValue, parseType, parseValue } from '../parser'; import { Source } from '../source'; import { TokenKind } from '../tokenKind'; -import { Console } from 'console'; function expectSyntaxError(text: string) { return expectToThrowJSON(() => parse(text)); diff --git a/src/language/parser.ts b/src/language/parser.ts index 8aa729ba72..cd75743664 100644 --- a/src/language/parser.ts +++ b/src/language/parser.ts @@ -254,9 +254,9 @@ export class Parser { */ parseDefinition(): DefinitionNode { // TODO: I don't know what isConst represents. Every other callsite has it false - let directives = this.parseDirectives(false); - for (let directive of directives) { - if (directive.name.value == "SemanticNullability") { + const directives = this.parseDirectives(false); + for (const directive of directives) { + if (directive.name.value === 'SemanticNullability') { this._options.useSemanticNullability = true; } } @@ -779,22 +779,22 @@ export class Parser { kind: Kind.SEMANTIC_NULLABLE_TYPE, type, }); - } else { - return this.node(start, { - kind: Kind.SEMANTIC_NON_NULL_TYPE, - type, - }); } - } else { - if (this.expectOptionalToken(TokenKind.BANG)) { - return this.node(start, { - kind: Kind.NON_NULL_TYPE, - type, - }); - } - - return type; + + return this.node(start, { + kind: Kind.SEMANTIC_NON_NULL_TYPE, + type, + }); + } + + if (this.expectOptionalToken(TokenKind.BANG)) { + return this.node(start, { + kind: Kind.NON_NULL_TYPE, + type, + }); } + + return type; } /** diff --git a/src/language/printer.ts b/src/language/printer.ts index a380b5c778..a72f5b8505 100644 --- a/src/language/printer.ts +++ b/src/language/printer.ts @@ -17,7 +17,7 @@ export interface PrintOptions { * Converts an AST into a string, using one set of reasonable * formatting rules. */ -export function print(ast: ASTNode, options: PrintOptions = {}): string { +export function print(ast: ASTNode): string { return visit(ast, printDocASTReducer); } From c472b9e4c80570233a08e6bc105a1bac70731a47 Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 22:41:28 -0800 Subject: [PATCH 30/31] run prettier --- src/execution/__tests__/executor-test.ts | 1 - .../__tests__/semantic-nullability-test.ts | 346 +++++++++--------- src/language/__tests__/parser-test.ts | 24 +- src/language/__tests__/schema-printer-test.ts | 22 +- src/language/lexer.ts | 7 +- src/language/parser.ts | 6 +- src/language/printer.ts | 4 +- src/type/definition.ts | 11 +- 8 files changed, 224 insertions(+), 197 deletions(-) diff --git a/src/execution/__tests__/executor-test.ts b/src/execution/__tests__/executor-test.ts index 04bab46d24..a7bc1c8265 100644 --- a/src/execution/__tests__/executor-test.ts +++ b/src/execution/__tests__/executor-test.ts @@ -1323,4 +1323,3 @@ describe('Execute: Handles basic execution tasks', () => { expect(possibleTypes).to.deep.equal([fooObject]); }); }); - diff --git a/src/execution/__tests__/semantic-nullability-test.ts b/src/execution/__tests__/semantic-nullability-test.ts index 73c7db65ad..20a33c2ffa 100644 --- a/src/execution/__tests__/semantic-nullability-test.ts +++ b/src/execution/__tests__/semantic-nullability-test.ts @@ -6,205 +6,215 @@ import { GraphQLError } from '../../error/GraphQLError'; import type { ExecutableDefinitionNode, FieldNode } from '../../language/ast'; import { parse } from '../../language/parser'; -import { GraphQLNonNull, GraphQLObjectType, GraphQLSemanticNonNull, GraphQLSemanticNullable } from '../../type/definition'; +import { + GraphQLNonNull, + GraphQLObjectType, + GraphQLSemanticNonNull, + GraphQLSemanticNullable, +} from '../../type/definition'; import { GraphQLString } from '../../type/scalars'; import { GraphQLSchema } from '../../type/schema'; import { execute } from '../execute'; describe('Execute: Handles Semantic Nullability', () => { - const DeepDataType = new GraphQLObjectType({ - name: 'DeepDataType', - fields: { - f: { type: new GraphQLNonNull(GraphQLString) } - }, - }); - - const DataType: GraphQLObjectType = new GraphQLObjectType({ - name: 'DataType', - fields: () => ({ - a: { type: new GraphQLSemanticNullable(GraphQLString) }, - b: { type: new GraphQLSemanticNonNull(GraphQLString) }, - c: { type: new GraphQLNonNull(GraphQLString) }, - d: { type: new GraphQLSemanticNonNull(DeepDataType) } - }), - }); - - it('SemanticNonNull throws error on null without error', async () => { - const data = { - a: () => 'Apple', - b: () => null, - c: () => 'Cookie' - }; - - const document = parse(` + const DeepDataType = new GraphQLObjectType({ + name: 'DeepDataType', + fields: { + f: { type: new GraphQLNonNull(GraphQLString) }, + }, + }); + + const DataType: GraphQLObjectType = new GraphQLObjectType({ + name: 'DataType', + fields: () => ({ + a: { type: new GraphQLSemanticNullable(GraphQLString) }, + b: { type: new GraphQLSemanticNonNull(GraphQLString) }, + c: { type: new GraphQLNonNull(GraphQLString) }, + d: { type: new GraphQLSemanticNonNull(DeepDataType) }, + }), + }); + + it('SemanticNonNull throws error on null without error', async () => { + const data = { + a: () => 'Apple', + b: () => null, + c: () => 'Cookie', + }; + + const document = parse(` query { b } `); - - const result = await execute({ - schema: new GraphQLSchema({ query: DataType }), - document, - rootValue: data, - }); - - const executable = document.definitions?.values().next().value as ExecutableDefinitionNode; - const selectionSet = executable.selectionSet.selections.values().next().value; - - expect(result).to.deep.equal({ - data: { - b: null - }, - errors: [ - new GraphQLError( - 'Cannot return null for semantic-non-nullable field DataType.b.', - { - nodes: selectionSet, - path: ['b'] - } - ) - ] - }); + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + const executable = document.definitions?.values().next() + .value as ExecutableDefinitionNode; + const selectionSet = executable.selectionSet.selections + .values() + .next().value; + + expect(result).to.deep.equal({ + data: { + b: null, + }, + errors: [ + new GraphQLError( + 'Cannot return null for semantic-non-nullable field DataType.b.', + { + nodes: selectionSet, + path: ['b'], + }, + ), + ], }); - - it('SemanticNonNull succeeds on null with error', async () => { - const data = { - a: () => 'Apple', - b: () => { throw new Error( - 'Something went wrong', - ); }, - c: () => 'Cookie' - }; - - const document = parse(` + }); + + it('SemanticNonNull succeeds on null with error', async () => { + const data = { + a: () => 'Apple', + b: () => { + throw new Error('Something went wrong'); + }, + c: () => 'Cookie', + }; + + const document = parse(` query { b } `); - - const executable = document.definitions?.values().next().value as ExecutableDefinitionNode; - const selectionSet = executable.selectionSet.selections.values().next().value; - - const result = await execute({ - schema: new GraphQLSchema({ query: DataType }), - document, - rootValue: data, - }); - - expect(result).to.deep.equal({ - data: { - b: null - }, - errors: [ - new GraphQLError( - 'Something went wrong', - { - nodes: selectionSet, - path: ['b'] - } - ) - ] - }); + + const executable = document.definitions?.values().next() + .value as ExecutableDefinitionNode; + const selectionSet = executable.selectionSet.selections + .values() + .next().value; + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + expect(result).to.deep.equal({ + data: { + b: null, + }, + errors: [ + new GraphQLError('Something went wrong', { + nodes: selectionSet, + path: ['b'], + }), + ], }); - - it('SemanticNonNull halts null propagation', async () => { - const deepData = { - f: () => null - }; - - const data = { - a: () => 'Apple', - b: () => null, - c: () => 'Cookie', - d: () => deepData - }; - - - const document = parse(` + }); + + it('SemanticNonNull halts null propagation', async () => { + const deepData = { + f: () => null, + }; + + const data = { + a: () => 'Apple', + b: () => null, + c: () => 'Cookie', + d: () => deepData, + }; + + const document = parse(` query { d { f } } `); - - const result = await execute({ - schema: new GraphQLSchema({ query: DataType }), - document, - rootValue: data, - }); - - const executable = document.definitions?.values().next().value as ExecutableDefinitionNode; - const dSelectionSet = executable.selectionSet.selections.values().next().value as FieldNode; - const fSelectionSet = dSelectionSet.selectionSet?.selections.values().next().value; - - expect(result).to.deep.equal({ - data: { - d: null - }, - errors: [ - new GraphQLError( - 'Cannot return null for non-nullable field DeepDataType.f.', - { - nodes: fSelectionSet, - path: ['d', 'f'] - } - ) - ] - }); + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + const executable = document.definitions?.values().next() + .value as ExecutableDefinitionNode; + const dSelectionSet = executable.selectionSet.selections.values().next() + .value as FieldNode; + const fSelectionSet = dSelectionSet.selectionSet?.selections + .values() + .next().value; + + expect(result).to.deep.equal({ + data: { + d: null, + }, + errors: [ + new GraphQLError( + 'Cannot return null for non-nullable field DeepDataType.f.', + { + nodes: fSelectionSet, + path: ['d', 'f'], + }, + ), + ], }); - - it('SemanticNullable allows null values', async () => { - const data = { - a: () => null, - b: () => null, - c: () => 'Cookie' - }; - - const document = parse(` + }); + + it('SemanticNullable allows null values', async () => { + const data = { + a: () => null, + b: () => null, + c: () => 'Cookie', + }; + + const document = parse(` query { a } `); - - const result = await execute({ - schema: new GraphQLSchema({ query: DataType }), - document, - rootValue: data, - }); - - expect(result).to.deep.equal({ - data: { - a: null - } - }); + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, }); - - it('SemanticNullable allows non-null values', async () => { - const data = { - a: () => 'Apple', - b: () => null, - c: () => 'Cookie' - }; - - const document = parse(` + + expect(result).to.deep.equal({ + data: { + a: null, + }, + }); + }); + + it('SemanticNullable allows non-null values', async () => { + const data = { + a: () => 'Apple', + b: () => null, + c: () => 'Cookie', + }; + + const document = parse(` query { a } `); - - const result = await execute({ - schema: new GraphQLSchema({ query: DataType }), - document, - rootValue: data, - }); - - expect(result).to.deep.equal({ - data: { - a: 'Apple' - } - }); + + const result = await execute({ + schema: new GraphQLSchema({ query: DataType }), + document, + rootValue: data, + }); + + expect(result).to.deep.equal({ + data: { + a: 'Apple', + }, }); }); - \ No newline at end of file +}); diff --git a/src/language/__tests__/parser-test.ts b/src/language/__tests__/parser-test.ts index 18011660ed..5567fc70cf 100644 --- a/src/language/__tests__/parser-test.ts +++ b/src/language/__tests__/parser-test.ts @@ -685,19 +685,19 @@ describe('Parser', () => { it('parses nullable types', () => { const result = parseType('MyType?', { useSemanticNullability: true }); - expectJSON(result).toDeepEqual( - { kind: Kind.SEMANTIC_NULLABLE_TYPE, - loc: { start: 0, end: 7 }, - type: { - kind: Kind.NAMED_TYPE, + expectJSON(result).toDeepEqual({ + kind: Kind.SEMANTIC_NULLABLE_TYPE, + loc: { start: 0, end: 7 }, + type: { + kind: Kind.NAMED_TYPE, + loc: { start: 0, end: 6 }, + name: { + kind: Kind.NAME, loc: { start: 0, end: 6 }, - name: { - kind: Kind.NAME, - loc: { start: 0, end: 6 }, - value: 'MyType', - }, - } - }); + value: 'MyType', + }, + }, + }); }); it('parses non-nullable types', () => { diff --git a/src/language/__tests__/schema-printer-test.ts b/src/language/__tests__/schema-printer-test.ts index f98d37e28f..ea4be63a3b 100644 --- a/src/language/__tests__/schema-printer-test.ts +++ b/src/language/__tests__/schema-printer-test.ts @@ -180,21 +180,31 @@ describe('Printer: SDL document', () => { } `); }); - + it('prints NamedType', () => { - expect(print(parseType('MyType', { useSemanticNullability: false }))).to.equal(dedent`MyType`); + expect( + print(parseType('MyType', { useSemanticNullability: false })), + ).to.equal(dedent`MyType`); }); it('prints SemanticNullableType', () => { - expect(print(parseType('MyType?', { useSemanticNullability: true }))).to.equal(dedent`MyType?`); + expect( + print(parseType('MyType?', { useSemanticNullability: true })), + ).to.equal(dedent`MyType?`); }); it('prints SemanticNonNullType', () => { - expect(print(parseType('MyType', { useSemanticNullability: true }))).to.equal(dedent`MyType`); + expect( + print(parseType('MyType', { useSemanticNullability: true })), + ).to.equal(dedent`MyType`); }); it('prints NonNullType', () => { - expect(print(parseType('MyType!', { useSemanticNullability: true }))).to.equal(dedent`MyType!`); - expect(print(parseType('MyType!', { useSemanticNullability: false }))).to.equal(dedent`MyType!`); + expect( + print(parseType('MyType!', { useSemanticNullability: true })), + ).to.equal(dedent`MyType!`); + expect( + print(parseType('MyType!', { useSemanticNullability: false })), + ).to.equal(dedent`MyType!`); }); }); diff --git a/src/language/lexer.ts b/src/language/lexer.ts index bdaf8b9b25..1696fa5c83 100644 --- a/src/language/lexer.ts +++ b/src/language/lexer.ts @@ -259,7 +259,12 @@ function readNextToken(lexer: Lexer, start: number): Token { case 0x0029: // ) return createToken(lexer, TokenKind.PAREN_R, position, position + 1); case 0x003f: // ? - return createToken(lexer, TokenKind.QUESTION_MARK, position, position + 1); + return createToken( + lexer, + TokenKind.QUESTION_MARK, + position, + position + 1, + ); case 0x002e: // . if ( body.charCodeAt(position + 1) === 0x002e && diff --git a/src/language/parser.ts b/src/language/parser.ts index cd75743664..90a978be4f 100644 --- a/src/language/parser.ts +++ b/src/language/parser.ts @@ -780,13 +780,13 @@ export class Parser { type, }); } - + return this.node(start, { kind: Kind.SEMANTIC_NON_NULL_TYPE, type, }); - } - + } + if (this.expectOptionalToken(TokenKind.BANG)) { return this.node(start, { kind: Kind.NON_NULL_TYPE, diff --git a/src/language/printer.ts b/src/language/printer.ts index a72f5b8505..17b805e624 100644 --- a/src/language/printer.ts +++ b/src/language/printer.ts @@ -135,9 +135,7 @@ const printDocASTReducer: ASTReducer = { // Type - NamedType: { leave: ({ name }) => - name -}, + NamedType: { leave: ({ name }) => name }, ListType: { leave: ({ type }) => '[' + type + ']' }, NonNullType: { leave: ({ type }) => type + '!' }, SemanticNonNullType: { leave: ({ type }) => type }, diff --git a/src/type/definition.ts b/src/type/definition.ts index a7d7d2cd0d..9d2fc95089 100644 --- a/src/type/definition.ts +++ b/src/type/definition.ts @@ -84,7 +84,7 @@ export type GraphQLType = | GraphQLEnumType | GraphQLInputObjectType | GraphQLList - >; + >; export function isType(type: unknown): type is GraphQLType { return ( @@ -561,7 +561,7 @@ export class GraphQLSemanticNonNull { * }) * }) * ``` - * Note: This is equivalent to the unadorned named type that is + * Note: This is equivalent to the unadorned named type that is * used by GraphQL when it is not operating in SemanticNullability mode. * * @experimental @@ -602,7 +602,12 @@ export type GraphQLWrappingType = | GraphQLSemanticNullable; export function isWrappingType(type: unknown): type is GraphQLWrappingType { - return isListType(type) || isNonNullType(type) || isSemanticNonNullType(type) || isSemanticNullableType(type); + return ( + isListType(type) || + isNonNullType(type) || + isSemanticNonNullType(type) || + isSemanticNullableType(type) + ); } export function assertWrappingType(type: unknown): GraphQLWrappingType { From 163785d2957d0098e11092482eac8bed765689f3 Mon Sep 17 00:00:00 2001 From: twof Date: Thu, 7 Nov 2024 22:59:55 -0800 Subject: [PATCH 31/31] Add comment to parser about document directive --- src/language/parser.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/language/parser.ts b/src/language/parser.ts index 90a978be4f..e947021baf 100644 --- a/src/language/parser.ts +++ b/src/language/parser.ts @@ -253,8 +253,10 @@ export class Parser { * - InputObjectTypeDefinition */ parseDefinition(): DefinitionNode { - // TODO: I don't know what isConst represents. Every other callsite has it false const directives = this.parseDirectives(false); + // If a document-level SemanticNullability directive exists as + // the first element in a document, then all parsing will + // happen in SemanticNullability mode. for (const directive of directives) { if (directive.name.value === 'SemanticNullability') { this._options.useSemanticNullability = true;