basic-memory 0.16.1__py3-none-any.whl → 0.17.4__py3-none-any.whl

basic_memory/cli/commands/telemetry.py

@@ -0,0 +1,81 @@
+"""Telemetry commands for basic-memory CLI."""
+
+import typer
+from rich.console import Console
+from rich.panel import Panel
+
+from basic_memory.cli.app import app
+from basic_memory.config import ConfigManager
+
+console = Console()
+
+# Create telemetry subcommand group
+telemetry_app = typer.Typer(help="Manage anonymous telemetry settings")
+app.add_typer(telemetry_app, name="telemetry")
+
+
+@telemetry_app.command("enable")
+def enable() -> None:
+    """Enable anonymous telemetry.
+
+    Telemetry helps improve Basic Memory by collecting anonymous usage data.
+    No personal data, note content, or file paths are ever collected.
+    """
+    config_manager = ConfigManager()
+    config = config_manager.config
+    config.telemetry_enabled = True
+    config_manager.save_config(config)
+    console.print("[green]Telemetry enabled[/green]")
+    console.print("[dim]Thank you for helping improve Basic Memory![/dim]")
+
+
+@telemetry_app.command("disable")
+def disable() -> None:
+    """Disable anonymous telemetry.
+
+    You can re-enable telemetry anytime with: bm telemetry enable
+    """
+    config_manager = ConfigManager()
+    config = config_manager.config
+    config.telemetry_enabled = False
+    config_manager.save_config(config)
+    console.print("[yellow]Telemetry disabled[/yellow]")
+
+
+@telemetry_app.command("status")
+def status() -> None:
+    """Show current telemetry status and what's collected."""
+    from basic_memory.telemetry import get_install_id, TELEMETRY_DOCS_URL
+
+    config = ConfigManager().config
+
+    status_text = (
+        "[green]enabled[/green]" if config.telemetry_enabled else "[yellow]disabled[/yellow]"
+    )
+
+    console.print(f"\nTelemetry: {status_text}")
+    console.print(f"Install ID: [dim]{get_install_id()}[/dim]")
+    console.print()
+
+    what_we_collect = """
+[bold]What we collect:[/bold]
+  - App version, Python version, OS, architecture
+  - Feature usage (which MCP tools and CLI commands)
+  - Sync statistics (entity count, duration)
+  - Error types (sanitized, no file paths)
+
+[bold]What we NEVER collect:[/bold]
+  - Note content, file names, or paths
+  - Personal information
+  - IP addresses
+"""
+
+    console.print(
+        Panel(
+            what_we_collect.strip(),
+            title="Telemetry Details",
+            border_style="blue",
+            expand=False,
+        )
+    )
+    console.print(f"[dim]Details: {TELEMETRY_DOCS_URL}[/dim]")

basic_memory/cli/container.py

@@ -0,0 +1,84 @@
+"""CLI composition root for Basic Memory.
+
+This container owns reading ConfigManager and environment variables for the
+CLI entrypoint. Downstream modules receive config/dependencies explicitly
+rather than reading globals.
+
+Design principles:
+- Only this module reads ConfigManager directly
+- Runtime mode (cloud/local/test) is resolved here
+- Different CLI commands may need different initialization
+"""
+
+from dataclasses import dataclass
+
+from basic_memory.config import BasicMemoryConfig, ConfigManager
+from basic_memory.runtime import RuntimeMode, resolve_runtime_mode
+
+
+@dataclass
+class CliContainer:
+    """Composition root for the CLI entrypoint.
+
+    Holds resolved configuration and runtime context.
+    Created once at CLI startup, then used by subcommands.
+    """
+
+    config: BasicMemoryConfig
+    mode: RuntimeMode
+
+    @classmethod
+    def create(cls) -> "CliContainer":
+        """Create container by reading ConfigManager.
+
+        This is the single point where CLI reads global config.
+        """
+        config = ConfigManager().config
+        mode = resolve_runtime_mode(
+            cloud_mode_enabled=config.cloud_mode_enabled,
+            is_test_env=config.is_test_env,
+        )
+        return cls(config=config, mode=mode)
+
+    # --- Runtime Mode Properties ---
+
+    @property
+    def is_cloud_mode(self) -> bool:
+        """Whether running in cloud mode."""
+        return self.mode.is_cloud
+
+
+# Module-level container instance (set by app callback)
+_container: CliContainer | None = None
+
+
+def get_container() -> CliContainer:
+    """Get the current CLI container.
+
+    Returns:
+        The CLI container
+
+    Raises:
+        RuntimeError: If container hasn't been initialized
+    """
+    if _container is None:
+        raise RuntimeError("CLI container not initialized. Call set_container() first.")
+    return _container
+
+
+def set_container(container: CliContainer) -> None:
+    """Set the CLI container (called by app callback)."""
+    global _container
+    _container = container
+
+
+def get_or_create_container() -> CliContainer:
+    """Get existing container or create new one.
+
+    This is useful for CLI commands that might be called before
+    the main app callback runs (e.g., eager options).
+    """
+    global _container
+    if _container is None:
+        _container = CliContainer.create()
+    return _container

