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/cmd: Check ingest flag before executing horizon db migrate commands #4664

Merged
merged 2 commits into from
Oct 18, 2022

Conversation

tamirms
Copy link
Contributor

@tamirms tamirms commented Oct 18, 2022

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

Close #4580

Only apply migrations in the horizon db migrate commands if the ingest flag is true.

Why

The horizon postinstall script in debian runs the db migrate up command

https://github.com/stellar/packages/blob/master/stellar-horizon/debian/stellar-horizon.postinst#L44

However, this command will fail if horizon is configured to use a read only connection (e.g. horizon is configured for request serving but not ingestion). When the command fails the debian installation will also fail.

To fix this issue we check that horizon ingestion is enabled before attempting to execute migrations. If ingestion is not enabled we print a warning and skip the migrations entirely.

Known limitations

Note that no error is returned if ingestion is disabled even though ingestion is a prerequisite for running the db migrate up command. Although this is a bit counter intuitive, it is consistent with the behavior of the --apply-migrations flag #3586

@tamirms tamirms requested review from jacekn and a team October 18, 2022 09:51
@tamirms tamirms merged commit 012bfe5 into stellar:release-horizon-v2.22.1 Oct 18, 2022
@tamirms tamirms deleted the check-ingest-flag branch October 18, 2022 13:39
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.

2 participants