Skip to content
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

Jump to bottom

Max query depth called later in beginExecuteOperation #2773

Merged
merged 4 commits into from Apr 29, 2022
Merged

Max query depth called later in beginExecuteOperation #2773

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
9f6b430
Investigation of NonNullableValueCoercedAsNullException is being thro…
bbakerman Mar 16, 2022
fd7e70f
Merge remote-tracking branch 'origin/master' into max-depth-and-coercing
bbakerman Mar 26, 2022
1ed54d9
MaxQueryDepthInstrumentation and MaxQueryComplexityInstrumentation no…
bbakerman Mar 26, 2022
46d4e53
use atomic ref
bbakerman Apr 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
94 changes: 57 additions & 37 deletions src/main/java/graphql/analysis/MaxQueryComplexityInstrumentation.java
View file
Open in desktop
@@ -1,9 +1,14 @@
package graphql.analysis;

import graphql.ExecutionResult;
import graphql.PublicApi;
import graphql.execution.AbortExecutionException;
import graphql.execution.ExecutionContext;
import graphql.execution.instrumentation.InstrumentationContext;
import graphql.execution.instrumentation.InstrumentationState;
import graphql.execution.instrumentation.SimpleInstrumentation;
import graphql.execution.instrumentation.parameters.InstrumentationCreateStateParameters;
import graphql.execution.instrumentation.parameters.InstrumentationExecuteOperationParameters;
import graphql.execution.instrumentation.parameters.InstrumentationValidationParameters;
import graphql.validation.ValidationError;
import org.slf4j.Logger;
Expand All @@ -12,10 +17,11 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Function;

import static graphql.Assert.assertNotNull;
import static graphql.execution.instrumentation.SimpleInstrumentationContext.whenCompleted;
import static graphql.execution.instrumentation.SimpleInstrumentationContext.noOp;
import static java.util.Optional.ofNullable;

