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: Remove global ledger state #3216

Merged
merged 5 commits into from
Nov 12, 2020

Conversation

tamirms
Copy link
Contributor

@tamirms tamirms commented Nov 11, 2020

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 #3195

horizon/ledger.State is a global variable. This is a bad pattern and caused some issues (see #3143). We should make the state local to horizon.App and pass a pointer to it to other parts of the system that need it.

@cla-bot cla-bot bot added the cla: yes label Nov 11, 2020
@tamirms tamirms force-pushed the ledger-state branch 4 times, most recently from 2e5ee7f to 05db866 Compare November 12, 2020 08:48
@tamirms tamirms marked this pull request as ready for review November 12, 2020 10:13
@tamirms tamirms requested a review from a team November 12, 2020 10:13
Comment on lines +20 to 26
pq, err := GetPageQuery(handler.LedgerState, r)
if err != nil {
return nil, err
}

err = validateCursorWithinHistory(pq)
err = validateCursorWithinHistory(handler.LedgerState, pq)
if err != nil {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's an issue now but it's possible that LedgerState will change between the first and second call to CurrentState(). It can be safer to read the state once and pass it to the functions that need it.

In the future, when #2674 is done, we can pass the actual state to the handler so it's not possible to misuse it.

@tamirms tamirms merged commit 5b28203 into stellar:master Nov 12, 2020
@tamirms tamirms deleted the ledger-state branch November 12, 2020 18:26
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.

services/horizon/ledger.State package in Horizon is a global variable
2 participants