Stop leaking internal error details on /health/deep#236
Open
agnesadoga-creator wants to merge 1 commit into
Open
Stop leaking internal error details on /health/deep#236agnesadoga-creator wants to merge 1 commit into
agnesadoga-creator wants to merge 1 commit into
Conversation
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.
Closes #13
Problem
The /health/deep endpoint (and the shared health-check helper it depends on) returned raw internal error details (
error.message, which can include DB connection info, internal hostnames, etc.) in the HTTP response body to any unauthenticated caller whenever a dependency check failed.Fix
In
src/health/health.service.ts, the privatetimed()helper (used by all dependency checks: Postgres, Redis, Horizon, Soroban RPC) no longer puts the raw caught error into the responsedetailfield. Instead:Logger.detailis now a generic, non-sensitive string like"database check failed"— no error message or stack is exposed to the caller.Testing
Reviewed by inspection (no local build/test run per task scope — dependencies not installed). Existing tests in
test/health-deep.spec.tsandtest/health-rpc.spec.tsonly assert onstatus/latencyMs/network/timestampfields, not on the exactdetailstring, so this change does not alter their expected behavior.