spindb 0.37.2 → 0.38.0

package/engines/mariadb/README.md

@@ -1,141 +0,0 @@
-# MariaDB Engine Implementation
-
-## Overview
-
-MariaDB is a MySQL-compatible SQL database. SpinDB downloads MariaDB binaries from hostdb and manages them with MySQL-compatible tooling.
-
-## Platform Support
-
-| Platform | Architecture | Status | Notes |
-|----------|--------------|--------|-------|
-| darwin | x64 | Supported | Uses hostdb binaries |
-| darwin | arm64 | Supported | Uses hostdb binaries (Apple Silicon) |
-| linux | x64 | Supported | Uses hostdb binaries |
-| linux | arm64 | Supported | Uses hostdb binaries |
-| win32 | x64 | Supported | Uses hostdb binaries |
-
-## Binary Packaging
-
-### Archive Format
-- **Unix (macOS/Linux)**: `tar.gz`
-- **Windows**: `zip`
-
-### Archive Structure
-```text
-mariadb/
-├── bin/
-│   ├── mariadbd         # Server binary (newer versions)
-│   ├── mysqld           # Server binary (legacy fallback)
-│   ├── mariadb          # Client binary (newer versions)
-│   ├── mysql            # Client binary (legacy fallback)
-│   ├── mariadb-dump     # Backup utility
-│   └── mysqldump        # Backup utility (legacy)
-├── lib/                 # Shared libraries
-└── share/               # Configuration files
-```
-
-### Server Binary Names
-
-MariaDB has transitioned binary names over versions:
-- **Newer versions (11.x+)**: `mariadbd`, `mariadb`, `mariadb-dump`
-- **Legacy versions (10.x)**: `mysqld`, `mysql`, `mysqldump`
-
-The binary manager checks for both names: `['mariadbd', 'mysqld']`
-
-### Version Map Sync
-
-```typescript
-export const MARIADB_VERSION_MAP: Record<string, string> = {
-  '10.11': '10.11.15',
-  '11.4': '11.4.5',
-  '11.8': '11.8.5',
-}
-```
-
-## Implementation Details
-
-### Binary Manager
-
-MariaDB uses `BaseServerBinaryManager` with configuration for multiple server binary names:
-
-```typescript
-serverBinaryNames: ['mariadbd', 'mysqld']
-```
-
-### Version Parsing
-
-- **Version output format**: `mariadbd  Ver 11.8.5-MariaDB`
-- **Parse pattern**: `/Ver\s+([\d.]+)/`
-- **Strip trailing .0**: Same handling as MySQL
-
-### Default Configuration
-
-- **Default Port**: 3306 (same as MySQL, auto-increments on conflict)
-- **Default Database**: Name derived from container name
-- **PID File**: `mariadb.pid` in container directory
-
-### Connection String Format
-
-```text
-mysql://127.0.0.1:{port}/{database}
-```
-
-Note: Uses `mysql://` scheme for client compatibility.
-
-## Backup & Restore
-
-### Backup Formats
-
-| Format | Extension | Tool | Notes |
-|--------|-----------|------|-------|
-| sql | `.sql` | mariadb-dump/mysqldump | Plain text SQL |
-| compressed | `.sql.gz` | dump + gzip | Compressed SQL |
-
-### Tool Detection
-
-The engine detects whether to use `mariadb-dump` or `mysqldump` based on which is available in the binary directory.
-
-## Integration Test Notes
-
-### Port Allocation
-
-MariaDB tests may share port range with MySQL tests. Ensure test isolation.
-
-### Test Fixtures
-
-Located in `tests/fixtures/mariadb/seeds/`:
-- `sample-db.sql`: Contains 5 test_user records
-
-## Docker E2E Test Notes
-
-MariaDB is tested in Docker E2E with MySQL-compatible operations.
-
-## Known Issues & Gotchas
-
-### 1. Binary Name Transition
-
-The transition from `mysqld` to `mariadbd` means the engine must check for both binaries. Always test with both old and new MariaDB versions.
-
-### 2. MySQL Compatibility
-
-MariaDB uses the `mysql://` connection scheme for client compatibility, even though it's a different database.
-
-### 3. Port Conflict with MySQL
-
-MariaDB and MySQL share the default port 3306. SpinDB prevents conflicts via auto-increment, but users should be aware of potential issues if running both.
-
-### 4. Client Tool Naming
-
-Client tools like `mariadb-dump` are preferred, but `mysqldump` is used as fallback. The engine's tool detection handles this transparently.
-
-## CI/CD Notes
-
-### GitHub Actions Cache Step
-
-```yaml
-- name: Cache MariaDB binaries
-  uses: actions/cache@v4
-  with:
-    path: ~/.spindb/bin/mariadb-*
-    key: mariadb-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('engines/mariadb/version-maps.ts') }}
-```

