[13] graph/db: SQL-ize the zombie index #9937

ellemouton · 2025-06-12T09:26:12Z

This PR adds the schema, queries and CRUD for the zombie index.
The following methods are implemented:

MarkEdgeZombie
MarkEdgeLive
IsZombieEdge
NumZombies
DeleteChannelEdges

This then lets us run TestGraphZombieIndex against the SQL backends.

Part of #9795
Depends on #9936
See #9932 for the full picture that we are aiming at

coderabbitai · 2025-06-12T09:26:19Z

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.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

graph/db/sql_store.go

lightninglabs-deploy · 2025-06-19T12:18:06Z

@bhandras: review reminder

ellemouton · 2025-06-20T10:26:02Z

(note: data race unrelated & is fixed here)

guggero

Super clean! Just one thing I think we should fix (type of scid column).

sqldb/sqlc/migrations/000007_graph.up.sql

graph/db/sql_store.go

sqldb/sqlc/queries/graph.sql

guggero

LGTM 🎉

bhandras

LGTM! 🎉

bhandras · 2025-06-24T16:26:45Z

graph/db/sql_store.go

+		return nil
+	}, sqldb.NoOpReset)
+	if err != nil {
+		return false, route.Vertex{}, route.Vertex{}


nit: could you pls add a TODO to return the error in the future?

ah yeah def - good catch. Will add TODO & make a note in the epic & fix by end of series 👍

bhandras · 2025-06-24T16:27:55Z

graph/db/sql_store.go

+		return nil
+	}, sqldb.NoOpReset)
+	if err != nil {
+		return err


nit: should we also decorate the error like we do below in NumZombies? Perhaps this could be a good practice in general due to the opaque nature of SQL errors. wdyt? (same above for MarkeEdgeZombie)

indeed 🫡 added

bhandras · 2025-06-24T16:29:42Z

graph/db/sql_store.go

+	err := s.db.ExecTx(ctx, sqldb.WriteTxOpt(), func(db SQLQueries) error {
+		for _, chanID := range chanIDs {
+			var chanIDB [8]byte
+			byteOrder.PutUint64(chanIDB[:], chanID)


nit: since this pattern is used everywhere, perhaps we could create a small helper function for it.

good idea - added a commit

So that we can use it in our SQLStore implementation too without needing to fetch the entire ChannelEdgePolicy.

Note that this table will only contain entries for channels that we have deleted from the `channels` table which is why we cannot use foreign keys. Similarly, we may no longer have node entries for the nodes in the table.

Here we implement the SQLStore methods: - MarkEdgeZombie - MarkEdgeLive - IsZombieEdge - NumZombies These will be tested in the next commit as one more method implementation is required.

This lets us run TestGraphZombieIndex against the SQL backends.

ellemouton added this to the v0.20.0 milestone Jun 12, 2025

ellemouton self-assigned this Jun 12, 2025

ellemouton added graph sql labels Jun 12, 2025

ellemouton mentioned this pull request Jun 12, 2025

[14] graph/db: implement more SQLStore methods #9938

Merged

ellemouton commented Jun 12, 2025

View reviewed changes

graph/db/sql_store.go Show resolved Hide resolved

ellemouton requested a review from bhandras June 12, 2025 12:11

ellemouton removed the request for review from bhandras June 19, 2025 12:51

ellemouton force-pushed the elle-graph13 branch from 5e8b169 to 2ee302a Compare June 19, 2025 13:58

ellemouton force-pushed the graphSQL-zombie-index branch from 56d3be6 to f09565e Compare June 19, 2025 13:58

ellemouton mentioned this pull request Jun 19, 2025

[epic]: graph db: SQL implementation & migration #9795

Open

83 tasks

ellemouton force-pushed the elle-graph13 branch from 2ee302a to be190a8 Compare June 20, 2025 09:09

ellemouton force-pushed the graphSQL-zombie-index branch from f09565e to 5efc000 Compare June 20, 2025 09:09

ellemouton requested review from guggero and bhandras June 20, 2025 10:13

guggero reviewed Jun 20, 2025

View reviewed changes

ellemouton force-pushed the elle-graph13 branch from be190a8 to 9ca966b Compare June 20, 2025 12:54

ellemouton force-pushed the graphSQL-zombie-index branch from 5efc000 to 5a7cf6b Compare June 20, 2025 12:54

ellemouton requested a review from guggero June 20, 2025 14:03

guggero approved these changes Jun 20, 2025

View reviewed changes

bhandras approved these changes Jun 24, 2025

View reviewed changes

ellemouton added 5 commits June 24, 2025 18:35

graph/db: make makeZombiePubkeys reusable

cee872a

So that we can use it in our SQLStore implementation too without needing to fetch the entire ChannelEdgePolicy.

sqldb/sqlc: add zombie index table

c648c7a

Note that this table will only contain entries for channels that we have deleted from the `channels` table which is why we cannot use foreign keys. Similarly, we may no longer have node entries for the nodes in the table.

graph/db: add channelIDToBytes helper

137fc09

graph/db+sqldb: implement various zombie index methods

00b6e02

Here we implement the SQLStore methods: - MarkEdgeZombie - MarkEdgeLive - IsZombieEdge - NumZombies These will be tested in the next commit as one more method implementation is required.

graph/db+sqldb: implement DeleteChannelEdges

2a6e668

This lets us run TestGraphZombieIndex against the SQL backends.

ellemouton changed the base branch from elle-graph13 to master June 24, 2025 17:03

ellemouton force-pushed the graphSQL-zombie-index branch from 5a7cf6b to 2a6e668 Compare June 24, 2025 17:04

ellemouton merged commit 4335d9c into lightningnetwork:master Jun 24, 2025
34 of 37 checks passed

ellemouton deleted the graphSQL-zombie-index branch June 24, 2025 18:59

[13] graph/db: SQL-ize the zombie index #9937

[13] graph/db: SQL-ize the zombie index #9937

Uh oh!

Conversation

ellemouton commented Jun 12, 2025

Uh oh!

coderabbitai bot commented Jun 12, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

lightninglabs-deploy commented Jun 19, 2025

Uh oh!

ellemouton commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

guggero left a comment

Choose a reason for hiding this comment

Uh oh!

bhandras left a comment

Choose a reason for hiding this comment

Uh oh!

bhandras Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

ellemouton Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

bhandras Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

ellemouton Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

bhandras Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

ellemouton Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

CodeRabbit Configuration File (`.coderabbit.yaml`)

ellemouton commented Jun 20, 2025 •

edited

Loading