Skip to content

This makes sure every introspection type actually has a concrete data fetcher #3004

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.

Sign up for GitHub

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
bbakerman merged 4 commits into from
Nov 29, 2022
Merged

This makes sure every introspection type actually has a concrete data fetcher #3004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
50ea978
This makes sure every introspection type actually has a concrete data…
bbakerman Oct 31, 2022
281fa4f
Tweak - use IntrospectionDataFetcher again
bbakerman Oct 31, 2022
d20c258
Tweak - use IntrospectionDataFetcher again - imports
bbakerman Oct 31, 2022
8ec986f
Tweak - use IntrospectionDataFetcher again - code tweak
bbakerman Oct 31, 2022
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
134 changes: 77 additions & 57 deletions src/main/java/graphql/introspection/Introspection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;

import static graphql.Assert.assertTrue;
Expand All @@ -65,6 +66,27 @@ private static void register(GraphQLFieldsContainer parentType, String fieldName
introspectionDataFetchers.put(coordinates(parentType.getName(), fieldName), introspectionDataFetcher);
}

/**
* To help runtimes such as graalvm, we make sure we have an explicit data fetchers rather then use {@link graphql.schema.PropertyDataFetcher}
* and its reflective mechanisms. This is not reflective because we have the class
*
* @param parentType the containing parent type
* @param fieldName the field name
* @param targetClass the target class of the getter
* @param getter the function to call to get a value of T
* @param <T> for two
*/
private static <T> void register(GraphQLFieldsContainer parentType, String fieldName, Class<T> targetClass, Function<T, Object> getter) {
IntrospectionDataFetcher<?> dataFetcher = env -> {
Object source = env.getSource();
if (targetClass.isInstance(source)) {
return getter.apply(targetClass.cast(source));
}
return null;
};
introspectionDataFetchers.put(coordinates(parentType.getName(), fieldName), dataFetcher);
}

