Handle API exceptions in upload and download operations by Fivell · Pull Request #38 · didww/didww-api-3-java-sdk

Fivell · 2026-03-10T22:36:44Z

Summary

Upload and download now throw DidwwApiException with parsed JSON:API errors instead of generic DidwwClientException
Added parseApiException() helper for consistent error handling

Test plan

Tests for upload API error with JSON and non-JSON bodies
Tests for download API error propagation
All tests pass

Copilot

Pull request overview

This PR updates the SDK’s upload/download operations to raise DidwwApiException with parsed JSON:API errors details (when available), enabling callers to handle API failures consistently instead of receiving generic DidwwClientExceptions.

Changes:

Updated uploadEncryptedFile() and downloadExport() to throw DidwwApiException on non-2xx responses.
Added parseApiException() helper in DidwwClient to parse JSON:API errors arrays and fall back to raw body text.
Added tests covering API error propagation for export download/decompress and encrypted file upload (JSON and non-JSON error bodies).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
`src/main/java/com/didww/sdk/DidwwClient.java`	Introduces `parseApiException()` and switches upload/download error handling to `DidwwApiException`.
`src/test/java/com/didww/sdk/EncryptedFileUploadTest.java`	Adds coverage for upload API failures returning JSON:API errors and plain-text bodies.
`src/test/java/com/didww/sdk/resource/ExportTest.java`	Adds coverage for download and download+decompress API error propagation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-10T22:40:36Z

src/main/java/com/didww/sdk/DidwwClient.java

+    private DidwwApiException parseApiException(int httpStatus, String body) {
+        try {
+            JsonNode root = objectMapper.readTree(body);
+            JsonNode errorsNode = root.get("errors");
+            if (errorsNode != null && errorsNode.isArray()) {
+                List<DidwwApiException.ApiError> errors = new ArrayList<>();
+                for (JsonNode errorNode : errorsNode) {
+                    DidwwApiException.ApiError error = objectMapper.treeToValue(
+                            errorNode, DidwwApiException.ApiError.class);
+                    errors.add(error);
+                }
+                if (!errors.isEmpty()) {
+                    return new DidwwApiException(httpStatus, errors);
+                }
+            }
+        } catch (Exception ignored) {
+        }
+        return new DidwwApiException(httpStatus, body.isEmpty()
+                ? "HTTP " + httpStatus
+                : body);
+    }


parseApiException() may produce an unhelpful exception message of ...: null when the JSON:API error object omits detail (e.g., the added test uses only title). DidwwApiException(List<ApiError>) currently builds its message from getDetail(), so consider normalizing parsed errors (e.g., if detail is blank, set it from title/status) or otherwise ensure the resulting exception message is meaningful.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-11T08:09:24Z

src/main/java/com/didww/sdk/DidwwClient.java

