chore: support last n versions for db reset

Author: sweatybridge

cmd/db.go

@@ -195,7 +195,7 @@ var (
 			if noSeed {
 				utils.Config.Db.Seed.Enabled = false
 			}
-			return reset.Run(cmd.Context(), migrationVersion, flags.DbConfig, afero.NewOsFs())
+			return reset.Run(cmd.Context(), migrationVersion, nLastVersion, flags.DbConfig, afero.NewOsFs())
 		},
 	}
 
@@ -319,6 +319,8 @@ func init() {
 	resetFlags.BoolVar(&noSeed, "no-seed", false, "Skip running the seed script after reset.")
 	dbResetCmd.MarkFlagsMutuallyExclusive("db-url", "linked", "local")
 	resetFlags.StringVar(&migrationVersion, "version", "", "Reset up to the specified version.")
+	resetFlags.UintVar(&nLastVersion, "last", 0, "Reset up to the last n migration versions.")
+	dbResetCmd.MarkFlagsMutuallyExclusive("version", "last")
 	dbCmd.AddCommand(dbResetCmd)
 	// Build lint command
 	lintFlags := dbLintCmd.Flags()

cmd/migration.go

@@ -4,9 +4,7 @@ import (
 	"fmt"
 	"os"
 	"os/signal"
-	"strconv"
 
-	"github.com/go-errors/errors"
 	"github.com/spf13/afero"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -93,24 +91,14 @@ var (
 		},
 	}
 
+	nLastVersion uint
+
 	migrationDownCmd = &cobra.Command{
-		Use:   "down [n]",
-		Short: "Resets local migrations up to the last n versions",
-		Args:  cobra.MaximumNArgs(1),
+		Use:   "down",
+		Short: "Resets applied migrations up to the last n versions",
+		Args:  cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			last := 1
-			if len(args) > 0 {
-				var err error
-				if last, err = strconv.Atoi(args[0]); err != nil {
-					return errors.Errorf("invalid last version: %w", err)
-				} else if last <= 0 {
-					return errors.Errorf("last version must be greater than 0")
-				}
-			}
-			return down.Run(cmd.Context(), last, flags.DbConfig, afero.NewOsFs())
-		},
-		PostRun: func(cmd *cobra.Command, args []string) {
-			fmt.Println("Local database is up to date.")
+			return down.Run(cmd.Context(), nLastVersion, flags.DbConfig, afero.NewOsFs())
 		},
 	}
 
