routing: Namespaced Mission Control by ellemouton · Pull Request #9001 · lightningnetwork/lnd

ellemouton · 2024-08-13T17:25:29Z

This PR:

migrates the Mission control store so that all existing entries are moved to a new "default" namespace sub-bucket.
The MissionControlManager now handles returning mission control instances based on namespace.

With this PR we still only use the default namespace, but this is a starting point for starting to make use of other namespaces. A follow up could add functionality to combine the results of 2 or more on-disk namespaces into one in-memory.

Required for #8991 where we will want to report MC results in a different (non payment related) namespace.
Addresses part of #7812
Addresses part of #8849

Depends on #8911

Visual

MC DB structure currently:

missioncontrol-results ---> < result ID 1> --> <encoded result 1> 
                       ---> < result ID 2> --> <encoded result 2> 
                       ---> < result ID 3> --> <encoded result 3> 
                                        .....

MC DB structure after this PR:

missioncontrol-results ---> "default" ---> < result ID 1> --> <encoded result 1> 
                                      ---> < result ID 2> --> <encoded result 2> 
                                      ---> < result ID 3> --> <encoded result 3> 
                                                      .....

coderabbitai · 2024-08-13T17:25:34Z

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)

llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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 using 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

ellemouton · 2024-08-14T06:39:43Z

Note: this is currently stacked on top of #8911 just to make my life easier for building on top of these 2 together but there is no actual dependency on that PR. So if this gets approved before that one, I can switch the order of dependencies (although, I think performance wise, it makes sense to get #8911 in first since it will make the size of the result blobs way smaller).

routing/missioncontrol.go

guggero

Very nice! Only small comments, everything's very straightforward 🚀

routing/missioncontrol.go

routing/missioncontrol_store.go

routing/missioncontrol.go

routing/router_test.go

routing/missioncontrol.go

ellemouton

Wohoooo thanks @guggero 🚀

routing/missioncontrol.go

routing/missioncontrol_store.go

routing/missioncontrol.go

guggero

LGTM and tACK 🎉

Ran this on a copy of my mainnet node with 474 entries, migration was super fast (for both migration 32 and 33):

2024-09-16 13:00:12.172 [INF] CHDB: Checking for schema update: latest_version=33, db_version=31
2024-09-16 13:00:12.172 [INF] CHDB: Performing database schema migration
2024-09-16 13:00:12.172 [INF] CHDB: Applying migration #32
2024-09-16 13:00:12.172 [INF] CHDB: Migrating Mission Control store to use a more minimal encoding for routes
2024-09-16 13:00:12.192 [INF] CHDB: Applying migration #33
2024-09-16 13:00:12.192 [INF] CHDB: Migrating Mission Control store to use namespaced results
2024-09-16 13:00:12.200 [INF] CHDB: Checking for optional update: prune_revocation_log=false, db_version=0: prune revocation log
2024-09-16 13:00:12.201 [INF] LTND: Database(s) now open (time_to_open=1.772583823s)!

...

2024-09-16 13:00:16.431 [DBG] CRTR: Instantiating mission control with config: maximum history: 1000, minimum failure relax interval: 1m0s, estimator type: apriori, penalty halflife time: 1h0m0s, apriori hop probability: 0.6, apriori weight: 0.5, previous success probability: 0.95, capacity fraction: 0.9999
2024-09-16 13:00:16.432 [INF] CRTR: Loaded 474 mission control entries
2024-09-16 13:00:16.432 [DBG] CRTR: [default]: Mission control state reconstruction started
2024-09-16 13:00:16.437 [DBG] CRTR: [default]: Reporting pair success to Mission Control: pair=0256812a1cb2539a5500f3c1c20db5ed7626e3878a552e3356c032c7bec2b3060e -> 03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f, amt=75403539 mSAT
2024-09-16 13:00:16.437 [DBG] CRTR: Setting 0256812a1cb2539a5500f3c1c20db5ed7626e3878a552e3356c032c7bec2b3060e->03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f range to [75403539 mSAT-0 mSAT]
2024-09-16 13:00:16.437 [DBG] CRTR: [default]: Reporting pair success to Mission Control: pair=03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f -> 032795584d041034d0daec6c048be786bb566282a9e275ca6b22085598dc6db71e, amt=75395000 mSAT

...

lightninglabs-deploy · 2024-09-27T09:33:29Z

@bitromortac: review reminder

bitromortac

LGTM ⚡ This will be very useful, do you plan to add RPC functionality to be able to switch to different mission control namespaces? SetMissionControlConfig could be great for that.

routing/missioncontrol.go

routing/payment_session_source.go

routing/missioncontrol.go

routing/missioncontrol_test.go

ellemouton · 2024-10-01T08:55:48Z

do you plan to add RPC functionality to be able to switch to different mission control namespaces? SetMissionControlConfig could be great for that.

Yes that is defs a next step but I think let's not do it in this PR just to keep this minimal for now

thanks for the review!

So that `missionControlStore` can be unaware of the backing DB structure it is writing to. In an upcoming commit when we change mission control to write to namespaced buckets instead, we then only need to update the `namespacedDB` implementation.

In this commit, the mission control store is migrated such that all existing pairs which are currently stored directly in the top level results bucket are now instead moved to a "default" namespace bucket. Note that this migration is not yet invoked in this commit. The migration will be invoked in the same commit that starts writing and reading the new format.