+            }
+        } catch (Exception ignored) {
+        }
+        return new DidwwApiException(httpStatus, body.isEmpty()


In parseApiException(), the fallback message uses body.isEmpty(). If the response body is whitespace-only (e.g., "\n"), this will create a DidwwApiException with a blank message. Consider treating blank bodies as empty (e.g., trim/isBlank) so the fallback message becomes something like "HTTP ".

Suggested change

return new DidwwApiException(httpStatus, body.isEmpty()

return new DidwwApiException(httpStatus, (body == null || body.trim().isEmpty())

Copilot · 2026-03-11T08:09:24Z

src/main/java/com/didww/sdk/DidwwClient.java

+    private DidwwApiException parseApiException(int httpStatus, String body) {
+        try {
+            JsonNode root = objectMapper.readTree(body);
+            JsonNode errorsNode = root.get("errors");
+            if (errorsNode != null && errorsNode.isArray()) {
+                List<DidwwApiException.ApiError> errors = new ArrayList<>();
+                for (JsonNode errorNode : errorsNode) {
+                    DidwwApiException.ApiError error = objectMapper.treeToValue(
+                            errorNode, DidwwApiException.ApiError.class);
+                    errors.add(error);
+                }
+                if (!errors.isEmpty()) {
+                    return new DidwwApiException(httpStatus, errors);
+                }
+            }
+        } catch (Exception ignored) {
+        }


parseApiException() duplicates the JSON:API error parsing logic already present in ReadOnlyRepository.handleErrorResponse(). To keep error parsing consistent across the SDK, consider extracting this into a shared helper (e.g., a small utility or a static method on DidwwApiException) and reusing it in both places.

Suggested change

private DidwwApiException parseApiException(int httpStatus, String body) {

try {

JsonNode root = objectMapper.readTree(body);

JsonNode errorsNode = root.get("errors");

if (errorsNode != null && errorsNode.isArray()) {

List<DidwwApiException.ApiError> errors = new ArrayList<>();

for (JsonNode errorNode : errorsNode) {

DidwwApiException.ApiError error = objectMapper.treeToValue(

errorNode, DidwwApiException.ApiError.class);

errors.add(error);

}

if (!errors.isEmpty()) {

return new DidwwApiException(httpStatus, errors);

}

}

} catch (Exception ignored) {

}

private static List<DidwwApiException.ApiError> extractApiErrors(String body, ObjectMapper objectMapper) {

List<DidwwApiException.ApiError> errors = new ArrayList<>();

try {

JsonNode root = objectMapper.readTree(body);

JsonNode errorsNode = root.get("errors");

if (errorsNode != null && errorsNode.isArray()) {

for (JsonNode errorNode : errorsNode) {

DidwwApiException.ApiError error =

objectMapper.treeToValue(errorNode, DidwwApiException.ApiError.class);

if (error != null) {

errors.add(error);

}

}

}

} catch (Exception ignored) {

// If parsing fails, fall back to using the raw body as the exception message.

}

return errors;

}

private DidwwApiException parseApiException(int httpStatus, String body) {

List<DidwwApiException.ApiError> errors = extractApiErrors(body, objectMapper);

if (!errors.isEmpty()) {

return new DidwwApiException(httpStatus, errors);

}

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-11T10:02:14Z

src/main/java/com/didww/sdk/DidwwClient.java

        try (Response response = httpClient.newCall(request).execute()) {
            if (!response.isSuccessful()) {
-                throw new DidwwClientException("Failed to download export: HTTP " + response.code());
+                throw new DidwwApiException(response.code(), "HTTP " + response.code());


In downloadExport(), unsuccessful responses currently throw a DidwwApiException with only "HTTP " and do not read/parse the response body. This loses JSON:API error details (and is inconsistent with uploadEncryptedFile()/parseApiException and repository error handling). Consider reading the error response body when !response.isSuccessful() and throwing parseApiException(response.code(), body) so callers get parsed errors / a more informative message.

Suggested change

throw new DidwwApiException(response.code(), "HTTP " + response.code());

String errorBody = null;

if (response.body() != null) {

errorBody = response.body().string();

}

throw parseApiException(response.code(), errorBody);

Copilot · 2026-03-11T10:02:14Z

src/main/java/com/didww/sdk/DidwwClient.java

+    private DidwwApiException parseApiException(int httpStatus, String body) {
+        try {
+            JsonNode root = objectMapper.readTree(body);
+            JsonNode errorsNode = root.get("errors");
+            if (errorsNode != null && errorsNode.isArray()) {


parseApiException() duplicates the JSON:API error parsing logic that already exists in ReadOnlyRepository.handleErrorResponse() (src/main/java/com/didww/sdk/repository/ReadOnlyRepository.java:91-110). This duplication risks the two implementations drifting over time. Consider extracting the parsing into a shared utility (e.g., a static helper on DidwwApiException or a small internal util class) and reusing it from both places.

Copilot · 2026-03-11T10:02:14Z

src/main/java/com/didww/sdk/exception/DidwwApiException.java

+        if (title != null && !title.isBlank()) {
+            return title;
+        }
+        return "HTTP " + httpStatus;


DidwwApiException.buildMessage() already includes the HTTP status in the prefix ("DIDWW API error (HTTP )"). When an ApiError has neither detail nor title, errorMessage() falls back to "HTTP ", producing redundant messages like "... (HTTP 404): HTTP 404". Consider using a non-duplicative fallback (e.g., error.getStatus()/error.getCode(), or a generic "Unknown error") instead.

Suggested change

return "HTTP " + httpStatus;

String status = error.getStatus();

if (status != null && !status.isBlank()) {

return status;

}

String code = error.getCode();

if (code != null && !code.isBlank()) {

return code;

}

return "Unknown error";

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-11T16:35:51Z

src/main/java/com/didww/sdk/exception/DidwwApiException.java

+    private static String errorMessage(ApiError error, int httpStatus) {
+        String detail = error.getDetail();
+        if (detail != null && !detail.isBlank()) {
+            return detail;
+        }
+        String title = error.getTitle();
+        if (title != null && !title.isBlank()) {
+            return title;
+        }
+        return "HTTP " + httpStatus;
+    }


errorMessage falls back to returning "HTTP <status>" when both detail and title are blank. Since buildMessage already includes the HTTP status prefix, this can produce redundant messages like "DIDWW API error (HTTP 404): HTTP 404". Consider returning a non-redundant placeholder (or an empty string and skipping it) so the message stays informative without repeating the status code.

When a JSON:API error has title but no detail, the exception message showed "null". Now falls back to title when detail is null/blank, and to HTTP status code when both are absent.

Download export errors return empty body with text/html Content-Type, not JSON:API error responses. Only upload errors return proper JSON:API errors, so keep parseApiException for upload only.

…body in parseApiException

…back message

sonarqubecloud · 2026-03-11T21:25:05Z

Quality Gate passed

Issues
6 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

src/main/java/com/didww/sdk/repository/ReadOnlyRepository.java:96

When the response is unsuccessful and the body is empty (e.g., no body or 0-length body), this throws new DidwwApiException(response.code(), body) with an empty message. Consider defaulting to a helpful message like "HTTP <status>" (similar to DidwwClient#parseApiException) when body is blank so callers don’t get a blank exception message.

            String body = response.body() != null ? response.body().string() : "";
            List<DidwwApiException.ApiError> errors = DidwwApiException.extractApiErrors(body, objectMapper);
            if (errors.isEmpty()) {
                throw new DidwwApiException(response.code(), body);
            }
            throw new DidwwApiException(response.code(), errors);

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-11T21:27:58Z

src/main/java/com/didww/sdk/exception/DidwwApiException.java

+    public static List<ApiError> extractApiErrors(String body, ObjectMapper objectMapper) {
+        List<ApiError> errors = new ArrayList<>();
+        try {
+            JsonNode root = objectMapper.readTree(body);
+            JsonNode errorsNode = root.get("errors");
+            if (errorsNode != null && errorsNode.isArray()) {
+                for (JsonNode errorNode : errorsNode) {
+                    ApiError error = objectMapper.treeToValue(errorNode, ApiError.class);
+                    if (error != null) {
+                        errors.add(error);
+                    }
+                }
+            }
+        } catch (Exception ignored) {
+        }
+        return errors;


extractApiErrors relies on objectMapper.readTree(body) throwing for null/blank/non-JSON bodies and then swallowing the exception. Adding an early return when body is null/blank (and ideally narrowing the catch to Jackson/IO parsing exceptions) would avoid using exceptions for control flow and reduce the risk of hiding unexpected failures.

Copilot · 2026-03-11T21:27:58Z

src/main/java/com/didww/sdk/exception/DidwwApiException.java

+    private static String errorMessage(ApiError error, int httpStatus) {
+        String detail = error.getDetail();
+        if (detail != null && !detail.isBlank()) {
+            return detail;
+        }
+        String title = error.getTitle();
+        if (title != null && !title.isBlank()) {
+            return title;
+        }
+        return "Unknown error";
+    }


errorMessage(ApiError error, int httpStatus) doesn’t use the httpStatus parameter. Dropping the unused parameter (and updating the call site) will avoid compiler/IDE warnings and keep the helper’s contract minimal.

Fivell · 2026-03-11T22:39:26Z

Closing this PR after testing actual DIDWW API error responses:

Upload 422: returns Rails-style validation hash ({"errors":{"base":["outdated fingerprint"]}}) — not JSON:API format
Upload 401: returns JSON:API but is already handled by the auth interceptor before reaching upload code
Download 404/401: returns empty HTML body

JSON:API error parsing in upload/download adds no practical value since the API doesn't return JSON:API errors for these endpoints.

Fivell requested a review from Copilot March 10, 2026 22:37

Copilot started reviewing on behalf of Fivell March 10, 2026 22:38 View session

Fivell force-pushed the fix/upload-download-api-exception branch from 420e25c to 75f7060 Compare March 10, 2026 22:39

Copilot AI reviewed Mar 10, 2026

View reviewed changes

Fivell requested a review from Copilot March 11, 2026 08:05

Copilot started reviewing on behalf of Fivell March 11, 2026 08:05 View session

Copilot AI reviewed Mar 11, 2026

View reviewed changes

Fivell requested a review from Copilot March 11, 2026 09:58

Copilot started reviewing on behalf of Fivell March 11, 2026 09:58 View session

Copilot AI reviewed Mar 11, 2026

View reviewed changes

Fivell force-pushed the fix/upload-download-api-exception branch from 2797fc1 to 3b46af0 Compare March 11, 2026 16:21

Fivell requested a review from Copilot March 11, 2026 16:31

Copilot started reviewing on behalf of Fivell March 11, 2026 16:33 View session

Copilot AI reviewed Mar 11, 2026

View reviewed changes

Fivell added 5 commits March 11, 2026 22:24

Handle API exceptions in upload and download operations

f4f351b

Fix error message to fallback to title when detail is missing

90070b7

When a JSON:API error has title but no detail, the exception message showed "null". Now falls back to title when detail is null/blank, and to HTTP status code when both are absent.

Remove JSON:API error parsing from download method

5083aea

Download export errors return empty body with text/html Content-Type, not JSON:API error responses. Only upload errors return proper JSON:API errors, so keep parseApiException for upload only.

Extract shared JSON:API error parsing helper, handle null/whitespace …

b88698e

…body in parseApiException

Parse error body in downloadExport, fix redundant HTTP status in fall…

a3cb1b4

…back message

Fivell force-pushed the fix/upload-download-api-exception branch from 4a22cb1 to a3cb1b4 Compare March 11, 2026 21:24

Fivell requested a review from Copilot March 11, 2026 21:25

Copilot started reviewing on behalf of Fivell March 11, 2026 21:25 View session

Copilot AI reviewed Mar 11, 2026

View reviewed changes

Fivell closed this Mar 11, 2026

	return new DidwwApiException(httpStatus, body.isEmpty()
	return new DidwwApiException(httpStatus, (body == null \|\| body.trim().isEmpty())

-                throw new DidwwApiException(response.code(), "HTTP " + response.code());
+                String errorBody = null;
+                if (response.body() != null) {
+                    errorBody = response.body().string();
+                }
+                throw parseApiException(response.code(), errorBody);

-        return "HTTP " + httpStatus;
+        String status = error.getStatus();
+        if (status != null && !status.isBlank()) {
+            return status;
+        }
+        String code = error.getCode();
+        if (code != null && !code.isBlank()) {
+            return code;
+        }
+        return "Unknown error";

Conversation

Fivell commented Mar 10, 2026

Summary

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Mar 11, 2026

Quality Gate passed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Fivell commented Mar 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants