Skip to content

Unify extending of type system #1261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 28, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/utilities/__tests__/extendSchema-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -794,7 +794,7 @@ describe('extendSchema', () => {
}
`);
expect(() => extendSchema(testSchema, ast)).to.throw(
'Cannot extend interface "UnknownInterfaceType" because it does not ' +
'Cannot extend type "UnknownInterfaceType" because it does not ' +
'exist in the existing schema.',
);
});
Expand Down
27 changes: 13 additions & 14 deletions src/utilities/buildASTSchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,7 @@ export function buildASTSchema(
},
);

const types = typeDefs.map(def => definitionBuilder.buildType(def));

const types = definitionBuilder.buildTypes(typeDefs);
const directives = directiveDefs.map(def =>
definitionBuilder.buildDirective(def),
);
Expand Down Expand Up @@ -266,6 +265,12 @@ export class ASTDefinitionBuilder {
);
}

buildTypes(
nodes: $ReadOnlyArray<NamedTypeNode | TypeDefinitionNode>,
): Array<GraphQLNamedType> {
return nodes.map(node => this.buildType(node));
}

buildType(node: NamedTypeNode | TypeDefinitionNode): GraphQLNamedType {
const typeName = node.name.value;
if (!this._cache[typeName]) {
Expand Down Expand Up @@ -334,11 +339,15 @@ export class ASTDefinitionBuilder {

_makeTypeDef(def: ObjectTypeDefinitionNode) {
const typeName = def.name.value;
const interfaces = def.interfaces;
return new GraphQLObjectType({
name: typeName,
description: getDescription(def, this._options),
fields: () => this._makeFieldDefMap(def),
interfaces: () => this._makeImplementedInterfaces(def),
// Note: While this could make early assertions to get the correctly
// typed values, that would throw immediately while type system
// validation with validateSchema() will produce more actionable results.
interfaces: interfaces ? () => (this.buildTypes(interfaces): any) : [],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice to avoid the lambda allocation if the AST defines no interfaces

astNode: def,
});
}
Expand All @@ -355,16 +364,6 @@ export class ASTDefinitionBuilder {
: {};
}

_makeImplementedInterfaces(def: ObjectTypeDefinitionNode) {
return (
def.interfaces &&
// Note: While this could make early assertions to get the correctly
// typed values, that would throw immediately while type system
// validation with validateSchema() will produce more actionable results.
def.interfaces.map(iface => (this.buildType(iface): any))
);
}

_makeInputValues(values: $ReadOnlyArray<InputValueDefinitionNode>) {
return keyValMap(
values,
Expand Down Expand Up @@ -419,7 +418,7 @@ export class ASTDefinitionBuilder {
// Note: While this could make assertions to get the correctly typed
// values below, that would throw immediately while type system
// validation with validateSchema() will produce more actionable results.
types: def.types ? def.types.map(t => (this.buildType(t): any)) : [],
types: def.types ? (this.buildTypes(def.types): any) : [],
astNode: def,
});
}
Expand Down
84 changes: 30 additions & 54 deletions src/utilities/extendSchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,7 @@ import { GraphQLDirective } from '../type/directives';
import { Kind } from '../language/kinds';

import type { GraphQLType, GraphQLNamedType } from '../type/definition';

import type {
DocumentNode,
DirectiveDefinitionNode,
TypeExtensionNode,
} from '../language/ast';
import type { DocumentNode, DirectiveDefinitionNode } from '../language/ast';

type Options = {|
...GraphQLSchemaValidationOptions,
Expand Down Expand Up @@ -114,6 +109,7 @@ export function extendSchema(
typeDefinitionMap[typeName] = def;
break;
case Kind.OBJECT_TYPE_EXTENSION:
case Kind.INTERFACE_TYPE_EXTENSION:
// Sanity check that this type extension exists within the
// schema's existing types.
const extendedTypeName = def.name.value;
Expand All @@ -125,39 +121,12 @@ export function extendSchema(
[def],
);
}
if (!isObjectType(existingType)) {
throw new GraphQLError(
`Cannot extend non-object type "${extendedTypeName}".`,
[def],
);
}
typeExtensionsMap[extendedTypeName] = appendExtensionToTypeExtensions(
def,
typeExtensionsMap[extendedTypeName],
);
break;
case Kind.INTERFACE_TYPE_EXTENSION:
const extendedInterfaceTypeName = def.name.value;
const existingInterfaceType = schema.getType(extendedInterfaceTypeName);
if (!existingInterfaceType) {
throw new GraphQLError(
`Cannot extend interface "${extendedInterfaceTypeName}" because ` +
'it does not exist in the existing schema.',
[def],
);
}
if (!isInterfaceType(existingInterfaceType)) {
throw new GraphQLError(
`Cannot extend non-interface type "${extendedInterfaceTypeName}".`,
[def],
);
}
typeExtensionsMap[
extendedInterfaceTypeName
] = appendExtensionToTypeExtensions(
def,
typeExtensionsMap[extendedInterfaceTypeName],
);
checkExtensionNode(existingType, def);

const existingTypeExtensions = typeExtensionsMap[extendedTypeName];
typeExtensionsMap[extendedTypeName] = existingTypeExtensions
? existingTypeExtensions.concat([def])
: [def];
break;
case Kind.DIRECTIVE_DEFINITION:
const directiveName = def.name.value;
Expand Down Expand Up @@ -212,9 +181,6 @@ export function extendSchema(
const extendTypeCache = Object.create(null);

// Get the root Query, Mutation, and Subscription object types.
// Note: While this could make early assertions to get the correctly
// typed values below, that would throw immediately while type system
// validation with validateSchema() will produce more actionable results.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is not relevant anymore since they're no any cast here.
Moreover, the result of extending object type will always be an object type.

const existingQueryType = schema.getQueryType();
const queryType = existingQueryType
? getExtendedType(existingQueryType)
Expand All @@ -235,7 +201,7 @@ export function extendSchema(
// that any type not directly referenced by a field will get created.
...objectValues(schema.getTypeMap()).map(type => getExtendedType(type)),
// Do the same with new types.
...objectValues(typeDefinitionMap).map(type => astBuilder.buildType(type)),
...astBuilder.buildTypes(objectValues(typeDefinitionMap)),
];

// Support both original legacy names and extended legacy names.
Expand All @@ -257,17 +223,6 @@ export function extendSchema(
allowedLegacyNames,
});

function appendExtensionToTypeExtensions(
extension: TypeExtensionNode,
existingTypeExtensions: ?Array<TypeExtensionNode>,
): Array<TypeExtensionNode> {
if (!existingTypeExtensions) {
return [extension];
}
existingTypeExtensions.push(extension);
return existingTypeExtensions;
}

// Below are functions used for producing this schema that have closed over
// this scope and have access to the schema, cache, and newly defined types.

Expand Down Expand Up @@ -420,3 +375,24 @@ export function extendSchema(
return getExtendedType(typeDef);
}
}

function checkExtensionNode(type, node) {
switch (node.kind) {
case Kind.OBJECT_TYPE_EXTENSION:
if (!isObjectType(type)) {
throw new GraphQLError(
`Cannot extend non-object type "${type.name}".`,
[node],
);
}
break;
case Kind.INTERFACE_TYPE_EXTENSION:
if (!isInterfaceType(type)) {
throw new GraphQLError(
`Cannot extend non-interface type "${type.name}".`,
[node],
);
}
break;
}
}