Elevate ErrorBehavior to be a specified enum

benjie · benjie · commit 726b4ba139c0 · 2025-05-01T09:34:28.000+01:00
diff --git a/src/__tests__/starWarsIntrospection-test.ts b/src/__tests__/starWarsIntrospection-test.ts
@@ -37,7 +37,7 @@ describe('Star Wars Introspection Tests', () => {
             { name: 'Droid' },
             { name: 'Query' },
             { name: 'Boolean' },
-            { name: '__ErrorBehavior' },
+            { name: 'ErrorBehavior' },
             { name: '__Schema' },
             { name: '__Type' },
             { name: '__TypeKind' },
diff --git a/src/error/ErrorBehavior.ts b/src/error/ErrorBehavior.ts
@@ -1,8 +1,6 @@
-export type GraphQLErrorBehavior = 'NO_PROPAGATE' | 'PROPAGATE' | 'ABORT';
+export type ErrorBehavior = 'NO_PROPAGATE' | 'PROPAGATE' | 'ABORT';
 
-export function isErrorBehavior(
-  onError: unknown,
-): onError is GraphQLErrorBehavior {
+export function isErrorBehavior(onError: unknown): onError is ErrorBehavior {
   return (
     onError === 'NO_PROPAGATE' || onError === 'PROPAGATE' || onError === 'ABORT'
   );
diff --git a/src/error/index.ts b/src/error/index.ts
@@ -9,4 +9,4 @@ export type {
 export { syntaxError } from './syntaxError';
 
 export { locatedError } from './locatedError';
-export type { GraphQLErrorBehavior } from './ErrorBehavior';
+export type { ErrorBehavior } from './ErrorBehavior';
diff --git a/src/execution/execute.ts b/src/execution/execute.ts
@@ -13,7 +13,7 @@ import { promiseForObject } from '../jsutils/promiseForObject';
 import type { PromiseOrValue } from '../jsutils/PromiseOrValue';
 import { promiseReduce } from '../jsutils/promiseReduce';
 
-import type { GraphQLErrorBehavior } from '../error/ErrorBehavior';
+import type { ErrorBehavior } from '../error/ErrorBehavior';
 import { isErrorBehavior } from '../error/ErrorBehavior';
 import type { GraphQLFormattedError } from '../error/GraphQLError';
 import { GraphQLError } from '../error/GraphQLError';
@@ -117,7 +117,7 @@ export interface ExecutionContext {
   typeResolver: GraphQLTypeResolver<any, any>;
   subscribeFieldResolver: GraphQLFieldResolver<any, any>;
   errors: Array<GraphQLError>;
-  errorBehavior: GraphQLErrorBehavior;
+  errorBehavior: ErrorBehavior;
 }
 
 /**
@@ -133,7 +133,6 @@ export interface ExecutionResult<
 > {
   errors?: ReadonlyArray<GraphQLError>;
   data?: TData | null;
-  onError?: GraphQLErrorBehavior;
   extensions?: TExtensions;
 }
 
@@ -164,7 +163,7 @@ export interface ExecutionArgs {
    *
    * @experimental
    */
-  onError?: GraphQLErrorBehavior;
+  onError?: ErrorBehavior;
   /** Additional execution options. */
   options?: {
     /** Set the maximum number of errors allowed for coercing (defaults to 50). */
diff --git a/src/graphql.ts b/src/graphql.ts
@@ -3,7 +3,7 @@ import { isPromise } from './jsutils/isPromise';
 import type { Maybe } from './jsutils/Maybe';
 import type { PromiseOrValue } from './jsutils/PromiseOrValue';
 
-import type { GraphQLErrorBehavior } from './error/ErrorBehavior';
+import type { ErrorBehavior } from './error/ErrorBehavior';
 
 import { parse } from './language/parser';
 import type { Source } from './language/source';
@@ -76,7 +76,7 @@ export interface GraphQLArgs {
    *
    * @experimental
    */
-  onError?: GraphQLErrorBehavior;
+  onError?: ErrorBehavior;
 }
 
 export function graphql(args: GraphQLArgs): Promise<ExecutionResult> {
diff --git a/src/index.ts b/src/index.ts
@@ -55,6 +55,9 @@ export {
   GraphQLString,
   GraphQLBoolean,
   GraphQLID,
+  // Standard GraphQL Enums
+  specifiedEnumTypes,
+  GraphQLErrorBehavior,
   // Int boundaries constants
   GRAPHQL_MAX_INT,
   GRAPHQL_MIN_INT,
@@ -79,7 +82,6 @@ export {
   __InputValue,
   __EnumValue,
   __TypeKind,
-  __ErrorBehavior,
   // Meta-field definitions.
   SchemaMetaFieldDef,
   TypeMetaFieldDef,
@@ -107,6 +109,7 @@ export {
   isRequiredArgument,
   isRequiredInputField,
   isSpecifiedScalarType,
+  isSpecifiedEnumType,
   isIntrospectionType,
   isSpecifiedDirective,
   // Assertions
@@ -396,7 +399,7 @@ export {
 } from './error/index';
 
 export type {
-  GraphQLErrorBehavior,
+  ErrorBehavior,
   GraphQLErrorOptions,
   GraphQLFormattedError,
   GraphQLErrorExtensions,
diff --git a/src/type/__tests__/introspection-test.ts b/src/type/__tests__/introspection-test.ts
@@ -102,7 +102,7 @@ describe('Introspection', () => {
               inputFields: null,
               interfaces: null,
               kind: 'ENUM',
-              name: '__ErrorBehavior',
+              name: 'ErrorBehavior',
               possibleTypes: null,
               specifiedByURL: null,
             },
@@ -213,7 +213,7 @@ describe('Introspection', () => {
                     name: null,
                     ofType: {
                       kind: 'ENUM',
-                      name: '__ErrorBehavior',
+                      name: 'ErrorBehavior',
                       ofType: null,
                     },
                   },
@@ -1059,7 +1059,7 @@ describe('Introspection', () => {
                     name: null,
                     ofType: {
                       kind: 'ENUM',
-                      name: '__ErrorBehavior',
+                      name: 'ErrorBehavior',
                       ofType: null,
                     },
                   },
diff --git a/src/type/__tests__/predicate-test.ts b/src/type/__tests__/predicate-test.ts
@@ -65,6 +65,7 @@ import {
   isDirective,
   isSpecifiedDirective,
 } from '../directives';
+import { GraphQLErrorBehavior, isSpecifiedEnumType } from '../enums';
 import {
   GraphQLBoolean,
   GraphQLFloat,
@@ -166,6 +167,16 @@ describe('Type predicates', () => {
     });
   });
 
+  describe('isSpecifiedEnumType', () => {
+    it('returns true for specified enums', () => {
+      expect(isSpecifiedEnumType(GraphQLErrorBehavior)).to.equal(true);
+    });
+
+    it('returns false for custom scalar', () => {
+      expect(isSpecifiedEnumType(EnumType)).to.equal(false);
+    });
+  });
+
   describe('isObjectType', () => {
     it('returns true for object type', () => {
       expect(isObjectType(ObjectType)).to.equal(true);
diff --git a/src/type/__tests__/schema-test.ts b/src/type/__tests__/schema-test.ts
@@ -296,7 +296,7 @@ describe('Type System: Schema', () => {
       'ASub',
       'Boolean',
       'String',
-      '__ErrorBehavior',
+      'ErrorBehavior',
       '__Schema',
       '__Type',
       '__TypeKind',
diff --git a/src/type/definition.ts b/src/type/definition.ts
@@ -14,7 +14,7 @@ import type { PromiseOrValue } from '../jsutils/PromiseOrValue';
 import { suggestionList } from '../jsutils/suggestionList';
 import { toObjMap } from '../jsutils/toObjMap';
 
-import type { GraphQLErrorBehavior } from '../error/ErrorBehavior';
+import type { ErrorBehavior } from '../error/ErrorBehavior';
 import { GraphQLError } from '../error/GraphQLError';
 
 import type {
@@ -990,7 +990,7 @@ export interface GraphQLResolveInfo {
   readonly operation: OperationDefinitionNode;
   readonly variableValues: { [variable: string]: unknown };
   /** @experimental */
-  readonly errorBehavior: GraphQLErrorBehavior;
+  readonly errorBehavior: ErrorBehavior;
 }
 
 /**
diff --git a/src/type/directives.ts b/src/type/directives.ts
@@ -18,7 +18,7 @@ import {
   defineArguments,
   GraphQLNonNull,
 } from './definition';
-import { __ErrorBehavior } from './introspection';
+import { GraphQLErrorBehavior } from './enums';
 import { GraphQLBoolean, GraphQLString } from './scalars';
 
 /**
@@ -230,7 +230,7 @@ export const GraphQLBehaviorDirective: GraphQLDirective = new GraphQLDirective({
   locations: [DirectiveLocation.SCHEMA],
   args: {
     onError: {
-      type: new GraphQLNonNull(__ErrorBehavior),
+      type: new GraphQLNonNull(GraphQLErrorBehavior),
       defaultValue: 'PROPAGATE',
     },
   },
diff --git a/src/type/enums.ts b/src/type/enums.ts
@@ -0,0 +1,33 @@
+import type { GraphQLNamedType } from './definition';
+import { GraphQLEnumType } from './definition';
+
+export const GraphQLErrorBehavior: GraphQLEnumType = new GraphQLEnumType({
+  name: 'ErrorBehavior',
+  description:
+    'An enum detailing the error behavior a GraphQL request should use.',
+  values: {
+    NO_PROPAGATE: {
+      value: 'NO_PROPAGATE',
+      description:
+        'Indicates that an error should result in the response position becoming null, even if it is marked as non-null.',
+    },
+    PROPAGATE: {
+      value: 'PROPAGATE',
+      description:
+        'Indicates that an error that occurs in a non-null position should propagate to the nearest nullable response position.',
+    },
+    ABORT: {
+      value: 'ABORT',
+      description:
+        'Indicates execution should cease when the first error occurs, and that the response data should be null.',
+    },
+  },
+});
+
+export const specifiedEnumTypes: ReadonlyArray<GraphQLEnumType> = Object.freeze(
+  [GraphQLErrorBehavior],
+);
+
+export function isSpecifiedEnumType(type: GraphQLNamedType): boolean {
+  return specifiedEnumTypes.some(({ name }) => type.name === name);
+}
diff --git a/src/type/index.ts b/src/type/index.ts
@@ -158,6 +158,13 @@ export {
   GRAPHQL_MAX_INT,
   GRAPHQL_MIN_INT,
 } from './scalars';
+export {
+  // Predicate
+  isSpecifiedEnumType,
+  // Standard GraphQL Enums
+  specifiedEnumTypes,
+  GraphQLErrorBehavior,
+} from './enums';
 
 export {
   // Predicate
@@ -172,7 +179,6 @@ export {
   __InputValue,
   __EnumValue,
   __TypeKind,
-  __ErrorBehavior,
   // "Enum" of Type Kinds
   TypeKind,
   // Meta-field definitions.
diff --git a/src/type/introspection.ts b/src/type/introspection.ts
@@ -30,6 +30,7 @@ import {
   isUnionType,
 } from './definition';
 import type { GraphQLDirective } from './directives';
+import { GraphQLErrorBehavior } from './enums';
 import { GraphQLBoolean, GraphQLString } from './scalars';
 import type { GraphQLSchema } from './schema';
 
@@ -77,7 +78,7 @@ export const __Schema: GraphQLObjectType = new GraphQLObjectType({
       defaultErrorBehavior: {
         description:
           'The default error behavior that will be used for requests which do not specify `onError`.',
-        type: new GraphQLNonNull(__ErrorBehavior),
+        type: new GraphQLNonNull(GraphQLErrorBehavior),
         resolve: (schema) => schema.defaultErrorBehavior,
       },
     } as GraphQLFieldConfigMap<GraphQLSchema, unknown>),
@@ -506,29 +507,6 @@ export const __TypeKind: GraphQLEnumType = new GraphQLEnumType({
   },
 });
 
-export const __ErrorBehavior: GraphQLEnumType = new GraphQLEnumType({
-  name: '__ErrorBehavior',
-  description:
-    'An enum detailing the error behavior a GraphQL request should use.',
-  values: {
-    NO_PROPAGATE: {
-      value: 'NO_PROPAGATE',
-      description:
-        'Indicates that an error should result in the response position becoming null, even if it is marked as non-null.',
-    },
-    PROPAGATE: {
-      value: 'PROPAGATE',
-      description:
-        'Indicates that an error that occurs in a non-null position should propagate to the nearest nullable response position.',
-    },
-    ABORT: {
-      value: 'ABORT',
-      description:
-        'Indicates execution should cease when the first error occurs, and that the response data should be null.',
-    },
-  },
-});
-
 /**
  * Note that these are GraphQLField and not GraphQLFieldConfig,
  * so the format for args is different.
@@ -587,7 +565,7 @@ export const introspectionTypes: ReadonlyArray<GraphQLNamedType> =
     __InputValue,
     __EnumValue,
     __TypeKind,
-    __ErrorBehavior,
+    // ErrorBehavior,
   ]);
 
 export function isIntrospectionType(type: GraphQLNamedType): boolean {
diff --git a/src/type/schema.ts b/src/type/schema.ts
@@ -6,7 +6,7 @@ import type { Maybe } from '../jsutils/Maybe';
 import type { ObjMap } from '../jsutils/ObjMap';
 import { toObjMap } from '../jsutils/toObjMap';
 
-import type { GraphQLErrorBehavior } from '../error/ErrorBehavior';
+import type { ErrorBehavior } from '../error/ErrorBehavior';
 import { isErrorBehavior } from '../error/ErrorBehavior';
 import type { GraphQLError } from '../error/GraphQLError';
 
@@ -132,7 +132,7 @@ export interface GraphQLSchemaExtensions {
 export class GraphQLSchema {
   description: Maybe<string>;
   /** @experimental */
-  readonly defaultErrorBehavior: GraphQLErrorBehavior;
+  readonly defaultErrorBehavior: ErrorBehavior;
   extensions: Readonly<GraphQLSchemaExtensions>;
   astNode: Maybe<SchemaDefinitionNode>;
   extensionASTNodes: ReadonlyArray<SchemaExtensionNode>;
@@ -410,7 +410,7 @@ export interface GraphQLSchemaConfig extends GraphQLSchemaValidationOptions {
    *
    * @experimental
    */
-  defaultErrorBehavior?: Maybe<GraphQLErrorBehavior>;
+  defaultErrorBehavior?: Maybe<ErrorBehavior>;
   extensions?: Maybe<Readonly<GraphQLSchemaExtensions>>;
   astNode?: Maybe<SchemaDefinitionNode>;
   extensionASTNodes?: Maybe<ReadonlyArray<SchemaExtensionNode>>;
diff --git a/src/utilities/__tests__/printSchema-test.ts b/src/utilities/__tests__/printSchema-test.ts
@@ -710,10 +710,10 @@ describe('Type System Printer', () => {
       directive @oneOf on INPUT_OBJECT
 
       """Indicates the default error behavior of the schema."""
-      directive @behavior(onError: __ErrorBehavior! = PROPAGATE) on SCHEMA
+      directive @behavior(onError: ErrorBehavior! = PROPAGATE) on SCHEMA
       
       """An enum detailing the error behavior a GraphQL request should use."""
-      enum __ErrorBehavior {
+      enum ErrorBehavior {
         """
         Indicates that an error should result in the response position becoming null, even if it is marked as non-null.
         """
@@ -758,7 +758,7 @@ describe('Type System Printer', () => {
         """
         The default error behavior that will be used for requests which do not specify \`onError\`.
         """
-        defaultErrorBehavior: __ErrorBehavior!
+        defaultErrorBehavior: ErrorBehavior!
       }
 
       """
diff --git a/src/utilities/buildClientSchema.ts b/src/utilities/buildClientSchema.ts
@@ -27,6 +27,7 @@ import {
   isOutputType,
 } from '../type/definition';
 import { GraphQLDirective } from '../type/directives';
+import { specifiedEnumTypes } from '../type/enums';
 import { introspectionTypes, TypeKind } from '../type/introspection';
 import { specifiedScalarTypes } from '../type/scalars';
 import type { GraphQLSchemaValidationOptions } from '../type/schema';
@@ -83,7 +84,11 @@ export function buildClientSchema(
   );
 
   // Include standard types only if they are used.
-  for (const stdType of [...specifiedScalarTypes, ...introspectionTypes]) {
+  for (const stdType of [
+    ...specifiedScalarTypes,
+    ...specifiedEnumTypes,
+    ...introspectionTypes,
+  ]) {
     if (typeMap[stdType.name]) {
       typeMap[stdType.name] = stdType;
     }
diff --git a/src/utilities/extendSchema.ts b/src/utilities/extendSchema.ts
diff --git a/src/utilities/findBreakingChanges.ts b/src/utilities/findBreakingChanges.ts
diff --git a/src/utilities/getIntrospectionQuery.ts b/src/utilities/getIntrospectionQuery.ts
diff --git a/src/utilities/lexicographicSortSchema.ts b/src/utilities/lexicographicSortSchema.ts
diff --git a/src/utilities/printSchema.ts b/src/utilities/printSchema.ts
diff --git a/src/validation/rules/KnownTypeNamesRule.ts b/src/validation/rules/KnownTypeNamesRule.ts

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import { isPromise } from './jsutils/isPromise';`
`3`	`3`	`import type { Maybe } from './jsutils/Maybe';`
`4`	`4`	`import type { PromiseOrValue } from './jsutils/PromiseOrValue';`
`5`	`5`
`6`		`-import type { GraphQLErrorBehavior } from './error/ErrorBehavior';`
	`6`	`+import type { ErrorBehavior } from './error/ErrorBehavior';`
`7`	`7`
`8`	`8`	`import { parse } from './language/parser';`
`9`	`9`	`import type { Source } from './language/source';`
`@@ -76,7 +76,7 @@ export interface GraphQLArgs {`
`76`	`76`	`*`
`77`	`77`	`* @experimental`
`78`	`78`	`*/`
`79`		`- onError?: GraphQLErrorBehavior;`
	`79`	`+ onError?: ErrorBehavior;`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`export function graphql(args: GraphQLArgs): Promise<ExecutionResult> {`