mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-05-22 19:57:07 +00:00
Reorganizes the 29 active scripts under scripts/ into purpose-driven subfolders: - scripts/build/ (11) — Build, install, publish, runtime env - scripts/dev/ (13) — Dev servers, test runners, healthchecks - scripts/check/ (10) — Lint/validation/coverage checks - scripts/docs/ (2) — Docs index and provider reference generation - scripts/i18n/ (+3) — Adds Python translation utilities (check/validate/autotranslate) - scripts/ad-hoc/ (4) — One-shot maintenance utilities Updates all references in package.json, electron/package.json, .husky/pre-commit, .github/workflows/ci.yml, Dockerfile, src/, tests/, scripts/ internal cross-imports, playwright.config.ts, and English docs (CODEBASE_DOCUMENTATION, ENVIRONMENT, FEATURES, RELEASE_CHECKLIST, COVERAGE_PLAN, ELECTRON_GUIDE, I18N, GEMINI). Also patches scripts/build/pack-artifact-policy.ts so the npm pack allowlist mirrors the new layout. Validates with: - npm run lint (exit 0 — pre-existing minified-bundle errors only) - npm run typecheck:core (exit 0) - npm run check:docs-all (exit 0) - unit tests for moved scripts (57 tests pass) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
323 lines
13 KiB
JavaScript
323 lines
13 KiB
JavaScript
#!/usr/bin/env node
|
||
/**
|
||
* OmniRoute — Zero-Config Bootstrap
|
||
*
|
||
* Auto-generates required secrets (JWT_SECRET, STORAGE_ENCRYPTION_KEY) if
|
||
* missing or empty, persists them to {DATA_DIR}/server.env so they survive
|
||
* restarts, Docker volume remounts, and upgrades.
|
||
*
|
||
* Works across all deployment modes:
|
||
* - npm / app runners: called from run-standalone.mjs and run-next.mjs
|
||
* - Docker: same, secrets persisted in mounted volume
|
||
* - Electron: called from main.js startup, persisted in DATA_DIR
|
||
*
|
||
* Priority (lowest → highest):
|
||
* 1. Auto-generated defaults
|
||
* 2. {DATA_DIR}/server.env (persisted on first boot)
|
||
* 3. Preferred config .env (DATA_DIR/.env -> ~/.omniroute/.env -> ./.env)
|
||
* 4. process.env (shell / Docker -e flags, highest priority)
|
||
*/
|
||
|
||
import { randomBytes, createDecipheriv, scryptSync, createHash } from "node:crypto";
|
||
import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
|
||
import { createRequire } from "node:module";
|
||
import { homedir } from "node:os";
|
||
import { join, resolve } from "node:path";
|
||
|
||
const require = createRequire(import.meta.url);
|
||
|
||
// ── OAuth secrets that are optional but warn if missing ─────────────────────
|
||
const OPTIONAL_OAUTH_SECRETS = [
|
||
{ keys: ["ANTIGRAVITY_OAUTH_CLIENT_SECRET"], label: "Antigravity OAuth" },
|
||
{ keys: ["QODER_OAUTH_CLIENT_SECRET"], label: "Qoder OAuth" },
|
||
{
|
||
keys: ["GEMINI_CLI_OAUTH_CLIENT_SECRET", "GEMINI_OAUTH_CLIENT_SECRET"],
|
||
label: "Gemini OAuth",
|
||
},
|
||
];
|
||
|
||
// ── Resolve DATA_DIR (mirrors dataPaths.ts logic) ───────────────────────────
|
||
function resolveDataDir(overridePath, env = process.env) {
|
||
if (overridePath?.trim()) return resolve(overridePath);
|
||
|
||
const configured = env.DATA_DIR?.trim();
|
||
if (configured) return resolve(configured);
|
||
|
||
if (process.platform === "win32") {
|
||
const appData = env.APPDATA || join(homedir(), "AppData", "Roaming");
|
||
return join(appData, "omniroute");
|
||
}
|
||
|
||
const xdg = env.XDG_CONFIG_HOME?.trim();
|
||
if (xdg) return join(resolve(xdg), "omniroute");
|
||
|
||
return join(homedir(), ".omniroute");
|
||
}
|
||
|
||
function getPreferredEnvFilePath(env = process.env) {
|
||
const candidates = [];
|
||
|
||
if (env.DATA_DIR?.trim()) {
|
||
candidates.push(join(resolve(env.DATA_DIR.trim()), ".env"));
|
||
}
|
||
|
||
candidates.push(join(resolveDataDir(null, env), ".env"));
|
||
candidates.push(join(process.cwd(), ".env"));
|
||
|
||
return candidates.find((filePath) => existsSync(filePath)) ?? null;
|
||
}
|
||
|
||
function hasEncryptedCredentials(dataDir) {
|
||
const dbPath = join(dataDir, "storage.sqlite");
|
||
if (!existsSync(dbPath)) return false;
|
||
|
||
try {
|
||
const Database = require("better-sqlite3");
|
||
const db = new Database(dbPath, { readonly: true, fileMustExist: true });
|
||
try {
|
||
const row = db
|
||
.prepare(
|
||
`SELECT 1
|
||
FROM provider_connections
|
||
WHERE access_token LIKE 'enc:v1:%'
|
||
OR refresh_token LIKE 'enc:v1:%'
|
||
OR api_key LIKE 'enc:v1:%'
|
||
OR id_token LIKE 'enc:v1:%'
|
||
LIMIT 1`
|
||
)
|
||
.get();
|
||
return !!row;
|
||
} finally {
|
||
db.close();
|
||
}
|
||
} catch (error) {
|
||
const message = error instanceof Error ? error.message : String(error);
|
||
throw new Error(`Unable to inspect existing database at ${dbPath}: ${message}`);
|
||
}
|
||
}
|
||
|
||
// ── Parse a simple KEY=VALUE env file ───────────────────────────────────────
|
||
function parseEnvFile(filePath) {
|
||
if (!existsSync(filePath)) return {};
|
||
const env = {};
|
||
const lines = readFileSync(filePath, "utf8").split(/\r?\n/);
|
||
for (const line of lines) {
|
||
const trimmed = line.trim();
|
||
if (!trimmed || trimmed.startsWith("#")) continue;
|
||
const eqIdx = trimmed.indexOf("=");
|
||
if (eqIdx < 1) continue;
|
||
const key = trimmed.slice(0, eqIdx).trim();
|
||
const val = unquoteEnvValue(trimmed.slice(eqIdx + 1).trim());
|
||
env[key] = val;
|
||
}
|
||
return env;
|
||
}
|
||
|
||
function unquoteEnvValue(value) {
|
||
if (value.length < 2) return value;
|
||
const quote = value[0];
|
||
if ((quote !== '"' && quote !== "'") || value[value.length - 1] !== quote) return value;
|
||
return value.slice(1, -1);
|
||
}
|
||
|
||
// ── Write a simple KEY=VALUE env file ───────────────────────────────────────
|
||
function writeEnvFile(filePath, env) {
|
||
const lines = [
|
||
"# Auto-generated by OmniRoute bootstrap — do not delete",
|
||
`# Created: ${new Date().toISOString()}`,
|
||
"",
|
||
...Object.entries(env).map(([k, v]) => `${k}=${v}`),
|
||
"",
|
||
];
|
||
writeFileSync(filePath, lines.join("\n"), "utf8");
|
||
}
|
||
|
||
// ── Main bootstrap function ──────────────────────────────────────────────────
|
||
/**
|
||
* @param {{ dataDirOverride?: string; quiet?: boolean }} options
|
||
* @returns {Record<string, string>} merged env to pass to child process
|
||
*/
|
||
export function bootstrapEnv({ dataDirOverride, quiet = false } = {}) {
|
||
const log = quiet ? () => {} : (msg) => process.stderr.write(`[bootstrap] ${msg}\n`);
|
||
|
||
const preferredEnvPath = getPreferredEnvFilePath(process.env);
|
||
const preferredEnv = preferredEnvPath ? parseEnvFile(preferredEnvPath) : {};
|
||
const dataDir = resolveDataDir(dataDirOverride, { ...preferredEnv, ...process.env });
|
||
const serverEnvPath = join(dataDir, "server.env");
|
||
|
||
// ── Layer 1: Load persisted server.env ────────────────────────────────────
|
||
let persisted = parseEnvFile(serverEnvPath);
|
||
|
||
// ── Layer 2: Load the same preferred .env that the CLI wrapper uses ───────
|
||
// This keeps run-next / run-standalone consistent with `bin/omniroute.mjs`.
|
||
const merged = { ...persisted, ...preferredEnv, ...process.env };
|
||
|
||
// ── Auto-generate required secrets ────────────────────────────────────────
|
||
let needsPersist = false;
|
||
|
||
if (!merged.JWT_SECRET?.trim()) {
|
||
persisted.JWT_SECRET = randomBytes(64).toString("hex");
|
||
merged.JWT_SECRET = persisted.JWT_SECRET;
|
||
needsPersist = true;
|
||
log("✨ JWT_SECRET auto-generated (first run)");
|
||
}
|
||
|
||
if (!merged.STORAGE_ENCRYPTION_KEY?.trim()) {
|
||
if (hasEncryptedCredentials(dataDir)) {
|
||
throw new Error(
|
||
`Refusing to auto-generate STORAGE_ENCRYPTION_KEY: encrypted credentials already exist in ${join(
|
||
dataDir,
|
||
"storage.sqlite"
|
||
)}. Restore the key via ${preferredEnvPath ?? "an appropriate .env file"}, ${serverEnvPath}, or process.env.`
|
||
);
|
||
}
|
||
persisted.STORAGE_ENCRYPTION_KEY = randomBytes(32).toString("hex");
|
||
merged.STORAGE_ENCRYPTION_KEY = persisted.STORAGE_ENCRYPTION_KEY;
|
||
needsPersist = true;
|
||
log("✨ STORAGE_ENCRYPTION_KEY auto-generated (first run)");
|
||
}
|
||
|
||
if (!merged.STORAGE_ENCRYPTION_KEY_VERSION?.trim()) {
|
||
persisted.STORAGE_ENCRYPTION_KEY_VERSION = "v1";
|
||
merged.STORAGE_ENCRYPTION_KEY_VERSION = persisted.STORAGE_ENCRYPTION_KEY_VERSION;
|
||
needsPersist = true;
|
||
}
|
||
|
||
if (!merged.API_KEY_SECRET?.trim()) {
|
||
persisted.API_KEY_SECRET = randomBytes(32).toString("hex");
|
||
merged.API_KEY_SECRET = persisted.API_KEY_SECRET;
|
||
needsPersist = true;
|
||
log("✨ API_KEY_SECRET auto-generated (first run)");
|
||
}
|
||
|
||
// ── Persist new secrets ────────────────────────────────────────────────────
|
||
if (needsPersist) {
|
||
try {
|
||
mkdirSync(dataDir, { recursive: true });
|
||
// Only persist keys that we auto-generated (not .env or process.env vals)
|
||
writeEnvFile(serverEnvPath, persisted);
|
||
log(`📁 Secrets persisted to: ${serverEnvPath}`);
|
||
} catch (e) {
|
||
log(`⚠️ Could not persist secrets to ${serverEnvPath}: ${e.message}`);
|
||
}
|
||
}
|
||
|
||
// ── Mark as bootstrapped ───────────────────────────────────────────────────
|
||
if (needsPersist) {
|
||
merged.OMNIROUTE_BOOTSTRAPPED = "true";
|
||
}
|
||
|
||
// ── Warn about missing optional OAuth secrets ──────────────────────────────
|
||
const missingOauth = OPTIONAL_OAUTH_SECRETS.filter(
|
||
({ keys }) => !keys.some((key) => merged[key]?.trim())
|
||
);
|
||
if (missingOauth.length > 0) {
|
||
log("ℹ️ The following OAuth integrations are not configured:");
|
||
for (const { keys, label } of missingOauth) {
|
||
log(` • ${label} (${keys.join(" or ")}) — set in .env or ${serverEnvPath}`);
|
||
}
|
||
log(" These providers will not work until configured.");
|
||
}
|
||
|
||
// ── Warn about default password ────────────────────────────────────────────
|
||
if (merged.INITIAL_PASSWORD === "CHANGEME" || !merged.INITIAL_PASSWORD?.trim()) {
|
||
log("⚠️ INITIAL_PASSWORD is not set — using default 'CHANGEME'. Change it in Settings!");
|
||
}
|
||
|
||
// ── Decrypt-probe: verify STORAGE_ENCRYPTION_KEY matches encrypted data (#1622) ─
|
||
if (merged.STORAGE_ENCRYPTION_KEY?.trim() && hasEncryptedCredentials(dataDir)) {
|
||
try {
|
||
const Database = require("better-sqlite3");
|
||
const db = new Database(join(dataDir, "storage.sqlite"), {
|
||
readonly: true,
|
||
fileMustExist: true,
|
||
});
|
||
try {
|
||
const row = db
|
||
.prepare(
|
||
`SELECT api_key, access_token, refresh_token, id_token
|
||
FROM provider_connections
|
||
WHERE api_key LIKE 'enc:v1:%'
|
||
OR access_token LIKE 'enc:v1:%'
|
||
OR refresh_token LIKE 'enc:v1:%'
|
||
OR id_token LIKE 'enc:v1:%'
|
||
LIMIT 1`
|
||
)
|
||
.get();
|
||
if (row) {
|
||
const ciphertext = row.api_key || row.access_token || row.refresh_token || row.id_token;
|
||
if (ciphertext?.startsWith("enc:v1:")) {
|
||
const parts = ciphertext.split(":");
|
||
// enc:v1:<iv>:<ct>:<tag>
|
||
if (parts.length >= 5) {
|
||
const iv = Buffer.from(parts[2], "hex");
|
||
const ct = Buffer.from(parts[3], "hex");
|
||
const tag = Buffer.from(parts[4], "hex");
|
||
|
||
// Try decrypting with both key derivation methods matching encryption.ts
|
||
const tryDecrypt = (derivedKey) => {
|
||
const decipher = createDecipheriv("aes-256-gcm", derivedKey, iv);
|
||
decipher.setAuthTag(tag);
|
||
decipher.update(ct);
|
||
decipher.final();
|
||
};
|
||
|
||
// Dynamic salt (current): scryptSync(secret, sha256(secret).slice(0,16), 32)
|
||
const dynamicSalt = createHash("sha256")
|
||
.update(merged.STORAGE_ENCRYPTION_KEY)
|
||
.digest()
|
||
.slice(0, 16);
|
||
const dynamicKey = scryptSync(merged.STORAGE_ENCRYPTION_KEY, dynamicSalt, 32);
|
||
|
||
// Legacy salt (fallback): scryptSync(secret, "omniroute-field-encryption-v1", 32)
|
||
const legacySalt = "omniroute-field-encryption-v1";
|
||
const legacyKey = scryptSync(merged.STORAGE_ENCRYPTION_KEY, legacySalt, 32);
|
||
|
||
let keyMatched = false;
|
||
try {
|
||
tryDecrypt(dynamicKey);
|
||
keyMatched = true;
|
||
} catch {
|
||
// Try legacy key as fallback
|
||
try {
|
||
tryDecrypt(legacyKey);
|
||
keyMatched = true;
|
||
} catch {
|
||
// Both failed — key truly doesn't match
|
||
}
|
||
}
|
||
|
||
if (!keyMatched) {
|
||
log(
|
||
"⛔ STORAGE_ENCRYPTION_KEY does not match the key used to encrypt your stored credentials."
|
||
);
|
||
log(
|
||
" Either restore your previous key via ~/.omniroute/server.env or ~/.omniroute/.env,"
|
||
);
|
||
log(
|
||
" or run: omniroute reset-encrypted-columns --force (wipes credentials, keeps provider config)"
|
||
);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
} finally {
|
||
db.close();
|
||
}
|
||
} catch {
|
||
// Non-fatal — probe is best-effort
|
||
}
|
||
}
|
||
|
||
return merged;
|
||
}
|
||
|
||
// ── CLI usage: node scripts/build/bootstrap-env.mjs ──────────────────────────────
|
||
if (process.argv[1] && process.argv[1].endsWith("bootstrap-env.mjs")) {
|
||
const env = bootstrapEnv();
|
||
process.stderr.write(`[bootstrap] Done. DATA_DIR resolved to: ${resolveDataDir()}\n`);
|
||
process.stderr.write(`[bootstrap] JWT_SECRET length: ${env.JWT_SECRET?.length ?? 0}\n`);
|
||
process.stderr.write(
|
||
`[bootstrap] STORAGE_ENCRYPTION_KEY length: ${env.STORAGE_ENCRYPTION_KEY?.length ?? 0}\n`
|
||
);
|
||
}
|