spindb 0.4.1 → 0.5.3

package/config/defaults.ts

@@ -1,3 +1,20 @@
+import {
+  engineDefaults,
+  getEngineDefaults,
+  isEngineSupported,
+  getSupportedEngines,
+  type EngineDefaults,
+} from './engine-defaults'
+
+// Re-export engine-related functions and types
+export {
+  engineDefaults,
+  getEngineDefaults,
+  isEngineSupported,
+  getSupportedEngines,
+  type EngineDefaults,
+}
+
 export type PlatformMappings = {
   [key: string]: string
 }
@@ -7,42 +24,50 @@ export type PortRange = {
   end: number
 }
 
+/**
+ * Legacy Defaults type - kept for backward compatibility
+ * New code should use getEngineDefaults(engine) instead
+ */
 export type Defaults = {
+  /** @deprecated Use getEngineDefaults(engine).defaultVersion instead */
   postgresVersion: string
   port: number
   portRange: PortRange
   engine: string
+  /** @deprecated Use getEngineDefaults(engine).supportedVersions instead */
   supportedPostgresVersions: string[]
   superuser: string
   platformMappings: PlatformMappings
 }
 
-// TODO - make defaults configurable via env vars or config file
-// TODO - make defaults generic so it supports multiple engines
-// TODO - consider using a configuration file or environment variables for overrides
+// Get PostgreSQL defaults from engine-defaults
+const pgDefaults = engineDefaults.postgresql
+
+/**
+ * Default configuration values
+ * For backward compatibility, this defaults to PostgreSQL settings.
+ * New code should use getEngineDefaults(engine) for engine-specific defaults.
+ */
 export const defaults: Defaults = {
-  // Default PostgreSQL version
-  postgresVersion: '16',
+  // Default PostgreSQL version (from engine defaults)
+  postgresVersion: pgDefaults.defaultVersion,
 
   // Default port (standard PostgreSQL port)
-  port: 5432,
+  port: pgDefaults.defaultPort,
 
   // Port range to scan if default is busy
-  portRange: {
-    start: 5432,
-    end: 5500,
-  },
+  portRange: pgDefaults.portRange,
 
   // Default engine
   engine: 'postgresql',
 
-  // Supported PostgreSQL versions
-  supportedPostgresVersions: ['14', '15', '16', '17'],
+  // Supported PostgreSQL versions (from engine defaults)
+  supportedPostgresVersions: pgDefaults.supportedVersions,
 
-  // Default superuser
-  superuser: 'postgres',
+  // Default superuser (from engine defaults)
+  superuser: pgDefaults.superuser,
 
-  // Platform mappings for zonky.io binaries
+  // Platform mappings for zonky.io binaries (PostgreSQL specific)
   platformMappings: {
     'darwin-arm64': 'darwin-arm64v8',
     'darwin-x64': 'darwin-amd64',

package/config/engine-defaults.ts

@@ -0,0 +1,107 @@
+/**
+ * Engine-specific default configurations
+ * Extracted for dependency injection pattern - allows each engine to define its own defaults
+ */
+
+export type EngineDefaults = {
+  /** Default version to use when not specified */
+  defaultVersion: string
+  /** Default port for this engine */
+  defaultPort: number
+  /** Port range to scan if default is busy */
+  portRange: { start: number; end: number }
+  /** Supported major versions */
+  supportedVersions: string[]
+  /** Latest major version (used for Homebrew package names like postgresql@17) */
+  latestVersion: string
+  /** Default superuser name */
+  superuser: string
+  /** Connection string scheme (e.g., 'postgresql', 'mysql') */
+  connectionScheme: string
+  /** Log file name within container directory */
+  logFileName: string
+  /** PID file name (relative to data directory or container) */
+  pidFileName: string
+  /** Subdirectory for data files within container */
+  dataSubdir: string
+  /** Client tools required for this engine */
+  clientTools: string[]
+}
+
+export const engineDefaults: Record<string, EngineDefaults> = {
+  postgresql: {
+    defaultVersion: '17',
+    defaultPort: 5432,
+    portRange: { start: 5432, end: 5500 },
+    supportedVersions: ['14', '15', '16', '17'],
+    latestVersion: '17', // Update when PostgreSQL 18 is released
+    superuser: 'postgres',
+    connectionScheme: 'postgresql',
+    logFileName: 'postgres.log',
+    pidFileName: 'postmaster.pid',
+    dataSubdir: 'data',
+    clientTools: ['psql', 'pg_dump', 'pg_restore', 'pg_basebackup'],
+  },
+  mysql: {
+    defaultVersion: '9.0',
+    defaultPort: 3306,
+    portRange: { start: 3306, end: 3400 },
+    supportedVersions: ['5.7', '8.0', '8.4', '9.0'],
+    latestVersion: '9.0', // MySQL doesn't use versioned Homebrew packages, but kept for consistency
+    superuser: 'root',
+    connectionScheme: 'mysql',
+    logFileName: 'mysql.log',
+    pidFileName: 'mysql.pid',
+    dataSubdir: 'data',
+    clientTools: ['mysql', 'mysqldump', 'mysqlpump'],
+  },
+}
+
+/**
+ * Get engine defaults by name
+ * @throws Error if engine is not found
+ */
+export function getEngineDefaults(engine: string): EngineDefaults {
+  const normalized = engine.toLowerCase()
+  const defaults = engineDefaults[normalized]
+  if (!defaults) {
+    const available = Object.keys(engineDefaults).join(', ')
+    throw new Error(
+      `Unknown engine "${engine}". Available engines: ${available}`,
+    )
+  }
+  return defaults
+}
+
+/**
+ * Check if an engine is supported
+ */
+export function isEngineSupported(engine: string): boolean {
+  return engine.toLowerCase() in engineDefaults
+}
+
+/**
+ * Get list of all supported engine names
+ */
+export function getSupportedEngines(): string[] {
+  return Object.keys(engineDefaults)
+}
+
+/**
+ * Get Homebrew package name for PostgreSQL client tools
+ * Returns 'postgresql@17' format for versioned installs
+ */
+export function getPostgresHomebrewPackage(): string {
+  const version = engineDefaults.postgresql.latestVersion
+  return `postgresql@${version}`
+}
+
+/**
+ * Get the PostgreSQL Homebrew bin path for a given architecture
+ * @param arch - 'arm64' or 'x64'
+ */
+export function getPostgresHomebrewBinPath(arch: 'arm64' | 'x64'): string {
+  const pkg = getPostgresHomebrewPackage()
+  const prefix = arch === 'arm64' ? '/opt/homebrew' : '/usr/local'
+  return `${prefix}/opt/${pkg}/bin`
+}

package/config/os-dependencies.ts

@@ -5,9 +5,11 @@
  * across different operating systems and package managers.
  */
 
+import { getPostgresHomebrewPackage } from './engine-defaults'
+
 export type PackageManagerId = 'brew' | 'apt' | 'yum' | 'dnf' | 'pacman'
 
-export type Platform = 'darwin' | 'linux'
+export type Platform = 'darwin' | 'linux' | 'win32'
 
 /**
  * Package definition for a specific package manager
@@ -116,177 +118,170 @@ export const packageManagers: PackageManagerConfig[] = [
 // PostgreSQL Dependencies
 // =============================================================================
 
+/**
+ * Helper to create PostgreSQL client tool dependency
+ * Uses getPostgresHomebrewPackage() to get the current latest version
+ */
+function createPostgresDependency(
+  name: string,
+  binary: string,
+  description: string,
+): Dependency {
+  const pgPackage = getPostgresHomebrewPackage()
+  return {
+    name,
+    binary,
+    description,
+    packages: {
+      brew: {
+        package: pgPackage,
+        postInstall: [`brew link --overwrite ${pgPackage}`],
+      },
+      apt: { package: 'postgresql-client' },
+      yum: { package: 'postgresql' },
+      dnf: { package: 'postgresql' },
+      pacman: { package: 'postgresql-libs' },
+    },
+    manualInstall: {
+      darwin: [
+        'Install Homebrew: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"',
+        `Then run: brew install ${pgPackage} && brew link --overwrite ${pgPackage}`,
+        'Or install Postgres.app: https://postgresapp.com/downloads.html',
+      ],
+      linux: [
+        'Ubuntu/Debian: sudo apt install postgresql-client',
+        'CentOS/RHEL: sudo yum install postgresql',
+        'Fedora: sudo dnf install postgresql',
+        'Arch: sudo pacman -S postgresql-libs',
+      ],
+    },
+  }
+}
+
 const postgresqlDependencies: EngineDependencies = {
   engine: 'postgresql',
   displayName: 'PostgreSQL',
+  dependencies: [
+    createPostgresDependency('psql', 'psql', 'PostgreSQL interactive terminal'),
+    createPostgresDependency(
+      'pg_dump',
+      'pg_dump',
+      'PostgreSQL database backup utility',
+    ),
+    createPostgresDependency(
+      'pg_restore',
+      'pg_restore',
+      'PostgreSQL database restore utility',
+    ),
+    createPostgresDependency(
+      'pg_basebackup',
+      'pg_basebackup',
+      'PostgreSQL base backup utility for physical backups',
+    ),
+  ],
+}
+
+// =============================================================================
+// MySQL Dependencies (placeholder for future)
+// =============================================================================
+
+const mysqlDependencies: EngineDependencies = {
+  engine: 'mysql',
+  displayName: 'MySQL/MariaDB',
   dependencies: [
     {
-      name: 'psql',
-      binary: 'psql',
-      description: 'PostgreSQL interactive terminal',
-      packages: {
-        brew: {
-          package: 'postgresql@17',
-          postInstall: ['brew link --overwrite postgresql@17'],
-        },
-        apt: { package: 'postgresql-client' },
-        yum: { package: 'postgresql' },
-        dnf: { package: 'postgresql' },
-        pacman: { package: 'postgresql-libs' },
-      },
-      manualInstall: {
-        darwin: [
-          'Install Homebrew: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"',
-          'Then run: brew install postgresql@17 && brew link --overwrite postgresql@17',
-          'Or install Postgres.app: https://postgresapp.com/downloads.html',
-        ],
-        linux: [
-          'Ubuntu/Debian: sudo apt install postgresql-client',
-          'CentOS/RHEL: sudo yum install postgresql',
-          'Fedora: sudo dnf install postgresql',
-          'Arch: sudo pacman -S postgresql-libs',
-        ],
-      },
-    },
-    {
-      name: 'pg_dump',
-      binary: 'pg_dump',
-      description: 'PostgreSQL database backup utility',
-      packages: {
-        brew: {
-          package: 'postgresql@17',
-          postInstall: ['brew link --overwrite postgresql@17'],
-        },
-        apt: { package: 'postgresql-client' },
-        yum: { package: 'postgresql' },
-        dnf: { package: 'postgresql' },
-        pacman: { package: 'postgresql-libs' },
-      },
-      manualInstall: {
-        darwin: [
-          'Install Homebrew: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"',
-          'Then run: brew install postgresql@17 && brew link --overwrite postgresql@17',
-          'Or install Postgres.app: https://postgresapp.com/downloads.html',
-        ],
-        linux: [
-          'Ubuntu/Debian: sudo apt install postgresql-client',
-          'CentOS/RHEL: sudo yum install postgresql',
-          'Fedora: sudo dnf install postgresql',
-          'Arch: sudo pacman -S postgresql-libs',
-        ],
-      },
-    },
-    {
-      name: 'pg_restore',
-      binary: 'pg_restore',
-      description: 'PostgreSQL database restore utility',
+      name: 'mysqld',
+      binary: 'mysqld',
+      description: 'MySQL/MariaDB server daemon',
       packages: {
-        brew: {
-          package: 'postgresql@17',
-          postInstall: ['brew link --overwrite postgresql@17'],
-        },
-        apt: { package: 'postgresql-client' },
-        yum: { package: 'postgresql' },
-        dnf: { package: 'postgresql' },
-        pacman: { package: 'postgresql-libs' },
+        brew: { package: 'mysql' },
+        // Modern Debian/Ubuntu use mariadb-server (MySQL-compatible)
+        apt: { package: 'mariadb-server' },
+        yum: { package: 'mariadb-server' },
+        dnf: { package: 'mariadb-server' },
+        pacman: { package: 'mariadb' },
       },
       manualInstall: {
         darwin: [
           'Install Homebrew: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"',
-          'Then run: brew install postgresql@17 && brew link --overwrite postgresql@17',
-          'Or install Postgres.app: https://postgresapp.com/downloads.html',
+          'Then run: brew install mysql',
         ],
         linux: [
-          'Ubuntu/Debian: sudo apt install postgresql-client',
-          'CentOS/RHEL: sudo yum install postgresql',
-          'Fedora: sudo dnf install postgresql',
-          'Arch: sudo pacman -S postgresql-libs',
+          'Debian/Ubuntu: sudo apt install mariadb-server',
+          'CentOS/RHEL: sudo yum install mariadb-server',
+          'Fedora: sudo dnf install mariadb-server',
+          'Arch: sudo pacman -S mariadb',
         ],
       },
     },
     {
-      name: 'pg_basebackup',
-      binary: 'pg_basebackup',
-      description: 'PostgreSQL base backup utility for physical backups',
+      name: 'mysql',
+      binary: 'mysql',
+      description: 'MySQL/MariaDB command-line client',
       packages: {
-        brew: {
-          package: 'postgresql@17',
-          postInstall: ['brew link --overwrite postgresql@17'],
-        },
-        apt: { package: 'postgresql-client' },
-        yum: { package: 'postgresql' },
-        dnf: { package: 'postgresql' },
-        pacman: { package: 'postgresql-libs' },
+        brew: { package: 'mysql' },
+        apt: { package: 'mariadb-client' },
+        yum: { package: 'mariadb' },
+        dnf: { package: 'mariadb' },
+        pacman: { package: 'mariadb-clients' },
       },
       manualInstall: {
         darwin: [
           'Install Homebrew: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"',
-          'Then run: brew install postgresql@17 && brew link --overwrite postgresql@17',
-          'Or install Postgres.app: https://postgresapp.com/downloads.html',
+          'Then run: brew install mysql',
         ],
         linux: [
-          'Ubuntu/Debian: sudo apt install postgresql-client',
-          'CentOS/RHEL: sudo yum install postgresql',
-          'Fedora: sudo dnf install postgresql',
-          'Arch: sudo pacman -S postgresql-libs',
+          'Debian/Ubuntu: sudo apt install mariadb-client',
+          'CentOS/RHEL: sudo yum install mariadb',
+          'Fedora: sudo dnf install mariadb',
+          'Arch: sudo pacman -S mariadb-clients',
         ],
       },
     },
-  ],
-}
-
-// =============================================================================
-// MySQL Dependencies (placeholder for future)
-// =============================================================================
-
-const mysqlDependencies: EngineDependencies = {
-  engine: 'mysql',
-  displayName: 'MySQL',
-  dependencies: [
     {
-      name: 'mysql',
-      binary: 'mysql',
-      description: 'MySQL command-line client',
+      name: 'mysqldump',
+      binary: 'mysqldump',
+      description: 'MySQL/MariaDB database backup utility',
       packages: {
-        brew: { package: 'mysql-client' },
-        apt: { package: 'mysql-client' },
-        yum: { package: 'mysql' },
-        dnf: { package: 'mysql' },
+        brew: { package: 'mysql' },
+        apt: { package: 'mariadb-client' },
+        yum: { package: 'mariadb' },
+        dnf: { package: 'mariadb' },
         pacman: { package: 'mariadb-clients' },
       },
       manualInstall: {
         darwin: [
           'Install Homebrew: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"',
-          'Then run: brew install mysql-client',
+          'Then run: brew install mysql',
         ],
         linux: [
-          'Ubuntu/Debian: sudo apt install mysql-client',
-          'CentOS/RHEL: sudo yum install mysql',
-          'Fedora: sudo dnf install mysql',
+          'Debian/Ubuntu: sudo apt install mariadb-client',
+          'CentOS/RHEL: sudo yum install mariadb',
+          'Fedora: sudo dnf install mariadb',
           'Arch: sudo pacman -S mariadb-clients',
         ],
       },
     },
     {
-      name: 'mysqldump',
-      binary: 'mysqldump',
-      description: 'MySQL database backup utility',
+      name: 'mysqladmin',
+      binary: 'mysqladmin',
+      description: 'MySQL/MariaDB server administration utility',
       packages: {
-        brew: { package: 'mysql-client' },
-        apt: { package: 'mysql-client' },
-        yum: { package: 'mysql' },
-        dnf: { package: 'mysql' },
+        brew: { package: 'mysql' },
+        apt: { package: 'mariadb-client' },
+        yum: { package: 'mariadb' },
+        dnf: { package: 'mariadb' },
         pacman: { package: 'mariadb-clients' },
       },
       manualInstall: {
         darwin: [
           'Install Homebrew: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"',
-          'Then run: brew install mysql-client',
+          'Then run: brew install mysql',
         ],
         linux: [
-          'Ubuntu/Debian: sudo apt install mysql-client',
-          'CentOS/RHEL: sudo yum install mysql',
-          'Fedora: sudo dnf install mysql',
+          'Debian/Ubuntu: sudo apt install mariadb-client',
+          'CentOS/RHEL: sudo yum install mariadb',
+          'Fedora: sudo dnf install mariadb',
           'Arch: sudo pacman -S mariadb-clients',
         ],
       },

package/config/paths.ts

@@ -1,45 +1,34 @@
-import { homedir } from 'os'
 import { join } from 'path'
-import { execSync } from 'child_process'
+import { getEngineDefaults } from './engine-defaults'
+import { platformService } from '../core/platform-service'
 
 /**
- * Get the real user's home directory, even when running under sudo.
- * When a user runs `sudo spindb`, we want to use their home directory,
- * not root's home directory.
+ * Get the SpinDB home directory using the platform service.
+ * This handles sudo detection and platform-specific home directories.
  */
-function getRealHomeDir(): string {
-  // Check if running under sudo
-  const sudoUser = process.env.SUDO_USER
+function getSpinDBHome(): string {
+  const platformInfo = platformService.getPlatformInfo()
+  return join(platformInfo.homeDir, '.spindb')
+}
 
-  if (sudoUser) {
-    // Get the original user's home directory
-    try {
-      // Use getent to reliably get the home directory for the sudo user
-      const result = execSync(`getent passwd ${sudoUser}`, {
-        encoding: 'utf-8',
-      })
-      const parts = result.trim().split(':')
-      if (parts.length >= 6 && parts[5]) {
-        return parts[5]
-      }
-    } catch {
-      // Fall back to constructing the path
-      // On most Linux systems, home dirs are /home/username
-      // On macOS, they're /Users/username
-      const platform = process.platform
-      if (platform === 'darwin') {
-        return `/Users/${sudoUser}`
-      } else {
-        return `/home/${sudoUser}`
-      }
-    }
-  }
+const SPINDB_HOME = getSpinDBHome()
 
-  // Not running under sudo, use normal homedir
-  return homedir()
+/**
+ * Options for container path functions
+ */
+type ContainerPathOptions = {
+  engine: string
 }
 
-const SPINDB_HOME = join(getRealHomeDir(), '.spindb')
+/**
+ * Options for binary path functions
+ */
+type BinaryPathOptions = {
+  engine: string
+  version: string
+  platform: string
+  arch: string
+}
 
 export const paths = {
   // Root directory for all spindb data
@@ -54,38 +43,75 @@ export const paths = {
   // Global config file
   config: join(SPINDB_HOME, 'config.json'),
 
-  // Get path for a specific binary version
-  getBinaryPath(
-    engine: string,
-    version: string,
-    platform: string,
-    arch: string,
-  ): string {
+  /**
+   * Get path for a specific binary version
+   */
+  getBinaryPath(options: BinaryPathOptions): string {
+    const { engine, version, platform, arch } = options
     return join(this.bin, `${engine}-${version}-${platform}-${arch}`)
   },
 
-  // Get path for a specific container
-  getContainerPath(name: string): string {
-    return join(this.containers, name)
+  /**
+   * Get path for a specific container
+   * New structure: ~/.spindb/containers/{engine}/{name}/
+   */
+  getContainerPath(name: string, options: ContainerPathOptions): string {
+    const { engine } = options
+    return join(this.containers, engine, name)
   },
 
-  // Get path for container config
-  getContainerConfigPath(name: string): string {
-    return join(this.containers, name, 'container.json')
+  /**
+   * Get path for container config file
+   */
+  getContainerConfigPath(name: string, options: ContainerPathOptions): string {
+    const { engine } = options
+    return join(this.containers, engine, name, 'container.json')
   },
 
-  // Get path for container data directory
-  getContainerDataPath(name: string): string {
-    return join(this.containers, name, 'data')
+  /**
+   * Get path for container data directory
+   */
+  getContainerDataPath(name: string, options: ContainerPathOptions): string {
+    const { engine } = options
+    const engineDef = getEngineDefaults(engine)
+    return join(this.containers, engine, name, engineDef.dataSubdir)
   },
 
-  // Get path for container log file
-  getContainerLogPath(name: string): string {
-    return join(this.containers, name, 'postgres.log')
+  /**
+   * Get path for container log file
+   */
+  getContainerLogPath(name: string, options: ContainerPathOptions): string {
+    const { engine } = options
+    const engineDef = getEngineDefaults(engine)
+    return join(this.containers, engine, name, engineDef.logFileName)
+  },
+
+  /**
+   * Get path for container PID file
+   * Note: For PostgreSQL, PID is inside data dir. For MySQL, it may differ.
+   */
+  getContainerPidPath(name: string, options: ContainerPathOptions): string {
+    const { engine } = options
+    const engineDef = getEngineDefaults(engine)
+    // PostgreSQL: data/postmaster.pid
+    // MySQL: data/mysql.pid (or just mysql.pid depending on config)
+    if (engine === 'postgresql') {
+      return join(
+        this.containers,
+        engine,
+        name,
+        engineDef.dataSubdir,
+        engineDef.pidFileName,
+      )
+    }
+    // MySQL and others: PID file at container level
+    return join(this.containers, engine, name, engineDef.pidFileName)
   },
 
-  // Get path for container PID file
-  getContainerPidPath(name: string): string {
-    return join(this.containers, name, 'data', 'postmaster.pid')
+  /**
+   * Get path for engine-specific containers directory
+   */
+  getEngineContainersPath(engine: string): string {
+    return join(this.containers, engine)
   },
 }