"""Profile management for hindsight-embed. Handles creation, deletion, and management of configuration profiles. Each profile has its own config, daemon lock, log file, and port. """ import hashlib import json import os import sys from dataclasses import dataclass, field from datetime import datetime, timezone from pathlib import Path from typing import Optional # ============================================================================== # Cross-platform file locking implementation # ============================================================================== # Why not use a library like portalocker or fasteners? # # 1. Minimal dependency: Our use case is extremely simple - only basic # exclusive file locking for metadata persistence. Adding a new dependency # (even a small one) for such a narrow use case is unnecessary. # # 2. Portability: We only need to support the two major platforms (Unix and # Windows), both of which have well-understood file locking mechanisms # that can be implemented in ~10 lines of code each. # # 3. Maintainability: The code is straightforward and has no external # dependencies to track or update. The locking logic is localized here, # making it easy to understand and modify if needed. # # 4. Feature scope: Libraries like portalocker provide many features we don't # need (timeout handling, shared locks, lock files, etc.), which would add # unnecessary complexity to our simple use case. # # If our locking requirements become more complex in the future (e.g., needing # timeouts, better error handling, or supporting more edge cases), reconsider # using a dedicated library like portalocker. # ============================================================================== if sys.platform != "win32": import fcntl def lock_file(file_obj): fcntl.flock(file_obj.fileno(), fcntl.LOCK_EX) def unlock_file(file_obj): fcntl.flock(file_obj.fileno(), fcntl.LOCK_UN) else: import msvcrt def lock_file(file_obj): msvcrt.locking(file_obj.fileno(), msvcrt.LK_LOCK, 1) def unlock_file(file_obj): msvcrt.locking(file_obj.fileno(), msvcrt.LK_UNLCK, 1) import httpx # Configuration paths CONFIG_DIR = Path.home() / ".hindsight" PROFILES_DIR = CONFIG_DIR / "profiles" METADATA_FILE = PROFILES_DIR / "metadata.json" ACTIVE_PROFILE_FILE = CONFIG_DIR / "active_profile" # Port allocation DEFAULT_PORT = 8888 PROFILE_PORT_BASE = 8889 PROFILE_PORT_RANGE = 1000 # 8889-9888 # UI port offset from daemon port (e.g., daemon 8888 -> UI 18888) UI_PORT_OFFSET = 10000 @dataclass class ProfilePaths: """Paths and port for a profile.""" config: Path lock: Path log: Path port: int ui_log: Path = None # type: ignore[assignment] def __post_init__(self): if self.ui_log is None: self.ui_log = self.log.parent / self.log.name.replace(".log", ".ui.log") @dataclass class ProfileInfo: """Profile information including metadata.""" name: str port: int created_at: str last_used: Optional[str] = None is_active: bool = False daemon_running: bool = False @dataclass class ProfileMetadata: """Metadata for all profiles.""" version: int = 1 profiles: dict[str, dict] = field(default_factory=dict) class ProfileManager: """Manages configuration profiles for hindsight-embed.""" def __init__(self): """Initialize the profile manager.""" self._ensure_directories() def _get_config_dir(self) -> Path: """Get config directory path dynamically (supports testing with temp HOME).""" return Path.home() / ".hindsight" def _get_profiles_dir(self) -> Path: """Get profiles directory path dynamically.""" return self._get_config_dir() / "profiles" def _get_metadata_file(self) -> Path: """Get metadata file path dynamically.""" return self._get_profiles_dir() / "metadata.json" def _get_active_profile_file(self) -> Path: """Get active profile file path dynamically.""" return self._get_config_dir() / "active_profile" def _ensure_directories(self): """Ensure profile directories exist.""" self._get_profiles_dir().mkdir(parents=True, exist_ok=True) def list_profiles(self) -> list[ProfileInfo]: """List all profiles with their status. Returns: List of ProfileInfo objects with daemon status. """ metadata = self._load_metadata() active_profile = self.get_active_profile() profiles = [] # Add default profile if config exists default_config = self._get_config_dir() / "embed" if default_config.exists(): profiles.append( ProfileInfo( name="", # Empty name = default port=DEFAULT_PORT, created_at="", # Don't track for default last_used=None, is_active=active_profile == "", daemon_running=self._check_daemon_running(DEFAULT_PORT), ) ) # Add named profiles for name, info in metadata.profiles.items(): profiles.append( ProfileInfo( name=name, port=info["port"], created_at=info.get("created_at", ""), last_used=info.get("last_used"), is_active=active_profile == name, daemon_running=self._check_daemon_running(info["port"]), ) ) return sorted(profiles, key=lambda p: (p.name != "", p.name)) def profile_exists(self, name: str) -> bool: """Check if a profile exists. Args: name: Profile name (empty string for default). Returns: True if profile exists. """ if not name: # Default profile exists if config file exists return (self._get_config_dir() / "embed").exists() # Named profile exists if config file exists config_path = self._get_profiles_dir() / f"{name}.env" return config_path.exists() def get_profile(self, name: str) -> Optional[ProfileInfo]: """Get profile information. Args: name: Profile name (empty string for default). Returns: ProfileInfo if profile exists, None otherwise. """ profiles = self.list_profiles() for profile in profiles: if profile.name == name: return profile return None def create_profile(self, name: str, port_or_config: int | dict[str, str], config: dict[str, str] | None = None): """Create or update a profile. Args: name: Profile name. port_or_config: Port number (int) or configuration dict. For backward compatibility, if this is a dict, it's treated as config and port is auto-allocated. config: Configuration dict (KEY=VALUE pairs). Only used if port_or_config is an int. Raises: ValueError: If profile name is invalid or port is invalid. """ # Handle backward compatibility - allow (name, config) or (name, port, config) if isinstance(port_or_config, dict): # Called with (name, config) - auto-allocate port port = None config = port_or_config else: # Called with (name, port, config) port = port_or_config if config is None: raise ValueError("Config must be provided when port is specified") if not name: raise ValueError("Profile name cannot be empty") if not name.replace("-", "").replace("_", "").isalnum(): raise ValueError(f"Invalid profile name '{name}'. Use alphanumeric chars, hyphens, and underscores.") if port is not None and (port < 1024 or port > 65535): raise ValueError(f"Invalid port {port}. Must be between 1024-65535.") # Ensure profile directory exists self._ensure_directories() # Load metadata to check if profile already exists metadata = self._load_metadata() # Determine port: use provided port, preserve existing, or allocate new if port is None: if name in metadata.profiles and "port" in metadata.profiles[name]: port = metadata.profiles[name]["port"] else: port = self._allocate_port(name) # Write config file config_path = self._get_profiles_dir() / f"{name}.env" config_lines = [f"{key}={value}" for key, value in config.items()] config_path.write_text("\n".join(config_lines) + "\n") # Update metadata (reuse metadata loaded earlier to avoid race conditions) now_iso = datetime.now(timezone.utc).isoformat() if name in metadata.profiles: # Update existing profile metadata.profiles[name]["last_used"] = now_iso metadata.profiles[name]["port"] = port else: # Create new profile metadata.profiles[name] = { "port": port, "created_at": now_iso, "last_used": now_iso, } self._save_metadata(metadata) def delete_profile(self, name: str): """Delete a profile. Args: name: Profile name. Raises: ValueError: If profile name is invalid or doesn't exist. """ if not name: raise ValueError("Cannot delete default profile") if not self.profile_exists(name): raise ValueError(f"Profile '{name}' does not exist") # Remove config file config_path = self._get_profiles_dir() / f"{name}.env" if config_path.exists(): config_path.unlink() # Remove lock file lock_path = self._get_profiles_dir() / f"{name}.lock" if lock_path.exists(): lock_path.unlink() # Remove log file log_path = self._get_profiles_dir() / f"{name}.log" if log_path.exists(): log_path.unlink() # Update metadata metadata = self._load_metadata() if name in metadata.profiles: del metadata.profiles[name] self._save_metadata(metadata) # Clear active profile if it was deleted if self.get_active_profile() == name: self.set_active_profile(None) def set_active_profile(self, name: Optional[str]): """Set the active profile. Args: name: Profile name to activate, or None to clear. Raises: ValueError: If profile doesn't exist. """ if name and not self.profile_exists(name): raise ValueError(f"Profile '{name}' does not exist") active_file = self._get_active_profile_file() if name: active_file.write_text(name) else: # Clear active profile if active_file.exists(): active_file.unlink() def get_active_profile(self) -> str: """Get the currently active profile name. Returns: Profile name, or empty string if no active profile. """ active_file = self._get_active_profile_file() if active_file.exists(): return active_file.read_text().strip() return "" def resolve_profile_paths(self, name: str) -> ProfilePaths: """Resolve paths for a profile. Args: name: Profile name (empty string for default). Returns: ProfilePaths with config, lock, log, and port. """ # Use dynamic path resolution to support testing with temporary HOME directories config_dir = Path.home() / ".hindsight" profiles_dir = config_dir / "profiles" if not name: # Default profile return ProfilePaths( config=config_dir / "embed", lock=config_dir / "daemon.lock", log=config_dir / "daemon.log", port=DEFAULT_PORT, ) # Named profile metadata = self._load_metadata() port = metadata.profiles.get(name, {}).get("port", self._allocate_port(name)) return ProfilePaths( config=profiles_dir / f"{name}.env", lock=profiles_dir / f"{name}.lock", log=profiles_dir / f"{name}.log", port=port, ) def load_profile_config(self, name: str) -> dict[str, str]: """Load configuration from a profile's .env file. Args: name: Profile name (empty string for default). Returns: Dictionary of environment variable key-value pairs from the profile's .env file. Also includes simple key aliases (e.g., 'idle_timeout' for 'HINDSIGHT_EMBED_DAEMON_IDLE_TIMEOUT'). """ paths = self.resolve_profile_paths(name) config = {} if not paths.config.exists(): return config # Parse .env file with open(paths.config) as f: for line in f: line = line.strip() # Skip comments and empty lines if not line or line.startswith("#"): continue # Handle 'export VAR=value' format if line.startswith("export "): line = line[7:] # Parse KEY=VALUE if "=" in line: key, value = line.split("=", 1) config[key.strip()] = value.strip() # Add simple key aliases for backward compatibility # Some code checks config.get("idle_timeout") instead of the full env var name key_aliases = { "HINDSIGHT_API_LLM_API_KEY": "llm_api_key", "HINDSIGHT_API_LLM_PROVIDER": "llm_provider", "HINDSIGHT_API_LLM_MODEL": "llm_model", "HINDSIGHT_API_LLM_BASE_URL": "llm_base_url", "HINDSIGHT_API_LOG_LEVEL": "log_level", "HINDSIGHT_EMBED_DAEMON_IDLE_TIMEOUT": "idle_timeout", } for env_key, simple_key in key_aliases.items(): if env_key in config and simple_key not in config: config[simple_key] = config[env_key] return config def _allocate_port(self, name: str) -> int: """Allocate a port for a profile using hash-based strategy. Args: name: Profile name. Returns: Port number (8889-9888). """ # Hash profile name to get consistent port hash_val = int(hashlib.sha256(name.encode()).hexdigest(), 16) port = PROFILE_PORT_BASE + (hash_val % PROFILE_PORT_RANGE) # Check if port is already allocated in metadata metadata = self._load_metadata() allocated_ports = {info["port"] for info in metadata.profiles.values() if info.get("port")} # If collision, find next available port attempt = 0 while port in allocated_ports and attempt < PROFILE_PORT_RANGE: port = PROFILE_PORT_BASE + ((hash_val + attempt) % PROFILE_PORT_RANGE) attempt += 1 if attempt >= PROFILE_PORT_RANGE: # Fallback: find first available port for p in range(PROFILE_PORT_BASE, PROFILE_PORT_BASE + PROFILE_PORT_RANGE): if p not in allocated_ports: return p raise RuntimeError("No available ports for profile") return port def _check_daemon_running(self, port: int) -> bool: """Check if daemon is running on a port. Args: port: Port number to check. Returns: True if daemon is responding. """ try: with httpx.Client() as client: response = client.get(f"http://127.0.0.1:{port}/health", timeout=1) return response.status_code == 200 except Exception: return False def _load_metadata(self) -> ProfileMetadata: """Load profile metadata from disk. Returns: ProfileMetadata object. """ metadata_file = self._get_metadata_file() if not metadata_file.exists(): return ProfileMetadata() try: with open(metadata_file) as f: data = json.load(f) return ProfileMetadata(version=data.get("version", 1), profiles=data.get("profiles", {})) except (json.JSONDecodeError, IOError) as e: print( f"Warning: Failed to load metadata: {e}. Using empty metadata.", file=sys.stderr, ) # Backup corrupted metadata backup_path = metadata_file.with_suffix(".json.bak") if metadata_file.exists(): metadata_file.rename(backup_path) return ProfileMetadata() def _save_metadata(self, metadata: ProfileMetadata): """Save profile metadata to disk with file locking. Args: metadata: ProfileMetadata to save. """ self._ensure_directories() # Use atomic write with temp file metadata_file = self._get_metadata_file() temp_file = metadata_file.with_suffix(".json.tmp") with open(temp_file, "w") as f: # Acquire exclusive lock (cross-platform) lock_file(f) try: json.dump( {"version": metadata.version, "profiles": metadata.profiles}, f, indent=2, ) f.flush() os.fsync(f.fileno()) finally: unlock_file(f) # Atomic rename temp_file.rename(metadata_file) def resolve_active_profile() -> str: """Resolve which profile to use based on priority. Priority (highest to lowest): 1. HINDSIGHT_EMBED_PROFILE environment variable 2. CLI --profile flag (from global context) 3. Active profile from file 4. Default (empty string) Returns: Profile name to use (empty string for default). """ # 1. Environment variable if env_profile := os.getenv("HINDSIGHT_EMBED_PROFILE"): return env_profile # 2. CLI flag (set by caller before invoking commands) from . import cli if cli_profile := cli.get_cli_profile_override(): return cli_profile # 3. Active profile file pm = ProfileManager() if active_profile := pm.get_active_profile(): return active_profile # 4. Default return "" def validate_profile_exists(profile: str): """Validate that a profile exists, exit if not. Args: profile: Profile name to validate. Exits: If profile doesn't exist, prints error and exits. """ if not profile: # Default profile - always valid return pm = ProfileManager() if not pm.profile_exists(profile): print( f"Error: Profile '{profile}' not found.", file=sys.stderr, ) print( f"Create it with: hindsight-embed configure --profile {profile}", file=sys.stderr, ) sys.exit(1)