[sql-46] trigger kvdb to sql migration using sqldb/v2

.golangci.yml

@@ -61,3 +61,9 @@ issues:
         - unused
         - deadcode
         - varcheck
+    # As the db/sqlcmig6 package has been copied from sqlc generated code,
+    # but isn't marked as code generated by sqlc, the code line length in the
+    # package will often exceed the lll limit.
+    - path: db/sqlcmig6/.*
+      linters:
+      - lll

accounts/service.go

@@ -361,7 +361,7 @@ func (s *InterceptorService) CreditAccount(ctx context.Context,
 		return nil, ErrAccountServiceDisabled
 	}
 
-	// Credit the account in the db.
+	// Credit the account in the DB.
 	err := s.store.CreditAccount(ctx, accountID, amount)
 	if err != nil {
 		return nil, fmt.Errorf("unable to credit account: %w", err)
@@ -386,7 +386,7 @@ func (s *InterceptorService) DebitAccount(ctx context.Context,
 		return nil, ErrAccountServiceDisabled
 	}
 
-	// Debit the account in the db.
+	// Debit the account in the DB.
 	err := s.store.DebitAccount(ctx, accountID, amount)
 	if err != nil {
 		return nil, fmt.Errorf("unable to debit account: %w", err)

accounts/service_test.go

@@ -246,7 +246,7 @@ func TestAccountService(t *testing.T) {
 
 			// Ensure that the service was started successfully and
 			// still running though, despite the closing of the
-			// db store.
+			// DB store.
 			require.True(t, s.IsRunning())
 
 			// Now let's send the invoice update, which should fail.

accounts/sql_migration.go

@@ -11,8 +11,11 @@ import (
 	"time"
 
 	"github.com/davecgh/go-spew/spew"
-	"github.com/lightninglabs/lightning-terminal/db/sqlc"
+	"github.com/lightninglabs/lightning-terminal/db/sqlcmig6"
 	"github.com/lightningnetwork/lnd/kvdb"
+	"github.com/lightningnetwork/lnd/lnrpc"
+	"github.com/lightningnetwork/lnd/lntypes"
+	"github.com/lightningnetwork/lnd/lnwire"
 	"github.com/pmezard/go-difflib/difflib"
 )
 
@@ -27,7 +30,7 @@ var (
 // the KV database to the SQL database. The migration is done in a single
 // transaction to ensure that all accounts are migrated or none at all.
 func MigrateAccountStoreToSQL(ctx context.Context, kvStore kvdb.Backend,
-	tx SQLQueries) error {
+	tx *sqlcmig6.Queries) error {
 
 	log.Infof("Starting migration of the KV accounts store to SQL")
 
@@ -50,7 +53,7 @@ func MigrateAccountStoreToSQL(ctx context.Context, kvStore kvdb.Backend,
 // to the SQL database. The migration is done in a single transaction to ensure
 // that all accounts are migrated or none at all.
 func migrateAccountsToSQL(ctx context.Context, kvStore kvdb.Backend,
-	tx SQLQueries) error {
+	tx *sqlcmig6.Queries) error {
 
 	log.Infof("Starting migration of accounts from KV to SQL")
 
@@ -68,7 +71,7 @@ func migrateAccountsToSQL(ctx context.Context, kvStore kvdb.Backend,
 				kvAccount.ID, err)
 		}
 
-		migratedAccount, err := getAndMarshalAccount(
+		migratedAccount, err := getAndMarshalMig6Account(
 			ctx, tx, migratedAccountID,
 		)
 		if err != nil {
@@ -151,17 +154,79 @@ func getBBoltAccounts(db kvdb.Backend) ([]*OffChainBalanceAccount, error) {
 	return accounts, nil
 }
 
+// getAndMarshalAccount retrieves the account with the given ID. If the account
+// cannot be found, then ErrAccNotFound is returned.
+func getAndMarshalMig6Account(ctx context.Context, db *sqlcmig6.Queries,
+	id int64) (*OffChainBalanceAccount, error) {
+
+	dbAcct, err := db.GetAccount(ctx, id)
+	if errors.Is(err, sql.ErrNoRows) {
+		return nil, ErrAccNotFound
+	} else if err != nil {
+		return nil, err
+	}
+
+	return marshalDBMig6Account(ctx, db, dbAcct)
+}
+
+func marshalDBMig6Account(ctx context.Context, db *sqlcmig6.Queries,
+	dbAcct sqlcmig6.Account) (*OffChainBalanceAccount, error) {
+
+	alias, err := AccountIDFromInt64(dbAcct.Alias)
+	if err != nil {
+		return nil, err
+	}
+
+	account := &OffChainBalanceAccount{
+		ID:             alias,
+		Type:           AccountType(dbAcct.Type),
+		InitialBalance: lnwire.MilliSatoshi(dbAcct.InitialBalanceMsat),
+		CurrentBalance: dbAcct.CurrentBalanceMsat,
+		LastUpdate:     dbAcct.LastUpdated.UTC(),
+		ExpirationDate: dbAcct.Expiration.UTC(),
+		Invoices:       make(AccountInvoices),
+		Payments:       make(AccountPayments),
+		Label:          dbAcct.Label.String,
+	}
+
+	invoices, err := db.ListAccountInvoices(ctx, dbAcct.ID)
+	if err != nil {
+		return nil, err
+	}
+	for _, invoice := range invoices {
+		var hash lntypes.Hash
+		copy(hash[:], invoice.Hash)
+		account.Invoices[hash] = struct{}{}
+	}
+
+	payments, err := db.ListAccountPayments(ctx, dbAcct.ID)
+	if err != nil {
+		return nil, err
+	}
+
+	for _, payment := range payments {
+		var hash lntypes.Hash
+		copy(hash[:], payment.Hash)
+		account.Payments[hash] = &PaymentEntry{
+			Status:     lnrpc.Payment_PaymentStatus(payment.Status),
+			FullAmount: lnwire.MilliSatoshi(payment.FullAmountMsat),
+		}
+	}
+
+	return account, nil
+}
+
 // migrateSingleAccountToSQL runs the migration for a single account from the
 // KV database to the SQL database.
 func migrateSingleAccountToSQL(ctx context.Context,
-	tx SQLQueries, account *OffChainBalanceAccount) (int64, error) {
+	tx *sqlcmig6.Queries, account *OffChainBalanceAccount) (int64, error) {
 
 	accountAlias, err := account.ID.ToInt64()
 	if err != nil {
 		return 0, err
 	}
 
-	insertAccountParams := sqlc.InsertAccountParams{
+	insertAccountParams := sqlcmig6.InsertAccountParams{
 		Type:               int16(account.Type),
 		InitialBalanceMsat: int64(account.InitialBalance),
 		CurrentBalanceMsat: account.CurrentBalance,
@@ -180,7 +245,7 @@ func migrateSingleAccountToSQL(ctx context.Context,
 	}
 
 	for hash := range account.Invoices {
-		addInvoiceParams := sqlc.AddAccountInvoiceParams{
+		addInvoiceParams := sqlcmig6.AddAccountInvoiceParams{
 			AccountID: sqlId,
 			Hash:      hash[:],
 		}
@@ -192,7 +257,7 @@ func migrateSingleAccountToSQL(ctx context.Context,
 	}
 
 	for hash, paymentEntry := range account.Payments {
-		upsertPaymentParams := sqlc.UpsertAccountPaymentParams{
+		upsertPaymentParams := sqlcmig6.UpsertAccountPaymentParams{
 			AccountID:      sqlId,
 			Hash:           hash[:],
 			Status:         int16(paymentEntry.Status),
@@ -211,7 +276,7 @@ func migrateSingleAccountToSQL(ctx context.Context,
 // migrateAccountsIndicesToSQL runs the migration for the account indices from
 // the KV database to the SQL database.
 func migrateAccountsIndicesToSQL(ctx context.Context, kvStore kvdb.Backend,
-	tx SQLQueries) error {
+	tx *sqlcmig6.Queries) error {
 
 	log.Infof("Starting migration of accounts indices from KV to SQL")
 
@@ -233,7 +298,7 @@ func migrateAccountsIndicesToSQL(ctx context.Context, kvStore kvdb.Backend,
 			settleIndexName, settleIndex)
 	}
 
-	setAddIndexParams := sqlc.SetAccountIndexParams{
+	setAddIndexParams := sqlcmig6.SetAccountIndexParams{
 		Name:  addIndexName,
 		Value: int64(addIndex),
 	}
@@ -243,7 +308,7 @@ func migrateAccountsIndicesToSQL(ctx context.Context, kvStore kvdb.Backend,
 		return err
 	}
 
-	setSettleIndexParams := sqlc.SetAccountIndexParams{
+	setSettleIndexParams := sqlcmig6.SetAccountIndexParams{
 		Name:  settleIndexName,
 		Value: int64(settleIndex),
 	}

accounts/sql_migration_test.go

@@ -2,18 +2,17 @@ package accounts
 
 import (
 	"context"
-	"database/sql"
 	"fmt"
 	"testing"
 	"time"
 
-	"github.com/lightninglabs/lightning-terminal/db"
+	"github.com/lightninglabs/lightning-terminal/db/sqlcmig6"
 	"github.com/lightningnetwork/lnd/clock"
 	"github.com/lightningnetwork/lnd/fn"
 	"github.com/lightningnetwork/lnd/lnrpc"
 	"github.com/lightningnetwork/lnd/lntypes"
 	"github.com/lightningnetwork/lnd/lnwire"
-	"github.com/lightningnetwork/lnd/sqldb"
+	"github.com/lightningnetwork/lnd/sqldb/v2"
 	"github.com/stretchr/testify/require"
 	"golang.org/x/exp/rand"
 	"pgregory.net/rapid"
@@ -36,7 +35,7 @@ func TestAccountStoreMigration(t *testing.T) {
 	}
 
 	makeSQLDB := func(t *testing.T) (*SQLStore,
-		*db.TransactionExecutor[SQLQueries]) {
+		*sqlcmig6.TxExecutor[*sqlcmig6.Queries]) {
 
 		testDBStore := NewTestDB(t, clock)
 
@@ -45,13 +44,9 @@ func TestAccountStoreMigration(t *testing.T) {
 
 		baseDB := store.BaseDB
 
-		genericExecutor := db.NewTransactionExecutor(
-			baseDB, func(tx *sql.Tx) SQLQueries {
-				return baseDB.WithTx(tx)
-			},
-		)
+		queries := sqlcmig6.NewForType(baseDB, baseDB.BackendType)
 
-		return store, genericExecutor
+		return store, sqlcmig6.NewTxExecutor(baseDB, queries)
 	}
 
 	assertMigrationResults := func(t *testing.T, sqlStore *SQLStore,
@@ -306,7 +301,7 @@ func TestAccountStoreMigration(t *testing.T) {
 			)
 			require.NoError(t, err)
 			t.Cleanup(func() {
-				require.NoError(t, kvStore.db.Close())
+				require.NoError(t, kvStore.DB.Close())
 			})
 
 			// Populate the kv store.
@@ -339,11 +334,11 @@ func TestAccountStoreMigration(t *testing.T) {
 			// Perform the migration.
 			err = txEx.ExecTx(
 				ctx, sqldb.WriteTxOpt(),
-				func(tx SQLQueries) error {
+				func(tx *sqlcmig6.Queries) error {
 					return MigrateAccountStoreToSQL(
-						ctx, kvStore.db, tx,
+						ctx, kvStore.DB, tx,
 					)
-				},
+				}, sqldb.NoOpReset,
 			)
 			require.NoError(t, err)
 
@@ -445,7 +440,7 @@ func rapidRandomizeAccounts(t *testing.T, kvStore *BoltStore) {
 		acct := makeAccountGen().Draw(t, "account")
 
 		// Then proceed to insert the account with its invoices and
-		// payments into the db
+		// payments into the DB
 		newAcct, err := kvStore.NewAccount(
 			ctx, acct.balance, acct.expiry, acct.label,
 		)

accounts/store_kvdb.go

@@ -24,7 +24,7 @@ import (
 const (
 	// DBFilename is the filename within the data directory which contains
 	// the macaroon stores.
-	DBFilename = "accounts.db"
+	DBFilename = "accounts.DB"
 
 	// dbPathPermission is the default permission the account database
 	// directory is created with (if it does not exist).
@@ -60,7 +60,7 @@ var (
 
 // BoltStore wraps the bolt DB that stores all accounts and their balances.
 type BoltStore struct {
-	db    kvdb.Backend
+	DB    kvdb.Backend
 	clock clock.Clock
 }
 
@@ -101,7 +101,7 @@ func NewBoltStore(dir, fileName string, clock clock.Clock) (*BoltStore, error) {
 
 	// Return the DB wrapped in a BoltStore object.
 	return &BoltStore{
-		db:    db,
+		DB:    db,
 		clock: clock,
 	}, nil
 }
@@ -110,7 +110,7 @@ func NewBoltStore(dir, fileName string, clock clock.Clock) (*BoltStore, error) {
 //
 // NOTE: This is part of the Store interface.
 func (s *BoltStore) Close() error {
-	return s.db.Close()
+	return s.DB.Close()
 }
 
 // NewAccount creates a new OffChainBalanceAccount with the given balance and a
@@ -162,7 +162,7 @@ func (s *BoltStore) NewAccount(ctx context.Context, balance lnwire.MilliSatoshi,
 
 	// Try storing the account in the account database, so we can keep track
 	// of its balance.
-	err := s.db.Update(func(tx walletdb.ReadWriteTx) error {
+	err := s.DB.Update(func(tx walletdb.ReadWriteTx) error {
 		bucket := tx.ReadWriteBucket(accountBucketName)
 		if bucket == nil {
 			return ErrAccountBucketNotFound
@@ -364,7 +364,7 @@ func (s *BoltStore) DeleteAccountPayment(_ context.Context, id AccountID,
 func (s *BoltStore) updateAccount(id AccountID,
 	updateFn func(*OffChainBalanceAccount) error) error {
 
-	return s.db.Update(func(tx kvdb.RwTx) error {
+	return s.DB.Update(func(tx kvdb.RwTx) error {
 		bucket := tx.ReadWriteBucket(accountBucketName)
 		if bucket == nil {
 			return ErrAccountBucketNotFound
@@ -451,7 +451,7 @@ func (s *BoltStore) Account(_ context.Context, id AccountID) (
 	// Try looking up and reading the account by its ID from the local
 	// bolt DB.
 	var accountBinary []byte
-	err := s.db.View(func(tx kvdb.RTx) error {
+	err := s.DB.View(func(tx kvdb.RTx) error {
 		bucket := tx.ReadBucket(accountBucketName)
 		if bucket == nil {
 			return ErrAccountBucketNotFound
@@ -487,7 +487,7 @@ func (s *BoltStore) Accounts(_ context.Context) ([]*OffChainBalanceAccount,
 	error) {
 
 	var accounts []*OffChainBalanceAccount
-	err := s.db.View(func(tx kvdb.RTx) error {
+	err := s.DB.View(func(tx kvdb.RTx) error {
 		// This function will be called in the ForEach and receive
 		// the key and value of each account in the DB. The key, which
 		// is also the ID is not used because it is also marshaled into
@@ -531,7 +531,7 @@ func (s *BoltStore) Accounts(_ context.Context) ([]*OffChainBalanceAccount,
 //
 // NOTE: This is part of the Store interface.
 func (s *BoltStore) RemoveAccount(_ context.Context, id AccountID) error {
-	return s.db.Update(func(tx kvdb.RwTx) error {
+	return s.DB.Update(func(tx kvdb.RwTx) error {
 		bucket := tx.ReadWriteBucket(accountBucketName)
 		if bucket == nil {
 			return ErrAccountBucketNotFound
@@ -554,7 +554,7 @@ func (s *BoltStore) LastIndexes(_ context.Context) (uint64, uint64, error) {
 	var (
 		addValue, settleValue []byte
 	)
-	err := s.db.View(func(tx kvdb.RTx) error {
+	err := s.DB.View(func(tx kvdb.RTx) error {
 		bucket := tx.ReadBucket(accountBucketName)
 		if bucket == nil {
 			return ErrAccountBucketNotFound
@@ -592,7 +592,7 @@ func (s *BoltStore) StoreLastIndexes(_ context.Context, addIndex,
 	byteOrder.PutUint64(addValue, addIndex)
 	byteOrder.PutUint64(settleValue, settleIndex)
 
-	return s.db.Update(func(tx kvdb.RwTx) error {
+	return s.DB.Update(func(tx kvdb.RwTx) error {
 		bucket := tx.ReadWriteBucket(accountBucketName)
 		if bucket == nil {
 			return ErrAccountBucketNotFound