Skip to content

Commit 8fcacc8

Browse files
benjiebenjie
committed
Switch to errorBehavior, replace contextual introspection to simple includeSemanticNonNull
1 parent 6ef4bec commit 8fcacc8

File tree

12 files changed

+73
-156
lines changed

12 files changed

+73
-156
lines changed

‎src/__tests__/starWarsIntrospection-test.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ describe('Star Wars Introspection Tests', () => {
4242
{ name: '__TypeKind' },
4343
{ name: '__Field' },
4444
{ name: '__InputValue' },
45-
{ name: '__TypeNullability' },
4645
{ name: '__EnumValue' },
4746
{ name: '__Directive' },
4847
{ name: '__DirectiveLocation' },

‎src/execution/__tests__/executor-test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ describe('Execute: Handles basic execution tasks', () => {
263263
'rootValue',
264264
'operation',
265265
'variableValues',
266-
'errorPropagation',
266+
'errorBehavior',
267267
);
268268

269269
const operation = document.definitions[0];
@@ -276,7 +276,7 @@ describe('Execute: Handles basic execution tasks', () => {
276276
schema,
277277
rootValue,
278278
operation,
279-
errorPropagation: true,
279+
errorBehavior: 'PROPAGATE',
280280
});
281281

282282
const field = operation.selectionSet.selections[0];

‎src/execution/execute.ts

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export interface ExecutionContext {
116116
typeResolver: GraphQLTypeResolver<any, any>;
117117
subscribeFieldResolver: GraphQLFieldResolver<any, any>;
118118
errors: Array<GraphQLError>;
119-
errorPropagation: boolean;
119+
errorBehavior: 'PROPAGATE' | 'NULL' | 'ABORT';
120120
}
121121

122122
/**
@@ -155,11 +155,14 @@ export interface ExecutionArgs {
155155
typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
156156
subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
157157
/**
158-
* Set to `false` to disable error propagation. Experimental.
158+
* Experimental. Set to NULL to prevent error propagation. Set to ABORT to
159+
* abort a request when any error occurs.
160+
*
161+
* Default: PROPAGATE
159162
*
160163
* @experimental
161164
*/
162-
errorPropagation?: boolean;
165+
errorBehavior?: 'PROPAGATE' | 'NULL' | 'ABORT';
163166
}
164167

165168
/**
@@ -294,7 +297,7 @@ export function buildExecutionContext(
294297
fieldResolver,
295298
typeResolver,
296299
subscribeFieldResolver,
297-
errorPropagation,
300+
errorBehavior,
298301
} = args;
299302

300303
let operation: OperationDefinitionNode | undefined;
@@ -356,7 +359,7 @@ export function buildExecutionContext(
356359
typeResolver: typeResolver ?? defaultTypeResolver,
357360
subscribeFieldResolver: subscribeFieldResolver ?? defaultFieldResolver,
358361
errors: [],
359-
errorPropagation: errorPropagation ?? true,
362+
errorBehavior: errorBehavior ?? 'PROPAGATE',
360363
};
361364
}
362365

@@ -595,7 +598,7 @@ export function buildResolveInfo(
595598
rootValue: exeContext.rootValue,
596599
operation: exeContext.operation,
597600
variableValues: exeContext.variableValues,
598-
errorPropagation: exeContext.errorPropagation,
601+
errorBehavior: exeContext.errorBehavior,
599602
};
600603
}
601604

@@ -604,10 +607,25 @@ function handleFieldError(
604607
returnType: GraphQLOutputType,
605608
exeContext: ExecutionContext,
606609
): null {
607-
// If the field type is non-nullable, then it is resolved without any
608-
// protection from errors, however it still properly locates the error.
609-
if (exeContext.errorPropagation && isNonNullType(returnType)) {
610+
if (exeContext.errorBehavior === 'PROPAGATE') {
611+
// If the field type is non-nullable, then it is resolved without any
612+
// protection from errors, however it still properly locates the error.
613+
// Note: semantic non-null types are treated as nullable for the purposes
614+
// of error handling.
615+
if (isNonNullType(returnType)) {
616+
throw error;
617+
}
618+
} else if (exeContext.errorBehavior === 'ABORT') {
619+
// In this mode, any error aborts the request
610620
throw error;
621+
} else if (exeContext.errorBehavior === 'NULL') {
622+
// In this mode, the client takes responsibility for error handling, so we
623+
// treat the field as if it were nullable.
624+
} else {
625+
invariant(
626+
false,
627+
'Unexpected errorBehavior setting: ' + inspect(exeContext.errorBehavior),
628+
);
611629
}
612630

613631
// Otherwise, error protection is applied, logging the error and resolving

‎src/graphql.ts

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,14 @@ export interface GraphQLArgs {
6767
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
6868
typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
6969
/**
70-
* Set to `false` to disable error propagation. Experimental.
70+
* Experimental. Set to NULL to prevent error propagation. Set to ABORT to
71+
* abort a request when any error occurs.
72+
*
73+
* Default: PROPAGATE
7174
*
7275
* @experimental
7376
*/
74-
errorPropagation?: boolean;
77+
errorBehavior?: 'PROPAGATE' | 'NULL' | 'ABORT';
7578
}
7679

7780
export function graphql(args: GraphQLArgs): Promise<ExecutionResult> {
@@ -112,7 +115,7 @@ function graphqlImpl(args: GraphQLArgs): PromiseOrValue<ExecutionResult> {
112115
operationName,
113116
fieldResolver,
114117
typeResolver,
115-
errorPropagation,
118+
errorBehavior,
116119
} = args;
117120

118121
// Validate Schema
@@ -145,6 +148,6 @@ function graphqlImpl(args: GraphQLArgs): PromiseOrValue<ExecutionResult> {
145148
operationName,
146149
fieldResolver,
147150
typeResolver,
148-
errorPropagation,
151+
errorBehavior,
149152
});
150153
}