package/engines/mariadb/backup.ts

@@ -1,233 +0,0 @@
-/**
- * MariaDB Backup
- *
- * Creates database backups in SQL or compressed (.dump = gzipped SQL) format using mariadb-dump.
- */
-
-import { spawn, type SpawnOptions } from 'child_process'
-import { createWriteStream, existsSync } from 'fs'
-import { stat } from 'fs/promises'
-import { join } from 'path'
-import { createGzip } from 'zlib'
-import { pipeline } from 'stream/promises'
-import {
-  getWindowsSpawnOptions,
-  isWindows,
-  platformService,
-} from '../../core/platform-service'
-import { getEngineDefaults } from '../../config/defaults'
-import { paths } from '../../config/paths'
-import { normalizeVersion } from './version-maps'
-import {
-  Platform,
-  type ContainerConfig,
-  type BackupOptions,
-  type BackupResult,
-} from '../../types'
-
-const engineDef = getEngineDefaults('mariadb')
-
-// Get the path to mariadb-dump or mysqldump from the container's binary path
-async function getDumpPath(container: ContainerConfig): Promise<string> {
-  const { platform, arch } = platformService.getPlatformInfo()
-  const ext = platform === Platform.Win32 ? '.exe' : ''
-
-  const fullVersion = normalizeVersion(container.version)
-  const binPath = paths.getBinaryPath({
-    engine: 'mariadb',
-    version: fullVersion,
-    platform,
-    arch,
-  })
-
-  // Try mariadb-dump first, then mysqldump
-  const mariadbDump = join(binPath, 'bin', `mariadb-dump${ext}`)
-  if (existsSync(mariadbDump)) {
-    return mariadbDump
-  }
-
-  const mysqldump = join(binPath, 'bin', `mysqldump${ext}`)
-  if (existsSync(mysqldump)) {
-    return mysqldump
-  }
-
-  throw new Error(
-    'mariadb-dump or mysqldump not found in MariaDB binary directory.\n' +
-      'Re-download the MariaDB binaries: spindb engines download mariadb',
-  )
-}
-
-/**
- * Create a backup of a MariaDB database
- *
- * CLI equivalent:
- * - SQL format: mariadb-dump -h 127.0.0.1 -P {port} -u root --result-file={outputPath} {database}
- * - Dump format: mariadb-dump -h 127.0.0.1 -P {port} -u root {database} | gzip > {outputPath}
- */
-export async function createBackup(
-  container: ContainerConfig,
-  outputPath: string,
-  options: BackupOptions,
-): Promise<BackupResult> {
-  const { port } = container
-  const { database, format } = options
-
-  const dumpPath = await getDumpPath(container)
-
-  if (format === 'sql') {
-    return createSqlBackup(dumpPath, port, database, outputPath)
-  } else {
-    return createCompressedBackup(dumpPath, port, database, outputPath)
-  }
-}
-
-// Create a plain SQL backup
-async function createSqlBackup(
-  dumpPath: string,
-  port: number,
-  database: string,
-  outputPath: string,
-): Promise<BackupResult> {
-  return new Promise((resolve, reject) => {
-    let settled = false
-    const safeResolve = (value: BackupResult) => {
-      if (!settled) {
-        settled = true
-        resolve(value)
-      }
-    }
-    const safeReject = (err: Error) => {
-      if (!settled) {
-        settled = true
-        reject(err)
-      }
-    }
-
-    const args = [
-      '-h',
-      '127.0.0.1',
-      '-P',
-      String(port),
-      '-u',
-      engineDef.superuser,
-      '--result-file',
-      outputPath,
-      database,
-    ]
-
-    const spawnOptions: SpawnOptions = {
-      stdio: ['pipe', 'pipe', 'pipe'],
-      ...getWindowsSpawnOptions(),
-    }
-
-    const command = isWindows() ? `"${dumpPath}"` : dumpPath
-    const proc = spawn(command, args, spawnOptions)
-
-    let stderr = ''
-
-    proc.stderr?.on('data', (data: Buffer) => {
-      stderr += data.toString()
-    })
-
-    proc.on('error', (err: NodeJS.ErrnoException) => {
-      safeReject(err)
-    })
-
-    proc.on('close', async (code) => {
-      if (code === 0) {
-        try {
-          const stats = await stat(outputPath)
-          safeResolve({
-            path: outputPath,
-            format: 'sql',
-            size: stats.size,
-          })
-        } catch (error) {
-          safeReject(
-            new Error(
-              `Backup completed but failed to read output file: ${error instanceof Error ? error.message : String(error)}`,
-            ),
-          )
-        }
-      } else {
-        const errorMessage = stderr || `mariadb-dump exited with code ${code}`
-        safeReject(new Error(errorMessage))
-      }
-    })
-  })
-}
-
-// Create a compressed (gzipped) backup
-async function createCompressedBackup(
-  dumpPath: string,
-  port: number,
-  database: string,
-  outputPath: string,
-): Promise<BackupResult> {
-  const args = [
-    '-h',
-    '127.0.0.1',
-    '-P',
-    String(port),
-    '-u',
-    engineDef.superuser,
-    database,
-  ]
-
-  const spawnOptions: SpawnOptions = {
-    stdio: ['pipe', 'pipe', 'pipe'],
-    ...getWindowsSpawnOptions(),
-  }
-
-  const command = isWindows() ? `"${dumpPath}"` : dumpPath
-  const proc = spawn(command, args, spawnOptions)
-
-  const gzip = createGzip()
-  const output = createWriteStream(outputPath)
-
-  let stderr = ''
-
-  proc.stderr?.on('data', (data: Buffer) => {
-    stderr += data.toString()
-  })
-
-  const pipelinePromise = pipeline(proc.stdout!, gzip, output)
-
-  const exitPromise = new Promise<void>((resolve, reject) => {
-    proc.on('error', (err: NodeJS.ErrnoException) => {
-      reject(err)
-    })
-
-    proc.on('close', (code) => {
-      if (code === 0) {
-        resolve()
-      } else {
-        const errorMessage = stderr || `mariadb-dump exited with code ${code}`
-        reject(new Error(errorMessage))
-      }
-    })
-  })
-
-  const results = await Promise.allSettled([pipelinePromise, exitPromise])
-
-  const [pipelineResult, exitResult] = results
-  if (exitResult.status === 'rejected') {
-    throw exitResult.reason
-  }
-  if (pipelineResult.status === 'rejected') {
-    throw pipelineResult.reason
-  }
-
-  try {
-    const stats = await stat(outputPath)
-    return {
-      path: outputPath,
-      format: 'compressed',
-      size: stats.size,
-    }
-  } catch (error) {
-    throw new Error(
-      `Backup completed but failed to read output file: ${error instanceof Error ? error.message : String(error)}`,
-    )
-  }
-}

