graphql.schema.idl.SchemaPrinter Maven / Gradle / Ivy
package graphql.schema.idl;
import graphql.Assert;
import graphql.DirectivesUtil;
import graphql.GraphQLContext;
import graphql.PublicApi;
import graphql.execution.ValuesResolver;
import graphql.language.AstPrinter;
import graphql.language.Comment;
import graphql.language.Description;
import graphql.language.DirectiveDefinition;
import graphql.language.Document;
import graphql.language.EnumTypeDefinition;
import graphql.language.EnumValueDefinition;
import graphql.language.FieldDefinition;
import graphql.language.InputObjectTypeDefinition;
import graphql.language.InputValueDefinition;
import graphql.language.InterfaceTypeDefinition;
import graphql.language.ObjectTypeDefinition;
import graphql.language.ScalarTypeDefinition;
import graphql.language.SchemaDefinition;
import graphql.language.SchemaExtensionDefinition;
import graphql.language.TypeDefinition;
import graphql.language.UnionTypeDefinition;
import graphql.schema.DefaultGraphqlTypeComparatorRegistry;
import graphql.schema.GraphQLAppliedDirective;
import graphql.schema.GraphQLAppliedDirectiveArgument;
import graphql.schema.GraphQLArgument;
import graphql.schema.GraphQLDirective;
import graphql.schema.GraphQLDirectiveContainer;
import graphql.schema.GraphQLEnumType;
import graphql.schema.GraphQLEnumValueDefinition;
import graphql.schema.GraphQLFieldDefinition;
import graphql.schema.GraphQLInputObjectField;
import graphql.schema.GraphQLInputObjectType;
import graphql.schema.GraphQLInputType;
import graphql.schema.GraphQLInterfaceType;
import graphql.schema.GraphQLNamedOutputType;
import graphql.schema.GraphQLNamedType;
import graphql.schema.GraphQLObjectType;
import graphql.schema.GraphQLOutputType;
import graphql.schema.GraphQLScalarType;
import graphql.schema.GraphQLSchema;
import graphql.schema.GraphQLSchemaElement;
import graphql.schema.GraphQLType;
import graphql.schema.GraphQLTypeUtil;
import graphql.schema.GraphQLUnionType;
import graphql.schema.GraphqlTypeComparatorEnvironment;
import graphql.schema.GraphqlTypeComparatorRegistry;
import graphql.schema.InputValueWithState;
import graphql.schema.visibility.GraphqlFieldVisibility;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import static graphql.Directives.DeprecatedDirective;
import static graphql.Scalars.GraphQLString;
import static graphql.schema.visibility.DefaultGraphqlFieldVisibility.DEFAULT_FIELD_VISIBILITY;
import static graphql.util.EscapeUtil.escapeJsonString;
import static java.util.Optional.ofNullable;
import static java.util.stream.Collectors.joining;
import static java.util.stream.Collectors.toList;
/**
* This can print an in memory GraphQL schema back to a logical schema definition
*/
@PublicApi
public class SchemaPrinter {
/**
* This predicate excludes all directives which are specified by the GraphQL Specification.
* Printing these directives is optional.
*/
public static final Predicate ExcludeGraphQLSpecifiedDirectivesPredicate = d -> !DirectiveInfo.isGraphqlSpecifiedDirective(d);
/**
* Options to use when printing a schema
*/
public static class Options {
private final boolean includeIntrospectionTypes;
private final boolean includeScalars;
private final boolean useAstDefinitions;
private final boolean includeSchemaDefinition;
private final boolean includeDirectiveDefinitions;
private final boolean descriptionsAsHashComments;
private final Predicate includeDirectiveDefinition;
private final Predicate includeDirective;
private final Predicate includeSchemaElement;
private final GraphqlTypeComparatorRegistry comparatorRegistry;
private final boolean includeAstDefinitionComments;
private Options(boolean includeIntrospectionTypes,
boolean includeScalars,
boolean includeSchemaDefinition,
boolean includeDirectiveDefinitions,
Predicate includeDirectiveDefinition,
boolean useAstDefinitions,
boolean descriptionsAsHashComments,
Predicate includeDirective,
Predicate includeSchemaElement,
GraphqlTypeComparatorRegistry comparatorRegistry,
boolean includeAstDefinitionComments) {
this.includeIntrospectionTypes = includeIntrospectionTypes;
this.includeScalars = includeScalars;
this.includeSchemaDefinition = includeSchemaDefinition;
this.includeDirectiveDefinitions = includeDirectiveDefinitions;
this.includeDirectiveDefinition = includeDirectiveDefinition;
this.includeDirective = includeDirective;
this.useAstDefinitions = useAstDefinitions;
this.descriptionsAsHashComments = descriptionsAsHashComments;
this.comparatorRegistry = comparatorRegistry;
this.includeSchemaElement = includeSchemaElement;
this.includeAstDefinitionComments = includeAstDefinitionComments;
}
public boolean isIncludeIntrospectionTypes() {
return includeIntrospectionTypes;
}
public boolean isIncludeScalars() {
return includeScalars;
}
public boolean isIncludeSchemaDefinition() {
return includeSchemaDefinition;
}
public boolean isIncludeDirectiveDefinitions() {
return includeDirectiveDefinitions;
}
public Predicate getIncludeDirectiveDefinition() {
return includeDirectiveDefinition;
}
public Predicate getIncludeDirective() {
return includeDirective;
}
public Predicate getIncludeSchemaElement() {
return includeSchemaElement;
}
public boolean isDescriptionsAsHashComments() {
return descriptionsAsHashComments;
}
public GraphqlTypeComparatorRegistry getComparatorRegistry() {
return comparatorRegistry;
}
public boolean isUseAstDefinitions() {
return useAstDefinitions;
}
public boolean isIncludeAstDefinitionComments() {
return includeAstDefinitionComments;
}
public static Options defaultOptions() {
return new Options(false,
true,
false,
true,
directive -> true, false,
false,
directive -> true,
element -> true,
DefaultGraphqlTypeComparatorRegistry.defaultComparators(),
false);
}
/**
* This will allow you to include introspection types that are contained in a schema
*
* @param flag whether to include them
*
* @return options
*/
public Options includeIntrospectionTypes(boolean flag) {
return new Options(flag,
this.includeScalars,
this.includeSchemaDefinition,
this.includeDirectiveDefinitions,
this.includeDirectiveDefinition, this.useAstDefinitions,
this.descriptionsAsHashComments,
this.includeDirective,
this.includeSchemaElement,
this.comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* This will allow you to include scalar types that are contained in a schema
*
* @param flag whether to include them
*
* @return options
*/
public Options includeScalarTypes(boolean flag) {
return new Options(this.includeIntrospectionTypes,
flag,
this.includeSchemaDefinition,
this.includeDirectiveDefinitions,
this.includeDirectiveDefinition, this.useAstDefinitions,
this.descriptionsAsHashComments,
this.includeDirective,
this.includeSchemaElement,
this.comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* This will force the printing of the graphql schema definition even if the query, mutation, and/or subscription
* types use the default names. Some graphql parsers require this information even if the schema uses the
* default type names. The schema definition will always be printed if any of the query, mutation, or subscription
* types do not use the default names.
*
* @param flag whether to force include the schema definition
*
* @return options
*/
public Options includeSchemaDefinition(boolean flag) {
return new Options(this.includeIntrospectionTypes,
this.includeScalars,
flag,
this.includeDirectiveDefinitions,
this.includeDirectiveDefinition,
this.useAstDefinitions,
this.descriptionsAsHashComments,
this.includeDirective,
this.includeSchemaElement,
this.comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* This flag controls whether schema printer will include directive definitions at the top of the schema, but does not remove them from the field or type usage.
*
* In some schema definitions, like Apollo Federation, the schema should be printed without the directive definitions.
* This simplified schema is returned by a GraphQL query to other services, in a format that is different that the introspection query.
*
* On by default.
*
* @param flag whether to print directive definitions
*
* @return new instance of options
*/
public Options includeDirectiveDefinitions(boolean flag) {
return new Options(this.includeIntrospectionTypes,
this.includeScalars,
this.includeSchemaDefinition,
flag,
directive -> flag,
this.useAstDefinitions,
this.descriptionsAsHashComments,
this.includeDirective,
this.includeSchemaElement,
this.comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* This is a Predicate that decides whether a directive definition is printed.
*
* @param includeDirectiveDefinition the predicate to decide of a directive definition is printed
*
* @return new instance of options
*/
public Options includeDirectiveDefinition(Predicate includeDirectiveDefinition) {
return new Options(this.includeIntrospectionTypes,
this.includeScalars,
this.includeSchemaDefinition,
this.includeDirectiveDefinitions,
includeDirectiveDefinition,
this.useAstDefinitions,
this.descriptionsAsHashComments,
this.includeDirective,
this.includeSchemaElement,
this.comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* Allow to print directives. In some situations, auto-generated schemas contain a lot of directives that
* make the printout noisy and having this flag would allow cleaner printout. On by default.
*
* @param flag whether to print directives
*
* @return new instance of options
*/
public Options includeDirectives(boolean flag) {
return new Options(this.includeIntrospectionTypes,
this.includeScalars,
this.includeSchemaDefinition,
this.includeDirectiveDefinitions,
this.includeDirectiveDefinition,
this.useAstDefinitions,
this.descriptionsAsHashComments,
directive -> flag,
this.includeSchemaElement,
this.comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* This is a Predicate that decides whether a directive element is printed.
*
* @param includeDirective the predicate to decide of a directive is printed
*
* @return new instance of options
*/
public Options includeDirectives(Predicate includeDirective) {
return new Options(this.includeIntrospectionTypes,
this.includeScalars,
this.includeSchemaDefinition,
this.includeDirectiveDefinitions,
this.includeDirectiveDefinition,
this.useAstDefinitions,
this.descriptionsAsHashComments,
includeDirective,
this.includeSchemaElement,
this.comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* This is a general purpose Predicate that decides whether a schema element is printed ever.
*
* @param includeSchemaElement the predicate to decide of a schema is printed
*
* @return new instance of options
*/
public Options includeSchemaElement(Predicate includeSchemaElement) {
Assert.assertNotNull(includeSchemaElement);
return new Options(this.includeIntrospectionTypes,
this.includeScalars,
this.includeSchemaDefinition,
this.includeDirectiveDefinitions,
this.includeDirectiveDefinition,
this.useAstDefinitions,
this.descriptionsAsHashComments,
this.includeDirective,
includeSchemaElement,
this.comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* This flag controls whether schema printer will use the {@link graphql.schema.GraphQLType}'s original Ast {@link graphql.language.TypeDefinition}s when printing the type. This
* allows access to any `extend type` declarations that might have been originally made.
*
* @param flag whether to print via AST type definitions
*
* @return new instance of options
*/
public Options useAstDefinitions(boolean flag) {
return new Options(this.includeIntrospectionTypes,
this.includeScalars,
this.includeSchemaDefinition,
this.includeDirectiveDefinitions,
this.includeDirectiveDefinition,
flag,
this.descriptionsAsHashComments,
this.includeDirective,
this.includeSchemaElement,
this.comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* Descriptions are defined as preceding string literals, however an older legacy
* versions of SDL supported preceding '#' comments as
* descriptions. Set this to true to enable this deprecated behavior.
* This option is provided to ease adoption and may be removed in future versions.
*
* @param flag whether to print description as # comments
*
* @return new instance of options
*/
public Options descriptionsAsHashComments(boolean flag) {
return new Options(this.includeIntrospectionTypes,
this.includeScalars,
this.includeSchemaDefinition,
this.includeDirectiveDefinitions,
this.includeDirectiveDefinition,
this.useAstDefinitions,
flag,
this.includeDirective,
this.includeSchemaElement,
this.comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* The comparator registry controls the printing order for registered {@code GraphQLType}s.
*
* The default is to sort elements by name but you can put in your own code to decide on the field order
*
* @param comparatorRegistry The registry containing the {@code Comparator} and environment scoping rules.
*
* @return options
*/
public Options setComparators(GraphqlTypeComparatorRegistry comparatorRegistry) {
return new Options(this.includeIntrospectionTypes,
this.includeScalars,
this.includeSchemaDefinition,
this.includeDirectiveDefinitions,
this.includeDirectiveDefinition,
this.useAstDefinitions,
this.descriptionsAsHashComments,
this.includeDirective,
this.includeSchemaElement,
comparatorRegistry,
this.includeAstDefinitionComments);
}
/**
* Sometimes it is useful to allow printing schema comments. This can be achieved by providing comments in the AST definitions.
*
* The default is to ignore these for backward compatibility and due to this being relatively uncommon need.
*
* @param flag whether to include AST definition comments.
*
* @return new instance of Options
*/
public Options includeAstDefinitionComments(boolean flag) {
return new Options(this.includeIntrospectionTypes,
this.includeScalars,
this.includeSchemaDefinition,
this.includeDirectiveDefinitions,
this.includeDirectiveDefinition,
this.useAstDefinitions,
this.descriptionsAsHashComments,
this.includeDirective,
this.includeSchemaElement,
comparatorRegistry,
flag);
}
}
private final Map, SchemaElementPrinter> printers = new LinkedHashMap<>();
private final Options options;
public SchemaPrinter() {
this(Options.defaultOptions());
}
public SchemaPrinter(Options options) {
this.options = options;
printers.put(GraphQLSchema.class, schemaPrinter());
printers.put(GraphQLDirective.class, directivePrinter());
printers.put(GraphQLObjectType.class, objectPrinter());
printers.put(GraphQLEnumType.class, enumPrinter());
printers.put(GraphQLScalarType.class, scalarPrinter());
printers.put(GraphQLInterfaceType.class, interfacePrinter());
printers.put(GraphQLUnionType.class, unionPrinter());
printers.put(GraphQLInputObjectType.class, inputObjectPrinter());
}
/**
* This can print an in memory GraphQL IDL document back to a logical schema definition.
* If you want to turn an Introspection query result into a Document (and then into a printed
* schema) then use {@link graphql.introspection.IntrospectionResultToSchema#createSchemaDefinition(java.util.Map)}
* first to get the {@link graphql.language.Document} and then print that.
*
* @param schemaIDL the parsed schema IDL
*
* @return the logical schema definition
*/
public String print(Document schemaIDL) {
TypeDefinitionRegistry registry = new SchemaParser().buildRegistry(schemaIDL);
return print(UnExecutableSchemaGenerator.makeUnExecutableSchema(registry));
}
/**
* This can print an in memory GraphQL schema back to a logical schema definition
*
* @param schema the schema in play
*
* @return the logical schema definition
*/
public String print(GraphQLSchema schema) {
StringWriter sw = new StringWriter();
PrintWriter out = new PrintWriter(sw);
GraphqlFieldVisibility visibility = schema.getCodeRegistry().getFieldVisibility();
printer(schema.getClass()).print(out, schema, visibility);
Comparator comparator = getComparator(GraphQLSchemaElement.class, null);
Stream directivesAndTypes = Stream.concat(
schema.getAllTypesAsList().stream(),
getSchemaDirectives(schema).stream());
List elements = directivesAndTypes
.map(e -> (GraphQLSchemaElement) e)
.filter(options.getIncludeSchemaElement())
.sorted(comparator)
.collect(toList());
for (GraphQLSchemaElement element : elements) {
printSchemaElement(out, element, visibility);
}
return trimNewLineChars(sw.toString());
}
private interface SchemaElementPrinter {
void print(PrintWriter out, T schemaElement, GraphqlFieldVisibility visibility);
}
private boolean isIntrospectionType(GraphQLNamedType type) {
return !options.isIncludeIntrospectionTypes() && type.getName().startsWith("__");
}
private SchemaElementPrinter scalarPrinter() {
return (out, type, visibility) -> {
if (!options.isIncludeScalars()) {
return;
}
boolean printScalar;
if (ScalarInfo.isGraphqlSpecifiedScalar(type)) {
printScalar = false;
//noinspection RedundantIfStatement
if (!ScalarInfo.isGraphqlSpecifiedScalar(type)) {
printScalar = true;
}
} else {
printScalar = true;
}
if (printScalar) {
if (shouldPrintAsAst(type.getDefinition())) {
printAsAst(out, type.getDefinition(), type.getExtensionDefinitions());
} else {
printComments(out, type, "");
out.format("scalar %s%s\n\n", type.getName(), directivesString(GraphQLScalarType.class, type));
}
}
};
}
private SchemaElementPrinter enumPrinter() {
return (out, type, visibility) -> {
if (isIntrospectionType(type)) {
return;
}
Comparator comparator = getComparator(GraphQLEnumType.class, GraphQLEnumValueDefinition.class);
if (shouldPrintAsAst(type.getDefinition())) {
printAsAst(out, type.getDefinition(), type.getExtensionDefinitions());
} else {
printComments(out, type, "");
out.format("enum %s%s", type.getName(), directivesString(GraphQLEnumType.class, type));
List values = type.getValues()
.stream()
.sorted(comparator)
.collect(toList());
if (values.size() > 0) {
out.format(" {\n");
for (GraphQLEnumValueDefinition enumValueDefinition : values) {
printComments(out, enumValueDefinition, " ");
out.format(" %s%s\n", enumValueDefinition.getName(), directivesString(GraphQLEnumValueDefinition.class, enumValueDefinition.isDeprecated(), enumValueDefinition));
}
out.format("}");
}
out.format("\n\n");
}
};
}
private void printFieldDefinitions(PrintWriter out, Comparator comparator, List fieldDefinitions) {
if (fieldDefinitions.size() == 0) {
return;
}
out.format(" {\n");
fieldDefinitions
.stream()
.filter(options.getIncludeSchemaElement())
.sorted(comparator)
.forEach(fd -> {
printComments(out, fd, " ");
out.format(" %s%s: %s%s\n",
fd.getName(), argsString(GraphQLFieldDefinition.class, fd.getArguments()), typeString(fd.getType()),
directivesString(GraphQLFieldDefinition.class, fd.isDeprecated(), fd));
});
out.format("}");
}
private SchemaElementPrinter interfacePrinter() {
return (out, type, visibility) -> {
if (isIntrospectionType(type)) {
return;
}
if (shouldPrintAsAst(type.getDefinition())) {
printAsAst(out, type.getDefinition(), type.getExtensionDefinitions());
} else {
printComments(out, type, "");
if (type.getInterfaces().isEmpty()) {
out.format("interface %s%s", type.getName(), directivesString(GraphQLInterfaceType.class, type));
} else {
Comparator implementsComparator = getComparator(GraphQLInterfaceType.class, GraphQLOutputType.class);
Stream interfaceNames = type.getInterfaces()
.stream()
.sorted(implementsComparator)
.map(GraphQLNamedType::getName);
out.format("interface %s implements %s%s",
type.getName(),
interfaceNames.collect(joining(" & ")),
directivesString(GraphQLInterfaceType.class, type));
}
Comparator comparator = getComparator(GraphQLInterfaceType.class, GraphQLFieldDefinition.class);
printFieldDefinitions(out, comparator, visibility.getFieldDefinitions(type));
out.format("\n\n");
}
};
}
private SchemaElementPrinter unionPrinter() {
return (out, type, visibility) -> {
if (isIntrospectionType(type)) {
return;
}
Comparator comparator = getComparator(GraphQLUnionType.class, GraphQLOutputType.class);
if (shouldPrintAsAst(type.getDefinition())) {
printAsAst(out, type.getDefinition(), type.getExtensionDefinitions());
} else {
printComments(out, type, "");
out.format("union %s%s = ", type.getName(), directivesString(GraphQLUnionType.class, type));
List types = type.getTypes()
.stream()
.sorted(comparator)
.collect(toList());
for (int i = 0; i < types.size(); i++) {
GraphQLNamedOutputType objectType = types.get(i);
if (i > 0) {
out.format(" | ");
}
out.format("%s", objectType.getName());
}
out.format("\n\n");
}
};
}
private SchemaElementPrinter directivePrinter() {
return (out, directive, visibility) -> {
boolean isOnEver = options.isIncludeDirectiveDefinitions();
boolean specificTest = options.getIncludeDirectiveDefinition().test(directive.getName());
if (isOnEver && specificTest) {
String s = directiveDefinition(directive);
out.format("%s", s);
out.print("\n\n");
}
};
}
private SchemaElementPrinter objectPrinter() {
return (out, type, visibility) -> {
if (isIntrospectionType(type)) {
return;
}
if (shouldPrintAsAst(type.getDefinition())) {
printAsAst(out, type.getDefinition(), type.getExtensionDefinitions());
} else {
printComments(out, type, "");
if (type.getInterfaces().isEmpty()) {
out.format("type %s%s", type.getName(), directivesString(GraphQLObjectType.class, type));
} else {
Comparator implementsComparator = getComparator(GraphQLObjectType.class, GraphQLOutputType.class);
Stream interfaceNames = type.getInterfaces()
.stream()
.sorted(implementsComparator)
.map(GraphQLNamedType::getName);
out.format("type %s implements %s%s",
type.getName(),
interfaceNames.collect(joining(" & ")),
directivesString(GraphQLObjectType.class, type));
}
Comparator comparator = getComparator(GraphQLObjectType.class, GraphQLFieldDefinition.class);
printFieldDefinitions(out, comparator, visibility.getFieldDefinitions(type));
out.format("\n\n");
}
};
}
private SchemaElementPrinter inputObjectPrinter() {
return (out, type, visibility) -> {
if (isIntrospectionType(type)) {
return;
}
if (shouldPrintAsAst(type.getDefinition())) {
printAsAst(out, type.getDefinition(), type.getExtensionDefinitions());
} else {
printComments(out, type, "");
Comparator comparator = getComparator(GraphQLInputObjectType.class, GraphQLInputObjectField.class);
out.format("input %s%s", type.getName(), directivesString(GraphQLInputObjectType.class, type));
List inputObjectFields = visibility.getFieldDefinitions(type);
if (inputObjectFields.size() > 0) {
out.format(" {\n");
inputObjectFields
.stream()
.filter(options.getIncludeSchemaElement())
.sorted(comparator)
.forEach(fd -> {
printComments(out, fd, " ");
out.format(" %s: %s",
fd.getName(), typeString(fd.getType()));
if (fd.hasSetDefaultValue()) {
InputValueWithState defaultValue = fd.getInputFieldDefaultValue();
String astValue = printAst(defaultValue, fd.getType());
out.format(" = %s", astValue);
}
out.print(directivesString(GraphQLInputObjectField.class, fd.isDeprecated(), fd));
out.format("\n");
});
out.format("}");
}
out.format("\n\n");
}
};
}
/**
* This will return true if the options say to use the AST and we have an AST element
*
* @param definition the AST type definition
*
* @return true if we should print using AST nodes
*/
private boolean shouldPrintAsAst(TypeDefinition definition) {
return options.isUseAstDefinitions() && definition != null;
}
/**
* This will return true if the options say to use the AST and we have an AST element
*
* @param definition the AST schema definition
*
* @return true if we should print using AST nodes
*/
private boolean shouldPrintAsAst(SchemaDefinition definition) {
return options.isUseAstDefinitions() && definition != null;
}
/**
* This will print out a runtime graphql schema element using its contained AST type definition. This
* must be guarded by a called to {@link #shouldPrintAsAst(TypeDefinition)}
*
* @param out the output writer
* @param definition the AST type definition
* @param extensions a list of type definition extensions
*/
private void printAsAst(PrintWriter out, TypeDefinition definition, List> extensions) {
out.printf("%s\n", AstPrinter.printAst(definition));
if (extensions != null) {
for (TypeDefinition extension : extensions) {
out.printf("\n%s\n", AstPrinter.printAst(extension));
}
}
out.print('\n');
}
/**
* This will print out a runtime graphql schema block using its AST definition. This
* must be guarded by a called to {@link #shouldPrintAsAst(SchemaDefinition)}
*
* @param out the output writer
* @param definition the AST schema definition
* @param extensions a list of schema definition extensions
*/
private void printAsAst(PrintWriter out, SchemaDefinition definition, List extensions) {
out.printf("%s\n", AstPrinter.printAst(definition));
if (extensions != null) {
for (SchemaExtensionDefinition extension : extensions) {
out.printf("\n%s\n", AstPrinter.printAst(extension));
}
}
out.print('\n');
}
private static String printAst(InputValueWithState value, GraphQLInputType type) {
return AstPrinter.printAst(ValuesResolver.valueToLiteral(value, type, GraphQLContext.getDefault(), Locale.getDefault()));
}
private SchemaElementPrinter schemaPrinter() {
return (out, schema, visibility) -> {
GraphQLObjectType queryType = schema.getQueryType();
GraphQLObjectType mutationType = schema.getMutationType();
GraphQLObjectType subscriptionType = schema.getSubscriptionType();
// when serializing a GraphQL schema using the type system language, a
// schema definition should be omitted only if it uses the default root type names.
boolean needsSchemaPrinted = options.isIncludeSchemaDefinition();
if (!needsSchemaPrinted) {
if (queryType != null && !queryType.getName().equals("Query")) {
needsSchemaPrinted = true;
}
if (mutationType != null && !mutationType.getName().equals("Mutation")) {
needsSchemaPrinted = true;
}
if (subscriptionType != null && !subscriptionType.getName().equals("Subscription")) {
needsSchemaPrinted = true;
}
}
if (needsSchemaPrinted) {
if (shouldPrintAsAst(schema.getDefinition())) {
printAsAst(out, schema.getDefinition(), schema.getExtensionDefinitions());
} else {
if (hasAstDefinitionComments(schema) || hasDescription(schema)) {
out.print(printComments(schema, ""));
}
List directives = DirectivesUtil.toAppliedDirectives(schema.getSchemaAppliedDirectives(), schema.getSchemaDirectives());
out.format("schema %s{\n", directivesString(GraphQLSchemaElement.class, directives));
if (queryType != null) {
out.format(" query: %s\n", queryType.getName());
}
if (mutationType != null) {
out.format(" mutation: %s\n", mutationType.getName());
}
if (subscriptionType != null) {
out.format(" subscription: %s\n", subscriptionType.getName());
}
out.format("}\n\n");
}
}
};
}
private List getSchemaDirectives(GraphQLSchema schema) {
Predicate includePredicate = d -> options.getIncludeDirective().test(d.getName());
return schema.getDirectives().stream()
.filter(includePredicate)
.filter(options.getIncludeSchemaElement())
.collect(toList());
}
String typeString(GraphQLType rawType) {
return GraphQLTypeUtil.simplePrint(rawType);
}
String argsString(List arguments) {
return argsString(null, arguments);
}
String argsString(Class parent, List arguments) {
boolean hasAstDefinitionComments = arguments.stream().anyMatch(this::hasAstDefinitionComments);
boolean hasDescriptions = arguments.stream().anyMatch(this::hasDescription);
String halfPrefix = hasAstDefinitionComments || hasDescriptions ? " " : "";
String prefix = hasAstDefinitionComments || hasDescriptions ? " " : "";
int count = 0;
StringBuilder sb = new StringBuilder();
Comparator comparator = getComparator(parent, GraphQLArgument.class);
arguments = arguments
.stream()
.sorted(comparator)
.filter(options.getIncludeSchemaElement())
.collect(toList());
for (GraphQLArgument argument : arguments) {
if (count == 0) {
sb.append("(");
} else {
sb.append(",");
if (!hasAstDefinitionComments && !hasDescriptions) {
sb.append(" ");
}
}
if (hasAstDefinitionComments || hasDescriptions) {
sb.append("\n");
}
sb.append(printComments(argument, prefix));
sb.append(prefix).append(argument.getName()).append(": ").append(typeString(argument.getType()));
if (argument.hasSetDefaultValue()) {
InputValueWithState defaultValue = argument.getArgumentDefaultValue();
sb.append(" = ");
sb.append(printAst(defaultValue, argument.getType()));
}
sb.append(directivesString(GraphQLArgument.class, argument.isDeprecated(), argument));
count++;
}
if (count > 0) {
if (hasAstDefinitionComments || hasDescriptions) {
sb.append("\n");
}
sb.append(halfPrefix).append(")");
}
return sb.toString();
}
public String directivesString(Class parentType, GraphQLDirectiveContainer directiveContainer) {
return directivesString(parentType, false, directiveContainer);
}
String directivesString(Class parentType, boolean isDeprecated, GraphQLDirectiveContainer directiveContainer) {
List directives;
if (isDeprecated) {
directives = addDeprecatedDirectiveIfNeeded(directiveContainer);
} else {
directives = DirectivesUtil.toAppliedDirectives(directiveContainer);
}
return directivesString(parentType, directives);
}
private String directivesString(Class parentType, List directives) {
directives = directives.stream()
// @deprecated is special - we always print it if something is deprecated
.filter(directive -> options.getIncludeDirective().test(directive.getName()))
.filter(options.getIncludeSchemaElement())
.collect(toList());
if (directives.isEmpty()) {
return "";
}
StringBuilder sb = new StringBuilder();
if (parentType != GraphQLSchemaElement.class) {
sb.append(" ");
}
Comparator comparator = getComparator(parentType, GraphQLAppliedDirective.class);
directives = directives
.stream()
.sorted(comparator)
.collect(toList());
for (int i = 0; i < directives.size(); i++) {
GraphQLAppliedDirective directive = directives.get(i);
sb.append(directiveString(directive));
if (i < directives.size() - 1) {
sb.append(" ");
}
}
return sb.toString();
}
private String directiveString(GraphQLAppliedDirective directive) {
if (!options.getIncludeSchemaElement().test(directive)) {
return "";
}
if (!options.getIncludeDirective().test(directive.getName())) {
return "";
}
StringBuilder sb = new StringBuilder();
sb.append("@").append(directive.getName());
Comparator comparator = getComparator(GraphQLAppliedDirective.class, GraphQLAppliedDirectiveArgument.class);
List args = directive.getArguments();
args = args
.stream()
.filter(arg -> arg.getArgumentValue().isSet())
.sorted(comparator)
.collect(toList());
if (!args.isEmpty()) {
sb.append("(");
for (int i = 0; i < args.size(); i++) {
GraphQLAppliedDirectiveArgument arg = args.get(i);
String argValue = null;
if (arg.hasSetValue()) {
argValue = printAst(arg.getArgumentValue(), arg.getType());
}
if (!isNullOrEmpty(argValue)) {
sb.append(arg.getName());
sb.append(" : ");
sb.append(argValue);
if (i < args.size() - 1) {
sb.append(", ");
}
}
}
sb.append(")");
}
return sb.toString();
}
private boolean isDeprecatedDirectiveAllowed() {
// we ask if the special deprecated directive,
// which can be programmatically on a type without an applied directive,
// should be printed or not
return options.getIncludeDirective().test(DeprecatedDirective.getName());
}
private boolean isDeprecatedDirective(GraphQLAppliedDirective directive) {
return directive.getName().equals(DeprecatedDirective.getName());
}
private boolean hasDeprecatedDirective(List directives) {
return directives.stream()
.filter(this::isDeprecatedDirective)
.count() == 1;
}
private List addDeprecatedDirectiveIfNeeded(GraphQLDirectiveContainer directiveContainer) {
List directives = DirectivesUtil.toAppliedDirectives(directiveContainer);
if (!hasDeprecatedDirective(directives) && isDeprecatedDirectiveAllowed()) {
directives = new ArrayList<>(directives);
String reason = getDeprecationReason(directiveContainer);
GraphQLAppliedDirectiveArgument arg = GraphQLAppliedDirectiveArgument.newArgument()
.name("reason")
.valueProgrammatic(reason)
.type(GraphQLString)
.build();
GraphQLAppliedDirective directive = GraphQLAppliedDirective.newDirective()
.name("deprecated")
.argument(arg)
.build();
directives.add(directive);
}
return directives;
}
private String getDeprecationReason(GraphQLDirectiveContainer directiveContainer) {
if (directiveContainer instanceof GraphQLFieldDefinition) {
GraphQLFieldDefinition type = (GraphQLFieldDefinition) directiveContainer;
return type.getDeprecationReason();
} else if (directiveContainer instanceof GraphQLEnumValueDefinition) {
GraphQLEnumValueDefinition type = (GraphQLEnumValueDefinition) directiveContainer;
return type.getDeprecationReason();
} else if (directiveContainer instanceof GraphQLInputObjectField) {
GraphQLInputObjectField type = (GraphQLInputObjectField) directiveContainer;
return type.getDeprecationReason();
} else if (directiveContainer instanceof GraphQLArgument) {
GraphQLArgument type = (GraphQLArgument) directiveContainer;
return type.getDeprecationReason();
} else {
return Assert.assertShouldNeverHappen();
}
}
private String directiveDefinition(GraphQLDirective directive) {
StringBuilder sb = new StringBuilder();
StringWriter sw = new StringWriter();
printComments(new PrintWriter(sw), directive, "");
sb.append(sw);
sb.append("directive @").append(directive.getName());
Comparator comparator = getComparator(GraphQLDirective.class, GraphQLArgument.class);
List args = directive.getArguments();
args = args
.stream()
.filter(options.getIncludeSchemaElement())
.sorted(comparator)
.collect(toList());
sb.append(argsString(GraphQLDirective.class, args));
if (directive.isRepeatable()) {
sb.append(" repeatable");
}
sb.append(" on ");
String locations = directive.validLocations().stream().map(Enum::name).collect(Collectors.joining(" | "));
sb.append(locations);
return sb.toString();
}
@SuppressWarnings("unchecked")
private SchemaElementPrinter printer(Class clazz) {
SchemaElementPrinter schemaElementPrinter = printers.get(clazz);
if (schemaElementPrinter == null) {
Class superClazz = clazz.getSuperclass();
if (superClazz != Object.class) {
schemaElementPrinter = printer(superClazz);
} else {
schemaElementPrinter = (out, type, visibility) -> out.print("Type not implemented : " + type + "\n");
}
printers.put(clazz, schemaElementPrinter);
}
return (SchemaElementPrinter) schemaElementPrinter;
}
public String print(GraphQLType type) {
StringWriter sw = new StringWriter();
PrintWriter out = new PrintWriter(sw);
printSchemaElement(out, type, DEFAULT_FIELD_VISIBILITY);
return trimNewLineChars(sw.toString());
}
public String print(List elements) {
StringWriter sw = new StringWriter();
PrintWriter out = new PrintWriter(sw);
for (GraphQLSchemaElement element : elements) {
if (element instanceof GraphQLDirective) {
out.print(print(((GraphQLDirective) element)));
} else if (element instanceof GraphQLType) {
printSchemaElement(out, element, DEFAULT_FIELD_VISIBILITY);
} else {
Assert.assertShouldNeverHappen("How did we miss a %s", element.getClass());
}
}
return trimNewLineChars(sw.toString());
}
public String print(GraphQLDirective graphQLDirective) {
return directiveDefinition(graphQLDirective);
}
private void printSchemaElement(PrintWriter out, GraphQLSchemaElement schemaElement, GraphqlFieldVisibility visibility) {
SchemaElementPrinter