basic_memory/cli/main.py

@@ -13,9 +13,16 @@ from basic_memory.cli.commands import (  # noqa: F401  # pragma: no cover
     mcp,
     project,
     status,
+    telemetry,
     tool,
 )
 
+# Re-apply warning filter AFTER all imports
+# (authlib adds a DeprecationWarning filter that overrides ours)
+import warnings  # pragma: no cover
+
+warnings.filterwarnings("ignore")  # pragma: no cover
+
 if __name__ == "__main__":  # pragma: no cover
     # start the app
     app()

basic_memory/config.py

@@ -6,12 +6,12 @@ from dataclasses import dataclass
 from datetime import datetime
 from pathlib import Path
 from typing import Any, Dict, Literal, Optional, List, Tuple
+from enum import Enum
 
 from loguru import logger
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, Field, model_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
-import basic_memory
 from basic_memory.utils import setup_logging, generate_permalink
 
 
@@ -24,6 +24,13 @@ WATCH_STATUS_JSON = "watch-status.json"
 Environment = Literal["test", "dev", "user"]
 
 
+class DatabaseBackend(str, Enum):
+    """Supported database backends."""
+
+    SQLITE = "sqlite"
+    POSTGRES = "postgres"
+
+
 @dataclass
 class ProjectConfig:
     """Configuration for a specific basic-memory project."""
@@ -33,7 +40,7 @@ class ProjectConfig:
 
     @property
     def project(self):
-        return self.name
+        return self.name  # pragma: no cover
 
     @property
     def project_url(self) -> str:  # pragma: no cover
@@ -63,8 +70,10 @@ class BasicMemoryConfig(BaseSettings):
 
     projects: Dict[str, str] = Field(
         default_factory=lambda: {
-            "main": Path(os.getenv("BASIC_MEMORY_HOME", Path.home() / "basic-memory")).as_posix()
-        },
+            "main": str(Path(os.getenv("BASIC_MEMORY_HOME", Path.home() / "basic-memory")))
+        }
+        if os.getenv("BASIC_MEMORY_HOME")
+        else {},
         description="Mapping of project names to their filesystem paths",
     )
     default_project: str = Field(
@@ -79,13 +88,43 @@ class BasicMemoryConfig(BaseSettings):
     # overridden by ~/.basic-memory/config.json
     log_level: str = "INFO"
 
+    # Database configuration
+    database_backend: DatabaseBackend = Field(
+        default=DatabaseBackend.SQLITE,
+        description="Database backend to use (sqlite or postgres)",
+    )
+
+    database_url: Optional[str] = Field(
+        default=None,
+        description="Database connection URL. For Postgres, use postgresql+asyncpg://user:pass@host:port/db. If not set, SQLite will use default path.",
+    )
+
+    # Database connection pool configuration (Postgres only)
+    db_pool_size: int = Field(
+        default=20,
+        description="Number of connections to keep in the pool (Postgres only)",
+        gt=0,
+    )
+    db_pool_overflow: int = Field(
+        default=40,
+        description="Max additional connections beyond pool_size under load (Postgres only)",
+        gt=0,
+    )
+    db_pool_recycle: int = Field(
+        default=180,
+        description="Recycle connections after N seconds to prevent stale connections. Default 180s works well with Neon's ~5 minute scale-to-zero (Postgres only)",
+        gt=0,
+    )
+
     # Watch service configuration
     sync_delay: int = Field(
         default=1000, description="Milliseconds to wait after changes before syncing", gt=0
     )
 
     watch_project_reload_interval: int = Field(
-        default=30, description="Seconds between reloading project list in watch service", gt=0
+        default=300,
+        description="Seconds between reloading project list in watch service. Higher values reduce CPU usage by minimizing watcher restarts. Default 300s (5 min) balances efficiency with responsiveness to new projects.",
+        gt=0,
     )
 
     # update permalinks on move
@@ -126,6 +165,28 @@ class BasicMemoryConfig(BaseSettings):
         description="Skip expensive initialization synchronization. Useful for cloud/stateless deployments where project reconciliation is not needed.",
     )
 
