Skip to content

fix(client): keep status and body when a 422 is not a validation error #704

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

Open
Ashfaqbs wants to merge 1 commit into
base: main
Choose a base branch
from
+72 −2
Open

fix(client): keep status and body when a 422 is not a validation error #704

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
17 changes: 15 additions & 2 deletions ...-serve/docling-serve-client/src/main/java/ai/docling/serve/client/DoclingServeClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,8 +347,9 @@ protected <T> T getResponse(HttpRequest request, HttpResponse<?> response, Class
}
}

if (statusCode == 422) {
var validationError = readValue(body.toString(), ValidationError.class);
var validationError = statusCode == 422 ? parseValidationError(body.toString()) : null;

if (validationError != null) {
var errorText = validationError.getErrorDetails()
.stream()
.map(ValidationErrorDetail::getMessage)
Expand Down Expand Up @@ -376,6 +377,18 @@ protected <T> T getResponse(HttpRequest request, HttpResponse<?> response, Class
}
}

// A 422 from something other than docling-serve (e.g. a gateway) may not carry a validation body;
// fall back to the generic error so the status code and body are not lost to a parse failure.
private @Nullable ValidationError parseValidationError(String body) {
try {
return readValue(body, ValidationError.class);
}
catch (RuntimeException e) {
LOG.debug("422 response body is not a validation error", e);
return null;
}
}

@Override
public HealthCheckResponse health() {
return this.healthOps.health();
Expand Down
57 changes: 57 additions & 0 deletions ...ve-client/src/test/java/ai/docling/serve/client/DoclingServeClientErrorResponseTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package ai.docling.serve.client;

import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
import static com.github.tomakehurst.wiremock.client.WireMock.get;
import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import com.github.tomakehurst.wiremock.junit5.WireMockExtension;

import ai.docling.serve.api.DoclingServeApi;
import ai.docling.serve.api.validation.ValidationException;

class DoclingServeClientErrorResponseTests {
@RegisterExtension
static WireMockExtension wireMock = WireMockExtension.newInstance()
.options(wireMockConfig().dynamicPort())
.build();

private DoclingServeApi client() {
return DoclingServeApi.builder()
.baseUrl("http://localhost:%d".formatted(wireMock.getRuntimeInfo().getHttpPort()))
.build();
}

@Test
void unprocessableEntityWithValidationBodyThrowsValidationException() {
wireMock.stubFor(get(urlPathEqualTo("/health"))
.willReturn(aResponse()
.withStatus(422)
.withHeader("Content-Type", "application/json")
.withBody("{\"detail\": [{\"type\": \"missing\", \"loc\": [\"body\"], \"msg\": \"Field required\"}]}")));

assertThatThrownBy(() -> client().health())
.isInstanceOf(ValidationException.class)
.hasMessageContaining("Field required");
}

@Test
void unprocessableEntityWithNonValidationBodyKeepsStatusAndBody() {
wireMock.stubFor(get(urlPathEqualTo("/health"))
.willReturn(aResponse()
.withStatus(422)
.withHeader("Content-Type", "text/html")
.withBody("<html>Unprocessable by gateway</html>")));

assertThatThrownBy(() -> client().health())
.isInstanceOfSatisfying(DoclingServeClientException.class, e -> {
assertThat(e.getStatusCode()).isEqualTo(422);
assertThat(e.getResponseBody()).isEqualTo("<html>Unprocessable by gateway</html>");
});
}
}