beads/cmd/bd/version_tracking.go

266 lines
8.9 KiB
Go

package main
import (
"context"
"fmt"
"os"
"path/filepath"
"strings"
"github.com/steveyegge/beads/cmd/bd/doctor"
"github.com/steveyegge/beads/internal/beads"
"github.com/steveyegge/beads/internal/configfile"
"github.com/steveyegge/beads/internal/debug"
"github.com/steveyegge/beads/internal/doltserver"
"github.com/steveyegge/beads/internal/storage/dolt"
)
// localVersionFile is the gitignored file that stores the last bd version used locally.
// This prevents the upgrade notification from firing repeatedly when git operations
// reset the tracked metadata.json file.
const localVersionFile = ".local_version"
// trackBdVersion checks if bd version has changed since last run and updates the local version file.
// This function is best-effort - failures are silent to avoid disrupting commands.
// Sets global variables versionUpgradeDetected and previousVersion if upgrade detected.
func trackBdVersion() {
// Find the beads directory
beadsDir := beads.FindBeadsDir()
if beadsDir == "" {
// No .beads directory found - this is fine (e.g., bd init, bd version, etc.)
return
}
// Read last version from local (gitignored) file
localVersionPath := filepath.Join(beadsDir, localVersionFile)
lastVersion := readLocalVersion(localVersionPath)
// Check if version changed (only flag actual upgrades, not downgrades)
if lastVersion != "" && lastVersion != Version {
if doctor.CompareVersions(Version, lastVersion) > 0 {
// Version upgrade detected!
versionUpgradeDetected = true
previousVersion = lastVersion
}
}
// Update local version file (best effort)
// Only write if version actually changed to minimize I/O
if lastVersion != Version {
_ = writeLocalVersion(localVersionPath, Version) // Best effort: version tracking is advisory
}
}
// readLocalVersion reads the last bd version from the local version file.
// Returns empty string if file doesn't exist or can't be read.
func readLocalVersion(path string) string {
// #nosec G304 - path is constructed from beadsDir + constant
data, err := os.ReadFile(path)
if err != nil {
return ""
}
return strings.TrimSpace(string(data))
}
// writeLocalVersion writes the current version to the local version file.
func writeLocalVersion(path, version string) error {
return os.WriteFile(path, []byte(version+"\n"), 0600)
}
// getVersionsSince returns all version changes since the given version.
// If sinceVersion is empty, returns all known versions.
// Returns changes in chronological order (oldest first).
//
// Note: versionChanges array is in reverse chronological order (newest first),
// so we return elements before the found index and reverse the slice.
func getVersionsSince(sinceVersion string) []VersionChange {
if sinceVersion == "" {
// Return all versions (already in reverse chronological, but kept for compatibility)
return versionChanges
}
// Find the index of sinceVersion
// versionChanges is ordered newest-first: [0.23.0, 0.22.1, 0.22.0, 0.21.0]
startIdx := -1
for i, vc := range versionChanges {
if vc.Version == sinceVersion {
startIdx = i
break
}
}
if startIdx == -1 {
// sinceVersion not found in our changelog - return all versions
// (user might be upgrading from a very old version)
return versionChanges
}
if startIdx == 0 {
// Already on the newest version
return []VersionChange{}
}
// Return versions before sinceVersion (those are newer)
// Then reverse to get chronological order (oldest first)
newerVersions := versionChanges[:startIdx]
// Reverse the slice to get chronological order
result := make([]VersionChange, len(newerVersions))
for i := range newerVersions {
result[i] = newerVersions[len(newerVersions)-1-i]
}
return result
}
// maybeShowUpgradeNotification displays a one-time upgrade notification if version changed.
// This is called by commands like 'bd ready' and 'bd list' to inform users of upgrades.
func maybeShowUpgradeNotification() {
// Only show if upgrade detected and not yet acknowledged
if !versionUpgradeDetected || upgradeAcknowledged {
return
}
// Mark as acknowledged so we only show once per session
upgradeAcknowledged = true
// Display notification
fmt.Printf("🔄 bd upgraded from v%s to v%s since last use\n", previousVersion, Version)
fmt.Println("💡 Run 'bd upgrade review' to see what changed")
if usesSQLServer() {
fmt.Println("💊 Run 'bd doctor' to verify upgrade completed cleanly")
}
fmt.Println()
}
// autoMigrateOnVersionBump automatically migrates the database when CLI version changes.
// This function is best-effort - failures are silent to avoid disrupting commands.
// Called from PersistentPreRun before opening DB for main operation.
//
// IMPORTANT: This must be called BEFORE opening the database to avoid opening DB twice.
//
// beadsDir is the path to the .beads directory.
func autoMigrateOnVersionBump(beadsDir string) {
// Only migrate if version upgrade was detected
if !versionUpgradeDetected {
return
}
// Validate beadsDir
if beadsDir == "" {
debug.Logf("auto-migrate: skipping migration, no beads directory")
return
}
// Load config to determine the correct database path for this backend
cfg, err := configfile.Load(beadsDir)
if err != nil {
debug.Logf("auto-migrate: failed to load config: %v", err)
return
}
if cfg == nil {
cfg = configfile.DefaultConfig()
}
if cfg.GetBackend() != configfile.BackendDolt {
debug.Logf("auto-migrate: skipping Dolt migration for backend %q", cfg.GetBackend())
return
}
if cfg.IsDoltProxiedServerMode() {
debug.Logf("auto-migrate: skipping embedded migration, proxied-server handled after UOW provider init")
return
}
// Check if database exists at the backend-appropriate path
dbPath := cfg.DatabasePath(beadsDir)
if _, err := os.Stat(dbPath); os.IsNotExist(err) {
// No database - nothing to migrate
debug.Logf("auto-migrate: skipping migration, database does not exist: %s", dbPath)
return
}
// GH#2137: If upgrading from pre-0.56, the dolt database may have been
// created by the old embedded Dolt mode. Recover by reinitializing.
if previousVersion != "" && doctor.CompareVersions(previousVersion, "0.56.0") < 0 {
recovered, recErr := doltserver.RecoverPreV56DoltDir(dbPath)
if recErr != nil {
debug.Logf("auto-migrate: pre-v56 recovery failed: %v", recErr)
}
if recovered {
debug.Logf("auto-migrate: rebuilt pre-v56 dolt database at %s", dbPath)
}
}
// Open database using factory (respects backend config from metadata.json)
// Use rootCtx if available and not canceled, otherwise use Background
ctx := rootCtx
if ctx == nil || ctx.Err() != nil {
// rootCtx is nil or canceled - use fresh background context
ctx = context.Background()
}
store, err := dolt.NewFromConfig(ctx, beadsDir)
if err != nil {
// Failed to open database - skip migration
debug.Logf("auto-migrate: failed to open database: %v", err)
return
}
// Get current database version (clone-local, dolt-ignored)
dbVersion, err := store.GetLocalMetadata(ctx, "bd_version")
if err != nil {
// Failed to read version - skip migration
debug.Logf("auto-migrate: failed to read database version: %v", err)
_ = store.Close() // Best effort cleanup on error path
return
}
// Check if migration is needed
if dbVersion == Version {
// Database is already at current version
debug.Logf("auto-migrate: database already at version %s", Version)
_ = store.Close() // Best effort cleanup on error path
return
}
// Check for downgrade: refuse to overwrite a newer version with an older one (gt-e3uiy)
maxVersion, _ := store.GetLocalMetadata(ctx, "bd_version_max")
if dbVersion != "" && doctor.CompareVersions(Version, dbVersion) < 0 {
debug.Logf("auto-migrate: refusing downgrade from %s to %s", dbVersion, Version)
_ = store.Close() // Best effort cleanup on error path
return
}
if maxVersion != "" && doctor.CompareVersions(Version, maxVersion) < 0 {
debug.Logf("auto-migrate: refusing downgrade (max version %s > current %s)", maxVersion, Version)
_ = store.Close() // Best effort cleanup on error path
return
}
// Perform migration: update database version
debug.Logf("auto-migrate: migrating database from %s to %s", dbVersion, Version)
if err := store.SetLocalMetadata(ctx, "bd_version", Version); err != nil {
// Migration failed - log and continue
debug.Logf("auto-migrate: failed to update database version: %v", err)
_ = store.Close() // Best effort cleanup on error path
return
}
// Update max version tracking
if maxVersion == "" || doctor.CompareVersions(Version, maxVersion) > 0 {
if err := store.SetLocalMetadata(ctx, "bd_version_max", Version); err != nil {
debug.Logf("auto-migrate: failed to update max version: %v", err)
}
}
// No Dolt commit needed — local_metadata is dolt-ignored and persists
// in the working set for the lifetime of the server session.
// Close database
if err := store.Close(); err != nil {
debug.Logf("auto-migrate: warning: failed to close database: %v", err)
}
debug.Logf("auto-migrate: successfully migrated database to version %s", Version)
}