migrationstreams: introduce migrationstreams pkg

Author: ViktorT-11

accounts/test_sqlite.go

@@ -6,7 +6,7 @@ import (
 	"errors"
 	"testing"
 
-	"github.com/lightninglabs/lightning-terminal/db"
+	"github.com/lightninglabs/lightning-terminal/db/migrationstreams"
 	"github.com/lightningnetwork/lnd/clock"
 	"github.com/lightningnetwork/lnd/sqldb/v2"
 )
@@ -18,7 +18,8 @@ var ErrDBClosed = errors.New("database is closed")
 // NewTestDB is a helper function that creates an SQLStore database for testing.
 func NewTestDB(t *testing.T, clock clock.Clock) Store {
 	return createStore(
-		t, sqldb.NewTestSqliteDB(t, db.LitdMigrationStreams).BaseDB,
+		t,
+		sqldb.NewTestSqliteDB(t, migrationstreams.LitdMigrationStreams).BaseDB,
 		clock,
 	)
 }
@@ -28,7 +29,9 @@ func NewTestDB(t *testing.T, clock clock.Clock) Store {
 func NewTestDBFromPath(t *testing.T, dbPath string,
 	clock clock.Clock) Store {
 
-	tDb := sqldb.NewTestSqliteDBFromPath(t, dbPath, db.LitdMigrationStreams)
+	tDb := sqldb.NewTestSqliteDBFromPath(
+		t, dbPath, migrationstreams.LitdMigrationStreams,
+	)
 
 	return createStore(t, tDb.BaseDB, clock)
 }

config_dev.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/lightninglabs/lightning-terminal/accounts"
 	"github.com/lightninglabs/lightning-terminal/db"
+	"github.com/lightninglabs/lightning-terminal/db/migrationstreams"
 	"github.com/lightninglabs/lightning-terminal/db/sqlc"
 	"github.com/lightninglabs/lightning-terminal/firewalldb"
 	"github.com/lightninglabs/lightning-terminal/session"
@@ -113,7 +114,7 @@ func NewStores(cfg *Config, clock clock.Clock) (*stores, error) {
 
 		if !cfg.Sqlite.SkipMigrations {
 			err = sqldb.ApplyAllMigrations(
-				sqlStore, db.LitdMigrationStreams,
+				sqlStore, migrationstreams.LitdMigrationStreams,
 			)
 			if err != nil {
 				return stores, fmt.Errorf("error applying "+
@@ -155,7 +156,7 @@ func NewStores(cfg *Config, clock clock.Clock) (*stores, error) {
 
 		if !cfg.Postgres.SkipMigrations {
 			err = sqldb.ApplyAllMigrations(
-				sqlStore, db.LitdMigrationStreams,
+				sqlStore, migrationstreams.LitdMigrationStreams,
 			)
 			if err != nil {
 				return stores, fmt.Errorf("error applying "+

db/migrations.go

@@ -120,7 +120,7 @@ func applyMigrations(fs fs.FS, driver database.Driver, path, dbName string,
 	targetVersion MigrationTarget, opts *migrateOptions) error {
 
 	// With the migrate instance open, we'll create a new migration source
-	// using the embedded file system stored in sqlSchemas. The library
+	// using the embedded file system stored in SqlSchemas. The library
 	// we're using can't handle a raw file system interface, so we wrap it
 	// in this intermediate layer.
 	migrateFileServer, err := httpfs.New(http.FS(fs), path)

db/migrationstreams/log.go

@@ -0,0 +1,25 @@
+package migrationstreams
+
+import (
+	"github.com/btcsuite/btclog/v2"
+	"github.com/lightningnetwork/lnd/build"
+)
+
+const Subsystem = "MIGS"
+
+// log is a logger that is initialized with no output filters.  This
+// means the package will not perform any logging by default until the caller
+// requests it.
+var log btclog.Logger
+
+// The default amount of logging is none.
+func init() {
+	UseLogger(build.NewSubLogger(Subsystem, nil))
+}
+
+// UseLogger uses a specified Logger to output package logging info.
+// This should be used in preference to SetLogWriter if the caller is also
+// using btclog.
+func UseLogger(logger btclog.Logger) {
+	log = logger
+}

db/sql_migrations.go renamed to db/migrationstreams/sql_migrations.go

@@ -1,23 +1,24 @@
-package db
+package migrationstreams
 
 import (
 	"github.com/golang-migrate/migrate/v4"
 	"github.com/golang-migrate/migrate/v4/database/pgx/v5"
+	"github.com/lightninglabs/lightning-terminal/db"
 	"github.com/lightningnetwork/lnd/sqldb/v2"
 )
 
 var (
 	LitdMigrationStream = sqldb.MigrationStream{
 		MigrateTableName: pgx.DefaultMigrationsTable,
 		SQLFileDirectory: "sqlc/migrations",
-		Schemas:          sqlSchemas,
+		Schemas:          db.SqlSchemas,
 
 		// LatestMigrationVersion is the latest migration version of the
 		// database.  This is used to implement downgrade protection for
 		// the daemon.
 		//
 		// NOTE: This MUST be updated when a new migration is added.
-		LatestMigrationVersion: LatestMigrationVersion,
+		LatestMigrationVersion: db.LatestMigrationVersion,
 
 		MakePostMigrationChecks: func(
 			db *sqldb.BaseDB) (map[uint]migrate.PostStepCallback,

db/postgres.go

@@ -8,6 +8,7 @@ import (
 
 	postgres_migrate "github.com/golang-migrate/migrate/v4/database/postgres"
 	_ "github.com/golang-migrate/migrate/v4/source/file"
+	"github.com/lightninglabs/lightning-terminal/db/migrationstreams"
 	"github.com/lightninglabs/lightning-terminal/db/sqlc"
 	"github.com/lightningnetwork/lnd/sqldb/v2"
 	"github.com/stretchr/testify/require"
@@ -149,7 +150,7 @@ func (s *PostgresStore) ExecuteMigrations(target MigrationTarget,
 		return fmt.Errorf("error creating postgres migration: %w", err)
 	}
 
-	postgresFS := newReplacerFS(sqlSchemas, postgresSchemaReplacements)
+	postgresFS := newReplacerFS(SqlSchemas, postgresSchemaReplacements)
 	return applyMigrations(
 		postgresFS, driver, "sqlc/migrations", s.cfg.DBName, target,
 		opts,
@@ -168,7 +169,9 @@ func NewTestPostgresDB(t *testing.T) *sqldb.PostgresStore {
 		sqlFixture.TearDown(t)
 	})
 
-	return sqldb.NewTestPostgresDB(t, sqlFixture, LitdMigrationStreams)
+	return sqldb.NewTestPostgresDB(
+		t, sqlFixture, migrationstreams.LitdMigrationStreams,
+	)
 }
 
 // NewTestPostgresDBWithVersion is a helper function that creates a Postgres

db/schemas.go

@@ -6,4 +6,4 @@ import (
 )
 
 //go:embed sqlc/migrations/*.*.sql
-var sqlSchemas embed.FS
+var SqlSchemas embed.FS

db/sqlite.go

@@ -235,7 +235,7 @@ func (s *SqliteStore) ExecuteMigrations(target MigrationTarget,
 		return fmt.Errorf("error creating sqlite migration: %w", err)
 	}
 
-	sqliteFS := newReplacerFS(sqlSchemas, sqliteSchemaReplacements)
+	sqliteFS := newReplacerFS(SqlSchemas, sqliteSchemaReplacements)
 	return applyMigrations(
 		sqliteFS, driver, "sqlc/migrations", "sqlite", target, opts,
 	)

firewalldb/test_sqlite.go

@@ -5,15 +5,16 @@ package firewalldb
 import (
 	"testing"
 
-	"github.com/lightninglabs/lightning-terminal/db"
+	"github.com/lightninglabs/lightning-terminal/db/migrationstreams"
 	"github.com/lightningnetwork/lnd/clock"
 	"github.com/lightningnetwork/lnd/sqldb/v2"
 )
 
 // NewTestDB is a helper function that creates an BBolt database for testing.
 func NewTestDB(t *testing.T, clock clock.Clock) FirewallDBs {
 	return createStore(
-		t, sqldb.NewTestSqliteDB(t, db.LitdMigrationStreams).BaseDB,
+		t,
+		sqldb.NewTestSqliteDB(t, migrationstreams.LitdMigrationStreams).BaseDB,
 		clock,
 	)
 }
@@ -23,7 +24,9 @@ func NewTestDB(t *testing.T, clock clock.Clock) FirewallDBs {
 func NewTestDBFromPath(t *testing.T, dbPath string,
 	clock clock.Clock) FirewallDBs {
 
-	tDb := sqldb.NewTestSqliteDBFromPath(t, dbPath, db.LitdMigrationStreams)
+	tDb := sqldb.NewTestSqliteDBFromPath(
+		t, dbPath, migrationstreams.LitdMigrationStreams,
+	)
 
 	return createStore(t, tDb.BaseDB, clock)
 }

log.go

@@ -8,6 +8,7 @@ import (
 	"github.com/lightninglabs/lightning-terminal/accounts"
 	"github.com/lightninglabs/lightning-terminal/autopilotserver"
 	"github.com/lightninglabs/lightning-terminal/db"
+	"github.com/lightninglabs/lightning-terminal/db/migrationstreams"
 	"github.com/lightninglabs/lightning-terminal/firewall"
 	"github.com/lightninglabs/lightning-terminal/firewalldb"
 	mid "github.com/lightninglabs/lightning-terminal/rpcmiddleware"
@@ -91,6 +92,10 @@ func SetupLoggers(root *build.SubLoggerManager, intercept signal.Interceptor) {
 		root, subservers.Subsystem, intercept, subservers.UseLogger,
 	)
 	lnd.AddSubLogger(root, db.Subsystem, intercept, db.UseLogger)
+	lnd.AddSubLogger(
+		root, migrationstreams.Subsystem, intercept,
+		migrationstreams.UseLogger,
+	)
 
 	// Add daemon loggers to lnd's root logger.
 	faraday.SetupLoggers(root, intercept)