TIKA-4753 - improve oom/timeout/crash msg - #2870
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates tika-server’s Pipes-based error handling so process failures (OOM/timeout/crash) return more machine-readable JSON bodies and aligns HTTP status codes (notably mapping UNSPECIFIED_CRASH to 503) with the “transient process failure” category. It also updates integration tests and user-facing docs to describe the new error response format.
Changes:
- Return JSON error bodies (
{"status": "...", "message": "..."}) from Pipes-based server endpoints on failures. - Treat
UNSPECIFIED_CRASHas503 Service Unavailable(same class asTIMEOUT/OOM) and update integration tests accordingly. - Document the new JSON error response shape and the HTTP-status-to-
statusmapping.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| tika-server/tika-server-core/src/test/java/org/apache/tika/server/core/TikaServerIntegrationTest.java | Updates integration tests to assert JSON error bodies and 503 for UNSPECIFIED_CRASH. |
| tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/resource/PipesParsingHelper.java | Builds and returns JSON error responses for PipesResult failures; refines status mapping. |
| docs/modules/ROOT/pages/using-tika/server/index.adoc | Adds an “Error Responses” section documenting JSON error bodies and mappings. |
| docs/modules/ROOT/pages/migration-to-4x/migrating-tika-server-4x.adoc | Notes the change from plain-text to JSON error bodies and the UNSPECIFIED_CRASH status-code change. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thanks for your contribution to Apache Tika! Your help is appreciated!
Before opening the pull request, please verify that
TIKA-XXXX)[TIKA-XXXX] Issue or pull request title)./mvnw clean testmainbranch. If there are conflicts, please try to rebase the pull request branch on top of a freshly pulledmainbranchtika-bom/pom.xml.We will be able to faster integrate your pull request if these conditions are met. If you have any questions how to fix your problem or about using Tika in general, please sign up for the Tika mailing list. Thanks!