mirror of
https://github.com/lightninglabs/lightning-terminal.git
synced 2026-08-13 12:33:36 +02:00
session: use sqlcmig6 for kvdb to sql migration
This commit updates the session package to use the new `sqlcmig6` package for kvdb to SQL migration.
This commit is contained in:
Viktor Torstensson
parent
0cb4901749
commit
80dead031f
2 changed files with 219 additions and 30 deletions
|
|
@ -10,13 +10,17 @@ import (
|
|||
"sort"
|
||||
"time"
|
||||
|
||||
"github.com/btcsuite/btcd/btcec/v2"
|
||||
"github.com/davecgh/go-spew/spew"
|
||||
"github.com/lightninglabs/lightning-node-connect/mailbox"
|
||||
"github.com/lightninglabs/lightning-terminal/accounts"
|
||||
"github.com/lightninglabs/lightning-terminal/db/sqlc"
|
||||
s6 "github.com/lightninglabs/lightning-terminal/db/sqlcmig6"
|
||||
"github.com/lightningnetwork/lnd/fn"
|
||||
"github.com/lightningnetwork/lnd/sqldb/v2"
|
||||
"github.com/pmezard/go-difflib/difflib"
|
||||
"go.etcd.io/bbolt"
|
||||
"gopkg.in/macaroon-bakery.v2/bakery"
|
||||
"gopkg.in/macaroon.v2"
|
||||
)
|
||||
|
||||
var (
|
||||
|
|
@ -33,7 +37,7 @@ var (
|
|||
// NOTE: As sessions may contain linked accounts, the accounts sql migration
|
||||
// MUST be run prior to this migration.
|
||||
func MigrateSessionStoreToSQL(ctx context.Context, kvStore *bbolt.DB,
|
||||
tx SQLQueries) error {
|
||||
tx *s6.Queries) error {
|
||||
|
||||
log.Infof("Starting migration of the KV sessions store to SQL")
|
||||
|
||||
|
|
@ -167,8 +171,8 @@ func getBBoltSessions(db *bbolt.DB) ([]*Session, error) {
|
|||
// migrateSessionsToSQLAndValidate runs the migration for the passed sessions
|
||||
// from the KV database to the SQL database, and validates that the migrated
|
||||
// sessions match the original sessions.
|
||||
func migrateSessionsToSQLAndValidate(ctx context.Context,
|
||||
tx SQLQueries, kvSessions []*Session) error {
|
||||
func migrateSessionsToSQLAndValidate(ctx context.Context, tx *s6.Queries,
|
||||
kvSessions []*Session) error {
|
||||
|
||||
for _, kvSession := range kvSessions {
|
||||
err := migrateSingleSessionToSQL(ctx, tx, kvSession)
|
||||
|
|
@ -177,18 +181,9 @@ func migrateSessionsToSQLAndValidate(ctx context.Context,
|
|||
kvSession.ID, err)
|
||||
}
|
||||
|
||||
// Validate that the session was correctly migrated and matches
|
||||
// the original session in the kv store.
|
||||
sqlSess, err := tx.GetSessionByAlias(ctx, kvSession.ID[:])
|
||||
if err != nil {
|
||||
if errors.Is(err, sql.ErrNoRows) {
|
||||
err = ErrSessionNotFound
|
||||
}
|
||||
return fmt.Errorf("unable to get migrated session "+
|
||||
"from sql store: %w", err)
|
||||
}
|
||||
|
||||
migratedSession, err := unmarshalSession(ctx, tx, sqlSess)
|
||||
migratedSession, err := getAndUnmarshalSession(
|
||||
ctx, tx, kvSession.ID[:],
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to unmarshal migrated "+
|
||||
"session: %w", err)
|
||||
|
|
@ -224,12 +219,206 @@ func migrateSessionsToSQLAndValidate(ctx context.Context,
|
|||
return nil
|
||||
}
|
||||
|
||||
func getAndUnmarshalSession(ctx context.Context, tx *s6.Queries,
|
||||
legacyID []byte) (*Session, error) {
|
||||
|
||||
// Validate that the session was correctly migrated and matches
|
||||
// the original session in the kv store.
|
||||
sqlSess, err := tx.GetSessionByAlias(ctx, legacyID)
|
||||
if err != nil {
|
||||
if errors.Is(err, sql.ErrNoRows) {
|
||||
err = ErrSessionNotFound
|
||||
}
|
||||
|
||||
return nil, fmt.Errorf("unable to get migrated session "+
|
||||
"from sql store: %w", err)
|
||||
}
|
||||
|
||||
migratedSession, err := unmarshalMig6Session(ctx, tx, sqlSess)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to unmarshal migrated "+
|
||||
"session: %w", err)
|
||||
}
|
||||
|
||||
return migratedSession, nil
|
||||
}
|
||||
|
||||
func unmarshalMig6Session(ctx context.Context, db *s6.Queries,
|
||||
dbSess s6.Session) (*Session, error) {
|
||||
|
||||
var legacyGroupID ID
|
||||
if dbSess.GroupID.Valid {
|
||||
groupID, err := db.GetAliasBySessionID(
|
||||
ctx, dbSess.GroupID.Int64,
|
||||
)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to get legacy group "+
|
||||
"Alias: %v", err)
|
||||
}
|
||||
|
||||
legacyGroupID, err = IDFromBytes(groupID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to get legacy Alias: %v",
|
||||
err)
|
||||
}
|
||||
}
|
||||
|
||||
var acctAlias fn.Option[accounts.AccountID]
|
||||
if dbSess.AccountID.Valid {
|
||||
account, err := db.GetAccount(ctx, dbSess.AccountID.Int64)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to get account: %v", err)
|
||||
}
|
||||
|
||||
accountAlias, err := accounts.AccountIDFromInt64(account.Alias)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to get account ID: %v",
|
||||
err)
|
||||
}
|
||||
acctAlias = fn.Some(accountAlias)
|
||||
}
|
||||
|
||||
legacyID, err := IDFromBytes(dbSess.Alias)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to get legacy Alias: %v", err)
|
||||
}
|
||||
|
||||
var revokedAt time.Time
|
||||
if dbSess.RevokedAt.Valid {
|
||||
revokedAt = dbSess.RevokedAt.Time
|
||||
}
|
||||
|
||||
localPriv, localPub := btcec.PrivKeyFromBytes(dbSess.LocalPrivateKey)
|
||||
|
||||
var remotePub *btcec.PublicKey
|
||||
if len(dbSess.RemotePublicKey) != 0 {
|
||||
remotePub, err = btcec.ParsePubKey(dbSess.RemotePublicKey)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to parse remote "+
|
||||
"public key: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Get the macaroon permissions if they exist.
|
||||
perms, err := db.GetSessionMacaroonPermissions(ctx, dbSess.ID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to get macaroon "+
|
||||
"permissions: %v", err)
|
||||
}
|
||||
|
||||
// Get the macaroon caveats if they exist.
|
||||
caveats, err := db.GetSessionMacaroonCaveats(ctx, dbSess.ID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to get macaroon "+
|
||||
"caveats: %v", err)
|
||||
}
|
||||
|
||||
var macRecipe *MacaroonRecipe
|
||||
if perms != nil || caveats != nil {
|
||||
macRecipe = &MacaroonRecipe{
|
||||
Permissions: unmarshalMig6MacPerms(perms),
|
||||
Caveats: unmarshalMig6MacCaveats(caveats),
|
||||
}
|
||||
}
|
||||
|
||||
// Get the feature configs if they exist.
|
||||
featureConfigs, err := db.GetSessionFeatureConfigs(ctx, dbSess.ID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to get feature configs: %v", err)
|
||||
}
|
||||
|
||||
var featureCfgs *FeaturesConfig
|
||||
if featureConfigs != nil {
|
||||
featureCfgs = unmarshalMig6FeatureConfigs(featureConfigs)
|
||||
}
|
||||
|
||||
// Get the privacy flags if they exist.
|
||||
privacyFlags, err := db.GetSessionPrivacyFlags(ctx, dbSess.ID)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to get privacy flags: %v", err)
|
||||
}
|
||||
|
||||
var privFlags PrivacyFlags
|
||||
if privacyFlags != nil {
|
||||
privFlags = unmarshalMig6PrivacyFlags(privacyFlags)
|
||||
}
|
||||
|
||||
var pairingSecret [mailbox.NumPassphraseEntropyBytes]byte
|
||||
copy(pairingSecret[:], dbSess.PairingSecret)
|
||||
|
||||
return &Session{
|
||||
ID: legacyID,
|
||||
Label: dbSess.Label,
|
||||
State: State(dbSess.State),
|
||||
Type: Type(dbSess.Type),
|
||||
Expiry: dbSess.Expiry,
|
||||
CreatedAt: dbSess.CreatedAt,
|
||||
RevokedAt: revokedAt,
|
||||
ServerAddr: dbSess.ServerAddress,
|
||||
DevServer: dbSess.DevServer,
|
||||
MacaroonRootKey: uint64(dbSess.MacaroonRootKey),
|
||||
PairingSecret: pairingSecret,
|
||||
LocalPrivateKey: localPriv,
|
||||
LocalPublicKey: localPub,
|
||||
RemotePublicKey: remotePub,
|
||||
WithPrivacyMapper: dbSess.Privacy,
|
||||
GroupID: legacyGroupID,
|
||||
PrivacyFlags: privFlags,
|
||||
MacaroonRecipe: macRecipe,
|
||||
FeatureConfig: featureCfgs,
|
||||
AccountID: acctAlias,
|
||||
}, nil
|
||||
}
|
||||
|
||||
func unmarshalMig6MacPerms(dbPerms []s6.SessionMacaroonPermission) []bakery.Op {
|
||||
ops := make([]bakery.Op, len(dbPerms))
|
||||
for i, dbPerm := range dbPerms {
|
||||
ops[i] = bakery.Op{
|
||||
Entity: dbPerm.Entity,
|
||||
Action: dbPerm.Action,
|
||||
}
|
||||
}
|
||||
|
||||
return ops
|
||||
}
|
||||
|
||||
func unmarshalMig6MacCaveats(c []s6.SessionMacaroonCaveat) []macaroon.Caveat {
|
||||
caveats := make([]macaroon.Caveat, len(c))
|
||||
for i, dbCaveat := range c {
|
||||
caveats[i] = macaroon.Caveat{
|
||||
Id: dbCaveat.CaveatID,
|
||||
VerificationId: dbCaveat.VerificationID,
|
||||
Location: dbCaveat.Location.String,
|
||||
}
|
||||
}
|
||||
|
||||
return caveats
|
||||
}
|
||||
|
||||
func unmarshalMig6FeatureConfigs(fc []s6.SessionFeatureConfig) *FeaturesConfig {
|
||||
configs := make(FeaturesConfig, len(fc))
|
||||
for _, dbConfig := range fc {
|
||||
configs[dbConfig.FeatureName] = dbConfig.Config
|
||||
}
|
||||
|
||||
return &configs
|
||||
}
|
||||
|
||||
func unmarshalMig6PrivacyFlags(dbFlags []s6.SessionPrivacyFlag) PrivacyFlags {
|
||||
flags := make(PrivacyFlags, len(dbFlags))
|
||||
for i, dbFlag := range dbFlags {
|
||||
flags[i] = PrivacyFlag(dbFlag.Flag)
|
||||
}
|
||||
|
||||
return flags
|
||||
}
|
||||
|
||||
// migrateSingleSessionToSQL runs the migration for a single session from the
|
||||
// KV database to the SQL database. Note that if the session links to an
|
||||
// account, the linked accounts store MUST have been migrated before that
|
||||
// session is migrated.
|
||||
func migrateSingleSessionToSQL(ctx context.Context,
|
||||
tx SQLQueries, session *Session) error {
|
||||
func migrateSingleSessionToSQL(ctx context.Context, tx *s6.Queries,
|
||||
session *Session) error {
|
||||
|
||||
var (
|
||||
acctID sql.NullInt64
|
||||
|
|
@ -275,7 +464,7 @@ func migrateSingleSessionToSQL(ctx context.Context,
|
|||
}
|
||||
|
||||
// Proceed to insert the session into the sql db.
|
||||
sqlId, err := tx.InsertSession(ctx, sqlc.InsertSessionParams{
|
||||
sqlId, err := tx.InsertSession(ctx, s6.InsertSessionParams{
|
||||
Alias: session.ID[:],
|
||||
Label: session.Label,
|
||||
State: int16(session.State),
|
||||
|
|
@ -301,7 +490,7 @@ func migrateSingleSessionToSQL(ctx context.Context,
|
|||
// has been created.
|
||||
if !session.RevokedAt.IsZero() {
|
||||
err = tx.SetSessionRevokedAt(
|
||||
ctx, sqlc.SetSessionRevokedAtParams{
|
||||
ctx, s6.SetSessionRevokedAtParams{
|
||||
ID: sqlId,
|
||||
RevokedAt: sqldb.SQLTime(
|
||||
session.RevokedAt.UTC(),
|
||||
|
|
@ -327,7 +516,7 @@ func migrateSingleSessionToSQL(ctx context.Context,
|
|||
}
|
||||
|
||||
// Now lets set the group ID for the session.
|
||||
err = tx.SetSessionGroupID(ctx, sqlc.SetSessionGroupIDParams{
|
||||
err = tx.SetSessionGroupID(ctx, s6.SetSessionGroupIDParams{
|
||||
ID: sqlId,
|
||||
GroupID: sqldb.SQLInt64(groupID),
|
||||
})
|
||||
|
|
@ -341,7 +530,7 @@ func migrateSingleSessionToSQL(ctx context.Context,
|
|||
// We start by inserting the macaroon permissions.
|
||||
for _, sessionPerm := range session.MacaroonRecipe.Permissions {
|
||||
err = tx.InsertSessionMacaroonPermission(
|
||||
ctx, sqlc.InsertSessionMacaroonPermissionParams{
|
||||
ctx, s6.InsertSessionMacaroonPermissionParams{
|
||||
SessionID: sqlId,
|
||||
Entity: sessionPerm.Entity,
|
||||
Action: sessionPerm.Action,
|
||||
|
|
@ -355,7 +544,7 @@ func migrateSingleSessionToSQL(ctx context.Context,
|
|||
// Next we insert the macaroon caveats.
|
||||
for _, caveat := range session.MacaroonRecipe.Caveats {
|
||||
err = tx.InsertSessionMacaroonCaveat(
|
||||
ctx, sqlc.InsertSessionMacaroonCaveatParams{
|
||||
ctx, s6.InsertSessionMacaroonCaveatParams{
|
||||
SessionID: sqlId,
|
||||
CaveatID: caveat.Id,
|
||||
VerificationID: caveat.VerificationId,
|
||||
|
|
@ -374,7 +563,7 @@ func migrateSingleSessionToSQL(ctx context.Context,
|
|||
if session.FeatureConfig != nil {
|
||||
for featureName, config := range *session.FeatureConfig {
|
||||
err = tx.InsertSessionFeatureConfig(
|
||||
ctx, sqlc.InsertSessionFeatureConfigParams{
|
||||
ctx, s6.InsertSessionFeatureConfigParams{
|
||||
SessionID: sqlId,
|
||||
FeatureName: featureName,
|
||||
Config: config,
|
||||
|
|
@ -389,7 +578,7 @@ func migrateSingleSessionToSQL(ctx context.Context,
|
|||
// Finally we insert the privacy flags.
|
||||
for _, privacyFlag := range session.PrivacyFlags {
|
||||
err = tx.InsertSessionPrivacyFlag(
|
||||
ctx, sqlc.InsertSessionPrivacyFlagParams{
|
||||
ctx, s6.InsertSessionPrivacyFlagParams{
|
||||
SessionID: sqlId,
|
||||
Flag: int32(privacyFlag),
|
||||
},
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ import (
|
|||
"time"
|
||||
|
||||
"github.com/lightninglabs/lightning-terminal/accounts"
|
||||
"github.com/lightninglabs/lightning-terminal/db/sqlc"
|
||||
"github.com/lightninglabs/lightning-terminal/db/sqlcmig6"
|
||||
"github.com/lightningnetwork/lnd/clock"
|
||||
"github.com/lightningnetwork/lnd/lnwire"
|
||||
"github.com/lightningnetwork/lnd/macaroons"
|
||||
|
|
@ -37,7 +37,7 @@ func TestSessionsStoreMigration(t *testing.T) {
|
|||
}
|
||||
|
||||
makeSQLDB := func(t *testing.T, acctStore accounts.Store) (*SQLStore,
|
||||
*sqlQueriesExecutor[SQLQueries]) {
|
||||
*sqlcmig6.TxExecutor) {
|
||||
|
||||
// Create a sql store with a linked account store.
|
||||
testDBStore := NewTestDBWithAccounts(t, clock, acctStore)
|
||||
|
|
@ -47,9 +47,9 @@ func TestSessionsStoreMigration(t *testing.T) {
|
|||
|
||||
baseDB := store.BaseDB
|
||||
|
||||
queries := sqlc.NewForType(baseDB, baseDB.BackendType)
|
||||
queries := sqlcmig6.NewForType(baseDB, baseDB.BackendType)
|
||||
|
||||
return store, newSQLQueriesExecutor(baseDB, queries)
|
||||
return store, sqlcmig6.NewTxExecutor(baseDB, queries)
|
||||
}
|
||||
|
||||
// assertMigrationResults asserts that the sql store contains the
|
||||
|
|
@ -588,7 +588,7 @@ func TestSessionsStoreMigration(t *testing.T) {
|
|||
|
||||
err = txEx.ExecTx(
|
||||
ctx, sqldb.WriteTxOpt(),
|
||||
func(tx SQLQueries) error {
|
||||
func(tx *sqlcmig6.Queries) error {
|
||||
return MigrateSessionStoreToSQL(
|
||||
ctx, kvStore.DB, tx,
|
||||
)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue