Skip to content

Commit 7fd1566

Browse files
committed
drop executable descriptions in AstSignature
1 parent 573e161 commit 7fd1566

2 files changed

Lines changed: 62 additions & 1 deletion

File tree

‎src/main/java/graphql/language/AstSignature.java‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ private OperationDefinition redactOperationDefinition(OperationDefinition operat
185185
Set<String> fragmentSpreads) {
186186
GraphQLOutputType rootType = operationRootType(operationDefinition, schema);
187187
return operationDefinition.transform(builder -> {
188+
builder.description(null);
188189
builder.variableDefinitions(redactVariableDefinitions(operationDefinition.getVariableDefinitions(), schema, variables, variableTypes, variableRemapping, variableCount, references));
189190
builder.directives(redactDirectives(operationDefinition.getDirectives(), schema, variables, variableTypes, variableRemapping, variableCount, references));
190191
builder.selectionSet(redactSelectionSet(operationDefinition.getSelectionSet(), rootType, schema, variables, variableTypes, variableRemapping, variableCount, references, fragmentSpreads));
@@ -205,6 +206,7 @@ private FragmentDefinition redactFragmentDefinition(FragmentDefinition fragmentD
205206
throw schemaMismatch("fragment type condition '%s' must be present in the schema as an output type", typeCondition.getName());
206207
}
207208
return fragmentDefinition.transform(builder -> {
209+
builder.description(null);
208210
builder.directives(redactDirectives(fragmentDefinition.getDirectives(), schema, variables, variableTypes, variableRemapping, variableCount, references));
209211
builder.selectionSet(redactSelectionSet(fragmentDefinition.getSelectionSet(), outputType, schema, variables, variableTypes, variableRemapping, variableCount, references, fragmentSpreads));
210212
});
@@ -238,6 +240,7 @@ private VariableDefinition redactVariableDefinition(VariableDefinition variableD
238240
: redactValue(defaultValue, variableType, schema, variables, variableRemapping, variableCount, references);
239241
return variableDefinition.transform(builder -> {
240242
builder.name(remapVariable(variableDefinition.getName(), variableRemapping, variableCount));
243+
builder.description(null);
241244
builder.defaultValue(redactedDefaultValue);
242245
builder.directives(redactDirectives(variableDefinition.getDirectives(), schema, variables, variableTypes, variableRemapping, variableCount, references));
243246
});
@@ -822,7 +825,17 @@ public TraversalControl visitVariableReference(VariableReference node, Traverser
822825
@Override
823826
public TraversalControl visitVariableDefinition(VariableDefinition node, TraverserContext<Node> context) {
824827
String varName = remapVariable(node.getName(), variableRemapping, variableCount);
825-
return changeNode(context, node.transform(builder -> builder.name(varName)));
828+
return changeNode(context, node.transform(builder -> builder.name(varName).description(null)));
829+
}
830+
831+
@Override
832+
public TraversalControl visitOperationDefinition(OperationDefinition node, TraverserContext<Node> context) {
833+
return changeNode(context, node.transform(builder -> builder.description(null)));
834+
}
835+
836+
@Override
837+
public TraversalControl visitFragmentDefinition(FragmentDefinition node, TraverserContext<Node> context) {
838+
return changeNode(context, node.transform(builder -> builder.description(null)));
826839
}
827840
};
828841
return transformDoc(document, visitor);

‎src/test/groovy/graphql/language/AstSignatureTest.groovy‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1162,6 +1162,54 @@ fragment ResultFields on SearchResult {
11621162
transformed.inputObjectFieldCoordinates == result.inputObjectFieldCoordinates
11631163
}
11641164

1165+
def describedQuery = '''
1166+
"operation note 4111 1111 1111 1111"
1167+
query Test("variable note hunter2" $term: String) {
1168+
search(term: $term) {
1169+
...Result
1170+
}
1171+
}
1172+
1173+
"""
1174+
fragment note secretPicture
1175+
"""
1176+
fragment Result on SearchResult {
1177+
id
1178+
}
1179+
'''
1180+
1181+
def "signature and privacy safe queries drop executable descriptions"() {
1182+
def expectedQuery = '''query Test($var1: String) {
1183+
search(term: $var1) {
1184+
...Result
1185+
}
1186+
}
1187+
1188+
fragment Result on SearchResult {
1189+
id
1190+
}
1191+
'''
1192+
def doc = TestUtil.parseQuery(describedQuery)
1193+
1194+
expect:
1195+
printAst(new AstSignature().signatureQuery(doc, "Test")) == expectedQuery
1196+
printAst(new AstSignature().privacySafeQuery(doc, "Test")) == expectedQuery
1197+
}
1198+
1199+
def "signature with input drops executable descriptions"() {
1200+
expect:
1201+
signatureWithInput(describedQuery, [term: "secret"]) == '''query Test($var1: String) {
1202+
search(term: "") {
1203+
...Result
1204+
}
1205+
}
1206+
1207+
fragment Result on SearchResult {
1208+
id
1209+
}
1210+
'''
1211+
}
1212+
11651213
def signatureWithInput(String query, Map<String, Object> variables = [:], String operationName = "Test") {
11661214
signatureWithInput(query, variables, operationName, inputSignatureSchema())
11671215
}

0 commit comments

Comments
 (0)