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/internal/ingest/processors: Refactor liquidity pools, trades, and claimable balances processors to support new ingestion data flow #5025

Merged
merged 4 commits into from
Aug 25, 2023

Conversation

tamirms
Copy link
Contributor

@tamirms tamirms commented Aug 23, 2023

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

Similar to #5024 , this PR refactors the LiquidityPoolsTransactionProcessor, the TradesProcessor, and the ClaimableBalancesTransactionProcessor so it conforms to the following interface:

type horizonTransactionProcessor interface {
	ProcessTransaction(xdr.LedgerCloseMeta, ingest.LedgerTransaction) error
	Flush(ctx context.Context, session db.SessionInterface) error
}

This PR also makes use of the loaders implemented in #5019.

Why

#4909

Known limitations

Several tests are failing because the ingestion framework still needs to be updated to support the new interface. All those tests will be fixed after all the processors have been migrated to the new data flow.

@tamirms tamirms requested a review from a team August 23, 2023 19:38
@tamirms tamirms changed the title services/horizon/internal/ingest/processors: Refactor liquidity pools processor and claimable balances processor to support new ingestion data flow services/horizon/internal/ingest/processors: Refactor liquidity pools, trades, and claimable balances processors to support new ingestion data flow Aug 25, 2023

// Insert updates the wrapped AccountLoader so that the given account
// address is mapped to the provided history account id
func (a AccountLoaderStub) Insert(address string, id int64) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I just wanted to understand what's the reason for using a stub wrapper vs. adding Insert(address, id) on to existing AccountLoader?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the history ids should be determined by calling the Exec() method which queries the DB. However, I don't want the unit tests to interact with the db so I added an Insert() method to allow tests to manually specify history ids for accounts. The reason Insert() is not defined on the existing AccountLoader is that it's only supposed to be used by unit tests.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok, which means AccountLoaderStub is only intended for test scope as well? can it be defined in account_loader_test.go instead to drive the test aspect from the code?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

AccountLoaderStub is used by the trades processor test which is in a different package. If AccountLoaderStub were defined in account_loader_test.go it would not be visible to other packages

@@ -47,80 +54,63 @@ func (stats *TradeStats) Map() map[string]interface{} {
}
}

func assetToKey(asset xdr.Asset) history.AssetKey {
Copy link
Contributor

Choose a reason for hiding this comment

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

how about history.AssetKey.FromAsset(asset xdr.Asset) for general re-use?

Copy link
Contributor

@sreuland sreuland left a comment

Choose a reason for hiding this comment

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

home stretch, looks great!

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