spindb 0.4.0 → 0.5.2

package/config/engine-defaults.ts

@@ -0,0 +1,84 @@
+/**
+ * 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[]
+  /** 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: '16',
+    defaultPort: 5432,
+    portRange: { start: 5432, end: 5500 },
+    supportedVersions: ['14', '15', '16', '17'],
+    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'],
+    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)
+}

package/config/os-dependencies.ts

@@ -241,28 +241,53 @@ const postgresqlDependencies: EngineDependencies = {
 
 const mysqlDependencies: EngineDependencies = {
   engine: 'mysql',
-  displayName: 'MySQL',
+  displayName: 'MySQL/MariaDB',
   dependencies: [
+    {
+      name: 'mysqld',
+      binary: 'mysqld',
+      description: 'MySQL/MariaDB server daemon',
+      packages: {
+        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 mysql',
+        ],
+        linux: [
+          '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: 'mysql',
       binary: 'mysql',
-      description: 'MySQL command-line client',
+      description: 'MySQL/MariaDB command-line client',
       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',
         ],
       },
@@ -270,23 +295,47 @@ const mysqlDependencies: EngineDependencies = {
     {
       name: 'mysqldump',
       binary: 'mysqldump',
-      description: 'MySQL database backup utility',
+      description: 'MySQL/MariaDB database backup utility',
+      packages: {
+        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',
+        ],
+        linux: [
+          '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: '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,7 +1,63 @@
 import { homedir } from 'os'
 import { join } from 'path'
+import { execSync } from 'child_process'
+import { getEngineDefaults } from './engine-defaults'
 
-const SPINDB_HOME = join(homedir(), '.spindb')
+/**
+ * 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.
+ */
+function getRealHomeDir(): string {
+  // Check if running under sudo
+  const sudoUser = process.env.SUDO_USER
+
+  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}`
+      }
+    }
+  }
+
+  // Not running under sudo, use normal homedir
+  return homedir()
+}
+
+const SPINDB_HOME = join(getRealHomeDir(), '.spindb')
+
+/**
+ * Options for container path functions
+ */
+type ContainerPathOptions = {
+  engine: string
+}
+
+/**
+ * Options for binary path functions
+ */
+type BinaryPathOptions = {
+  engine: string
+  version: string
+  platform: string
+  arch: string
+}
 
 export const paths = {
   // Root directory for all spindb data
@@ -16,38 +72,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 file
+   */
+  getContainerConfigPath(name: string, options: ContainerPathOptions): string {
+    const { engine } = options
+    return join(this.containers, engine, name, 'container.json')
   },
 
-  // Get path for container config
-  getContainerConfigPath(name: string): string {
-    return join(this.containers, name, 'container.json')
+  /**
+   * 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 data directory
-  getContainerDataPath(name: string): string {
-    return join(this.containers, name, 'data')
+  /**
+   * 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 log file
-  getContainerLogPath(name: string): string {
-    return join(this.containers, name, 'postgres.log')
+  /**
+   * 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)
   },
 }

package/core/binary-manager.ts

@@ -62,7 +62,12 @@ export class BinaryManager {
     platform: string,
     arch: string,
   ): Promise<boolean> {
-    const binPath = paths.getBinaryPath('postgresql', version, platform, arch)
+    const binPath = paths.getBinaryPath({
+      engine: 'postgresql',
+      version,
+      platform,
+      arch,
+    })
     const postgresPath = join(binPath, 'bin', 'postgres')
     return existsSync(postgresPath)
   }
@@ -109,7 +114,12 @@ export class BinaryManager {
     onProgress?: ProgressCallback,
   ): Promise<string> {
     const url = this.getDownloadUrl(version, platform, arch)
-    const binPath = paths.getBinaryPath('postgresql', version, platform, arch)
+    const binPath = paths.getBinaryPath({
+      engine: 'postgresql',
+      version,
+      platform,
+      arch,
+    })
     const tempDir = join(paths.bin, `temp-${version}-${platform}-${arch}`)
     const jarFile = join(tempDir, 'postgres.jar')
 
@@ -190,7 +200,12 @@ export class BinaryManager {
     platform: string,
     arch: string,
   ): Promise<boolean> {
-    const binPath = paths.getBinaryPath('postgresql', version, platform, arch)
+    const binPath = paths.getBinaryPath({
+      engine: 'postgresql',
+      version,
+      platform,
+      arch,
+    })
     const postgresPath = join(binPath, 'bin', 'postgres')
 
     if (!existsSync(postgresPath)) {
@@ -241,7 +256,12 @@ export class BinaryManager {
     arch: string,
     binary: string,
   ): string {
-    const binPath = paths.getBinaryPath('postgresql', version, platform, arch)
+    const binPath = paths.getBinaryPath({
+      engine: 'postgresql',
+      version,
+      platform,
+      arch,
+    })
     return join(binPath, 'bin', binary)
   }
 
@@ -259,7 +279,12 @@ export class BinaryManager {
         stage: 'cached',
         message: 'Using cached PostgreSQL binaries',
       })
-      return paths.getBinaryPath('postgresql', version, platform, arch)
+      return paths.getBinaryPath({
+        engine: 'postgresql',
+        version,
+        platform,
+        arch,
+      })
     }
 
     return this.download(version, platform, arch, onProgress)