multi: plug in sessions SQL DB

Let LiTd support a SQL db for the sessions store under the `dev` build
tag. This can be used via itests.

Author: ellemouton

config_dev.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/lightninglabs/lightning-terminal/accounts"
 	"github.com/lightninglabs/lightning-terminal/db"
+	"github.com/lightninglabs/lightning-terminal/session"
 	"github.com/lightningnetwork/lnd/clock"
 )
 
@@ -80,14 +81,19 @@ func defaultDevConfig() *DevConfig {
 	}
 }
 
-// NewAccountStore creates a new account store based on the chosen database
-// backend.
-func NewAccountStore(cfg *Config, clock clock.Clock) (accounts.Store, error) {
+// NewStores creates a new stores instance based on the chosen database backend.
+func NewStores(cfg *Config, clock clock.Clock) (*stores, error) {
+	var (
+		networkDir = filepath.Join(cfg.LitDir, cfg.Network)
+		acctStore  accounts.Store
+		sessStore  session.Store
+		closeFn    func() error
+	)
+
 	switch cfg.DatabaseBackend {
 	case DatabaseBackendSqlite:
 		// Before we initialize the SQLite store, we'll make sure that
 		// the directory where we will store the database file exists.
-		networkDir := filepath.Join(cfg.LitDir, cfg.Network)
 		err := makeDirectories(networkDir)
 		if err != nil {
 			return nil, err
@@ -98,20 +104,57 @@ func NewAccountStore(cfg *Config, clock clock.Clock) (accounts.Store, error) {
 			return nil, err
 		}
 
-		return accounts.NewSQLStore(sqlStore.BaseDB, clock), nil
+		acctStore = accounts.NewSQLStore(sqlStore.BaseDB, clock)
+		sessStore = session.NewSQLStore(sqlStore.BaseDB, clock)
+		closeFn = sqlStore.BaseDB.Close
 
 	case DatabaseBackendPostgres:
 		sqlStore, err := db.NewPostgresStore(cfg.Postgres)
 		if err != nil {
 			return nil, err
 		}
 
-		return accounts.NewSQLStore(sqlStore.BaseDB, clock), nil
+		acctStore = accounts.NewSQLStore(sqlStore.BaseDB, clock)
+		sessStore = session.NewSQLStore(sqlStore.BaseDB, clock)
+		closeFn = sqlStore.BaseDB.Close
 
 	default:
-		return accounts.NewBoltStore(
+		accountStore, err := accounts.NewBoltStore(
 			filepath.Dir(cfg.MacaroonPath), accounts.DBFilename,
 			clock,
 		)
+		if err != nil {
+			return nil, err
+		}
+
+		sessionStore, err := session.NewDB(
+			networkDir, session.DBFilename, clock, accountStore,
+		)
+		if err != nil {
+			return nil, err
+		}
+
+		acctStore = accountStore
+		sessStore = sessionStore
+		closeFn = func() error {
+			var returnErr error
+			err = accountStore.Close()
+			if err != nil {
+				returnErr = err
+			}
+
+			err = sessionStore.Close()
+			if err != nil {
+				returnErr = err
+			}
+
+			return returnErr
+		}
 	}
+
+	return &stores{
+		accounts: acctStore,
+		sessions: sessStore,
+		close:    closeFn,
+	}, nil
 }

config_prod.go

@@ -3,9 +3,11 @@
 package terminal
 
 import (
+	"fmt"
 	"path/filepath"
 
 	"github.com/lightninglabs/lightning-terminal/accounts"
+	"github.com/lightninglabs/lightning-terminal/session"
 	"github.com/lightningnetwork/lnd/clock"
 )
 
@@ -24,10 +26,41 @@ func (c *DevConfig) Validate(_, _ string) error {
 	return nil
 }
 
-// NewAccountStore creates a new account store using the default Bolt backend
-// since in production, this is the only backend supported currently.
-func NewAccountStore(cfg *Config, clock clock.Clock) (accounts.Store, error) {
-	return accounts.NewBoltStore(
+// NewStores creates a new instance of the stores struct using the default Bolt
+// backend since in production, this is currently the only backend supported.
+func NewStores(cfg *Config, clock clock.Clock) (*stores, error) {
+	networkDir := filepath.Join(cfg.LitDir, cfg.Network)
+
+	acctStore, err := accounts.NewBoltStore(
 		filepath.Dir(cfg.MacaroonPath), accounts.DBFilename, clock,
 	)
+	if err != nil {
+		return nil, err
+	}
+
+	sessStore, err := session.NewDB(
+		networkDir, session.DBFilename, clock, acctStore,
+	)
+	if err != nil {
+		return nil, fmt.Errorf("error creating session BoltStore: %v",
+			err)
+	}
+
+	return &stores{
+		accounts: acctStore,
+		sessions: sessStore,
+		close: func() error {
+			var returnErr error
+			if err := acctStore.Close(); err != nil {
+				returnErr = fmt.Errorf("error closing "+
+					"account store: %v", err)
+			}
+			if err := sessStore.Close(); err != nil {
+				returnErr = fmt.Errorf("error closing "+
+					"session store: %v", err)
+			}
+
+			return returnErr
+		},
+	}, nil
 }

terminal.go

@@ -216,14 +216,14 @@ type LightningTerminal struct {
 	middleware        *mid.Manager
 	middlewareStarted bool
 
-	accountsStore         accounts.Store
 	accountService        *accounts.InterceptorService
 	accountServiceStarted bool
 
 	accountRpcServer *accounts.RPCServer
 
+	stores *stores
+
 	firewallDB *firewalldb.DB
-	sessionDB  *session.BoltStore
 
 	restHandler http.Handler
 	restCancel  func()
@@ -236,6 +236,16 @@ func New() *LightningTerminal {
 	}
 }
 
+// stores holds a collection of the DB stores that are used by LiT.
+type stores struct {
+	accounts accounts.Store
+	sessions session.Store
+
+	// close is a callback that can be used to close all the stores in the
+	// stores struct.
+	close func() error
+}
+
 // Run starts everything and then blocks until either the application is shut
 // down or a critical error happens.
 func (g *LightningTerminal) Run(ctx context.Context) error {
@@ -421,14 +431,13 @@ func (g *LightningTerminal) start(ctx context.Context) error {
 		return fmt.Errorf("could not create network directory: %v", err)
 	}
 
-	clock := clock.NewDefaultClock()
-	g.accountsStore, err = NewAccountStore(g.cfg, clock)
+	g.stores, err = NewStores(g.cfg, clock.NewDefaultClock())
 	if err != nil {
-		return fmt.Errorf("error creating accounts store: %w", err)
+		return fmt.Errorf("could not create stores: %v", err)
 	}
 
 	g.accountService, err = accounts.NewService(
-		g.accountsStore, accountServiceErrCallback,
+		g.stores.accounts, accountServiceErrCallback,
 	)
 	if err != nil {
 		return fmt.Errorf("error creating account service: %v", err)
@@ -448,16 +457,8 @@ func (g *LightningTerminal) start(ctx context.Context) error {
 
 	g.ruleMgrs = rules.NewRuleManagerSet()
 
-	// Create an instance of the local Terminal Connect session store DB.
-	g.sessionDB, err = session.NewDB(
-		networkDir, session.DBFilename, clock, g.accountsStore,
-	)
-	if err != nil {
-		return fmt.Errorf("error creating session DB: %v", err)
-	}
-
 	g.firewallDB, err = firewalldb.NewDB(
-		networkDir, firewalldb.DBFilename, g.sessionDB,
+		networkDir, firewalldb.DBFilename, g.stores.sessions,
 	)
 	if err != nil {
 		return fmt.Errorf("error creating firewall DB: %v", err)
@@ -493,7 +494,7 @@ func (g *LightningTerminal) start(ctx context.Context) error {
 	}
 
 	g.sessionRpcServer, err = newSessionRPCServer(&sessionRpcServerConfig{
-		db:        g.sessionDB,
+		db:        g.stores.sessions,
 		basicAuth: g.rpcProxy.basicAuth,
 		grpcOptions: []grpc.ServerOption{
 			grpc.CustomCodec(grpcProxy.Codec()), // nolint: staticcheck,
@@ -1086,7 +1087,7 @@ func (g *LightningTerminal) startInternalSubServers(ctx context.Context,
 
 	privacyMapper := firewall.NewPrivacyMapper(
 		g.firewallDB.PrivacyDB, firewall.CryptoRandIntn,
-		g.sessionDB,
+		g.stores.sessions,
 	)
 
 	mw := []mid.RequestInterceptor{
@@ -1097,7 +1098,7 @@ func (g *LightningTerminal) startInternalSubServers(ctx context.Context,
 
 	if !g.cfg.Autopilot.Disable {
 		ruleEnforcer := firewall.NewRuleEnforcer(
-			g.firewallDB, g.firewallDB, g.sessionDB,
+			g.firewallDB, g.firewallDB, g.stores.sessions,
 			g.autopilotClient.ListFeaturePerms,
 			g.permsMgr, g.lndClient.NodePubkey,
 			g.lndClient.Router,
@@ -1436,14 +1437,6 @@ func (g *LightningTerminal) shutdownSubServers() error {
 		}
 	}
 
-	if g.accountsStore != nil {
-		err = g.accountsStore.Close()
-		if err != nil {
-			log.Errorf("Error closing accounts store: %v", err)
-			returnErr = err
-		}
-	}
-
 	if g.middlewareStarted {
 		g.middleware.Stop()
 	}
@@ -1462,9 +1455,10 @@ func (g *LightningTerminal) shutdownSubServers() error {
 		}
 	}
 
-	if g.sessionDB != nil {
-		if err := g.sessionDB.Close(); err != nil {
-			log.Errorf("Error closing session DB: %v", err)
+	if g.stores != nil {
+		err = g.stores.close()
+		if err != nil {
+			log.Errorf("Error closing stores: %v", err)
 			returnErr = err
 		}
 	}