+    # File formatting configuration
+    format_on_save: bool = Field(
+        default=False,
+        description="Automatically format files after saving using configured formatter. Disabled by default.",
+    )
+
+    formatter_command: Optional[str] = Field(
+        default=None,
+        description="External formatter command. Use {file} as placeholder for file path. If not set, uses built-in mdformat (Python, no Node.js required). Set to 'npx prettier --write {file}' for Prettier.",
+    )
+
+    formatters: Dict[str, str] = Field(
+        default_factory=dict,
+        description="Per-extension formatters. Keys are extensions (without dot), values are commands. Example: {'md': 'prettier --write {file}', 'json': 'prettier --write {file}'}",
+    )
+
+    formatter_timeout: float = Field(
+        default=5.0,
+        description="Maximum seconds to wait for formatter to complete",
+        gt=0,
+    )
+
     # Project path constraints
     project_root: Optional[str] = Field(
         default=None,
@@ -160,6 +221,34 @@ class BasicMemoryConfig(BaseSettings):
         description="Cloud project sync configuration mapping project names to their local paths and sync state",
     )
 
+    # Telemetry configuration (Homebrew-style opt-out)
+    telemetry_enabled: bool = Field(
+        default=True,
+        description="Send anonymous usage statistics to help improve Basic Memory. Disable with: bm telemetry disable",
+    )
+
+    telemetry_notice_shown: bool = Field(
+        default=False,
+        description="Whether the one-time telemetry notice has been shown to the user",
+    )
+
+    @property
+    def is_test_env(self) -> bool:
+        """Check if running in a test environment.
+
+        Returns True if any of:
+        - env field is set to "test"
+        - BASIC_MEMORY_ENV environment variable is "test"
+        - PYTEST_CURRENT_TEST environment variable is set (pytest is running)
+
+        Used to disable features like telemetry and file watchers during tests.
+        """
+        return (
+            self.env == "test"
+            or os.getenv("BASIC_MEMORY_ENV", "").lower() == "test"
+            or os.getenv("PYTEST_CURRENT_TEST") is not None
+        )
+
     @property
     def cloud_mode_enabled(self) -> bool:
         """Check if cloud mode is enabled.
@@ -176,6 +265,36 @@ class BasicMemoryConfig(BaseSettings):
         # Fall back to config file value
         return self.cloud_mode
 
+    @classmethod
+    def for_cloud_tenant(
+        cls,
+        database_url: str,
+        projects: Optional[Dict[str, str]] = None,
+    ) -> "BasicMemoryConfig":
+        """Create config for cloud tenant - no config.json, database is source of truth.
+
+        This factory method creates a BasicMemoryConfig suitable for cloud deployments
+        where:
+        - Database is Postgres (Neon), not SQLite
+        - Projects are discovered from the database, not config file
+        - Path validation is skipped (no local filesystem in cloud)
+        - Initialization sync is skipped (stateless deployment)
+
+        Args:
+            database_url: Postgres connection URL for tenant database
+            projects: Optional project mapping (usually empty, discovered from DB)
+
+        Returns:
+            BasicMemoryConfig configured for cloud mode
+        """
+        return cls(  # pragma: no cover
+            database_backend=DatabaseBackend.POSTGRES,
+            database_url=database_url,
+            projects=projects or {},
+            cloud_mode=True,
+            skip_initialization_sync=True,
+        )
+
     model_config = SettingsConfigDict(
         env_prefix="BASIC_MEMORY_",
         extra="ignore",
@@ -192,15 +311,20 @@ class BasicMemoryConfig(BaseSettings):
 
     def model_post_init(self, __context: Any) -> None:
         """Ensure configuration is valid after initialization."""
-        # Ensure main project exists
-        if "main" not in self.projects:  # pragma: no cover
-            self.projects["main"] = (
+        # Skip project initialization in cloud mode - projects are discovered from DB
+        if self.database_backend == DatabaseBackend.POSTGRES:  # pragma: no cover
+            return  # pragma: no cover
+
+        # Ensure at least one project exists; if none exist then create main
+        if not self.projects:  # pragma: no cover
+            self.projects["main"] = str(
                 Path(os.getenv("BASIC_MEMORY_HOME", Path.home() / "basic-memory"))
-            ).as_posix()
+            )
 
-        # Ensure default project is valid
+        # Ensure default project is valid (i.e. points to an existing project)
         if self.default_project not in self.projects:  # pragma: no cover
-            self.default_project = "main"
+            # Set default to first available project
+            self.default_project = next(iter(self.projects.keys()))
 
     @property
     def app_database_path(self) -> Path:
@@ -233,19 +357,26 @@ class BasicMemoryConfig(BaseSettings):
         """Get all configured projects as ProjectConfig objects."""
         return [ProjectConfig(name=name, home=Path(path)) for name, path in self.projects.items()]
 
-    @field_validator("projects")
-    @classmethod
-    def ensure_project_paths_exists(cls, v: Dict[str, str]) -> Dict[str, str]:  # pragma: no cover
-        """Ensure project path exists."""
-        for name, path_value in v.items():
+    @model_validator(mode="after")
+    def ensure_project_paths_exists(self) -> "BasicMemoryConfig":  # pragma: no cover
+        """Ensure project paths exist.
+
+        Skips path creation when using Postgres backend (cloud mode) since
+        cloud tenants don't use local filesystem paths.
+        """
+        # Skip path creation for cloud mode - no local filesystem
+        if self.database_backend == DatabaseBackend.POSTGRES:
+            return self
+
+        for name, path_value in self.projects.items():
             path = Path(path_value)
-            if not Path(path).exists():
+            if not path.exists():
                 try:
                     path.mkdir(parents=True)
                 except Exception as e:
                     logger.error(f"Failed to create project path: {e}")
                     raise e
-        return v
+        return self
 
     @property
     def data_dir_path(self):
@@ -358,7 +489,7 @@ class ConfigManager:
 
         # Load config, modify it, and save it
         config = self.load_config()
-        config.projects[name] = project_path.as_posix()
+        config.projects[name] = str(project_path)
         self.save_config(config)
         return ProjectConfig(name=name, home=project_path)
 
@@ -448,69 +579,38 @@ def save_basic_memory_config(file_path: Path, config: BasicMemoryConfig) -> None
         logger.error(f"Failed to save config: {e}")
 
 
-# setup logging to a single log file in user home directory
-user_home = Path.home()
-log_dir = user_home / DATA_DIR_NAME
-log_dir.mkdir(parents=True, exist_ok=True)
+# Logging initialization functions for different entry points
 
 
-# Process info for logging
-def get_process_name():  # pragma: no cover
-    """
-    get the type of process for logging
-    """
-    import sys
-
-    if "sync" in sys.argv:
-        return "sync"
-    elif "mcp" in sys.argv:
-        return "mcp"
-    elif "cli" in sys.argv:
-        return "cli"
-    else:
-        return "api"
-
-
-process_name = get_process_name()
-
-# Global flag to track if logging has been set up
-_LOGGING_SETUP = False
-
-
-# Logging
+def init_cli_logging() -> None:  # pragma: no cover
+    """Initialize logging for CLI commands - file only.
 
+    CLI commands should not log to stdout to avoid interfering with
+    command output and shell integration.
+    """
+    log_level = os.getenv("BASIC_MEMORY_LOG_LEVEL", "INFO")
+    setup_logging(log_level=log_level, log_to_file=True)
 
-def setup_basic_memory_logging():  # pragma: no cover
-    """Set up logging for basic-memory, ensuring it only happens once."""
-    global _LOGGING_SETUP
-    if _LOGGING_SETUP:
-        # We can't log before logging is set up
-        # print("Skipping duplicate logging setup")
-        return
-
-    # Check for console logging environment variable - accept more truthy values
-    console_logging_env = os.getenv("BASIC_MEMORY_CONSOLE_LOGGING", "false").lower()
-    console_logging = console_logging_env in ("true", "1", "yes", "on")
 
-    # Check for log level environment variable first, fall back to config
-    log_level = os.getenv("BASIC_MEMORY_LOG_LEVEL")
-    if not log_level:
-        config_manager = ConfigManager()
-        log_level = config_manager.config.log_level
+def init_mcp_logging() -> None:  # pragma: no cover
+    """Initialize logging for MCP server - file only.
 
-    config_manager = ConfigManager()
-    config = get_project_config()
-    setup_logging(
-        env=config_manager.config.env,
-        home_dir=user_home,  # Use user home for logs
-        log_level=log_level,
-        log_file=f"{DATA_DIR_NAME}/basic-memory-{process_name}.log",
-        console=console_logging,
-    )
+    MCP server must not log to stdout as it would corrupt the
+    JSON-RPC protocol communication.
+    """
+    log_level = os.getenv("BASIC_MEMORY_LOG_LEVEL", "INFO")
+    setup_logging(log_level=log_level, log_to_file=True)
 
-    logger.info(f"Basic Memory {basic_memory.__version__} (Project: {config.project})")
-    _LOGGING_SETUP = True
 
+def init_api_logging() -> None:  # pragma: no cover
+    """Initialize logging for API server.
 
-# Set up logging
-setup_basic_memory_logging()
+    Cloud mode (BASIC_MEMORY_CLOUD_MODE=1): stdout with structured context
+    Local mode: file only
+    """
+    log_level = os.getenv("BASIC_MEMORY_LOG_LEVEL", "INFO")
+    cloud_mode = os.getenv("BASIC_MEMORY_CLOUD_MODE", "").lower() in ("1", "true")
+    if cloud_mode:
+        setup_logging(log_level=log_level, log_to_stdout=True, structured_context=True)
+    else:
+        setup_logging(log_level=log_level, log_to_file=True)