pw: add db status command

Allow listing all database schema migrations and identify which ones
have been applied.

Signed-off-by: Robin Jarry <robin@jarry.cc>

Author: rjarry

cmd/pw/db/main.go

@@ -8,6 +8,7 @@ package db
 // CLI groups the database management subcommands.
 type CLI struct {
 	Sync   SyncCmd   `cmd:"" help:"Create or update the database schema."`
+	Status StatusCmd `cmd:"" help:"Show database schema migrations status."`
 	Export ExportCmd `cmd:"" help:"Export database contents as SQL."`
 	Import ImportCmd `cmd:"" name:"import" help:"Import SQL data from stdin."`
 }

cmd/pw/db/status.go

@@ -0,0 +1,31 @@
+// Patchwork - automated patch tracking system
+// Copyright (C) The Patchwork Contributors (see CONTRIBUTORS)
+//
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+package db
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"text/tabwriter"
+
+	"github.com/getpatchwork/patchwork/cmd/pw/pw"
+	"github.com/getpatchwork/patchwork/pkg/db/migrations"
+)
+
+type StatusCmd struct{}
+
+func (c *StatusCmd) Run(ctx context.Context) error {
+	w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
+	fmt.Fprintf(w, "SCHEMA_MIGRATION\tAPPLIED\n")
+	for _, m := range migrations.ListMigrations(ctx, pw.GetDB(ctx)) {
+		if m.AppliedAt.IsZero() {
+			fmt.Fprintf(w, "%s\t%s\n", m.Name, "")
+		} else {
+			fmt.Fprintf(w, "%s\t%s\n", m.Name, m.AppliedAt)
+		}
+	}
+	return w.Flush()
+}

docs/deployment/management.rst

@@ -30,6 +30,15 @@ Database
 Create or update the database schema. On a fresh database, this creates all
 tables. On an existing one, it applies pending migrations.
 
+
+``pw db status``
+~~~~~~~~~~~~~~
+
+.. program:: pw db status
+
+List all database schema migrations and the date at which they were applied.
+
+
 ``pw db export``
 ~~~~~~~~~~~~~~~~
 

pkg/db/migrations/migrations.go

@@ -11,13 +11,15 @@ import (
 	"path/filepath"
 	"regexp"
 	"runtime"
+	"slices"
 	"sort"
 	"strconv"
 	"time"
 
 	"github.com/uptrace/bun"
 
 	"github.com/getpatchwork/patchwork/pkg/db"
+	"github.com/getpatchwork/patchwork/pkg/log"
 )
 
 type MigrationFunc func(ctx context.Context, tx bun.Tx) error
@@ -64,7 +66,7 @@ func Register(up, down MigrationFunc) {
 	})
 }
 
-type schemaMigration struct {
+type SchemaMigration struct {
 	bun.BaseModel `bun:"table:schema_migrations"`
 	Num           int       `bun:"num,pk"`
 	Name          string    `bun:"name,notnull"`
@@ -73,15 +75,15 @@ type schemaMigration struct {
 
 func ensureTable(ctx context.Context, database bun.IDB) error {
 	_, err := database.NewCreateTable().
-		Model((*schemaMigration)(nil)).
+		Model((*SchemaMigration)(nil)).
 		IfNotExists().
 		Exec(ctx)
 	return err
 }
 
 func lastApplied(ctx context.Context, database *bun.DB) (int, error) {
 	var num int
-	err := database.NewSelect().Model((*schemaMigration)(nil)).
+	err := database.NewSelect().Model((*SchemaMigration)(nil)).
 		ColumnExpr("COALESCE(MAX(num), 0)").
 		Scan(ctx, &num)
 	return num, err
@@ -96,6 +98,22 @@ func sorted() []Migration {
 	return out
 }
 
+func ListMigrations(ctx context.Context, database *bun.DB) []SchemaMigration {
+	var out []SchemaMigration
+
+	// first get all applied from DB (ignore errors)
+	database.NewSelect().Model(&out).OrderExpr("num ASC").Scan(ctx)
+
+	for _, m := range sorted() {
+		if !slices.ContainsFunc(out, func(s SchemaMigration) bool { return s.Num == m.Num }) {
+			// then, fill in unapplied ones (AppliedAt will be zero)
+			out = append(out, SchemaMigration{Num: m.Num, Name: m.Name})
+		}
+	}
+
+	return out
+}
+
 func RunMigrations(ctx context.Context, database *bun.DB) error {
 	if !tableExists(ctx, database, "schema_migrations") {
 		return bootstrap(ctx, database)
@@ -118,6 +136,8 @@ func RunMigrations(ctx context.Context, database *bun.DB) error {
 			continue
 		}
 
+		log.Noticef("Running database migration %s", m.Name)
+
 		tx, err := database.BeginTx(ctx, nil)
 		if err != nil {
 			return fmt.Errorf("%s: begin tx: %w", m.Name, err)
@@ -128,7 +148,7 @@ func RunMigrations(ctx context.Context, database *bun.DB) error {
 			return fmt.Errorf("%s: %w", m.Name, err)
 		}
 
-		if _, err := tx.NewInsert().Model(&schemaMigration{
+		if _, err := tx.NewInsert().Model(&SchemaMigration{
 			Num:       m.Num,
 			Name:      m.Name,
 			AppliedAt: time.Now(),
@@ -182,7 +202,7 @@ func Rollback(ctx context.Context, database *bun.DB) error {
 		return fmt.Errorf("%s: %w", last.Name, err)
 	}
 
-	if _, err := tx.NewDelete().Model((*schemaMigration)(nil)).
+	if _, err := tx.NewDelete().Model((*SchemaMigration)(nil)).
 		Where("num = ?", last.Num).Exec(ctx); err != nil {
 		_ = tx.Rollback()
 		return fmt.Errorf("%s: remove record: %w", last.Name, err)
@@ -224,7 +244,7 @@ func bootstrap(ctx context.Context, database *bun.DB) error {
 	}
 
 	for _, m := range sorted() {
-		if _, err := tx.NewInsert().Model(&schemaMigration{
+		if _, err := tx.NewInsert().Model(&SchemaMigration{
 			Num:       m.Num,
 			Name:      m.Name,
 			AppliedAt: time.Now(),

pkg/db/schema.go

@@ -68,6 +68,7 @@ func (idx *tableIndex) create(model any, ctx context.Context, database bun.IDB)
 		tokens = append(tokens, name)
 	}
 	name := strings.Join(tokens, "_")
+	log.Noticef("creating index %q", name)
 	_, err := c.Index(name).Exec(ctx)
 	return err
 }