Skip to content
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
5 changes: 3 additions & 2 deletions src/main/antlr/Graphql.g4
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ operationDefinition:
selectionSet |
operationType name? variableDefinitions? directives? selectionSet;

operationType : MUTATION | QUERY;
operationType : SUBSCRIPTION | MUTATION | QUERY;

variableDefinitions : '(' variableDefinition+ ')';

Expand Down Expand Up @@ -59,7 +59,7 @@ typeCondition : 'on' typeName;

// Value

name: NAME | FRAGMENT | QUERY | MUTATION | SCHEMA | SCALAR | TYPE | INTERFACE | IMPLEMENTS | ENUM | UNION | INPUT | EXTEND | DIRECTIVE;
name: NAME | FRAGMENT | QUERY | MUTATION | SUBSCRIPTION | SCHEMA | SCALAR | TYPE | INTERFACE | IMPLEMENTS | ENUM | UNION | INPUT | EXTEND | DIRECTIVE;

value :
IntValue |
Expand Down Expand Up @@ -179,6 +179,7 @@ BooleanValue: 'true' | 'false';
FRAGMENT: 'fragment';
QUERY: 'query';
MUTATION: 'mutation';
SUBSCRIPTION: 'subscription';
SCHEMA: 'schema';
SCALAR: 'scalar';
TYPE: 'type';
Expand Down
38 changes: 31 additions & 7 deletions src/main/java/graphql/GraphQL.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
package graphql;


import graphql.execution.*;
import graphql.execution.Execution;
import graphql.execution.ExecutionId;
import graphql.execution.ExecutionIdProvider;
import graphql.execution.ExecutionStrategy;
import graphql.execution.SimpleExecutionStrategy;
import graphql.execution.instrumentation.Instrumentation;
import graphql.execution.instrumentation.InstrumentationContext;
import graphql.execution.instrumentation.NoOpInstrumentation;
Expand Down Expand Up @@ -33,6 +36,7 @@ public class GraphQL {
private final GraphQLSchema graphQLSchema;
private final ExecutionStrategy queryStrategy;
private final ExecutionStrategy mutationStrategy;
private final ExecutionStrategy subscriptionStrategy;
private final ExecutionIdProvider idProvider;
private final Instrumentation instrumentation;

Expand All @@ -49,7 +53,6 @@ public GraphQL(GraphQLSchema graphQLSchema) {
this(graphQLSchema, null, null);
}


/**
* A GraphQL object ready to execute queries
*
Expand All @@ -73,13 +76,28 @@ public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy) {
* @deprecated use the {@link #newGraphQL(GraphQLSchema)} builder instead. This will be removed in a future version.
*/
public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy) {
this(graphQLSchema,queryStrategy,mutationStrategy, DEFAULT_EXECUTION_ID_PROVIDER, NoOpInstrumentation.INSTANCE);
this(graphQLSchema, queryStrategy, mutationStrategy, null, DEFAULT_EXECUTION_ID_PROVIDER, NoOpInstrumentation.INSTANCE);
}

private GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, ExecutionIdProvider idProvider, Instrumentation instrumentation) {
/**
* A GraphQL object ready to execute queries
*
* @param graphQLSchema the schema to use
* @param queryStrategy the query execution strategy to use
* @param mutationStrategy the mutation execution strategy to use
* @param subscriptionStrategy the subscription execution strategy to use
*
* @deprecated use the {@link #newGraphQL(GraphQLSchema)} builder instead. This will be removed in a future version.
*/
public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, ExecutionStrategy subscriptionStrategy) {
this(graphQLSchema, queryStrategy, mutationStrategy, subscriptionStrategy, DEFAULT_EXECUTION_ID_PROVIDER, NoOpInstrumentation.INSTANCE);
}

private GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, ExecutionStrategy subscriptionStrategy, ExecutionIdProvider idProvider, Instrumentation instrumentation) {
this.graphQLSchema = assertNotNull(graphQLSchema,"queryStrategy must be non null");
this.queryStrategy = queryStrategy != null ? queryStrategy : new SimpleExecutionStrategy();
this.mutationStrategy = mutationStrategy != null ? mutationStrategy : new SimpleExecutionStrategy();
this.subscriptionStrategy = subscriptionStrategy != null ? subscriptionStrategy : new SimpleExecutionStrategy();
this.idProvider = assertNotNull(idProvider, "idProvider must be non null");
this.instrumentation = instrumentation;
}
Expand All @@ -100,6 +118,7 @@ public static class Builder {
private GraphQLSchema graphQLSchema;
private ExecutionStrategy queryExecutionStrategy = new SimpleExecutionStrategy();
private ExecutionStrategy mutationExecutionStrategy = new SimpleExecutionStrategy();
private ExecutionStrategy subscriptionExecutionStrategy = new SimpleExecutionStrategy();
private ExecutionIdProvider idProvider = DEFAULT_EXECUTION_ID_PROVIDER;
private Instrumentation instrumentation = NoOpInstrumentation.INSTANCE;

Expand All @@ -123,6 +142,11 @@ public Builder mutationExecutionStrategy(ExecutionStrategy executionStrategy) {
return this;
}

public Builder subscriptionExecutionStrategy(ExecutionStrategy executionStrategy) {
this.subscriptionExecutionStrategy = assertNotNull(executionStrategy, "Subscription ExecutionStrategy must be non null");
return this;
}

public Builder instrumentation(Instrumentation instrumentation) {
this.instrumentation = assertNotNull(instrumentation, "Instrumentation must be non null");
return this;
Expand All @@ -137,7 +161,7 @@ public GraphQL build() {
assertNotNull(graphQLSchema,"queryStrategy must be non null");
assertNotNull(queryExecutionStrategy, "queryStrategy must be non null");
assertNotNull(idProvider, "idProvider must be non null");
return new GraphQL(graphQLSchema, queryExecutionStrategy, mutationExecutionStrategy, idProvider, instrumentation);
return new GraphQL(graphQLSchema, queryExecutionStrategy, mutationExecutionStrategy, subscriptionExecutionStrategy, idProvider, instrumentation);
}
}

Expand Down Expand Up @@ -188,7 +212,7 @@ public ExecutionResult execute(String requestString, String operationName, Objec
}
ExecutionId executionId = idProvider.provide(requestString, operationName, context);

Execution execution = new Execution(queryStrategy, mutationStrategy, instrumentation);
Execution execution = new Execution(queryStrategy, mutationStrategy, subscriptionStrategy, instrumentation);
ExecutionResult result = execution.execute(executionId, graphQLSchema, context, document, operationName, arguments);

executionCtx.onEnd(result);
Expand Down
12 changes: 10 additions & 2 deletions src/main/java/graphql/execution/Execution.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,28 @@

import static graphql.language.OperationDefinition.Operation.MUTATION;
import static graphql.language.OperationDefinition.Operation.QUERY;
import static graphql.language.OperationDefinition.Operation.SUBSCRIPTION;

public class Execution {

private final FieldCollector fieldCollector = new FieldCollector();
private final ExecutionStrategy queryStrategy;
private final ExecutionStrategy mutationStrategy;
private final ExecutionStrategy subscriptionStrategy;
private final Instrumentation instrumentation;

public Execution(ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, Instrumentation instrumentation) {
public Execution(ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, ExecutionStrategy subscriptionStrategy, Instrumentation instrumentation) {
this.queryStrategy = queryStrategy != null ? queryStrategy : new SimpleExecutionStrategy();
this.mutationStrategy = mutationStrategy != null ? mutationStrategy : new SimpleExecutionStrategy();
this.subscriptionStrategy = subscriptionStrategy != null ? subscriptionStrategy : new SimpleExecutionStrategy();
this.instrumentation = instrumentation;
}

public ExecutionResult execute(ExecutionId executionId, GraphQLSchema graphQLSchema, Object root, Document document, String operationName, Map<String, Object> args) {
ExecutionContextBuilder executionContextBuilder = new ExecutionContextBuilder(new ValuesResolver(), instrumentation);
ExecutionContext executionContext = executionContextBuilder
.executionId(executionId)
.build(graphQLSchema, queryStrategy, mutationStrategy, root, document, operationName, args);
.build(graphQLSchema, queryStrategy, mutationStrategy, subscriptionStrategy, root, document, operationName, args);
return executeOperation(executionContext, root, executionContext.getOperationDefinition());
}

Expand All @@ -54,6 +57,9 @@ private GraphQLObjectType getOperationRootType(GraphQLSchema graphQLSchema, Oper
} else if (operation == QUERY) {
return graphQLSchema.getQueryType();

} else if (operation == SUBSCRIPTION) {
return graphQLSchema.getSubscriptionType();

} else {
throw new GraphQLException("Unhandled case. An extra operation enum has been added without code support");
}
Expand Down Expand Up @@ -92,6 +98,8 @@ private ExecutionResult executeOperation(
try {
if (operation == OperationDefinition.Operation.MUTATION) {
result = mutationStrategy.execute(executionContext, parameters);
} else if (operation == SUBSCRIPTION) {
result = subscriptionStrategy.execute(executionContext, parameters);
} else {
result = queryStrategy.execute(executionContext, parameters);
}
Expand Down
8 changes: 7 additions & 1 deletion src/main/java/graphql/execution/ExecutionContext.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,20 @@ public class ExecutionContext {
private final ExecutionId executionId;
private final ExecutionStrategy queryStrategy;
private final ExecutionStrategy mutationStrategy;
private final ExecutionStrategy subscriptionStrategy;
private final Map<String, FragmentDefinition> fragmentsByName;
private final OperationDefinition operationDefinition;
private final Map<String, Object> variables;
private final Object root;
private final List<GraphQLError> errors = new CopyOnWriteArrayList<>();
private final Instrumentation instrumentation;

public ExecutionContext(Instrumentation instrumentation, ExecutionId executionId, GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, Map<String, FragmentDefinition> fragmentsByName, OperationDefinition operationDefinition, Map<String, Object> variables, Object root) {
public ExecutionContext(Instrumentation instrumentation, ExecutionId executionId, GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, ExecutionStrategy subscriptionStrategy, Map<String, FragmentDefinition> fragmentsByName, OperationDefinition operationDefinition, Map<String, Object> variables, Object root) {
this.graphQLSchema = graphQLSchema;
this.executionId = executionId;
this.queryStrategy = queryStrategy;
this.mutationStrategy = mutationStrategy;
this.subscriptionStrategy = subscriptionStrategy;
this.fragmentsByName = fragmentsByName;
this.operationDefinition = operationDefinition;
this.variables = variables;
Expand Down Expand Up @@ -86,4 +88,8 @@ public ExecutionStrategy getQueryStrategy() {
public ExecutionStrategy getMutationStrategy() {
return mutationStrategy;
}

public ExecutionStrategy getSubscriptionStrategy() {
return subscriptionStrategy;
}
}
3 changes: 2 additions & 1 deletion src/main/java/graphql/execution/ExecutionContextBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public ExecutionContextBuilder executionId(ExecutionId executionId) {
return this;
}

public ExecutionContext build(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, Object root, Document document, String operationName, Map<String, Object> args) {
public ExecutionContext build(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, ExecutionStrategy subscriptionStrategy, Object root, Document document, String operationName, Map<String, Object> args) {
// preconditions
assertNotNull(executionId, "You must provide a query identifier");

Expand Down Expand Up @@ -68,6 +68,7 @@ public ExecutionContext build(GraphQLSchema graphQLSchema, ExecutionStrategy que
graphQLSchema,
queryStrategy,
mutationStrategy,
subscriptionStrategy,
fragmentsByName,
operation,
variableValues,
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/graphql/introspection/Introspection.java
Original file line number Diff line number Diff line change
Expand Up @@ -392,8 +392,8 @@ public enum DirectiveLocation {
.description("'If this server support subscription, the type that subscription operations will be rooted at.")
.type(__Type)
.dataFetcher(environment -> {
// Not yet supported
return null;
GraphQLSchema schema = environment.getSource();
return schema.getSubscriptionType();
}))
.build();

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/graphql/language/OperationDefinition.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
public class OperationDefinition extends AbstractNode implements Definition {

public enum Operation {
QUERY, MUTATION
QUERY, MUTATION, SUBSCRIPTION
}

private String name;
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/graphql/parser/GraphqlAntlrToLanguage.java
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,8 @@ private OperationDefinition.Operation parseOperation(GraphqlParser.OperationType
return OperationDefinition.Operation.QUERY;
} else if (operationTypeContext.getText().equals("mutation")) {
return OperationDefinition.Operation.MUTATION;
} else if (operationTypeContext.getText().equals("subscription")) {
return OperationDefinition.Operation.SUBSCRIPTION;
} else {
throw new RuntimeException("InternalError: unknown operationTypeContext=" + operationTypeContext.getText());
}
Expand Down
44 changes: 34 additions & 10 deletions src/main/java/graphql/schema/GraphQLSchema.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,44 @@
import graphql.schema.validation.ValidationError;
import graphql.schema.validation.Validator;

import java.util.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static graphql.Assert.assertNotNull;

public class GraphQLSchema {

private final GraphQLObjectType queryType;
private final GraphQLObjectType mutationType;
private final GraphQLObjectType subscriptionType;
private final Map<String, GraphQLType> typeMap;
private Set<GraphQLType> additionalTypes;

public GraphQLSchema(GraphQLObjectType queryType) {
this(queryType, null, Collections.emptySet());
}

public Set<GraphQLType> getAdditionalTypes() {
return additionalTypes;
public GraphQLSchema(GraphQLObjectType queryType, GraphQLObjectType mutationType, Set<GraphQLType> additionalTypes) {
this(queryType, mutationType, null, additionalTypes);
}

public GraphQLSchema(GraphQLObjectType queryType, GraphQLObjectType mutationType, Set<GraphQLType> additionalTypes) {
assertNotNull(additionalTypes, "additionalTypes can't be null");
public GraphQLSchema(GraphQLObjectType queryType, GraphQLObjectType mutationType, GraphQLObjectType subscriptionType, Set<GraphQLType> dictionary) {
assertNotNull(dictionary, "dictionary can't be null");
assertNotNull(queryType, "queryType can't be null");
this.queryType = queryType;
this.mutationType = mutationType;
this.additionalTypes = additionalTypes;
typeMap = new SchemaUtil().allTypes(this, additionalTypes);
this.subscriptionType = subscriptionType;
this.additionalTypes = dictionary;
typeMap = new SchemaUtil().allTypes(this, dictionary);
}

public Set<GraphQLType> getAdditionalTypes() {
return additionalTypes;
}

public GraphQLType getType(String typeName) {
Expand All @@ -46,11 +58,14 @@ public GraphQLObjectType getQueryType() {
return queryType;
}


public GraphQLObjectType getMutationType() {
return mutationType;
}

public GraphQLObjectType getSubscriptionType() {
return subscriptionType;
}

public List<GraphQLDirective> getDirectives() {
return Arrays.asList(Directives.IncludeDirective, Directives.SkipDirective);
}
Expand All @@ -62,7 +77,6 @@ public GraphQLDirective getDirective(String name) {
return null;
}


public boolean isSupportingMutations() {
return mutationType != null;
}
Expand All @@ -74,6 +88,7 @@ public static Builder newSchema() {
public static class Builder {
private GraphQLObjectType queryType;
private GraphQLObjectType mutationType;
private GraphQLObjectType subscriptionType;

public Builder query(GraphQLObjectType.Builder builder) {
return query(builder.build());
Expand All @@ -93,13 +108,22 @@ public Builder mutation(GraphQLObjectType mutationType) {
return this;
}

public Builder subscription(GraphQLObjectType.Builder builder) {
return subscription(builder.build());
}

public Builder subscription(GraphQLObjectType subscriptionType) {
this.subscriptionType = subscriptionType;
return this;
}

public GraphQLSchema build() {
return build(Collections.emptySet());
}

public GraphQLSchema build(Set<GraphQLType> additionalTypes) {
assertNotNull(additionalTypes, "additionalTypes can't be null");
GraphQLSchema graphQLSchema = new GraphQLSchema(queryType, mutationType, additionalTypes);
GraphQLSchema graphQLSchema = new GraphQLSchema(queryType, mutationType, subscriptionType, additionalTypes);
new SchemaUtil().replaceTypeReferences(graphQLSchema);
Collection<ValidationError> errors = new Validator().validateSchema(graphQLSchema);
if (errors.size() > 0) {
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/graphql/validation/TraversalContext.java
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ private void enterImpl(OperationDefinition operationDefinition) {
addType(schema.getMutationType());
} else if (operationDefinition.getOperation() == OperationDefinition.Operation.QUERY) {
addType(schema.getQueryType());
} else if (operationDefinition.getOperation() == OperationDefinition.Operation.SUBSCRIPTION) {
addType(schema.getSubscriptionType());
} else {
throw new ShouldNotHappenException();
}
Expand Down
Loading