@@ -166,9 +154,10 @@ func init() {
 	migrationUpCmd.MarkFlagsMutuallyExclusive("db-url", "linked", "local")
 	migrationCmd.AddCommand(migrationUpCmd)
 	downFlags := migrationDownCmd.Flags()
-	downFlags.String("db-url", "", "Applies migrations to the database specified by the connection string (must be percent-encoded).")
-	downFlags.Bool("linked", false, "Applies pending migrations to the linked project.")
-	downFlags.Bool("local", true, "Applies pending migrations to the local database.")
+	downFlags.UintVar(&nLastVersion, "last", 1, "Reset up to the last n migration versions.")
+	downFlags.String("db-url", "", "Resets applied migrations on the database specified by the connection string (must be percent-encoded).")
+	downFlags.Bool("linked", false, "Resets applied migrations on the linked project.")
+	downFlags.Bool("local", true, "Resets applied migrations on the local database.")
 	migrationDownCmd.MarkFlagsMutuallyExclusive("db-url", "linked", "local")
 	migrationCmd.AddCommand(migrationDownCmd)
 	// Build up command

internal/db/reset/reset.go

@@ -23,21 +23,33 @@ import (
 	"github.com/supabase/cli/internal/db/start"
 	"github.com/supabase/cli/internal/gen/keys"
 	"github.com/supabase/cli/internal/migration/apply"
+	"github.com/supabase/cli/internal/migration/list"
 	"github.com/supabase/cli/internal/migration/repair"
 	"github.com/supabase/cli/internal/seed/buckets"
 	"github.com/supabase/cli/internal/utils"
 	"github.com/supabase/cli/pkg/migration"
 	"github.com/supabase/cli/pkg/vault"
 )
 
-func Run(ctx context.Context, version string, config pgconn.Config, fsys afero.Fs, options ...func(*pgx.ConnConfig)) error {
+func Run(ctx context.Context, version string, last uint, config pgconn.Config, fsys afero.Fs, options ...func(*pgx.ConnConfig)) error {
 	if len(version) > 0 {
 		if _, err := strconv.Atoi(version); err != nil {
 			return errors.New(repair.ErrInvalidVersion)
 		}
 		if _, err := repair.GetMigrationFile(version, fsys); err != nil {
 			return err
 		}
+	} else if last > 0 {
+		localMigrations, err := list.LoadLocalVersions(fsys)
+		if err != nil {
+			return err
+		}
+		if total := uint(len(localMigrations)); last < total {
+			version = localMigrations[total-last-1]
+		} else {
+			// Negative skips all migrations
+			version = "-"
+		}
 	}
 	if !utils.IsLocalDatabase(config) {
 		msg := "Do you want to reset the remote database?"

internal/db/reset/reset_test.go

@@ -96,7 +96,7 @@ func TestResetCommand(t *testing.T) {
 			Reply(http.StatusOK).
 			JSON([]storage.BucketResponse{})
 		// Run test
-		err := Run(context.Background(), "", dbConfig, fsys, conn.Intercept)
+		err := Run(context.Background(), "", 0, dbConfig, fsys, conn.Intercept)
 		// Check error
 		assert.NoError(t, err)
 		assert.Empty(t, apitest.ListUnmatchedRequests())
@@ -106,7 +106,7 @@ func TestResetCommand(t *testing.T) {
 		// Setup in-memory fs
 		fsys := afero.NewMemMapFs()
 		// Run test
-		err := Run(context.Background(), "", pgconn.Config{Host: "db.supabase.co"}, fsys)
+		err := Run(context.Background(), "", 0, pgconn.Config{Host: "db.supabase.co"}, fsys)
 		// Check error
 		assert.ErrorIs(t, err, context.Canceled)
 	})
@@ -116,7 +116,7 @@ func TestResetCommand(t *testing.T) {
 		// Setup in-memory fs
 		fsys := afero.NewMemMapFs()
 		// Run test
-		err := Run(context.Background(), "", pgconn.Config{Host: "db.supabase.co"}, fsys)
+		err := Run(context.Background(), "", 0, pgconn.Config{Host: "db.supabase.co"}, fsys)
 		// Check error
 		assert.ErrorContains(t, err, "invalid port (outside range)")
 	})
@@ -131,7 +131,7 @@ func TestResetCommand(t *testing.T) {
 			Get("/v" + utils.Docker.ClientVersion() + "/containers").
 			Reply(http.StatusNotFound)
 		// Run test
-		err := Run(context.Background(), "", dbConfig, fsys)
+		err := Run(context.Background(), "", 0, dbConfig, fsys)
 		// Check error
 		assert.ErrorIs(t, err, utils.ErrNotRunning)
 		assert.Empty(t, apitest.ListUnmatchedRequests())
@@ -153,7 +153,7 @@ func TestResetCommand(t *testing.T) {
 			Delete("/v" + utils.Docker.ClientVersion() + "/containers/" + utils.DbId).
 			ReplyError(errors.New("network error"))
 		// Run test
-		err := Run(context.Background(), "", dbConfig, fsys)
+		err := Run(context.Background(), "", 0, dbConfig, fsys)
 		// Check error
 		assert.ErrorContains(t, err, "network error")
 		assert.Empty(t, apitest.ListUnmatchedRequests())

internal/migration/down/down.go

@@ -13,9 +13,7 @@ import (
 	"github.com/supabase/cli/pkg/migration"
 )
 
-var errOutOfRange = errors.New("last version must be smaller than total applied migrations")
-
-func Run(ctx context.Context, last int, config pgconn.Config, fsys afero.Fs, options ...func(*pgx.ConnConfig)) error {
+func Run(ctx context.Context, last uint, config pgconn.Config, fsys afero.Fs, options ...func(*pgx.ConnConfig)) error {
 	conn, err := utils.ConnectByConfig(ctx, config, options...)
 	if err != nil {
 		return err
@@ -25,14 +23,11 @@ func Run(ctx context.Context, last int, config pgconn.Config, fsys afero.Fs, opt
 	if err != nil {
 		return err
 	}
-	version := ""
-	if i := len(remoteMigrations) - last; i > 0 {
-		version = remoteMigrations[i-1]
-	} else {
-		if i == 0 {
-			utils.CmdSuggestion = fmt.Sprintf("Try %s if you want to revert all migrations.", utils.Aqua("supabase db reset"))
-		}
-		return errors.New(errOutOfRange)
+	total := uint(len(remoteMigrations))
+	if total <= last {
+		utils.CmdSuggestion = fmt.Sprintf("Try %s if you want to revert all migrations.", utils.Aqua("supabase db reset"))
+		return errors.Errorf("--last must be smaller than total applied migrations: %d", total)
 	}
-	return reset.Run(ctx, version, config, fsys)
+	version := remoteMigrations[total-last-1]
+	return reset.Run(ctx, version, 0, config, fsys)
 }

internal/migration/down/down_test.go

@@ -57,7 +57,7 @@ func TestMigrationsDown(t *testing.T) {
 		// Run test
 		err := Run(context.Background(), 2, dbConfig, fsys, conn.Intercept)
 		// Check error
-		assert.ErrorIs(t, err, errOutOfRange)
+		assert.ErrorContains(t, err, "--last must be smaller than total applied migrations: 2")
 	})
 
 	t.Run("throws error on missing version", func(t *testing.T) {