@Internal
public static void addCodeForIntrospectionTypes(GraphQLCodeRegistry.Builder codeRegistry) {
// place the system __ fields into the mix. They have no parent types
Expand Down Expand Up @@ -160,7 +182,7 @@ public enum TypeKind {
.build();

static {
register(__InputValue, "defaultValue", environment -> {
IntrospectionDataFetcher<?> defaultValueDataFetcher = environment -> {
Object type = environment.getSource();
if (type instanceof GraphQLArgument) {
GraphQLArgument inputField = (GraphQLArgument) type;
Expand All @@ -174,18 +196,41 @@ public enum TypeKind {
: null;
}
return null;
});
register(__InputValue, "isDeprecated", environment -> {
};
IntrospectionDataFetcher<?> isDeprecatedDataFetcher = environment -> {
Object type = environment.getSource();
if (type instanceof GraphQLArgument) {
return ((GraphQLArgument) type).isDeprecated();
} else if (type instanceof GraphQLInputObjectField) {
return ((GraphQLInputObjectField) type).isDeprecated();
}
return null;
});
};
IntrospectionDataFetcher<?> typeDataFetcher = environment -> {
Object type = environment.getSource();
if (type instanceof GraphQLArgument) {
return ((GraphQLArgument) type).getType();
} else if (type instanceof GraphQLInputObjectField) {
return ((GraphQLInputObjectField) type).getType();
}
return null;
};
IntrospectionDataFetcher<?> deprecationReasonDataFetcher = environment -> {
Object type = environment.getSource();
if (type instanceof GraphQLArgument) {
return ((GraphQLArgument) type).getDeprecationReason();
} else if (type instanceof GraphQLInputObjectField) {
return ((GraphQLInputObjectField) type).getDeprecationReason();
}
return null;
};

register(__InputValue, "name", nameDataFetcher);
register(__InputValue, "description", descriptionDataFetcher);
register(__InputValue, "type", typeDataFetcher);
register(__InputValue, "defaultValue", defaultValueDataFetcher);
register(__InputValue, "isDeprecated", isDeprecatedDataFetcher);
register(__InputValue, "deprecationReason", deprecationReasonDataFetcher);
}
Copy link
Member Author

@bbakerman bbakerman Oct 31, 2022

Choose a reason for hiding this comment

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

I reorganised the registration to that the register call is done in simple lines and the fetchers are defined above.

I also ordered them in the order of field definition from above.

So you can see that we defined name field first, so its DF registration is first and so on.


private static String printDefaultValue(InputValueWithState inputValueWithState, GraphQLInputType type, GraphQLContext graphQLContext, Locale locale) {
Expand Down Expand Up @@ -220,20 +265,20 @@ private static String printDefaultValue(InputValueWithState inputValueWithState,
.build();

static {
register(__Field, "args", environment -> {
IntrospectionDataFetcher<?> argsDataFetcher = environment -> {
Object type = environment.getSource();
GraphQLFieldDefinition fieldDef = (GraphQLFieldDefinition) type;
Boolean includeDeprecated = environment.getArgument("includeDeprecated");
return fieldDef.getArguments().stream()
.filter(arg -> includeDeprecated || !arg.isDeprecated())
.collect(Collectors.toList());
});
register(__Field, "isDeprecated", environment -> {
Object type = environment.getSource();
return ((GraphQLFieldDefinition) type).isDeprecated();
});
};
register(__Field, "name", nameDataFetcher);
register(__Field, "description", descriptionDataFetcher);
register(__Field, "args", argsDataFetcher);
register(__Field, "type", GraphQLFieldDefinition.class, GraphQLFieldDefinition::getType);
register(__Field, "isDeprecated", GraphQLFieldDefinition.class, GraphQLFieldDefinition::isDeprecated);
register(__Field, "deprecationReason", GraphQLFieldDefinition.class, GraphQLFieldDefinition::getDeprecationReason);
}


Expand All @@ -254,12 +299,10 @@ private static String printDefaultValue(InputValueWithState inputValueWithState,
.build();

static {
register(__EnumValue, "isDeprecated", environment -> {
GraphQLEnumValueDefinition enumValue = environment.getSource();
return enumValue.isDeprecated();
});
register(__EnumValue, "name", nameDataFetcher);
register(__EnumValue, "description", descriptionDataFetcher);
register(__EnumValue, "isDeprecated", GraphQLEnumValueDefinition.class, GraphQLEnumValueDefinition::isDeprecated);
register(__EnumValue, "deprecationReason", GraphQLEnumValueDefinition.class, GraphQLEnumValueDefinition::getDeprecationReason);
}


Expand Down Expand Up @@ -401,22 +444,22 @@ private static String printDefaultValue(InputValueWithState inputValueWithState,
.name("specifiedByURL")
.type(GraphQLString))
.field(newFieldDefinition()
.name("specifiedByUrl")
.type(GraphQLString)
.deprecate("see `specifiedByURL`")
.name("specifiedByUrl")
.type(GraphQLString)
.deprecate("This legacy name has been replaced by `specifiedByURL`")
Copy link
Member Author

@bbakerman bbakerman Oct 31, 2022

Choose a reason for hiding this comment

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

Tweaked the comment while I was here - boy scout!

)
.build();

static {
register(__Type, "kind", kindDataFetcher);
register(__Type, "name", nameDataFetcher);
register(__Type, "description", descriptionDataFetcher);
register(__Type, "fields", fieldsFetcher);
register(__Type, "interfaces", interfacesFetcher);
register(__Type, "possibleTypes", possibleTypesFetcher);
register(__Type, "enumValues", enumValuesTypesFetcher);
register(__Type, "inputFields", inputFieldsFetcher);
register(__Type, "ofType", OfTypeFetcher);
register(__Type, "name", nameDataFetcher);
register(__Type, "description", descriptionDataFetcher);
register(__Type, "specifiedByURL", specifiedByUrlDataFetcher);
register(__Type, "specifiedByUrl", specifiedByUrlDataFetcher); // note that this field is deprecated
}
Expand Down Expand Up @@ -497,38 +540,25 @@ public enum DirectiveLocation {
.name("includeDeprecated")
.type(GraphQLBoolean)
.defaultValueProgrammatic(false)))
.field(newFieldDefinition()
.name("onOperation")
.type(GraphQLBoolean)
.deprecate("Use `locations`."))
.field(newFieldDefinition()
.name("onFragment")
.type(GraphQLBoolean)
.deprecate("Use `locations`."))
.field(newFieldDefinition()
.name("onField")
.type(GraphQLBoolean)
.deprecate("Use `locations`."))
Copy link
Member Author

@bbakerman bbakerman Oct 31, 2022

Choose a reason for hiding this comment

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

onOperation / onFragment and onField was removed from the spec in 2016 - this has just sat around. I think it was broken. We have NO data fetcher defined AND there is not getOnFragment method that would give a value so it would always be null

I took the opportunity to remove this very old code

.build();

static {
register(__Directive, "locations", environment -> {
IntrospectionDataFetcher<?> locationsDataFetcher = environment -> {
GraphQLDirective directive = environment.getSource();
return new ArrayList<>(directive.validLocations());
});
register(__Directive, "args", environment -> {
};
IntrospectionDataFetcher<?> argsDataFetcher = environment -> {
GraphQLDirective directive = environment.getSource();
Boolean includeDeprecated = environment.getArgument("includeDeprecated");
return directive.getArguments().stream()
.filter(arg -> includeDeprecated || !arg.isDeprecated())
.collect(Collectors.toList());
});
};
register(__Directive, "name", nameDataFetcher);
register(__Directive, "description", descriptionDataFetcher);
register(__Directive, "isRepeatable", environment -> {
GraphQLDirective directive = environment.getSource();
return directive.isRepeatable();
});
register(__Directive, "isRepeatable", GraphQLDirective.class, GraphQLDirective::isRepeatable);
register(__Directive, "locations", locationsDataFetcher);
register(__Directive, "args", argsDataFetcher);
}

public static final GraphQLObjectType __Schema = newObject()
Expand Down Expand Up @@ -562,24 +592,14 @@ public enum DirectiveLocation {
.build();

static {
register(__Schema, "description", environment -> environment.getGraphQLSchema().getDescription());
register(__Schema, "types", environment -> {
GraphQLSchema schema = environment.getSource();
return schema.getAllTypesAsList();
});
register(__Schema, "queryType", environment -> {
GraphQLSchema schema = environment.getSource();
return schema.getQueryType();
});
register(__Schema, "mutationType", environment -> {
GraphQLSchema schema = environment.getSource();
return schema.getMutationType();
});
register(__Schema, "directives", environment -> environment.getGraphQLSchema().getDirectives());
register(__Schema, "subscriptionType", environment -> {
GraphQLSchema schema = environment.getSource();
return schema.getSubscriptionType();
});
IntrospectionDataFetcher<?> descriptionsDataFetcher = environment -> environment.getGraphQLSchema().getDescription();

register(__Schema, "description", descriptionsDataFetcher);
register(__Schema, "types", GraphQLSchema.class, GraphQLSchema::getAllTypesAsList);
register(__Schema, "queryType", GraphQLSchema.class, GraphQLSchema::getQueryType);
register(__Schema, "mutationType", GraphQLSchema.class, GraphQLSchema::getMutationType);
register(__Schema, "directives", GraphQLSchema.class, GraphQLSchema::getDirectives);
register(__Schema, "subscriptionType", GraphQLSchema.class, GraphQLSchema::getSubscriptionType);
}

public static final GraphQLFieldDefinition SchemaMetaFieldDef = buildSchemaField(__Schema);
Expand Down
11 changes: 11 additions & 0 deletions src/main/java/graphql/introspection/IntrospectionWithDirectivesSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import graphql.schema.GraphQLCodeRegistry;
import graphql.schema.GraphQLDirective;
import graphql.schema.GraphQLDirectiveContainer;
import graphql.schema.GraphQLNamedSchemaElement;
import graphql.schema.GraphQLObjectType;
import graphql.schema.GraphQLSchema;
import graphql.schema.GraphQLSchemaElement;
Expand Down Expand Up @@ -207,8 +208,18 @@ private GraphQLObjectType addAppliedDirectives(GraphQLObjectType originalType, G
Node<?> literal = ValuesResolver.valueToLiteral(value, argument.getType(), env.getGraphQlContext(), env.getLocale());
return AstPrinter.printAst(literal);
};
DataFetcher<?> nameDF = env -> {
if (env.getSource() instanceof GraphQLNamedSchemaElement) {
return ((GraphQLNamedSchemaElement) env.getSource()).getName();
}
return null;
};

codeRegistry.dataFetcher(coordinates(objectType, "appliedDirectives"), df);
codeRegistry.dataFetcher(coordinates(appliedDirectiveType, "name"), nameDF);
codeRegistry.dataFetcher(coordinates(appliedDirectiveType, "args"), argsDF);

codeRegistry.dataFetcher(coordinates(directiveArgumentType, "name"), nameDF);
codeRegistry.dataFetcher(coordinates(directiveArgumentType, "value"), argValueDF);
return objectType;
}
Expand Down