Skip to content
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.

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

services/horizon: Return 503 error in POST /transactions if Stellar-Core not synced #3653

Merged
merged 5 commits into from
Jun 4, 2021

Conversation

bartekn
Copy link
Contributor

@bartekn bartekn commented Jun 2, 2021

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

This commit changes POST /transactions behaviour to return 503 Service Unavailable (stale_history) instead of 504 Gateway Timeout (timeout) response if connected Stellar-Core is not synced.

Close #3550.

Why

timeout error is confusing when the connected Stellar-Core is not synced because it means that the transaction has been broadcasted but there is no result yet. What actually happens is that the transaction is not broadcasted (and Horizon cannot ingest it) when Stellar-Core is not in synced. The new response is returned as soon as Horizon determines that the Stellar-Core status has changed.

Known limitations

[TODO or N/A]

@bartekn bartekn marked this pull request as ready for review June 2, 2021 15:26
@bartekn bartekn requested a review from a team June 2, 2021 15:26
@bartekn bartekn merged commit 0c60e5e into stellar:master Jun 4, 2021
@bartekn bartekn deleted the txsub-check-core-sync branch June 4, 2021 14:41
bartekn added a commit that referenced this pull request Jun 15, 2021
Adds sanity integration test for txsub. Add a test
(`submit_transaction_test.go`) I forgot to include in #3653. While we have some
unit tests for txsub we don't test the transaction submission endpoint during
mirroring test. A simple integration test should at least catch the most obvious
bugs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Horizon txsub endpoint should return 503 Service Unavailable when underlying Stellar-Core not synced
2 participants