feat: Reimplement & test GetCandidateRoute algorithm #379

p0mvn · 2024-07-09T21:44:26Z

https://linear.app/osmosis/issue/DATA-250/[candidaterouteopt]-reimplement-and-test-getcandidateroute-algorithm

Implements cleaner abstractions for the new candidate route logic
Adds unit tests from mock mainnet state
Adds benchmark for future improvement measurement

Summary by CodeRabbit

New Features
- Introduced candidate route search functionality for enhanced token routing.
- Added new methods and structs for finding candidate routes in token transactions.
Bug Fixes
- Improved type safety and error handling in route search functionalities.
Tests
- Added unit tests and benchmarks for new candidate route search features to ensure reliability and performance.
Refactor
- Updated existing use cases to utilize the new candidate route search logic for improved modularity and clarity.

* fix alloyed prices breakage with candidate route optimization * update docs * unit test and docs * clean up * clean up * remove test

coderabbitai · 2024-07-09T21:44:30Z

Warning

Review failed

The pull request is closed.

Walkthrough

The updates primarily introduce a new CandidateRouteSearcher component to the routing logic, enhancing the ability to find candidate routes for token swaps within a blockchain network. This involves changes to interfaces, use cases, repositories, and tests, integrating the searcher into the existing architecture.

Changes

File(s)	Change Summary
`app/sidecar_query_server.go`	Added `candidateRouteSearcher` initialization and usage in `routerUsecase` and `pricingSimpleRouterUsecase`. Updated the function signatures accordingly.
`domain/candidate_routes.go`	Introduced `CandidateRouteSearcher` interface and `CandidateRouteSearchOptions` struct for finding candidate token routes.
`domain/mocks/candidate_route_data_holder_mock.go` \| `domain/mocks/candidate_route_finder_mock.go`	Added mocks for candidate route search data and route finding functionality.
`domain/mvc/router.go`	Added method `GetRankedPoolsByDenom` to `CandidateRouteSearchDataHolder` interface.
`router/repository/memory_router_repository.go` \| `router/repository/memory_router_repository_test.go`	Implemented and tested `GetRankedPoolsByDenom` in the repository.
`router/usecase/candidate_routes.go`	Added `candidateRouteFinder` type and refactored `GetCandidateRoutesNew` to use it for candidate route searching.
`router/usecase/candidate_routes_bench_test.go` \| `router/usecase/candidate_routes_test.go`	Added benchmark and unit tests for candidate route searching.
`router/usecase/optimized_routes_test.go` \| `router/usecase/router_usecase_test.go`	Updated tests to include `candidateRouteFinderMock` in `routerUseCase` initialization.
`router/usecase/routertesting/suite.go`	Added `CandidateRouteSearcher` to `MockMainnetUsecase` and updated setup to use the new searcher.

Sequence Diagrams

Candidate Route Searching

sequenceDiagram
    participant User
    participant RouterUsecase
    participant CandidateRouteFinder

    User ->> RouterUsecase: Request Token Swap Route
    RouterUsecase ->> CandidateRouteFinder: FindCandidateRoutes(options)
    CandidateRouteFinder ->> RouterUsecase: Return Routes
    RouterUsecase ->> User: Return Token Swap Route

Poem

In code so new, the routes align,
Tokens dance, a swap divine.
With searchers keen, paths now clear,
Liquidity flows, far and near.
🌟 A network bright with data's might,
Blockchain's song, from day to night. 🌟

Tip

CodeRabbit can use your project's `golangci-lint` configuration to improve the quality of code reviews

Add a configuration file to your project to let CodeRabbit know how to run golangci-lint.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

deividaspetraitis

I have left a few questions ( non blocking ), looks good to me! I think breaking app in smaller parts by reating a new candidate route search abstraction really helps to manage and reduce complexity.

deividaspetraitis · 2024-07-10T13:59:23Z

router/usecase/candidate_routes.go

 			return sqsdomain.CandidateRoutes{}, fmt.Errorf("no pools found for denom %s", currenTokenInDenom)
 		}

