Files
beads/internal/storage/sqlite/adaptive_length.go
Steve Yegge b4cb636d92 Switch from hex to Base36 encoding for issue IDs (GH #213)
This change improves information density by using Base36 (0-9, a-z) instead
of hex (0-9, a-f) for hash-based issue IDs. Key benefits:

- Shorter IDs: Can now use 3-char IDs (was 4-char minimum)
- Better scaling: 3 chars good for ~160 issues, 4 chars for ~980 issues
- Case-insensitive: Maintains excellent CLI usability
- Backward compatible: Old hex IDs continue to work

Changes:
- Implemented Base36 encoding with proper truncation (keep LSB)
- Updated adaptive length thresholds (3-8 chars instead of 4-8)
- Fixed collision probability math to match encoding (was calculating
  for base36 but encoding in hex - now both use base36)
- Fixed ID parser bug (use prefixWithHyphen for substring matching)
- Updated all tests and test data patterns

Fixes #213

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-03 12:02:15 -08:00

128 lines
4.1 KiB
Go

package sqlite
import (
"context"
"database/sql"
"math"
"strconv"
)
// AdaptiveIDConfig holds configuration for adaptive ID length scaling
type AdaptiveIDConfig struct {
// MaxCollisionProbability is the threshold at which we scale up ID length (e.g., 0.25 = 25%)
MaxCollisionProbability float64
// MinLength is the minimum hash length to use (default 3)
MinLength int
// MaxLength is the maximum hash length to use (default 8)
MaxLength int
}
// DefaultAdaptiveConfig returns sensible defaults for base36 encoding
// With base36 (0-9, a-z), we can use shorter IDs than hex:
// 3 chars: ~46K namespace, good for up to ~160 issues (25% collision prob)
// 4 chars: ~1.7M namespace, good for up to ~980 issues
// 5 chars: ~60M namespace, good for up to ~5.9K issues
// 6 chars: ~2.2B namespace, good for up to ~35K issues
// 7 chars: ~78B namespace, good for up to ~212K issues
// 8 chars: ~2.8T namespace, good for up to ~1M+ issues
func DefaultAdaptiveConfig() AdaptiveIDConfig {
return AdaptiveIDConfig{
MaxCollisionProbability: 0.25, // 25% threshold
MinLength: 3,
MaxLength: 8,
}
}
// collisionProbability calculates P(collision) using birthday paradox approximation
// P(collision) ≈ 1 - e^(-n²/2N)
// where n = number of items, N = total possible values
func collisionProbability(numIssues int, idLength int) float64 {
const base = 36.0 // base36 encoding (0-9, a-z)
totalPossibilities := math.Pow(base, float64(idLength))
exponent := -float64(numIssues*numIssues) / (2.0 * totalPossibilities)
return 1.0 - math.Exp(exponent)
}
// computeAdaptiveLength determines the optimal ID length for the current database size
func computeAdaptiveLength(numIssues int, config AdaptiveIDConfig) int {
// Try lengths from min to max, return first that meets threshold
for length := config.MinLength; length <= config.MaxLength; length++ {
prob := collisionProbability(numIssues, length)
if prob <= config.MaxCollisionProbability {
return length
}
}
// If even maxLength doesn't meet threshold, return maxLength anyway
return config.MaxLength
}
// getAdaptiveConfig reads adaptive ID config from database, returns defaults if not set
func getAdaptiveConfig(ctx context.Context, conn *sql.Conn) AdaptiveIDConfig {
config := DefaultAdaptiveConfig()
// Read max_collision_prob
var probStr string
err := conn.QueryRowContext(ctx, `SELECT value FROM config WHERE key = ?`, "max_collision_prob").Scan(&probStr)
if err == nil && probStr != "" {
if prob, err := strconv.ParseFloat(probStr, 64); err == nil {
config.MaxCollisionProbability = prob
}
}
// Read min_hash_length
var minLenStr string
err = conn.QueryRowContext(ctx, `SELECT value FROM config WHERE key = ?`, "min_hash_length").Scan(&minLenStr)
if err == nil && minLenStr != "" {
if minLen, err := strconv.Atoi(minLenStr); err == nil {
config.MinLength = minLen
}
}
// Read max_hash_length
var maxLenStr string
err = conn.QueryRowContext(ctx, `SELECT value FROM config WHERE key = ?`, "max_hash_length").Scan(&maxLenStr)
if err == nil && maxLenStr != "" {
if maxLen, err := strconv.Atoi(maxLenStr); err == nil {
config.MaxLength = maxLen
}
}
return config
}
// countTopLevelIssues returns the number of top-level issues (excluding child issues)
func countTopLevelIssues(ctx context.Context, conn *sql.Conn, prefix string) (int, error) {
var count int
// Count only top-level issues (no dot in ID after prefix)
err := conn.QueryRowContext(ctx, `
SELECT COUNT(*)
FROM issues
WHERE id LIKE ? || '-%'
AND instr(substr(id, length(?) + 2), '.') = 0
`, prefix, prefix).Scan(&count)
if err != nil {
return 0, err
}
return count, nil
}
// GetAdaptiveIDLength returns the appropriate hash length based on database size
func GetAdaptiveIDLength(ctx context.Context, conn *sql.Conn, prefix string) (int, error) {
// Get current issue count
numIssues, err := countTopLevelIssues(ctx, conn, prefix)
if err != nil {
return 6, err // Fallback to 6 on error
}
// Get adaptive config
config := getAdaptiveConfig(ctx, conn)
// Compute optimal length
length := computeAdaptiveLength(numIssues, config)
return length, nil
}