session: add a clock to the DB

Author: ellemouton

session/kvdb_store.go

@@ -10,6 +10,7 @@ import (
 	"time"
 
 	"github.com/btcsuite/btcd/btcec/v2"
+	"github.com/lightningnetwork/lnd/clock"
 	"go.etcd.io/bbolt"
 	"gopkg.in/macaroon-bakery.v2/bakery"
 	"gopkg.in/macaroon.v2"
@@ -79,13 +80,15 @@ const (
 // BoltStore is a bolt-backed persistent store.
 type BoltStore struct {
 	*bbolt.DB
+
+	clock clock.Clock
 }
 
 // A compile-time check to ensure that BoltStore implements the Store interface.
 var _ Store = (*BoltStore)(nil)
 
 // NewDB creates a new bolt database that can be found at the given directory.
-func NewDB(dir, fileName string) (*BoltStore, error) {
+func NewDB(dir, fileName string, clock clock.Clock) (*BoltStore, error) {
 	firstInit := false
 	path := filepath.Join(dir, fileName)
 
@@ -108,7 +111,10 @@ func NewDB(dir, fileName string) (*BoltStore, error) {
 		return nil, err
 	}
 
-	return &BoltStore{DB: db}, nil
+	return &BoltStore{
+		DB:    db,
+		clock: clock,
+	}, nil
 }
 
 // fileExists reports whether the named file or directory exists.

session/store_test.go

@@ -6,14 +6,17 @@ import (
 	"time"
 
 	"github.com/btcsuite/btcd/btcec/v2"
+	"github.com/lightningnetwork/lnd/clock"
 	"github.com/stretchr/testify/require"
 )
 
+var testTime = time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC)
+
 // TestBasicSessionStore tests the basic getters and setters of the session
 // store.
 func TestBasicSessionStore(t *testing.T) {
 	// Set up a new DB.
-	db, err := NewDB(t.TempDir(), "test.db")
+	db, err := NewDB(t.TempDir(), "test.db", clock.NewTestClock(testTime))
 	require.NoError(t, err)
 	t.Cleanup(func() {
 		_ = db.Close()
@@ -89,7 +92,7 @@ func TestBasicSessionStore(t *testing.T) {
 // TestLinkingSessions tests that session linking works as expected.
 func TestLinkingSessions(t *testing.T) {
 	// Set up a new DB.
-	db, err := NewDB(t.TempDir(), "test.db")
+	db, err := NewDB(t.TempDir(), "test.db", clock.NewTestClock(testTime))
 	require.NoError(t, err)
 	t.Cleanup(func() {
 		_ = db.Close()
@@ -125,7 +128,7 @@ func TestLinkingSessions(t *testing.T) {
 // of the GetGroupID and GetSessionIDs methods.
 func TestLinkedSessions(t *testing.T) {
 	// Set up a new DB.
-	db, err := NewDB(t.TempDir(), "test.db")
+	db, err := NewDB(t.TempDir(), "test.db", clock.NewTestClock(testTime))
 	require.NoError(t, err)
 	t.Cleanup(func() {
 		_ = db.Close()
@@ -192,7 +195,7 @@ func TestLinkedSessions(t *testing.T) {
 // method correctly checks if each session in a group passes a predicate.
 func TestCheckSessionGroupPredicate(t *testing.T) {
 	// Set up a new DB.
-	db, err := NewDB(t.TempDir(), "test.db")
+	db, err := NewDB(t.TempDir(), "test.db", clock.NewTestClock(testTime))
 	require.NoError(t, err)
 	t.Cleanup(func() {
 		_ = db.Close()

terminal.go

@@ -446,7 +446,9 @@ func (g *LightningTerminal) start(ctx context.Context) error {
 
 	// Create an instance of the local Terminal Connect session store DB.
 	networkDir := filepath.Join(g.cfg.LitDir, g.cfg.Network)
-	g.sessionDB, err = session.NewDB(networkDir, session.DBFilename)
+	g.sessionDB, err = session.NewDB(
+		networkDir, session.DBFilename, clock.NewDefaultClock(),
+	)
 	if err != nil {
 		return fmt.Errorf("error creating session DB: %v", err)
 	}