‎src/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ export {
7575
__Schema,
7676
__Directive,
7777
__DirectiveLocation,
78-
__TypeNullability,
7978
__Type,
8079
__Field,
8180
__InputValue,

‎src/type/__tests__/introspection-test.ts

Lines changed: 4 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -513,17 +513,17 @@ describe('Introspection', () => {
513513
name: 'type',
514514
args: [
515515
{
516-
name: 'nullability',
516+
name: 'includeSemanticNonNull',
517517
type: {
518518
kind: 'NON_NULL',
519519
name: null,
520520
ofType: {
521-
kind: 'ENUM',
522-
name: '__TypeNullability',
521+
kind: 'SCALAR',
522+
name: 'Boolean',
523523
ofType: null,
524524
},
525525
},
526-
defaultValue: 'AUTO',
526+
defaultValue: 'false',
527527
},
528528
],
529529
type: {
@@ -659,37 +659,6 @@ describe('Introspection', () => {
659659
enumValues: null,
660660
possibleTypes: null,
661661
},
662-
{
663-
kind: 'ENUM',
664-
name: '__TypeNullability',
665-
specifiedByURL: null,
666-
fields: null,
667-
inputFields: null,
668-
interfaces: null,
669-
enumValues: [
670-
{
671-
name: 'AUTO',
672-
isDeprecated: false,
673-
deprecationReason: null,
674-
},
675-
{
676-
name: 'TRADITIONAL',
677-
isDeprecated: false,
678-
deprecationReason: null,
679-
},
680-
{
681-
name: 'SEMANTIC',
682-
isDeprecated: false,
683-
deprecationReason: null,
684-
},
685-
{
686-
name: 'FULL',
687-
isDeprecated: false,
688-
deprecationReason: null,
689-
},
690-
],
691-
possibleTypes: null,
692-
},
693662
{
694663
kind: 'OBJECT',
695664
name: '__EnumValue',

‎src/type/__tests__/schema-test.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,6 @@ describe('Type System: Schema', () => {
301301
'__TypeKind',
302302
'__Field',
303303
'__InputValue',
304-
'__TypeNullability',
305304
'__EnumValue',
306305
'__Directive',
307306
'__DirectiveLocation',

‎src/type/definition.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1088,7 +1088,7 @@ export interface GraphQLResolveInfo {
10881088
readonly operation: OperationDefinitionNode;
10891089
readonly variableValues: { [variable: string]: unknown };
10901090
/** @experimental */
1091-
readonly errorPropagation: boolean;
1091+
readonly errorBehavior: 'PROPAGATE' | 'NULL' | 'ABORT';
10921092
}
10931093

10941094
/**

‎src/type/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,6 @@ export {
170170
__Schema,
171171
__Directive,
172172
__DirectiveLocation,
173-
__TypeNullability,
174173
__Type,
175174
__Field,
176175
__InputValue,

‎src/type/introspection.ts

Lines changed: 21 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ import type {
1212
GraphQLFieldConfigMap,
1313
GraphQLInputField,
1414
GraphQLNamedType,
15+
GraphQLOutputType,
1516
GraphQLType,
1617
} from './definition';
1718
import {
1819
GraphQLEnumType,
1920
GraphQLList,
2021
GraphQLNonNull,
2122
GraphQLObjectType,
22-
GraphQLSemanticNonNull,
2323
isAbstractType,
2424
isEnumType,
2525
isInputObjectType,
@@ -206,40 +206,6 @@ export const __DirectiveLocation: GraphQLEnumType = new GraphQLEnumType({
206206
},
207207
});
208208

209-
// TODO: rename enum and options
210-
enum TypeNullability {
211-
AUTO = 'AUTO',
212-
TRADITIONAL = 'TRADITIONAL',
213-
SEMANTIC = 'SEMANTIC',
214-
FULL = 'FULL',
215-
}
216-
217-
// TODO: rename
218-
export const __TypeNullability: GraphQLEnumType = new GraphQLEnumType({
219-
name: '__TypeNullability',
220-
description: 'TODO',
221-
values: {
222-
AUTO: {
223-
value: TypeNullability.AUTO,
224-
description:
225-
'Determines nullability mode based on errorPropagation mode.',
226-
},
227-
TRADITIONAL: {
228-
value: TypeNullability.TRADITIONAL,
229-
description: 'Turn semantic-non-null types into nullable types.',
230-
},
231-
SEMANTIC: {
232-
value: TypeNullability.SEMANTIC,
233-
description: 'Turn non-null types into semantic-non-null types.',
234-
},
235-
FULL: {
236-
value: TypeNullability.FULL,
237-
description:
238-
'Render the true nullability in the schema; be prepared for new types of nullability in future!',
239-
},
240-
},
241-
});
242-
243209
export const __Type: GraphQLObjectType = new GraphQLObjectType({
244210
name: '__Type',
245211
description:
@@ -406,22 +372,17 @@ export const __Field: GraphQLObjectType = new GraphQLObjectType({
406372
type: {
407373
type: new GraphQLNonNull(__Type),
408374
args: {
409-
nullability: {
410-
type: new GraphQLNonNull(__TypeNullability),
411-
defaultValue: TypeNullability.AUTO,
375+
includeSemanticNonNull: {
376+
type: new GraphQLNonNull(GraphQLBoolean),
377+
defaultValue: false,
412378
},
413379
},
414-
resolve: (field, { nullability }, _context, info) => {
415-
if (nullability === TypeNullability.FULL) {
380+
resolve: (field, { includeSemanticNonNull }, _context) => {
381+
if (includeSemanticNonNull) {
416382
return field.type;
417383
}
418-
const mode =
419-
nullability === TypeNullability.AUTO
420-
? info.errorPropagation
421-
? TypeNullability.TRADITIONAL
422-
: TypeNullability.SEMANTIC
423-
: nullability;
424-
return convertOutputTypeToNullabilityMode(field.type, mode);
384+
// TODO: memoize
385+
return stripSemanticNonNullTypes(field.type);
425386
},
426387
},
427388
isDeprecated: {
@@ -436,32 +397,21 @@ export const __Field: GraphQLObjectType = new GraphQLObjectType({
436397
});
437398

438399
// TODO: move this elsewhere, rename, memoize
439-
function convertOutputTypeToNullabilityMode(
440-
type: GraphQLType,
441-
mode: TypeNullability.TRADITIONAL | TypeNullability.SEMANTIC,
442-
): GraphQLType {
443-
if (mode === TypeNullability.TRADITIONAL) {
444-
if (isNonNullType(type)) {
445-
return new GraphQLNonNull(
446-
convertOutputTypeToNullabilityMode(type.ofType, mode),
447-
);
448-
} else if (isSemanticNonNullType(type)) {
449-
return convertOutputTypeToNullabilityMode(type.ofType, mode);
450-
} else if (isListType(type)) {
451-
return new GraphQLList(
452-
convertOutputTypeToNullabilityMode(type.ofType, mode),
453-
);
400+
function stripSemanticNonNullTypes(type: GraphQLOutputType): GraphQLOutputType {
401+
if (isNonNullType(type)) {
402+
const convertedInner = stripSemanticNonNullTypes(type.ofType);
403+
if (convertedInner === type.ofType) {
404+
return type; // No change needed
454405
}
455-
return type;
456-
}
457-
if (isNonNullType(type) || isSemanticNonNullType(type)) {
458-
return new GraphQLSemanticNonNull(
459-
convertOutputTypeToNullabilityMode(type.ofType, mode),
460-
);
406+
return new GraphQLNonNull(convertedInner);
461407
} else if (isListType(type)) {
462-
return new GraphQLList(
463-
convertOutputTypeToNullabilityMode(type.ofType, mode),
464-
);
408+
const convertedInner = stripSemanticNonNullTypes(type.ofType);
409+
if (convertedInner === type.ofType) {
410+
return type; // No change needed
411+
}
412+
return new GraphQLList(convertedInner);
413+
} else if (isSemanticNonNullType(type)) {
414+
return stripSemanticNonNullTypes(type.ofType);
465415
}
466416
return type;
467417
}
@@ -646,7 +596,6 @@ export const introspectionTypes: ReadonlyArray<GraphQLNamedType> =
646596
__Schema,
647597
__Directive,
648598
__DirectiveLocation,
649-
__TypeNullability,
650599
__Type,
651600
__Field,
652601
__InputValue,

0 commit comments

Comments
 (0)