beads/internal/storage/embeddeddolt/open.go
Kevin Glynn dbf793fdb6
fix: auto-sanitize hyphenated dolt_database on embedded-mode upgrade (#3231) (#3232)
Auto-sanitize hyphenated `dolt_database` names on embedded-mode upgrade. Projects initialized before #2142 retain hyphenated names in `metadata.json`; after the 1.0.0 embedded-mode default flip, those names are rejected by the embedded Dolt engine. This change detects legacy names on store open, renames the database directory, persists the fix to `metadata.json`, and adds a doctor check + init guard for future prevention.

Closes #3231. Related: #2142, #2160, #3128, #3129.

Thanks @kevglynn for the thorough fix, migration safety (collision detection, crash-safe ordering), and test coverage.
2026-04-20 13:17:26 -07:00

120 lines
3.5 KiB
Go

//go:build cgo
package embeddeddolt
import (
"context"
"database/sql"
"errors"
"fmt"
"net/url"
"os"
"regexp"
"strings"
"time"
"github.com/cenkalti/backoff/v4"
doltembed "github.com/dolthub/driver"
)
// validIdentifier matches safe SQL identifiers (letters, digits, underscores).
// Hyphens are excluded because database names are interpolated into system
// variable identifiers (@@<db>_head_ref) where hyphens are invalid.
var validIdentifier = regexp.MustCompile(`^[a-zA-Z_][a-zA-Z0-9_]*$`)
const (
commitName = "beads"
commitEmail = "beads@local"
)
// OpenSQL opens an embedded Dolt database at dir. The returned cleanup
// function closes both the *sql.DB and the underlying connector.
func OpenSQL(ctx context.Context, dir, database, branch string) (*sql.DB, func() error, error) {
dsn := buildDSN(dir, database)
cfg, err := doltembed.ParseDSN(dsn)
if err != nil {
return nil, nil, err
}
bo := backoff.NewExponentialBackOff()
bo.MaxElapsedTime = 0 // wait until ctx cancellation
bo.MaxInterval = 5 * time.Second
cfg.BackOff = bo
connector, err := doltembed.NewConnector(cfg)
if err != nil {
return nil, nil, err
}
db := sql.OpenDB(connector)
db.SetMaxOpenConns(1)
db.SetMaxIdleConns(1)
db.SetConnMaxIdleTime(0)
db.SetConnMaxLifetime(0)
cleanup := func() error {
dbErr := db.Close()
connErr := connector.Close()
// connector.Close → engine.Close → BackgroundThreads.Shutdown
// always returns context.Canceled because Shutdown cancels its
// own parent context then returns parentCtx.Err(). This is
// a spurious error from a clean shutdown; filter it from each
// result individually so real close errors are still surfaced.
if errors.Is(dbErr, context.Canceled) {
dbErr = nil
}
if errors.Is(connErr, context.Canceled) {
connErr = nil
}
return errors.Join(dbErr, connErr)
}
if err := db.PingContext(ctx); err != nil {
return nil, nil, errors.Join(err, cleanup())
}
if strings.TrimSpace(database) != "" {
if !validIdentifier.MatchString(database) {
msg := fmt.Sprintf("invalid database name: %q", database)
if strings.ContainsRune(database, '-') {
msg += "; hyphens are not allowed in embedded mode — replace with underscores in .beads/metadata.json dolt_database field, or run 'bd doctor'"
}
return nil, nil, errors.Join(errors.New(msg), cleanup())
}
if _, err := db.ExecContext(ctx, "USE `"+database+"`"); err != nil {
return nil, nil, errors.Join(err, cleanup())
}
if strings.TrimSpace(branch) != "" {
if _, err := db.ExecContext(ctx, fmt.Sprintf("SET @@%s_head_ref = %s", database, sqlStringLiteral(branch))); err != nil {
return nil, nil, errors.Join(err, cleanup())
}
}
}
return db, cleanup, nil
}
func buildDSN(dir, database string) string {
v := url.Values{}
v.Set(doltembed.CommitNameParam, commitName)
v.Set(doltembed.CommitEmailParam, commitEmail)
v.Set(doltembed.MultiStatementsParam, "true")
if strings.TrimSpace(database) != "" {
v.Set(doltembed.DatabaseParam, database)
}
// Build the DSN string manually instead of using url.URL.String(),
// which percent-encodes the path (spaces → %20). The embedded Dolt
// driver's ParseDataSource strips the "file://" prefix and uses the
// remainder as a literal filesystem path, so encoding breaks paths
// that contain spaces. See #2920.
path := dir
if os.PathSeparator == '\\' {
path = strings.ReplaceAll(path, `\`, `/`)
}
return "file://" + path + "?" + v.Encode()
}
func sqlStringLiteral(s string) string {
return "'" + strings.ReplaceAll(strings.TrimSpace(s), "'", "''") + "'"
}