-		for i := 0; i < len(rankedPools) && len(routes) < maxRoutes; i++ {
+		for i := 0; i < len(rankedPools) && len(routes) < options.MaxRoutes; i++ {


it may be just a personal preference, but now options.MaxRoute reads much better than maxRoutes, and even better, we have documented everything in the single place!

deividaspetraitis · 2024-07-10T14:01:55Z

router/usecase/candidate_routes.go

+					return sqsdomain.CandidateRoutes{}, err
+				}
+				if len(rankedPools) == 0 {
+					c.logger.Debug("no pools found for denom in candidate route search", zap.String("denom", denom))


just a random idea, would it be any benefit feed this data to our observability service?

Thanks for suggestion!. Specifically for this one - I don't think so. The reason is that this branch may be taken in the expected cases. It also happens quite frequently. Adding some counter/alert for this specific case would result in too much noise.

However, it might be helpful for debugging, thus, I added a log at the Debug level.

…t-test-getcandidateroute

p0mvn added 9 commits July 8, 2024 00:13

feat: introduce dynamic min liquidity into pricing (fix e2e flakiness)

dbbcf32

fixes

60d83a6

comment

ee6a2b5

e2e test flakiness

cb94185

fix test

88ad17b

fix alloyed prices breakage with candidate route optimization (#377)

4658dac

* fix alloyed prices breakage with candidate route optimization * update docs * unit test and docs * clean up * clean up * remove test

comment

fa5e5af

update spec

399f817

feat: Reimplement & test GetCandidateRoute algorithm

2ad9587

p0mvn marked this pull request as ready for review July 9, 2024 21:44

lint

515580e

p0mvn requested review from cryptomatictrader and deividaspetraitis July 9, 2024 22:44

cryptomatictrader approved these changes Jul 10, 2024

View reviewed changes

deividaspetraitis approved these changes Jul 10, 2024

View reviewed changes

Base automatically changed from roman/data-253-candidaterouteopt-introduce-dynamic-min-liquidity-into to v25.x July 10, 2024 21:41

Merge branch 'v25.x' into roman/data-250-candidaterouteopt-reimplemen…

63f991a

…t-test-getcandidateroute

p0mvn merged commit 4efc3ab into v25.x Jul 10, 2024
7 checks passed

p0mvn deleted the roman/data-250-candidaterouteopt-reimplement-test-getcandidateroute branch July 10, 2024 21:56

coderabbitai bot mentioned this pull request Sep 27, 2024

deps: remove sqs from sqsdomain #522

Merged

This was referenced Nov 3, 2024

feat: simulate swap as part of quotes #547

Merged

refactor: decouple base fee fetching as part of quote from simulation #550

Merged

coderabbitai bot mentioned this pull request Dec 2, 2024

BE-636 | Add pagination + sorting + query filtering support for /pools endpoint #553

Merged

coderabbitai bot mentioned this pull request Dec 9, 2024

BE-632 | Include limit order balances in passthrough/portfolio-assets #552

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Reimplement & test GetCandidateRoute algorithm #379

feat: Reimplement & test GetCandidateRoute algorithm #379

p0mvn commented Jul 9, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 9, 2024 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

deividaspetraitis left a comment

deividaspetraitis Jul 10, 2024

deividaspetraitis Jul 10, 2024

p0mvn Jul 10, 2024

feat: Reimplement & test GetCandidateRoute algorithm #379

feat: Reimplement & test GetCandidateRoute algorithm #379

Conversation

p0mvn commented Jul 9, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jul 9, 2024 • edited Loading

Review failed

Walkthrough

Changes

Sequence Diagrams

Candidate Route Searching

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

deividaspetraitis left a comment

Choose a reason for hiding this comment

deividaspetraitis Jul 10, 2024

Choose a reason for hiding this comment

deividaspetraitis Jul 10, 2024

Choose a reason for hiding this comment

p0mvn Jul 10, 2024

Choose a reason for hiding this comment

p0mvn commented Jul 9, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 9, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)