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

Accept GraphQL queries with line breaks and tabs #17823

Merged
merged 1 commit into from
Jun 10, 2021
Merged

Accept GraphQL queries with line breaks and tabs #17823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions ...-graphql/deployment/src/test/java/io/quarkus/smallrye/graphql/deployment/GraphQLTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,28 @@ public void testGenerics() {
"{\"data\":{\"generics\":{\"message\":\"I know it\"}}}"));
}

/**
* Send a query in JSON that contains raw unescaped line breaks and tabs inside the "query" string,
* which technically is forbidden by the JSON spec, but we want to seamlessly support
* queries from Java text blocks, for example, which preserve line breaks and tab characters.
*/
@Test
public void testQueryWithNewlinesAndTabs() {
String foosRequest = "{\"query\": \"query myquery { \n generics { \n \t message } } \"}";

RestAssured.given().when()
.accept(MEDIATYPE_JSON)
.contentType(MEDIATYPE_JSON)
.body(foosRequest)
.post("/graphql")
.then()
.assertThat()
.statusCode(200)
.and()
.body(CoreMatchers.containsString(
"{\"data\":{\"generics\":{\"message\":\"I know it\"}}}"));
}

@Test
public void testContext() {
String query = getPayload("{context}");
Expand Down
25 changes: 21 additions & 4 deletions ...me/src/main/java/io/quarkus/smallrye/graphql/runtime/SmallRyeGraphQLExecutionHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ private void handleGet(HttpServerResponse response, RoutingContext ctx) {
private JsonObject getJsonObjectFromQueryParameters(RoutingContext ctx) throws UnsupportedEncodingException {
JsonObjectBuilder input = Json.createObjectBuilder();
// Query
String query = readQueryParameter(ctx, QUERY);
String query = stripNewlinesAndTabs(readQueryParameter(ctx, QUERY));
if (query != null && !query.isEmpty()) {
input.add(QUERY, URLDecoder.decode(query, "UTF8"));
}
Expand All @@ -129,14 +129,14 @@ private JsonObject getJsonObjectFromQueryParameters(RoutingContext ctx) throws U
}

// Variables
String variables = readQueryParameter(ctx, VARIABLES);
String variables = stripNewlinesAndTabs(readQueryParameter(ctx, VARIABLES));
if (variables != null && !variables.isEmpty()) {
JsonObject jsonObject = toJsonObject(URLDecoder.decode(variables, "UTF8"));
input.add(VARIABLES, jsonObject);
}

// Extensions
String extensions = readQueryParameter(ctx, EXTENSIONS);
String extensions = stripNewlinesAndTabs(readQueryParameter(ctx, EXTENSIONS));
if (extensions != null && !extensions.isEmpty()) {
JsonObject jsonObject = toJsonObject(URLDecoder.decode(extensions, "UTF8"));
input.add(EXTENSIONS, jsonObject);
Expand All @@ -148,7 +148,8 @@ private JsonObject getJsonObjectFromQueryParameters(RoutingContext ctx) throws U
private JsonObject getJsonObjectFromBody(RoutingContext ctx) throws IOException {

String contentType = readContentType(ctx);
String body = readBody(ctx);
String body = stripNewlinesAndTabs(readBody(ctx));

// If the content type is application/graphql, the query is in the body
if (contentType != null && contentType.startsWith(APPLICATION_GRAPHQL)) {
JsonObjectBuilder input = Json.createObjectBuilder();
Expand Down Expand Up @@ -188,6 +189,22 @@ private String readQueryParameter(RoutingContext ctx, String parameterName) {
return null;
}

/**
* Strip away unescaped tabs and line breaks from the incoming JSON document so that it can be
* successfully parsed by a JSON parser.
* This does NOT remove properly escaped \n and \t inside the document, just the raw characters (ASCII
* values 9 and 10). Technically, this is not compliant with the JSON spec,
* but we want to seamlessly support queries from Java text blocks, for example,
* which preserve line breaks and tab characters.
*/
private String stripNewlinesAndTabs(String input) {
if (input == null || input.isEmpty()) {
return input;
}
return input.replaceAll("\\n", " ")
.replaceAll("\\t", " ");
}

private boolean hasQueryParameters(RoutingContext ctx) {
return hasQueryParameter(ctx, QUERY) || hasQueryParameter(ctx, OPERATION_NAME) || hasQueryParameter(ctx, VARIABLES)
|| hasQueryParameter(ctx, EXTENSIONS);
Expand Down