|
| 1 | +// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license. |
| 2 | + |
| 3 | +import { Command, Flags } from '@oclif/core'; |
| 4 | +import { statSync, existsSync } from 'node:fs'; |
| 5 | +import chalk from 'chalk'; |
| 6 | +import { printError } from '../../utils/format.js'; |
| 7 | +import { resolveDefaultDevDbUrl } from '../dev.js'; |
| 8 | +import { resolveTelemetryDbPath } from '../../utils/telemetry-datasource.js'; |
| 9 | + |
| 10 | +/** |
| 11 | + * `os db clean` — one-time SQLite space reclamation (ADR-0057 §3.4). |
| 12 | + * |
| 13 | + * The platform LifecycleService reclaims space incrementally |
| 14 | + * (`auto_vacuum=INCREMENTAL` + `PRAGMA incremental_vacuum` after sweeps) — |
| 15 | + * but `auto_vacuum` only changes the page layout of a FRESH database, so a |
| 16 | + * file created before the ADR-0057 default stays pinned at its high-water |
| 17 | + * mark until one full `VACUUM` rebuilds it. This command runs exactly that: |
| 18 | + * set the pragma, `VACUUM`, report the reclaimed bytes. Non-destructive — |
| 19 | + * every row survives; only free pages are returned to the OS. |
| 20 | + */ |
| 21 | +export default class DbClean extends Command { |
| 22 | + static override description = |
| 23 | + 'Reclaim SQLite free space (one-time VACUUM) so legacy files adopt auto_vacuum=INCREMENTAL — ADR-0057 §3.4'; |
| 24 | + |
| 25 | + static override examples = [ |
| 26 | + '$ os db clean', |
| 27 | + '$ os db clean --database file:./.objectstack/data/dev.db', |
| 28 | + ]; |
| 29 | + |
| 30 | + static override flags = { |
| 31 | + database: Flags.string({ |
| 32 | + char: 'd', |
| 33 | + description: 'SQLite database URL/path (defaults to $OS_DATABASE_URL, then the per-project dev DB)', |
| 34 | + env: 'OS_DATABASE_URL', |
| 35 | + }), |
| 36 | + }; |
| 37 | + |
| 38 | + async run(): Promise<void> { |
| 39 | + const { flags } = await this.parse(DbClean); |
| 40 | + |
| 41 | + const raw = |
| 42 | + flags.database?.trim() || |
| 43 | + resolveDefaultDevDbUrl({ env: process.env, cwd: process.cwd() }) || |
| 44 | + ''; |
| 45 | + const primary = raw.replace(/^file:/i, '').replace(/^sqlite:/i, ''); |
| 46 | + |
| 47 | + if (!primary || primary === ':memory:' || primary.startsWith(':')) { |
| 48 | + printError('No file-backed SQLite database to clean (in-memory databases reclaim nothing).'); |
| 49 | + this.exit(1); |
| 50 | + return; |
| 51 | + } |
| 52 | + if (!/\.(db|sqlite3|sqlite)$/i.test(primary) && !existsSync(primary)) { |
| 53 | + printError(`Not a SQLite database path: ${primary}`); |
| 54 | + this.exit(1); |
| 55 | + return; |
| 56 | + } |
| 57 | + |
| 58 | + // Clean the telemetry sibling too when one exists (ADR-0057 §3.6). |
| 59 | + const telemetrySibling = resolveTelemetryDbPath({ primaryPath: primary, env: process.env, dev: true }); |
| 60 | + const targets = [primary, telemetrySibling].filter( |
| 61 | + (p): p is string => !!p && existsSync(p), |
| 62 | + ); |
| 63 | + if (targets.length === 0) { |
| 64 | + printError(`Database file not found: ${primary}`); |
| 65 | + this.exit(1); |
| 66 | + return; |
| 67 | + } |
| 68 | + |
| 69 | + const { resolveSqliteDriver } = await import('@objectstack/service-datasource'); |
| 70 | + |
| 71 | + let failed = false; |
| 72 | + for (const file of targets) { |
| 73 | + const before = statSync(file).size; |
| 74 | + try { |
| 75 | + const resolved = await resolveSqliteDriver({ |
| 76 | + filename: file, |
| 77 | + dev: true, // allow the wasm step-down; memory fallback is rejected below |
| 78 | + warn: (m) => console.warn(chalk.yellow(m)), |
| 79 | + }); |
| 80 | + if (resolved.engine === 'memory') { |
| 81 | + throw new Error('no SQLite engine available (native and wasm both failed to load)'); |
| 82 | + } |
| 83 | + // Order matters: the pragma must be set BEFORE the VACUUM so the |
| 84 | + // rebuilt file carries auto_vacuum=INCREMENTAL from here on. |
| 85 | + await resolved.driver.execute('PRAGMA auto_vacuum = INCREMENTAL'); |
| 86 | + await resolved.driver.execute('VACUUM'); |
| 87 | + await resolved.driver.disconnect(); |
| 88 | + |
| 89 | + const after = statSync(file).size; |
| 90 | + const saved = before - after; |
| 91 | + const fmt = (n: number) => `${(n / 1024 / 1024).toFixed(2)} MB`; |
| 92 | + console.log( |
| 93 | + `${chalk.green('✓')} ${file}: ${fmt(before)} → ${fmt(after)}` + |
| 94 | + (saved > 0 ? chalk.dim(` (reclaimed ${fmt(saved)})`) : chalk.dim(' (already compact)')), |
| 95 | + ); |
| 96 | + } catch (error: any) { |
| 97 | + failed = true; |
| 98 | + printError(`VACUUM failed for ${file}: ${error?.message ?? error}`); |
| 99 | + } |
| 100 | + } |
| 101 | + if (failed) this.exit(1); |
| 102 | + } |
| 103 | +} |
0 commit comments