package/engines/mariadb/binary-manager.ts

@@ -1,45 +0,0 @@
-/**
- * MariaDB Binary Manager
- *
- * Handles downloading, extracting, and managing MariaDB binaries from hostdb.
- * MariaDB binaries may use either 'mariadbd' or 'mysqld' as the server binary name,
- * so both are checked in order of preference.
- */
-
-import {
-  BaseServerBinaryManager,
-  type ServerBinaryManagerConfig,
-} from '../../core/base-server-binary-manager'
-import { getBinaryUrl } from './binary-urls'
-import { normalizeVersion } from './version-maps'
-import { Engine, type Platform, type Arch } from '../../types'
-
-class MariaDBBinaryManager extends BaseServerBinaryManager {
-  protected readonly config: ServerBinaryManagerConfig = {
-    engine: Engine.MariaDB,
-    engineName: 'mariadb',
-    displayName: 'MariaDB',
-    // MariaDB may use either mariadbd (newer) or mysqld (legacy)
-    serverBinaryNames: ['mariadbd', 'mysqld'],
-  }
-
-  protected getBinaryUrlFromModule(
-    version: string,
-    platform: Platform,
-    arch: Arch,
-  ): string {
-    return getBinaryUrl(version, platform, arch)
-  }
-
-  protected normalizeVersionFromModule(version: string): string {
-    return normalizeVersion(version)
-  }
-
-  protected parseVersionFromOutput(stdout: string): string | null {
-    // Extract version from output like "mariadbd  Ver 11.8.5-MariaDB"
-    const match = stdout.match(/Ver\s+([\d.]+)/)
-    return match?.[1] ?? null
-  }
-}
-
-export const mariadbBinaryManager = new MariaDBBinaryManager()

package/engines/mariadb/hostdb-releases.ts

@@ -1,23 +0,0 @@
-/**
- * hostdb Releases Module for MariaDB
- *
- * Fetches MariaDB binary information from the hostdb repository at
- * https://github.com/robertjbass/hostdb
- */
-
-import { createHostdbReleases } from '../../core/hostdb-releases-factory'
-import { MARIADB_VERSION_MAP, SUPPORTED_MAJOR_VERSIONS } from './version-maps'
-import { mariadbBinaryManager } from './binary-manager'
-import { Engine } from '../../types'
-
-const hostdbReleases = createHostdbReleases({
-  engine: Engine.MariaDB,
-  displayName: 'MariaDB',
-  versionMap: MARIADB_VERSION_MAP,
-  supportedMajorVersions: SUPPORTED_MAJOR_VERSIONS,
-  groupingStrategy: 'xy-format',
-  listInstalled: () => mariadbBinaryManager.listInstalled(),
-})
-
-export const fetchAvailableVersions = hostdbReleases.fetchAvailableVersions
-export const getLatestVersion = hostdbReleases.getLatestVersion