and invoke the associated mission control migration.

Only the MissionControl instance should use this variable and it should not be accessible to users of MissionControl.

This commit renames the previous MissionControl to MissionController and the previous MissionController interface to MissionControlQuerier. This is done because soon the (new) MissionController will back multiple namespaced MissionControl instances. For now, it just houses a single MissionControl in the default namespace. This commit also replaces the MissionControl's `now` function with a `clock.Clock`.

ellemouton mentioned this pull request Aug 13, 2024

[Feature]: Persist imported Mission Control Data across restarts #8898

Draft

8 tasks

ellemouton force-pushed the namespacedMC branch 2 times, most recently from 1658430 to dc718ac Compare August 13, 2024 18:23

guggero self-requested a review August 13, 2024 18:23

ellemouton mentioned this pull request Aug 14, 2024

[feature]: Persist imported Mission Control Data across restarts. #8849

Open

ellemouton force-pushed the namespacedMC branch from dc718ac to cef2379 Compare August 14, 2024 06:37

ellemouton force-pushed the namespacedMC branch from cef2379 to 200547c Compare August 14, 2024 07:00

ellemouton changed the title ~~MC: Namespaced Mission Control~~ routing: Namespaced Mission Control Aug 14, 2024

ellemouton commented Aug 14, 2024

View reviewed changes

routing/missioncontrol.go Show resolved Hide resolved

ellemouton force-pushed the namespacedMC branch 2 times, most recently from bbea090 to 8e4c0e5 Compare August 14, 2024 13:24

ellemouton mentioned this pull request Aug 14, 2024

route blinding [4/4]: update MC on receive from blinded path #9004

Open

ellemouton force-pushed the elle-reduceMCEncoding branch from 1c0bba2 to 8af0803 Compare August 15, 2024 07:41

ellemouton force-pushed the namespacedMC branch 2 times, most recently from 5c444a6 to a996efe Compare August 15, 2024 08:24

ellemouton added mission control migration labels Aug 15, 2024

ellemouton added the size/kilo medium, proper context needed, less than 1000 lines label Aug 22, 2024

ellemouton force-pushed the elle-reduceMCEncoding branch from 8af0803 to 3cf0d5f Compare September 9, 2024 08:18

ellemouton force-pushed the namespacedMC branch from a996efe to c2195f1 Compare September 9, 2024 08:23

guggero reviewed Sep 9, 2024

View reviewed changes

ellemouton force-pushed the namespacedMC branch from c2195f1 to 6d320d1 Compare September 9, 2024 10:27

ellemouton force-pushed the elle-reduceMCEncoding branch from 3cf0d5f to 9d45dc9 Compare September 9, 2024 10:27

ellemouton force-pushed the namespacedMC branch 3 times, most recently from 9691ae5 to 0582ce4 Compare September 9, 2024 10:30

ellemouton commented Sep 9, 2024

View reviewed changes

ellemouton requested a review from guggero September 10, 2024 19:59

guggero approved these changes Sep 16, 2024

View reviewed changes

saubyk assigned ellemouton Sep 17, 2024

saubyk requested a review from bitromortac September 17, 2024 16:32

bitromortac approved these changes Sep 30, 2024

View reviewed changes

routing/missioncontrol.go Outdated Show resolved Hide resolved

routing/payment_session_source.go Outdated Show resolved Hide resolved

routing/missioncontrol.go Outdated Show resolved Hide resolved

routing/missioncontrol_test.go Show resolved Hide resolved

ellemouton added 4 commits October 1, 2024 13:50

routing: start writing and reading from namespaced MC

6b449a6

and invoke the associated mission control migration.

routing: unexport MissionControl mutex

28a828a

Only the MissionControl instance should use this variable and it should not be accessible to users of MissionControl.

ellemouton force-pushed the namespacedMC branch from 0582ce4 to f687b10 Compare October 1, 2024 11:59

ellemouton changed the base branch from elle-reduceMCEncoding to master October 1, 2024 12:00

ellemouton force-pushed the namespacedMC branch from f687b10 to 7c20895 Compare October 1, 2024 12:01

ellemouton added 3 commits October 1, 2024 14:06

routing: prefix MC logs with namespace

5eff056

routing: support multiple namespaced MissionControls

8126930

ellemouton force-pushed the namespacedMC branch from 7c20895 to 5bfc236 Compare October 1, 2024 12:11

docs: add release note entry

83c1d73

ellemouton force-pushed the namespacedMC branch from 5bfc236 to 83c1d73 Compare October 1, 2024 16:02

ellemouton merged commit f1207ef into lightningnetwork:master Oct 1, 2024

ellemouton deleted the namespacedMC branch October 1, 2024 18:21

Conversation

ellemouton commented Aug 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Visual

Uh oh!

coderabbitai bot commented Aug 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

ellemouton commented Aug 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

guggero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ellemouton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

guggero left a comment

Choose a reason for hiding this comment

Uh oh!

lightninglabs-deploy commented Sep 27, 2024

Uh oh!

bitromortac left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ellemouton commented Oct 1, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ellemouton commented Aug 13, 2024 •

edited

Loading

coderabbitai bot commented Aug 13, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

ellemouton commented Aug 14, 2024 •

edited

Loading