You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
364 lines
12 KiB
364 lines
12 KiB
5 months ago
|
import { devAssert } from '../jsutils/devAssert.mjs';
|
||
|
import { inspect } from '../jsutils/inspect.mjs';
|
||
|
import { isObjectLike } from '../jsutils/isObjectLike.mjs';
|
||
|
import { keyValMap } from '../jsutils/keyValMap.mjs';
|
||
|
import { parseValue } from '../language/parser.mjs';
|
||
|
import {
|
||
|
assertInterfaceType,
|
||
|
assertNullableType,
|
||
|
assertObjectType,
|
||
|
GraphQLEnumType,
|
||
|
GraphQLInputObjectType,
|
||
|
GraphQLInterfaceType,
|
||
|
GraphQLList,
|
||
|
GraphQLNonNull,
|
||
|
GraphQLObjectType,
|
||
|
GraphQLScalarType,
|
||
|
GraphQLUnionType,
|
||
|
isInputType,
|
||
|
isOutputType,
|
||
|
} from '../type/definition.mjs';
|
||
|
import { GraphQLDirective } from '../type/directives.mjs';
|
||
|
import { introspectionTypes, TypeKind } from '../type/introspection.mjs';
|
||
|
import { specifiedScalarTypes } from '../type/scalars.mjs';
|
||
|
import { GraphQLSchema } from '../type/schema.mjs';
|
||
|
import { valueFromAST } from './valueFromAST.mjs';
|
||
|
/**
|
||
|
* Build a GraphQLSchema for use by client tools.
|
||
|
*
|
||
|
* Given the result of a client running the introspection query, creates and
|
||
|
* returns a GraphQLSchema instance which can be then used with all graphql-js
|
||
|
* tools, but cannot be used to execute a query, as introspection does not
|
||
|
* represent the "resolver", "parse" or "serialize" functions or any other
|
||
|
* server-internal mechanisms.
|
||
|
*
|
||
|
* This function expects a complete introspection result. Don't forget to check
|
||
|
* the "errors" field of a server response before calling this function.
|
||
|
*/
|
||
|
|
||
|
export function buildClientSchema(introspection, options) {
|
||
|
(isObjectLike(introspection) && isObjectLike(introspection.__schema)) ||
|
||
|
devAssert(
|
||
|
false,
|
||
|
`Invalid or incomplete introspection result. Ensure that you are passing "data" property of introspection response and no "errors" was returned alongside: ${inspect(
|
||
|
introspection,
|
||
|
)}.`,
|
||
|
); // Get the schema from the introspection result.
|
||
|
|
||
|
const schemaIntrospection = introspection.__schema; // Iterate through all types, getting the type definition for each.
|
||
|
|
||
|
const typeMap = keyValMap(
|
||
|
schemaIntrospection.types,
|
||
|
(typeIntrospection) => typeIntrospection.name,
|
||
|
(typeIntrospection) => buildType(typeIntrospection),
|
||
|
); // Include standard types only if they are used.
|
||
|
|
||
|
for (const stdType of [...specifiedScalarTypes, ...introspectionTypes]) {
|
||
|
if (typeMap[stdType.name]) {
|
||
|
typeMap[stdType.name] = stdType;
|
||
|
}
|
||
|
} // Get the root Query, Mutation, and Subscription types.
|
||
|
|
||
|
const queryType = schemaIntrospection.queryType
|
||
|
? getObjectType(schemaIntrospection.queryType)
|
||
|
: null;
|
||
|
const mutationType = schemaIntrospection.mutationType
|
||
|
? getObjectType(schemaIntrospection.mutationType)
|
||
|
: null;
|
||
|
const subscriptionType = schemaIntrospection.subscriptionType
|
||
|
? getObjectType(schemaIntrospection.subscriptionType)
|
||
|
: null; // Get the directives supported by Introspection, assuming empty-set if
|
||
|
// directives were not queried for.
|
||
|
|
||
|
const directives = schemaIntrospection.directives
|
||
|
? schemaIntrospection.directives.map(buildDirective)
|
||
|
: []; // Then produce and return a Schema with these types.
|
||
|
|
||
|
return new GraphQLSchema({
|
||
|
description: schemaIntrospection.description,
|
||
|
query: queryType,
|
||
|
mutation: mutationType,
|
||
|
subscription: subscriptionType,
|
||
|
types: Object.values(typeMap),
|
||
|
directives,
|
||
|
assumeValid:
|
||
|
options === null || options === void 0 ? void 0 : options.assumeValid,
|
||
|
}); // Given a type reference in introspection, return the GraphQLType instance.
|
||
|
// preferring cached instances before building new instances.
|
||
|
|
||
|
function getType(typeRef) {
|
||
|
if (typeRef.kind === TypeKind.LIST) {
|
||
|
const itemRef = typeRef.ofType;
|
||
|
|
||
|
if (!itemRef) {
|
||
|
throw new Error('Decorated type deeper than introspection query.');
|
||
|
}
|
||
|
|
||
|
return new GraphQLList(getType(itemRef));
|
||
|
}
|
||
|
|
||
|
if (typeRef.kind === TypeKind.NON_NULL) {
|
||
|
const nullableRef = typeRef.ofType;
|
||
|
|
||
|
if (!nullableRef) {
|
||
|
throw new Error('Decorated type deeper than introspection query.');
|
||
|
}
|
||
|
|
||
|
const nullableType = getType(nullableRef);
|
||
|
return new GraphQLNonNull(assertNullableType(nullableType));
|
||
|
}
|
||
|
|
||
|
return getNamedType(typeRef);
|
||
|
}
|
||
|
|
||
|
function getNamedType(typeRef) {
|
||
|
const typeName = typeRef.name;
|
||
|
|
||
|
if (!typeName) {
|
||
|
throw new Error(`Unknown type reference: ${inspect(typeRef)}.`);
|
||
|
}
|
||
|
|
||
|
const type = typeMap[typeName];
|
||
|
|
||
|
if (!type) {
|
||
|
throw new Error(
|
||
|
`Invalid or incomplete schema, unknown type: ${typeName}. Ensure that a full introspection query is used in order to build a client schema.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
return type;
|
||
|
}
|
||
|
|
||
|
function getObjectType(typeRef) {
|
||
|
return assertObjectType(getNamedType(typeRef));
|
||
|
}
|
||
|
|
||
|
function getInterfaceType(typeRef) {
|
||
|
return assertInterfaceType(getNamedType(typeRef));
|
||
|
} // Given a type's introspection result, construct the correct
|
||
|
// GraphQLType instance.
|
||
|
|
||
|
function buildType(type) {
|
||
|
// eslint-disable-next-line @typescript-eslint/prefer-optional-chain
|
||
|
if (type != null && type.name != null && type.kind != null) {
|
||
|
// FIXME: Properly type IntrospectionType, it's a breaking change so fix in v17
|
||
|
// eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
|
||
|
switch (type.kind) {
|
||
|
case TypeKind.SCALAR:
|
||
|
return buildScalarDef(type);
|
||
|
|
||
|
case TypeKind.OBJECT:
|
||
|
return buildObjectDef(type);
|
||
|
|
||
|
case TypeKind.INTERFACE:
|
||
|
return buildInterfaceDef(type);
|
||
|
|
||
|
case TypeKind.UNION:
|
||
|
return buildUnionDef(type);
|
||
|
|
||
|
case TypeKind.ENUM:
|
||
|
return buildEnumDef(type);
|
||
|
|
||
|
case TypeKind.INPUT_OBJECT:
|
||
|
return buildInputObjectDef(type);
|
||
|
}
|
||
|
}
|
||
|
|
||
|
const typeStr = inspect(type);
|
||
|
throw new Error(
|
||
|
`Invalid or incomplete introspection result. Ensure that a full introspection query is used in order to build a client schema: ${typeStr}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
function buildScalarDef(scalarIntrospection) {
|
||
|
return new GraphQLScalarType({
|
||
|
name: scalarIntrospection.name,
|
||
|
description: scalarIntrospection.description,
|
||
|
specifiedByURL: scalarIntrospection.specifiedByURL,
|
||
|
});
|
||
|
}
|
||
|
|
||
|
function buildImplementationsList(implementingIntrospection) {
|
||
|
// TODO: Temporary workaround until GraphQL ecosystem will fully support
|
||
|
// 'interfaces' on interface types.
|
||
|
if (
|
||
|
implementingIntrospection.interfaces === null &&
|
||
|
implementingIntrospection.kind === TypeKind.INTERFACE
|
||
|
) {
|
||
|
return [];
|
||
|
}
|
||
|
|
||
|
if (!implementingIntrospection.interfaces) {
|
||
|
const implementingIntrospectionStr = inspect(implementingIntrospection);
|
||
|
throw new Error(
|
||
|
`Introspection result missing interfaces: ${implementingIntrospectionStr}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
return implementingIntrospection.interfaces.map(getInterfaceType);
|
||
|
}
|
||
|
|
||
|
function buildObjectDef(objectIntrospection) {
|
||
|
return new GraphQLObjectType({
|
||
|
name: objectIntrospection.name,
|
||
|
description: objectIntrospection.description,
|
||
|
interfaces: () => buildImplementationsList(objectIntrospection),
|
||
|
fields: () => buildFieldDefMap(objectIntrospection),
|
||
|
});
|
||
|
}
|
||
|
|
||
|
function buildInterfaceDef(interfaceIntrospection) {
|
||
|
return new GraphQLInterfaceType({
|
||
|
name: interfaceIntrospection.name,
|
||
|
description: interfaceIntrospection.description,
|
||
|
interfaces: () => buildImplementationsList(interfaceIntrospection),
|
||
|
fields: () => buildFieldDefMap(interfaceIntrospection),
|
||
|
});
|
||
|
}
|
||
|
|
||
|
function buildUnionDef(unionIntrospection) {
|
||
|
if (!unionIntrospection.possibleTypes) {
|
||
|
const unionIntrospectionStr = inspect(unionIntrospection);
|
||
|
throw new Error(
|
||
|
`Introspection result missing possibleTypes: ${unionIntrospectionStr}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
return new GraphQLUnionType({
|
||
|
name: unionIntrospection.name,
|
||
|
description: unionIntrospection.description,
|
||
|
types: () => unionIntrospection.possibleTypes.map(getObjectType),
|
||
|
});
|
||
|
}
|
||
|
|
||
|
function buildEnumDef(enumIntrospection) {
|
||
|
if (!enumIntrospection.enumValues) {
|
||
|
const enumIntrospectionStr = inspect(enumIntrospection);
|
||
|
throw new Error(
|
||
|
`Introspection result missing enumValues: ${enumIntrospectionStr}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
return new GraphQLEnumType({
|
||
|
name: enumIntrospection.name,
|
||
|
description: enumIntrospection.description,
|
||
|
values: keyValMap(
|
||
|
enumIntrospection.enumValues,
|
||
|
(valueIntrospection) => valueIntrospection.name,
|
||
|
(valueIntrospection) => ({
|
||
|
description: valueIntrospection.description,
|
||
|
deprecationReason: valueIntrospection.deprecationReason,
|
||
|
}),
|
||
|
),
|
||
|
});
|
||
|
}
|
||
|
|
||
|
function buildInputObjectDef(inputObjectIntrospection) {
|
||
|
if (!inputObjectIntrospection.inputFields) {
|
||
|
const inputObjectIntrospectionStr = inspect(inputObjectIntrospection);
|
||
|
throw new Error(
|
||
|
`Introspection result missing inputFields: ${inputObjectIntrospectionStr}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
return new GraphQLInputObjectType({
|
||
|
name: inputObjectIntrospection.name,
|
||
|
description: inputObjectIntrospection.description,
|
||
|
fields: () => buildInputValueDefMap(inputObjectIntrospection.inputFields),
|
||
|
});
|
||
|
}
|
||
|
|
||
|
function buildFieldDefMap(typeIntrospection) {
|
||
|
if (!typeIntrospection.fields) {
|
||
|
throw new Error(
|
||
|
`Introspection result missing fields: ${inspect(typeIntrospection)}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
return keyValMap(
|
||
|
typeIntrospection.fields,
|
||
|
(fieldIntrospection) => fieldIntrospection.name,
|
||
|
buildField,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
function buildField(fieldIntrospection) {
|
||
|
const type = getType(fieldIntrospection.type);
|
||
|
|
||
|
if (!isOutputType(type)) {
|
||
|
const typeStr = inspect(type);
|
||
|
throw new Error(
|
||
|
`Introspection must provide output type for fields, but received: ${typeStr}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
if (!fieldIntrospection.args) {
|
||
|
const fieldIntrospectionStr = inspect(fieldIntrospection);
|
||
|
throw new Error(
|
||
|
`Introspection result missing field args: ${fieldIntrospectionStr}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
return {
|
||
|
description: fieldIntrospection.description,
|
||
|
deprecationReason: fieldIntrospection.deprecationReason,
|
||
|
type,
|
||
|
args: buildInputValueDefMap(fieldIntrospection.args),
|
||
|
};
|
||
|
}
|
||
|
|
||
|
function buildInputValueDefMap(inputValueIntrospections) {
|
||
|
return keyValMap(
|
||
|
inputValueIntrospections,
|
||
|
(inputValue) => inputValue.name,
|
||
|
buildInputValue,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
function buildInputValue(inputValueIntrospection) {
|
||
|
const type = getType(inputValueIntrospection.type);
|
||
|
|
||
|
if (!isInputType(type)) {
|
||
|
const typeStr = inspect(type);
|
||
|
throw new Error(
|
||
|
`Introspection must provide input type for arguments, but received: ${typeStr}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
const defaultValue =
|
||
|
inputValueIntrospection.defaultValue != null
|
||
|
? valueFromAST(parseValue(inputValueIntrospection.defaultValue), type)
|
||
|
: undefined;
|
||
|
return {
|
||
|
description: inputValueIntrospection.description,
|
||
|
type,
|
||
|
defaultValue,
|
||
|
deprecationReason: inputValueIntrospection.deprecationReason,
|
||
|
};
|
||
|
}
|
||
|
|
||
|
function buildDirective(directiveIntrospection) {
|
||
|
if (!directiveIntrospection.args) {
|
||
|
const directiveIntrospectionStr = inspect(directiveIntrospection);
|
||
|
throw new Error(
|
||
|
`Introspection result missing directive args: ${directiveIntrospectionStr}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
if (!directiveIntrospection.locations) {
|
||
|
const directiveIntrospectionStr = inspect(directiveIntrospection);
|
||
|
throw new Error(
|
||
|
`Introspection result missing directive locations: ${directiveIntrospectionStr}.`,
|
||
|
);
|
||
|
}
|
||
|
|
||
|
return new GraphQLDirective({
|
||
|
name: directiveIntrospection.name,
|
||
|
description: directiveIntrospection.description,
|
||
|
isRepeatable: directiveIntrospection.isRepeatable,
|
||
|
locations: directiveIntrospection.locations.slice(),
|
||
|
args: buildInputValueDefMap(directiveIntrospection.args),
|
||
|
});
|
||
|
}
|
||
|
}
|