graph: fix inefficient query for IsPublicNode

[Abdulkbk]

fixes #10337 (partially)

Change Description

In this PR, we rewrite the query for IsPublicV1Node, which returns a boolean based on if a node has a public or private channel. This particularly fixes an issue sqlite backend as it struggles to efficiently use multiple indexes across seperate columns in one query.

Step to test

cd graph/db

go test -tags test_db_sqlite  -run TestNodeIsPublic -v # ensure we still correctly distinguish between pub & priv

[gemini-code-assist]

Summary of Changes

Hello @Abdulkbk, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a significant performance bottleneck in the IsPublicV1Node query, which was particularly inefficient for sqlite databases due to its struggle with complex OR conditions across multiple indexed columns. By restructuring the query to use UNION ALL, the change optimizes how the database utilizes indexes, leading to more efficient execution and resolving the identified performance issue.

Highlights

• Query Optimization: The IsPublicV1Node query has been rewritten to improve its efficiency, specifically targeting performance issues with the sqlite backend.
• SQL Query Refactoring: The original query's OR condition across joined tables (n.id = c.node_id_1 OR n.id = c.node_id_2) has been refactored into two separate SELECT statements combined with UNION ALL. This change allows for better utilization of database indexes.
• Dependency Management: A local replace directive for github.com/lightningnetwork/lnd/sqldb has been added to go.mod, pointing to the local sqldb directory.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request refactors the IsPublicV1Node SQL query to improve performance, particularly for the SQLite backend. The change replaces an OR condition in a JOIN with a UNION ALL construct, which is a sound optimization strategy to help the query planner use indexes more effectively. The change is logical and well-explained. I have one minor suggestion regarding SQL formatting to ensure consistency.

[ziggie1984]

can you create some stress tests to see whether union is actually better ?

[Abdulkbk]

can you create some stress tests to see whether union is actually better ?

I added a benchmark as the first commit, the following is what I found after running:

go test -tags=test_db_sqlite -bench=BenchmarkIsPublicNode  > sqlite_or.txt

# then

go test -tags=test_db_sqlite -bench=BenchmarkIsPublicNode  > sqlite_union.txt

# finally
benchstat sqlite_or.txt sqlite_union.txt 

Query Type	Iterations (b.N)	Time per op (ns/op)
UNION ALL	388	3,009,488 ns/op (~3ms)
OR	289	4,063,903 ns/op (~4ms)

The fact that this benchmark is run with approximately 8k nodes means that, if the number of nodes is increased to around ~80k, the difference will become more noticeable.

[lightninglabs-deploy]

@Abdulkbk, remember to re-request review from reviewers when ready

[MPins]

Hello @Abdulkbk, I ran the benchmark as is and got the following numbers.

go test -tags=test_db_sqlite -bench=BenchmarkIsPublicNode

*** SELECT WITH UNION ***

goos: linux
goarch: amd64
pkg: github.com/lightningnetwork/lnd/graph/db
cpu: AMD Ryzen 7 7840HS w/ Radeon 780M Graphics     
BenchmarkIsPublicNode-16    	     122	   9719683 ns/op
--- BENCH: BenchmarkIsPublicNode-16
    test_sqlite.go:49: Creating new SQLite DB for testing
PASS
ok  	github.com/lightningnetwork/lnd/graph/db	119.003s

Then changed the go.mod line 216:

from replace github.com/lightningnetwork/lnd/sqldb => ./sqldb
to //replace github.com/lightningnetwork/lnd/sqldb => ./sqldb

And ran it again :

*** SELECT USING OR ***

goos: linux
goarch: amd64
pkg: github.com/lightningnetwork/lnd/graph/db
cpu: AMD Ryzen 7 7840HS w/ Radeon 780M Graphics     
BenchmarkIsPublicNode-16    	      93	  11786240 ns/op
--- BENCH: BenchmarkIsPublicNode-16
    test_sqlite.go:49: Creating new SQLite DB for testing
PASS
ok  	github.com/lightningnetwork/lnd/graph/db	120.685s

The BenchmarkIsPublicNode using SELECT WITH UNION took 9.7ms and using SELECT WITH OR 11.7ms.

[MPins]

After changing the number of nodes to 16000 I got:

*** SELECT WITH UNION ***

go test -tags=test_db_sqlite -bench=BenchmarkIsPublicNode

goos: linux
goarch: amd64
pkg: github.com/lightningnetwork/lnd/graph/db
cpu: AMD Ryzen 7 7840HS w/ Radeon 780M Graphics     
BenchmarkIsPublicNode-16    	      93	  11939604 ns/op
--- BENCH: BenchmarkIsPublicNode-16
    test_sqlite.go:49: Creating new SQLite DB for testing
PASS
ok  	github.com/lightningnetwork/lnd/graph/db	212.488s

Then changed the go.mod line 216:

from replace github.com/lightningnetwork/lnd/sqldb => ./sqldb
to //replace github.com/lightningnetwork/lnd/sqldb => ./sqldb

*** SELECT USING OR ***
And ran it again :

goos: linux
goarch: amd64
pkg: github.com/lightningnetwork/lnd/graph/db
cpu: AMD Ryzen 7 7840HS w/ Radeon 780M Graphics     
BenchmarkIsPublicNode-16    	      48	  24982592 ns/op
--- BENCH: BenchmarkIsPublicNode-16
    test_sqlite.go:49: Creating new SQLite DB for testing
PASS
ok  	github.com/lightningnetwork/lnd/graph/db	228.831s

The BenchmarkIsPublicNode using SELECT WITH UNION took 11.9ms and using SELECT WITH OR 24.9ms.

[Abdulkbk]

Thanks @MPins, for taking a look. I've addressed the feedback.