plug into itests behind feature flag

Author: ellemouton

.github/workflows/main.yml

@@ -368,10 +368,14 @@ jobs:
             args: backend=bitcoind dbbackend=sqlite
           - name: bitcoind-sqlite-nativesql
             args: backend=bitcoind dbbackend=sqlite nativesql=true
+          - name: bitcoind-sqlite=nativesql-experiment
+            args: backend=bitcoind dbbackend=sqlite nativesql=true tags=test_native_sql
           - name: bitcoind-postgres
             args: backend=bitcoind dbbackend=postgres
           - name: bitcoind-postgres-nativesql
             args: backend=bitcoind dbbackend=postgres nativesql=true
+          - name: bitcoind-postgres-nativesql-experiment
+            args: backend=bitcoind dbbackend=postgres nativesql=true tags=test_native_sql
     steps:
       - name: git checkout
         uses: actions/checkout@v4

config_builder.go

@@ -1046,23 +1046,13 @@ func (d *DefaultDatabaseBuilder) BuildDatabase(
 		)
 	}
 
-	graphStore, err := graphdb.NewKVStore(
+	kvGraphStore, err := graphdb.NewKVStore(
 		databaseBackends.GraphDB, graphDBOptions...,
 	)
 	if err != nil {
 		return nil, nil, err
 	}
 
-	dbs.GraphDB, err = graphdb.NewChannelGraph(graphStore, chanGraphOpts...)
-	if err != nil {
-		cleanUp()
-
-		err = fmt.Errorf("unable to open graph DB: %w", err)
-		d.logger.Error(err)
-
-		return nil, nil, err
-	}
-
 	dbOptions := []channeldb.OptionModifier{
 		channeldb.OptionDryRunMigration(cfg.DryRunMigration),
 		channeldb.OptionKeepFailedPaymentAttempts(
@@ -1096,6 +1086,8 @@ func (d *DefaultDatabaseBuilder) BuildDatabase(
 		return nil, nil, err
 	}
 
+	var graphStore graphdb.V1Store
+
 	// Instantiate a native SQL store if the flag is set.
 	if d.cfg.DB.UseNativeSQL {
 		migrations := sqldb.GetMigrations()
@@ -1108,7 +1100,7 @@ func (d *DefaultDatabaseBuilder) BuildDatabase(
 		// migration's version (7), it will be skipped permanently,
 		// regardless of the flag.
 		if !d.cfg.DB.SkipNativeSQLMigration {
-			migrationFn := func(tx *sqlc.Queries) error {
+			invoiceMigFn := func(tx *sqlc.Queries) error {
 				err := invoices.MigrateInvoicesToSQL(
 					ctx, dbs.ChanStateDB.Backend,
 					dbs.ChanStateDB, tx,
@@ -1130,11 +1122,21 @@ func (d *DefaultDatabaseBuilder) BuildDatabase(
 			// Make sure we attach the custom migration function to
 			// the correct migration version.
 			for i := 0; i < len(migrations); i++ {
-				if migrations[i].Version != invoiceMigration {
+				version := migrations[i].Version
+				if version == invoiceMigration {
+					migrations[i].MigrationFn = invoiceMigFn
+
+					continue
+				}
+
+				migFn, ok := getSQLMigration(
+					ctx, version, kvGraphStore,
+				)
+				if !ok {
 					continue
 				}
 
-				migrations[i].MigrationFn = migrationFn
+				migrations[i].MigrationFn = migFn
 			}
 		}
 
@@ -1154,17 +1156,27 @@ func (d *DefaultDatabaseBuilder) BuildDatabase(
 		// the base DB and transaction executor for the native SQL
 		// invoice store.
 		baseDB := dbs.NativeSQLStore.GetBaseDB()
-		executor := sqldb.NewTransactionExecutor(
+		invoiceExecutor := sqldb.NewTransactionExecutor(
 			baseDB, func(tx *sql.Tx) invoices.SQLInvoiceQueries {
 				return baseDB.WithTx(tx)
 			},
 		)
 
 		sqlInvoiceDB := invoices.NewSQLStore(
-			executor, clock.NewDefaultClock(),
+			invoiceExecutor, clock.NewDefaultClock(),
 		)
 
 		dbs.InvoiceDB = sqlInvoiceDB
+
+		graphStore, err = d.getGraphStore(
+			baseDB, kvGraphStore, graphDBOptions...,
+		)
+		if err != nil {
+			err = fmt.Errorf("unable to get graph store: %w", err)
+			d.logger.Error(err)
+
+			return nil, nil, err
+		}
 	} else {
 		// Check if the invoice bucket tombstone is set. If it is, we
 		// need to return and ask the user switch back to using the
@@ -1186,6 +1198,18 @@ func (d *DefaultDatabaseBuilder) BuildDatabase(
 		}
 
 		dbs.InvoiceDB = dbs.ChanStateDB
+
+		graphStore = kvGraphStore
+	}
+
+	dbs.GraphDB, err = graphdb.NewChannelGraph(graphStore, chanGraphOpts...)
+	if err != nil {
+		cleanUp()
+
+		err = fmt.Errorf("unable to open channel graph: %w", err)
+		d.logger.Error(err)
+
+		return nil, nil, err
 	}
 
 	// Wrap the watchtower client DB and make sure we clean up.

config_prod.go

@@ -0,0 +1,24 @@
+//go:build !test_native_sql
+
+package lnd
+
+import (
+	"context"
+
+	graphdb "github.com/lightningnetwork/lnd/graph/db"
+	"github.com/lightningnetwork/lnd/sqldb"
+	"github.com/lightningnetwork/lnd/sqldb/sqlc"
+)
+
+func getSQLMigration(ctx context.Context, version int,
+	kvGraphStore *graphdb.KVStore) (func(tx *sqlc.Queries) error, bool) {
+
+	return nil, false
+}
+
+func (d *DefaultDatabaseBuilder) getGraphStore(_ *sqldb.BaseDB,
+	kvGraphStore *graphdb.KVStore,
+	_ ...graphdb.StoreOptionModifier) (graphdb.V1Store, error) {
+
+	return kvGraphStore, nil
+}

config_test_native_sql.go

@@ -0,0 +1,53 @@
+//go:build test_native_sql
+
+package lnd
+
+import (
+	"context"
+	"database/sql"
+	"fmt"
+
+	graphdb "github.com/lightningnetwork/lnd/graph/db"
+	"github.com/lightningnetwork/lnd/sqldb"
+	"github.com/lightningnetwork/lnd/sqldb/sqlc"
+)
+
+const graphSQLMigration = 9
+
+func getSQLMigration(ctx context.Context, version int,
+	kvGraphStore *graphdb.KVStore) (func(tx *sqlc.Queries) error, bool) {
+
+	if version != graphSQLMigration {
+		return nil, false
+	}
+
+	return func(tx *sqlc.Queries) error {
+		err := graphdb.MigrateGraphToSQL(
+			ctx, kvGraphStore, tx,
+		)
+		if err != nil {
+			return fmt.Errorf("failed to migrate "+
+				"graph to SQL: %w", err)
+		}
+
+		return nil
+	}, true
+}
+
+func (d *DefaultDatabaseBuilder) getGraphStore(baseDB *sqldb.BaseDB,
+	_ *graphdb.KVStore,
+	opts ...graphdb.StoreOptionModifier) (graphdb.V1Store, error) {
+
+	graphExecutor := sqldb.NewTransactionExecutor(
+		baseDB, func(tx *sql.Tx) graphdb.SQLQueries {
+			return baseDB.WithTx(tx)
+		},
+	)
+
+	return graphdb.NewSQLStore(
+		&graphdb.SQLStoreConfig{
+			ChainHash: *d.cfg.ActiveNetParams.GenesisHash,
+		},
+		graphExecutor, opts...,
+	)
+}

sqldb/migrations_dev.go

@@ -1,4 +1,4 @@
-//go:build test_db_postgres || test_db_sqlite
+//go:build test_db_postgres || test_db_sqlite || test_native_sql
 
 package sqldb
 
@@ -8,4 +8,13 @@ var migrationAdditions = []MigrationConfig{
 		Version:       8,
 		SchemaVersion: 7,
 	},
+	{
+		Name:          "kv_graph_migration",
+		Version:       9,
+		SchemaVersion: 7,
+		// A migration function may be attached to this
+		// migration to migrate KV graph to the native SQL
+		// schema. This is optional and can be disabled by the
+		// user if necessary.
+	},
 }

sqldb/migrations_prod.go

@@ -1,4 +1,4 @@
-//go:build !test_db_postgres && !test_db_sqlite
+//go:build !test_db_postgres && !test_db_sqlite && !test_native_sql
 
 package sqldb