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

[Backport 8.16] Parse ES|QL response body header more leniently #906

Merged
merged 1 commit into from
Nov 18, 2024
Merged

[Backport 8.16] Parse ES|QL response body header more leniently #906

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
42 changes: 28 additions & 14 deletions ...-client/src/main/java/co/elastic/clients/elasticsearch/_helpers/esql/EsqlAdapterBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,26 +34,40 @@ public abstract class EsqlAdapterBase<T> implements EsqlAdapter<T> {
* The caller can then read row arrays until finding an end array that closes the top-level array.
*/
public static EsqlMetadata readHeader(JsonParser parser, JsonpMapper mapper) {
EsqlMetadata result = new EsqlMetadata();

JsonpUtils.expectNextEvent(parser, JsonParser.Event.START_OBJECT);
JsonpUtils.expectNextEvent(parser, JsonParser.Event.KEY_NAME);

if (!"columns".equals(parser.getString())) {
throw new JsonpMappingException("Expecting a 'columns' property, but found '" + parser.getString() + "'", parser.getLocation());
parse: while (JsonpUtils.expectNextEvent(parser, JsonParser.Event.KEY_NAME) != null) {
switch (parser.getString()) {
case "values": {
// We're done parsing header information
break parse;
}
case "columns": {
result.columns = JsonpDeserializer
.arrayDeserializer(EsqlMetadata.EsqlColumn._DESERIALIZER)
.deserialize(parser, mapper);
break;
}
case "took": {
JsonpUtils.expectNextEvent(parser, JsonParser.Event.VALUE_NUMBER);
result.took = parser.getLong();
break;
}
default: {
// Ignore everything else
JsonpUtils.skipValue(parser);
break;
}
}
}

List<EsqlMetadata.EsqlColumn> columns = JsonpDeserializer
.arrayDeserializer(EsqlMetadata.EsqlColumn._DESERIALIZER)
.deserialize(parser, mapper);

EsqlMetadata result = new EsqlMetadata();
result.columns = columns;

JsonpUtils.expectNextEvent(parser, JsonParser.Event.KEY_NAME);

if (!"values".equals(parser.getString())) {
throw new JsonpMappingException("Expecting a 'values' property, but found '" + parser.getString() + "'", parser.getLocation());
if (result.columns == null) {
throw new JsonpMappingException("Expecting a 'columns' property before 'values'.", parser.getLocation());
}

// Beginning of the `values` property
JsonpUtils.expectNextEvent(parser, JsonParser.Event.START_ARRAY);

return result;
Expand Down
4 changes: 4 additions & 0 deletions java-client/src/main/java/co/elastic/clients/elasticsearch/_helpers/esql/EsqlMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.ObjectBuilderBase;

import javax.annotation.Nullable;
import java.util.List;

public class EsqlMetadata {
Expand Down Expand Up @@ -74,4 +75,7 @@ protected static void setupEsqlColumnDeserializer(ObjectDeserializer<EsqlColumn.
}

public List<EsqlColumn> columns;

@Nullable
public Long took;
}
26 changes: 26 additions & 0 deletions ...-client/src/test/java/co/elastic/clients/elasticsearch/_helpers/esql/EsqlAdapterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import co.elastic.clients.elasticsearch._helpers.esql.jdbc.ResultSetEsqlAdapter;
import co.elastic.clients.elasticsearch._helpers.esql.objects.ObjectsEsqlAdapter;
import co.elastic.clients.elasticsearch.esql.query.EsqlFormat;
import co.elastic.clients.json.JsonpMappingException;
import co.elastic.clients.json.jackson.JacksonJsonpMapper;
import co.elastic.clients.testkit.MockHttpClient;
import co.elastic.clients.transport.endpoints.BinaryResponse;
Expand All @@ -36,6 +37,7 @@
public class EsqlAdapterTest extends Assertions {

String json = "{\n" +
" \"took\": 10," +
" \"columns\": [\n" +
"\t{\"name\": \"avg_salary\", \"type\": \"double\"},\n" +
"\t{\"name\": \"lang\", \t\"type\": \"keyword\"}\n" +
Expand All @@ -56,6 +58,30 @@ public static class Data {
public String lang;
}

@Test
public void testMissingColumns() throws IOException {
String badJson = "{\n" +
" \"took\": 10," +
" \"values\": [\n" +
"\t[43760.0, \"Spanish\"],\n" +
"\t[48644.0, \"French\"],\n" +
"\t[48832.0, \"German\"]\n" +
" ]\n" +
"}\n";

ElasticsearchClient esClient = new MockHttpClient()
.add("/_query", "application/json", badJson)
.client(new JacksonJsonpMapper());

JsonpMappingException jsonMappingException = assertThrows(JsonpMappingException.class, () -> {
esClient.esql().query(
ResultSetEsqlAdapter.INSTANCE,
"FROM employees | STATS avg_salary = AVG(salary) by country"
);
});
assertTrue(jsonMappingException.getMessage().contains("Expecting a 'columns' property"));
}

@Test
public void testObjectDeserializer() throws IOException {

Expand Down
Loading