Skip to content

Place the errors field first in bulk response #98303

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

Merged
merged 2 commits into from
Aug 9, 2023
Merged

Place the errors field first in bulk response #98303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6df688
Place the errors field first in bulk response
Tim-Brooks Aug 8, 2023
b95ff9c
Merge remote-tracking branch 'upstream/main' into errors_first_in_bulk
Tim-Brooks Aug 9, 2023
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
2 changes: 1 addition & 1 deletion server/src/main/java/org/elasticsearch/action/bulk/BulkResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,11 @@ public RestStatus status() {
@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject();
builder.field(ERRORS, hasFailures());
builder.field(TOOK, tookInMillis);
if (ingestTookInMillis != BulkResponse.NO_INGEST_TOOK) {
builder.field(INGEST_TOOK, ingestTookInMillis);
}
builder.field(ERRORS, hasFailures());
builder.startArray(ITEMS);
for (BulkItemResponse item : this) {
item.toXContent(builder, params);
Expand Down
73 changes: 62 additions & 11 deletions server/src/test/java/org/elasticsearch/action/bulk/BulkResponseTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import static org.elasticsearch.action.bulk.BulkResponse.NO_INGEST_TOOK;
import static org.elasticsearch.common.xcontent.XContentHelper.toXContent;
import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.assertToXContentEquivalent;
import static org.hamcrest.Matchers.equalTo;

public class BulkResponseTests extends ESTestCase {

Expand All @@ -47,17 +48,7 @@ public void testToAndFromXContent() throws IOException {
DocWriteRequest.OpType opType = randomFrom(DocWriteRequest.OpType.values());

if (frequently()) {
Tuple<? extends DocWriteResponse, ? extends DocWriteResponse> randomDocWriteResponses = null;
if (opType == DocWriteRequest.OpType.INDEX || opType == DocWriteRequest.OpType.CREATE) {
randomDocWriteResponses = IndexResponseTests.randomIndexResponse();
} else if (opType == DocWriteRequest.OpType.DELETE) {
randomDocWriteResponses = DeleteResponseTests.randomDeleteResponse();
} else if (opType == DocWriteRequest.OpType.UPDATE) {
randomDocWriteResponses = UpdateResponseTests.randomUpdateResponse(xContentType);
} else {
fail("Test does not support opType [" + opType + "]");
}

Tuple<? extends DocWriteResponse, ? extends DocWriteResponse> randomDocWriteResponses = success(opType, xContentType);
bulkItems[i] = BulkItemResponse.success(i, opType, randomDocWriteResponses.v1());
expectedBulkItems[i] = BulkItemResponse.success(i, opType, randomDocWriteResponses.v2());
} else {
Expand Down Expand Up @@ -97,4 +88,64 @@ public void testToAndFromXContent() throws IOException {
BytesReference expectedFinalBytes = toXContent(parsedBulkResponse, xContentType, humanReadable);
assertToXContentEquivalent(expectedFinalBytes, finalBytes, xContentType);
}

public void testToXContentPlacesErrorsFirst() throws IOException {
XContentType xContentType = randomFrom(XContentType.values());
boolean humanReadable = randomBoolean();

boolean errors = false;
long took = randomFrom(randomNonNegativeLong(), -1L);
long ingestTook = randomFrom(randomNonNegativeLong(), NO_INGEST_TOOK);
int nbBulkItems = randomIntBetween(1, 10);

BulkItemResponse[] bulkItems = new BulkItemResponse[nbBulkItems];

for (int i = 0; i < nbBulkItems; i++) {
DocWriteRequest.OpType opType = randomFrom(DocWriteRequest.OpType.values());
if (frequently()) {
Tuple<? extends DocWriteResponse, ? extends DocWriteResponse> randomDocWriteResponses = success(opType, xContentType);

BulkItemResponse success = BulkItemResponse.success(i, opType, randomDocWriteResponses.v1());
bulkItems[i] = success;
} else {
errors = true;
String index = randomAlphaOfLength(5);
String id = randomAlphaOfLength(5);

Tuple<Throwable, ElasticsearchException> failures = randomExceptions();

Exception bulkItemCause = (Exception) failures.v1();
bulkItems[i] = BulkItemResponse.failure(i, opType, new BulkItemResponse.Failure(index, id, bulkItemCause));
}
}

BulkResponse bulkResponse = new BulkResponse(bulkItems, took, ingestTook);
BytesReference originalBytes = toXContent(bulkResponse, xContentType, ToXContent.EMPTY_PARAMS, humanReadable);

try (XContentParser parser = createParser(xContentType.xContent(), originalBytes)) {
assertThat(parser.nextToken(), equalTo(XContentParser.Token.START_OBJECT));
XContentParser.Token firstField = parser.nextToken();
assertThat(firstField, equalTo(XContentParser.Token.FIELD_NAME));
assertThat(parser.currentName(), equalTo("errors"));
assertThat(parser.nextToken(), equalTo(XContentParser.Token.VALUE_BOOLEAN));
assertThat(parser.booleanValue(), equalTo(errors));
}
}

private static Tuple<? extends DocWriteResponse, ? extends DocWriteResponse> success(
DocWriteRequest.OpType opType,
XContentType xContentType
) {
Tuple<? extends DocWriteResponse, ? extends DocWriteResponse> randomDocWriteResponses = null;
if (opType == DocWriteRequest.OpType.INDEX || opType == DocWriteRequest.OpType.CREATE) {
randomDocWriteResponses = IndexResponseTests.randomIndexResponse();
} else if (opType == DocWriteRequest.OpType.DELETE) {
randomDocWriteResponses = DeleteResponseTests.randomDeleteResponse();
} else if (opType == DocWriteRequest.OpType.UPDATE) {
randomDocWriteResponses = UpdateResponseTests.randomUpdateResponse(xContentType);
} else {
fail("Test does not support opType [" + opType + "]");
}
return randomDocWriteResponses;
}
}