/**
Expand Down Expand Up @@ -76,41 +82,52 @@ public MaxQueryComplexityInstrumentation(int maxComplexity, FieldComplexityCalcu
this.maxQueryComplexityExceededFunction = maxQueryComplexityExceededFunction;
}

@Override
public InstrumentationState createState(InstrumentationCreateStateParameters parameters) {
return new State();
}
Copy link
Member Author

Choose a reason for hiding this comment

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

Only needed so we can capture InstrumentationValidationParameters parameters to maintain API


@Override
public InstrumentationContext<List<ValidationError>> beginValidation(InstrumentationValidationParameters parameters) {
return whenCompleted((errors, throwable) -> {
if ((errors != null && errors.size() > 0) || throwable != null) {
return;
}
QueryTraverser queryTraverser = newQueryTraverser(parameters);

Map<QueryVisitorFieldEnvironment, Integer> valuesByParent = new LinkedHashMap<>();
queryTraverser.visitPostOrder(new QueryVisitorStub() {
@Override
public void visitField(QueryVisitorFieldEnvironment env) {
int childsComplexity = valuesByParent.getOrDefault(env, 0);
int value = calculateComplexity(env, childsComplexity);

valuesByParent.compute(env.getParentEnvironment(), (key, oldValue) ->
ofNullable(oldValue).orElse(0) + value
);
}
});
int totalComplexity = valuesByParent.getOrDefault(null, 0);
if (log.isDebugEnabled()) {
log.debug("Query complexity: {}", totalComplexity);
}
if (totalComplexity > maxComplexity) {
QueryComplexityInfo queryComplexityInfo = QueryComplexityInfo.newQueryComplexityInfo()
.complexity(totalComplexity)
.instrumentationValidationParameters(parameters)
.build();
boolean throwAbortException = maxQueryComplexityExceededFunction.apply(queryComplexityInfo);
if (throwAbortException) {
throw mkAbortException(totalComplexity, maxComplexity);
}
State state = parameters.getInstrumentationState();
// for API backwards compatibility reasons we capture the validation parameters, so we can put them into QueryComplexityInfo
state.instrumentationValidationParameters.set(parameters);
return noOp();
}

@Override
public InstrumentationContext<ExecutionResult> beginExecuteOperation(InstrumentationExecuteOperationParameters instrumentationExecuteOperationParameters) {
State state = instrumentationExecuteOperationParameters.getInstrumentationState();
QueryTraverser queryTraverser = newQueryTraverser(instrumentationExecuteOperationParameters.getExecutionContext());

Map<QueryVisitorFieldEnvironment, Integer> valuesByParent = new LinkedHashMap<>();
queryTraverser.visitPostOrder(new QueryVisitorStub() {
@Override
public void visitField(QueryVisitorFieldEnvironment env) {
int childsComplexity = valuesByParent.getOrDefault(env, 0);
int value = calculateComplexity(env, childsComplexity);

valuesByParent.compute(env.getParentEnvironment(), (key, oldValue) ->
ofNullable(oldValue).orElse(0) + value
);
}
});
int totalComplexity = valuesByParent.getOrDefault(null, 0);
if (log.isDebugEnabled()) {
log.debug("Query complexity: {}", totalComplexity);
}
if (totalComplexity > maxComplexity) {
QueryComplexityInfo queryComplexityInfo = QueryComplexityInfo.newQueryComplexityInfo()
.complexity(totalComplexity)
.instrumentationValidationParameters(state.instrumentationValidationParameters.get())
.instrumentationExecuteOperationParameters(instrumentationExecuteOperationParameters)
.build();
boolean throwAbortException = maxQueryComplexityExceededFunction.apply(queryComplexityInfo);
if (throwAbortException) {
throw mkAbortException(totalComplexity, maxComplexity);
}
}
return noOp();
}

/**
Expand All @@ -125,12 +142,12 @@ protected AbortExecutionException mkAbortException(int totalComplexity, int maxC
return new AbortExecutionException("maximum query complexity exceeded " + totalComplexity + " > " + maxComplexity);
}

QueryTraverser newQueryTraverser(InstrumentationValidationParameters parameters) {
QueryTraverser newQueryTraverser(ExecutionContext executionContext) {
return QueryTraverser.newQueryTraverser()
.schema(parameters.getSchema())
.document(parameters.getDocument())
.operationName(parameters.getOperation())
.variables(parameters.getVariables())
.schema(executionContext.getGraphQLSchema())
.document(executionContext.getDocument())
.operationName(executionContext.getExecutionInput().getOperationName())
.variables(executionContext.getVariables())
.build();
}

Expand All @@ -156,5 +173,8 @@ private FieldComplexityEnvironment convertEnv(QueryVisitorFieldEnvironment query
);
}

private static class State implements InstrumentationState {
AtomicReference<InstrumentationValidationParameters> instrumentationValidationParameters = new AtomicReference<>();
}

}
52 changes: 24 additions & 28 deletions src/main/java/graphql/analysis/MaxQueryDepthInstrumentation.java
View file
Open in desktop
@@ -1,18 +1,18 @@
package graphql.analysis;

import graphql.ExecutionResult;
import graphql.PublicApi;
import graphql.execution.AbortExecutionException;
import graphql.execution.ExecutionContext;
import graphql.execution.instrumentation.InstrumentationContext;
import graphql.execution.instrumentation.SimpleInstrumentation;
import graphql.execution.instrumentation.parameters.InstrumentationValidationParameters;
import graphql.validation.ValidationError;
import graphql.execution.instrumentation.parameters.InstrumentationExecuteOperationParameters;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.List;
import java.util.function.Function;

import static graphql.execution.instrumentation.SimpleInstrumentationContext.whenCompleted;
import static graphql.execution.instrumentation.SimpleInstrumentationContext.noOp;

/**
* Prevents execution if the query depth is greater than the specified maxDepth.
Expand Down Expand Up @@ -49,26 +49,22 @@ public MaxQueryDepthInstrumentation(int maxDepth, Function<QueryDepthInfo, Boole
}

@Override
public InstrumentationContext<List<ValidationError>> beginValidation(InstrumentationValidationParameters parameters) {
return whenCompleted((errors, throwable) -> {
if ((errors != null && errors.size() > 0) || throwable != null) {
return;
}
QueryTraverser queryTraverser = newQueryTraverser(parameters);
int depth = queryTraverser.reducePreOrder((env, acc) -> Math.max(getPathLength(env.getParentEnvironment()), acc), 0);
if (log.isDebugEnabled()) {
log.debug("Query depth info: {}", depth);
}
if (depth > maxDepth) {
QueryDepthInfo queryDepthInfo = QueryDepthInfo.newQueryDepthInfo()
.depth(depth)
.build();
boolean throwAbortException = maxQueryDepthExceededFunction.apply(queryDepthInfo);
if (throwAbortException) {
throw mkAbortException(depth, maxDepth);
}
public InstrumentationContext<ExecutionResult> beginExecuteOperation(InstrumentationExecuteOperationParameters parameters) {
QueryTraverser queryTraverser = newQueryTraverser(parameters.getExecutionContext());
int depth = queryTraverser.reducePreOrder((env, acc) -> Math.max(getPathLength(env.getParentEnvironment()), acc), 0);
if (log.isDebugEnabled()) {
log.debug("Query depth info: {}", depth);
}
if (depth > maxDepth) {
QueryDepthInfo queryDepthInfo = QueryDepthInfo.newQueryDepthInfo()
.depth(depth)
.build();
boolean throwAbortException = maxQueryDepthExceededFunction.apply(queryDepthInfo);
if (throwAbortException) {
throw mkAbortException(depth, maxDepth);
}
});
}
return noOp();
}

/**
Expand All @@ -83,12 +79,12 @@ protected AbortExecutionException mkAbortException(int depth, int maxDepth) {
return new AbortExecutionException("maximum query depth exceeded " + depth + " > " + maxDepth);
}

QueryTraverser newQueryTraverser(InstrumentationValidationParameters parameters) {
QueryTraverser newQueryTraverser(ExecutionContext executionContext) {
return QueryTraverser.newQueryTraverser()
.schema(parameters.getSchema())
.document(parameters.getDocument())
.operationName(parameters.getOperation())
.variables(parameters.getVariables())
.schema(executionContext.getGraphQLSchema())
.document(executionContext.getDocument())
.operationName(executionContext.getExecutionInput().getOperationName())
.variables(executionContext.getVariables())
.build();
}

Expand Down
30 changes: 25 additions & 5 deletions src/main/java/graphql/analysis/QueryComplexityInfo.java
View file
Open in desktop
@@ -1,6 +1,7 @@
package graphql.analysis;

import graphql.PublicApi;
import graphql.execution.instrumentation.parameters.InstrumentationExecuteOperationParameters;
import graphql.execution.instrumentation.parameters.InstrumentationValidationParameters;

/**
Expand All @@ -10,11 +11,13 @@
public class QueryComplexityInfo {

private final int complexity;
private InstrumentationValidationParameters instrumentationValidationParameters;
private final InstrumentationValidationParameters instrumentationValidationParameters;
private final InstrumentationExecuteOperationParameters instrumentationExecuteOperationParameters;

private QueryComplexityInfo(int complexity, InstrumentationValidationParameters parameters) {
this.complexity = complexity;
this.instrumentationValidationParameters = parameters;
private QueryComplexityInfo(Builder builder) {
this.complexity = builder.complexity;
this.instrumentationValidationParameters = builder.instrumentationValidationParameters;
this.instrumentationExecuteOperationParameters = builder.instrumentationExecuteOperationParameters;
}

/**
Expand All @@ -35,6 +38,15 @@ public InstrumentationValidationParameters getInstrumentationValidationParameter
return instrumentationValidationParameters;
}

/**
* This returns the instrumentation execute operation parameters.
*
* @return the instrumentation execute operation parameters.
*/
public InstrumentationExecuteOperationParameters getInstrumentationExecuteOperationParameters() {
return instrumentationExecuteOperationParameters;
}

