import 'dart:async'; import 'package:graphql_parser/graphql_parser.dart'; import 'package:graphql_schema/graphql_schema.dart'; import 'introspection.dart'; /// Transforms any [Map] into `Map`. Map foldToStringDynamic(Map map) { return map == null ? null : map.keys.fold>( {}, (out, k) => out..[k.toString()] = map[k]); } /// A Dart implementation of a GraphQL server. class GraphQL { /// Any custom types to include in introspection information. final List customTypes = []; /// An optional callback that can be used to resolve fields from objects that are not [Map]s, /// when the related field has no resolver. final FutureOr Function(T, String, Map) defaultFieldResolver; GraphQLSchema _schema; GraphQL(GraphQLSchema schema, {bool introspect = true, this.defaultFieldResolver, List customTypes = const []}) : _schema = schema { if (customTypes?.isNotEmpty == true) { this.customTypes.addAll(customTypes); } if (introspect) { var allTypes = []; allTypes.addAll(this.customTypes); _schema = reflectSchema(_schema, allTypes); for (var type in allTypes.toSet()) { if (!this.customTypes.contains(type)) { this.customTypes.add(type); } } } if (_schema.queryType != null) this.customTypes.add(_schema.queryType); if (_schema.mutationType != null) this.customTypes.add(_schema.mutationType); if (_schema.subscriptionType != null) this.customTypes.add(_schema.subscriptionType); } GraphQLType convertType(TypeContext ctx) { if (ctx.listType != null) { return GraphQLListType(convertType(ctx.listType.type)); } else if (ctx.typeName != null) { switch (ctx.typeName.name) { case 'Int': return graphQLString; case 'Float': return graphQLFloat; case 'String': return graphQLString; case 'Boolean': return graphQLBoolean; case 'ID': return graphQLId; case 'Date': case 'DateTime': return graphQLDate; default: return customTypes.firstWhere((t) => t.name == ctx.typeName.name, orElse: () => throw ArgumentError( 'Unknown GraphQL type: "${ctx.typeName.name}"')); } } else { throw ArgumentError('Invalid GraphQL type: "${ctx.span.text}"'); } } Future parseAndExecute(String text, {String operationName, sourceUrl, Map variableValues = const {}, initialValue, Map globalVariables}) { var tokens = scan(text, sourceUrl: sourceUrl); var parser = Parser(tokens); var document = parser.parseDocument(); if (parser.errors.isNotEmpty) { throw GraphQLException(parser.errors .map((e) => GraphQLExceptionError(e.message, locations: [ GraphExceptionErrorLocation.fromSourceLocation(e.span.start) ])) .toList()); } return executeRequest( _schema, document, operationName: operationName, initialValue: initialValue, variableValues: variableValues, globalVariables: globalVariables, ); } Future executeRequest(GraphQLSchema schema, DocumentContext document, {String operationName, Map variableValues = const {}, initialValue, Map globalVariables = const {}}) async { var operation = getOperation(document, operationName); var coercedVariableValues = coerceVariableValues( schema, operation, variableValues ?? {}); if (operation.isQuery) return await executeQuery(document, operation, schema, coercedVariableValues, initialValue, globalVariables); else if (operation.isSubscription) { return await subscribe(document, operation, schema, coercedVariableValues, globalVariables, initialValue); } else { return executeMutation(document, operation, schema, coercedVariableValues, initialValue, globalVariables); } } OperationDefinitionContext getOperation( DocumentContext document, String operationName) { var ops = document.definitions.where((d) => d is OperationDefinitionContext); if (operationName == null) { return ops.length == 1 ? ops.first as OperationDefinitionContext : throw GraphQLException.fromMessage( 'This document does not define any operations.'); } else { return ops.firstWhere( (d) => (d as OperationDefinitionContext).name == operationName, orElse: () => throw GraphQLException.fromMessage( 'Missing required operation "$operationName".')) as OperationDefinitionContext; } } Map coerceVariableValues( GraphQLSchema schema, OperationDefinitionContext operation, Map variableValues) { var coercedValues = {}; var variableDefinitions = operation.variableDefinitions?.variableDefinitions ?? []; for (var variableDefinition in variableDefinitions) { var variableName = variableDefinition.variable.name; var variableType = variableDefinition.type; var defaultValue = variableDefinition.defaultValue; var value = variableValues[variableName]; if (value == null) { if (defaultValue != null) { coercedValues[variableName] = defaultValue.value.value; } else if (!variableType.isNullable) { throw GraphQLException.fromSourceSpan( 'Missing required variable "$variableName".', variableDefinition.span); } } else { var type = convertType(variableType); var validation = type.validate(variableName, value); if (!validation.successful) { throw GraphQLException(validation.errors .map((e) => GraphQLExceptionError(e, locations: [ GraphExceptionErrorLocation.fromSourceLocation( variableDefinition.span.start) ])) .toList()); } else { coercedValues[variableName] = type.deserialize(value); } } } return coercedValues; } Future> executeQuery( DocumentContext document, OperationDefinitionContext query, GraphQLSchema schema, Map variableValues, initialValue, Map globalVariables) async { var queryType = schema.queryType; var selectionSet = query.selectionSet; return await executeSelectionSet(document, selectionSet, queryType, initialValue, variableValues, globalVariables); } Future> executeMutation( DocumentContext document, OperationDefinitionContext mutation, GraphQLSchema schema, Map variableValues, initialValue, Map globalVariables) async { var mutationType = schema.mutationType; if (mutationType == null) { throw GraphQLException.fromMessage( 'The schema does not define a mutation type.'); } var selectionSet = mutation.selectionSet; return await executeSelectionSet(document, selectionSet, mutationType, initialValue, variableValues, globalVariables); } Future>> subscribe( DocumentContext document, OperationDefinitionContext subscription, GraphQLSchema schema, Map variableValues, Map globalVariables, initialValue) async { var sourceStream = await createSourceEventStream( document, subscription, schema, variableValues, initialValue); return mapSourceToResponseEvent(sourceStream, subscription, schema, document, initialValue, variableValues, globalVariables); } Future createSourceEventStream( DocumentContext document, OperationDefinitionContext subscription, GraphQLSchema schema, Map variableValues, initialValue) { var selectionSet = subscription.selectionSet; var subscriptionType = schema.subscriptionType; if (subscriptionType == null) throw GraphQLException.fromSourceSpan( 'The schema does not define a subscription type.', subscription.span); var groupedFieldSet = collectFields(document, subscriptionType, selectionSet, variableValues); if (groupedFieldSet.length != 1) throw GraphQLException.fromSourceSpan( 'The grouped field set from this query must have exactly one entry.', selectionSet.span); var fields = groupedFieldSet.entries.first.value; var fieldName = fields.first.field.fieldName.alias?.name ?? fields.first.field.fieldName.name; var field = fields.first; var argumentValues = coerceArgumentValues(subscriptionType, field, variableValues); return resolveFieldEventStream( subscriptionType, initialValue, fieldName, argumentValues); } Stream> mapSourceToResponseEvent( Stream sourceStream, OperationDefinitionContext subscription, GraphQLSchema schema, DocumentContext document, initialValue, Map variableValues, Map globalVariables, ) async* { await for (var event in sourceStream) { yield await executeSubscriptionEvent(document, subscription, schema, event, variableValues, globalVariables); } } Future> executeSubscriptionEvent( DocumentContext document, OperationDefinitionContext subscription, GraphQLSchema schema, initialValue, Map variableValues, Map globalVariables) async { var selectionSet = subscription.selectionSet; var subscriptionType = schema.subscriptionType; if (subscriptionType == null) throw GraphQLException.fromSourceSpan( 'The schema does not define a subscription type.', subscription.span); try { var data = await executeSelectionSet(document, selectionSet, subscriptionType, initialValue, variableValues, globalVariables); return {'data': data}; } on GraphQLException catch (e) { return { 'data': null, 'errors': [e.errors.map((e) => e.toJson()).toList()] }; } } Future resolveFieldEventStream(GraphQLObjectType subscriptionType, rootValue, String fieldName, Map argumentValues) async { var field = subscriptionType.fields.firstWhere((f) => f.name == fieldName, orElse: () { throw GraphQLException.fromMessage( 'No subscription field named "$fieldName" is defined.'); }); var resolver = field.resolve; var result = await resolver(rootValue, argumentValues); if (result is Stream) return result; else return Stream.fromIterable([result]); } Future> executeSelectionSet( DocumentContext document, SelectionSetContext selectionSet, GraphQLObjectType objectType, objectValue, Map variableValues, Map globalVariables) async { var groupedFieldSet = collectFields(document, objectType, selectionSet, variableValues); var resultMap = {}; for (var responseKey in groupedFieldSet.keys) { var fields = groupedFieldSet[responseKey]; for (var field in fields) { var fieldName = field.field.fieldName.alias?.name ?? field.field.fieldName.name; var responseValue; if (fieldName == '__typename') { responseValue = objectType.name; } else { var fieldType = objectType.fields .firstWhere((f) => f.name == fieldName, orElse: () => null) ?.type; if (fieldType == null) continue; responseValue = await executeField( document, fieldName, objectType, objectValue, fields, fieldType, Map.from( globalVariables ?? {}) ..addAll(variableValues), globalVariables); } resultMap[responseKey] = responseValue; } } return resultMap; } Future executeField( DocumentContext document, String fieldName, GraphQLObjectType objectType, objectValue, List fields, GraphQLType fieldType, Map variableValues, Map globalVariables) async { var field = fields[0]; var argumentValues = coerceArgumentValues(objectType, field, variableValues); var resolvedValue = await resolveFieldValue( objectType, objectValue, fieldName, Map.from(globalVariables ?? {}) ..addAll(argumentValues ?? {})); return completeValue(document, fieldName, fieldType, fields, resolvedValue, variableValues, globalVariables); } Map coerceArgumentValues(GraphQLObjectType objectType, SelectionContext field, Map variableValues) { var coercedValues = {}; var argumentValues = field.field.arguments; var fieldName = field.field.fieldName.alias?.name ?? field.field.fieldName.name; var desiredField = objectType.fields.firstWhere((f) => f.name == fieldName, orElse: () => throw FormatException( '${objectType.name} has no field named "$fieldName".')); var argumentDefinitions = desiredField.inputs; for (var argumentDefinition in argumentDefinitions) { var argumentName = argumentDefinition.name; var argumentType = argumentDefinition.type; var defaultValue = argumentDefinition.defaultValue; var value = argumentValues.firstWhere((a) => a.name == argumentName, orElse: () => null); if (value?.valueOrVariable?.variable != null) { var variableName = value.valueOrVariable.variable.name; var variableValue = variableValues[variableName]; if (variableValues.containsKey(variableName)) { coercedValues[argumentName] = variableValue; } else if (defaultValue != null || argumentDefinition.defaultsToNull) { coercedValues[argumentName] = defaultValue; } else if (argumentType is GraphQLNonNullableType) { throw GraphQLException.fromSourceSpan( 'Missing value for argument "$argumentName" of field "$fieldName".', value.valueOrVariable.span); } else { continue; } } else if (value == null) { if (defaultValue != null || argumentDefinition.defaultsToNull) { coercedValues[argumentName] = defaultValue; } else if (argumentType is GraphQLNonNullableType) { throw GraphQLException.fromMessage( 'Missing value for argument "$argumentName" of field "$fieldName".'); } else { continue; } } else { try { var validation = argumentType.validate( fieldName, value.valueOrVariable.value.value); if (!validation.successful) { var errors = [ GraphQLExceptionError( 'Type coercion error for value of argument "$argumentName" of field "$fieldName".', locations: [ GraphExceptionErrorLocation.fromSourceLocation( value.valueOrVariable.span.start) ], ) ]; for (var error in validation.errors) { errors.add( GraphQLExceptionError( error, locations: [ GraphExceptionErrorLocation.fromSourceLocation( value.valueOrVariable.span.start) ], ), ); } throw GraphQLException(errors); } else { var coercedValue = validation.value; coercedValues[argumentName] = coercedValue; } } on TypeError catch (e) { throw GraphQLException([ GraphQLExceptionError( 'Type coercion error for value of argument "$argumentName" of field "$fieldName".', locations: [ GraphExceptionErrorLocation.fromSourceLocation( value.valueOrVariable.span.start) ], ), GraphQLExceptionError( e.message.toString(), locations: [ GraphExceptionErrorLocation.fromSourceLocation( value.valueOrVariable.span.start) ], ), ]); } } } return coercedValues; } Future resolveFieldValue(GraphQLObjectType objectType, T objectValue, String fieldName, Map argumentValues) async { var field = objectType.fields.firstWhere((f) => f.name == fieldName); if (objectValue is Map) { return objectValue[fieldName] as T; } else if (field.resolve == null) { if (defaultFieldResolver != null) return await defaultFieldResolver( objectValue, fieldName, argumentValues); return null; } else { return await field.resolve(objectValue, argumentValues) as T; } } Future completeValue( DocumentContext document, String fieldName, GraphQLType fieldType, List fields, result, Map variableValues, Map globalVariables) async { if (fieldType is GraphQLNonNullableType) { var innerType = fieldType.ofType; var completedResult = await completeValue(document, fieldName, innerType, fields, result, variableValues, globalVariables); if (completedResult == null) { throw GraphQLException.fromMessage( 'Null value provided for non-nullable field "$fieldName".'); } else { return completedResult; } } if (result == null) { return null; } if (fieldType is GraphQLListType) { if (result is! Iterable) { throw GraphQLException.fromMessage( 'Value of field "$fieldName" must be a list or iterable, got $result instead.'); } var innerType = fieldType.ofType; var out = []; for (var resultItem in (result as Iterable)) { out.add(await completeValue(document, '(item in "$fieldName")', innerType, fields, resultItem, variableValues, globalVariables)); } return out; } if (fieldType is GraphQLScalarType) { try { var validation = fieldType.validate(fieldName, result); if (!validation.successful) { return null; } else { return validation.value; } } on TypeError { throw GraphQLException.fromMessage( 'Value of field "$fieldName" must be ${fieldType.valueType}, got $result instead.'); } } if (fieldType is GraphQLObjectType || fieldType is GraphQLUnionType) { GraphQLObjectType objectType; if (fieldType is GraphQLObjectType && !fieldType.isInterface) { objectType = fieldType; } else { objectType = resolveAbstractType(fieldName, fieldType, result); } var subSelectionSet = mergeSelectionSets(fields); return await executeSelectionSet(document, subSelectionSet, objectType, result, variableValues, globalVariables); } throw UnsupportedError('Unsupported type: $fieldType'); } GraphQLObjectType resolveAbstractType( String fieldName, GraphQLType type, result) { List possibleTypes; if (type is GraphQLObjectType) { if (type.isInterface) { possibleTypes = type.possibleTypes; } else { return type; } } else if (type is GraphQLUnionType) { possibleTypes = type.possibleTypes; } else { throw ArgumentError(); } var errors = []; for (var t in possibleTypes) { try { var validation = t.validate(fieldName, foldToStringDynamic(result as Map)); if (validation.successful) { return t; } errors .addAll(validation.errors.map((m) => GraphQLExceptionError(m))); } on GraphQLException catch (e) { errors.addAll(e.errors); } } errors.insert( 0, GraphQLExceptionError( 'Cannot convert value $result to type $type.')); throw GraphQLException(errors); } SelectionSetContext mergeSelectionSets(List fields) { var selections = []; for (var field in fields) { if (field.field?.selectionSet != null) { selections.addAll(field.field.selectionSet.selections); } else if (field.inlineFragment?.selectionSet != null) { selections.addAll(field.inlineFragment.selectionSet.selections); } } return SelectionSetContext.merged(selections); } Map> collectFields( DocumentContext document, GraphQLObjectType objectType, SelectionSetContext selectionSet, Map variableValues, {List visitedFragments}) { var groupedFields = >{}; visitedFragments ??= []; for (var selection in selectionSet.selections) { if (getDirectiveValue('skip', 'if', selection, variableValues) == true) continue; if (getDirectiveValue('include', 'if', selection, variableValues) == false) continue; if (selection.field != null) { var responseKey = selection.field.fieldName.alias?.alias ?? selection.field.fieldName.name; var groupForResponseKey = groupedFields.putIfAbsent(responseKey, () => []); groupForResponseKey.add(selection); } else if (selection.fragmentSpread != null) { var fragmentSpreadName = selection.fragmentSpread.name; if (visitedFragments.contains(fragmentSpreadName)) continue; visitedFragments.add(fragmentSpreadName); var fragment = document.definitions .where((d) => d is FragmentDefinitionContext) .firstWhere( (f) => (f as FragmentDefinitionContext).name == fragmentSpreadName, orElse: () => null) as FragmentDefinitionContext; if (fragment == null) continue; var fragmentType = fragment.typeCondition; if (!doesFragmentTypeApply(objectType, fragmentType)) continue; var fragmentSelectionSet = fragment.selectionSet; var fragmentGroupFieldSet = collectFields( document, objectType, fragmentSelectionSet, variableValues); for (var responseKey in fragmentGroupFieldSet.keys) { var fragmentGroup = fragmentGroupFieldSet[responseKey]; var groupForResponseKey = groupedFields.putIfAbsent(responseKey, () => []); groupForResponseKey.addAll(fragmentGroup); } } else if (selection.inlineFragment != null) { var fragmentType = selection.inlineFragment.typeCondition; if (fragmentType != null && !doesFragmentTypeApply(objectType, fragmentType)) continue; var fragmentSelectionSet = selection.inlineFragment.selectionSet; var fragmentGroupFieldSet = collectFields( document, objectType, fragmentSelectionSet, variableValues); for (var responseKey in fragmentGroupFieldSet.keys) { var fragmentGroup = fragmentGroupFieldSet[responseKey]; var groupForResponseKey = groupedFields.putIfAbsent(responseKey, () => []); groupForResponseKey.addAll(fragmentGroup); } } } return groupedFields; } getDirectiveValue(String name, String argumentName, SelectionContext selection, Map variableValues) { if (selection.field == null) return null; var directive = selection.field.directives.firstWhere((d) { var vv = d.valueOrVariable; if (vv.value != null) return vv.value.value == name; return vv.variable.name == name; }, orElse: () => null); if (directive == null) return null; if (directive.argument?.name != argumentName) return null; var vv = directive.argument.valueOrVariable; if (vv.value != null) return vv.value.value; var vname = vv.variable.name; if (!variableValues.containsKey(vname)) throw GraphQLException.fromSourceSpan( 'Unknown variable: "$vname"', vv.span); return variableValues[vname]; } bool doesFragmentTypeApply( GraphQLObjectType objectType, TypeConditionContext fragmentType) { var type = convertType(TypeContext(fragmentType.typeName, null)); if (type is GraphQLObjectType && !type.isInterface) { for (var field in type.fields) if (!objectType.fields.any((f) => f.name == field.name)) return false; return true; } else if (type is GraphQLObjectType && type.isInterface) { return objectType.isImplementationOf(type); } else if (type is GraphQLUnionType) { return type.possibleTypes.any((t) => objectType.isImplementationOf(t)); } return false; } }