Support POST health checks for HTTP RPC APIs - #1952
Open
Karavil wants to merge 2 commits into
Open
Conversation
Karavil
force-pushed
the
karavil/integration-health-depot
branch
from
September 5, 2026 23:07
776a0c4 to
31be3aa
Compare
Karavil
force-pushed
the
karavil/integration-health-depot
branch
from
September 5, 2026 23:18
31be3aa to
9163007
Compare
Karavil
marked this pull request as ready for review
September 5, 2026 23:42
Author
|
@RhysSullivan lmk if this makes sense! We use Depot's API in Executor but I can't add health checks to it (which inspired this PR). |
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.
Summary
Some APIs use RPC over HTTP and expose read operations only through POST, so they have no GET endpoint for a health check. Allow POST probes with a warning that health checks run automatically and repeatedly, and users must choose an operation that only reads data.
Add validated JSON request bodies to the setup and edit forms, preserve them through save and preview, and show the reason when a configured probe cannot run. GET candidates still rank ahead of POST; PUT, PATCH, and DELETE probes remain blocked.
Before and after
Verification
bun run format:checkbun run lint-- passed in CI; changed files also pass local lint.The POST scenario uses the published service emulator. Its request ledger confirms that both live preview and a saved connection send POST with the expected JSON body and receive a successful response. Browser checks cover the warning, malformed JSON, save/reopen, and the reason an unsupported probe cannot run. Seven health-check API regressions and twelve UI scenarios pass, including saving a check with no arguments.
Run the browser scenarios with
cd e2e && bunx vitest run --project selfhost scenarios/health-check-rpc-ui.test.ts.POST warning and JSON validation:
Normal-speed native Chrome recording (1:51): choose a POST endpoint, enter its JSON body, run a healthy preview, save, and reopen the health check. The recording captures only the app tab and its naturally silent audio.
post-health-check-realtime.mp4
Successful POST preview:
Checklist
@executor-js/plugin-openapiand@executor-js/react.