@Override
public String toString() {
return "QueryComplexityInfo{" +
Expand All @@ -54,6 +66,7 @@ public static class Builder {

private int complexity;
private InstrumentationValidationParameters instrumentationValidationParameters;
private InstrumentationExecuteOperationParameters instrumentationExecuteOperationParameters;

private Builder() {
}
Expand All @@ -62,6 +75,7 @@ private Builder() {
* The query complexity.
*
* @param complexity the query complexity
*
* @return this builder
*/
public Builder complexity(int complexity) {
Expand All @@ -73,18 +87,24 @@ public Builder complexity(int complexity) {
* The instrumentation validation parameters.
*
* @param parameters the instrumentation validation parameters.
*
* @return this builder
*/
public Builder instrumentationValidationParameters(InstrumentationValidationParameters parameters) {
this.instrumentationValidationParameters = parameters;
return this;
}

public Builder instrumentationExecuteOperationParameters(InstrumentationExecuteOperationParameters instrumentationExecuteOperationParameters) {
this.instrumentationExecuteOperationParameters = instrumentationExecuteOperationParameters;
return this;
}

/**
* @return a built {@link QueryComplexityInfo} object
*/
public QueryComplexityInfo build() {
return new QueryComplexityInfo(complexity, instrumentationValidationParameters);
return new QueryComplexityInfo(this);
}
}
}