Files
OmniRoute/src/lib/db/jsonMigration.ts
Diego Rodrigues de Sa e Souza 91b6983564 Release v3.8.1 (#2441)
Release v3.8.1 — feature flags settings page, bracketed combo names, security hardening, multi-driver SQLite
2026-05-21 01:29:12 -03:00

321 lines
13 KiB
TypeScript

/**
* db/jsonMigration.ts — Shared helper to hydrate an SQLite database from a
* legacy OmniRoute JSON backup object.
*
* Used by:
* - db/core.ts (auto-migration at startup when db.json is found)
* - api/settings/import-json/route.ts (on-demand import via dashboard)
*
* 🔒 Security: the caller is responsible for stripping sensitive keys
* (password, requireLogin) from `data.settings` BEFORE passing the object
* here, so this function never touches authentication configuration.
*/
import type { SqliteAdapter } from "./adapters/types";
import { normalizeRoutingStrategy } from "@/shared/constants/routingStrategies";
type SqliteDatabase = SqliteAdapter;
export interface LegacyJsonData {
providerConnections?: Record<string, unknown>[];
providerNodes?: Record<string, unknown>[];
combos?: Record<string, unknown>[];
apiKeys?: Record<string, unknown>[];
settings?: Record<string, unknown>;
modelAliases?: Record<string, unknown>;
mitmAlias?: Record<string, unknown>;
pricing?: Record<string, unknown>;
customModels?: Record<string, unknown>;
proxyConfig?: {
global?: unknown;
providers?: unknown;
combos?: unknown;
keys?: unknown;
};
usageHistory?: Record<string, unknown>[];
domainCostHistory?: Record<string, unknown>[];
domainBudgets?: Record<string, unknown>[];
}
/**
* Runs a single SQLite transaction that upserts all entities from a legacy
* JSON backup into the provided database instance.
*
* Returns counts of what was inserted/replaced for logging.
*/
export function runJsonMigration(
db: SqliteDatabase,
data: LegacyJsonData
): {
connections: number;
nodes: number;
combos: number;
apiKeys: number;
usageHistory: number;
domainCostHistory: number;
domainBudgets: number;
} {
const insertConn = db.prepare(`
INSERT OR REPLACE INTO provider_connections (
id, provider, auth_type, name, email, priority, is_active,
access_token, refresh_token, expires_at, token_expires_at,
scope, project_id, test_status, error_code, last_error,
last_error_at, last_error_type, last_error_source, backoff_level,
rate_limited_until, health_check_interval, last_health_check_at,
last_tested, api_key, id_token, provider_specific_data,
expires_in, display_name, global_priority, default_model,
token_type, consecutive_use_count, rate_limit_protection, last_used_at, created_at, updated_at
) VALUES (
@id, @provider, @authType, @name, @email, @priority, @isActive,
@accessToken, @refreshToken, @expiresAt, @tokenExpiresAt,
@scope, @projectId, @testStatus, @errorCode, @lastError,
@lastErrorAt, @lastErrorType, @lastErrorSource, @backoffLevel,
@rateLimitedUntil, @healthCheckInterval, @lastHealthCheckAt,
@lastTested, @apiKey, @idToken, @providerSpecificData,
@expiresIn, @displayName, @globalPriority, @defaultModel,
@tokenType, @consecutiveUseCount, @rateLimitProtection, @lastUsedAt, @createdAt, @updatedAt
)
`);
const insertNode = db.prepare(`
INSERT OR REPLACE INTO provider_nodes (id, type, name, prefix, api_type, base_url, created_at, updated_at)
VALUES (@id, @type, @name, @prefix, @apiType, @baseUrl, @createdAt, @updatedAt)
`);
const insertKv = db.prepare(
"INSERT OR REPLACE INTO key_value (namespace, key, value) VALUES (?, ?, ?)"
);
const insertCombo = db.prepare(`
INSERT OR REPLACE INTO combos (id, name, data, sort_order, created_at, updated_at)
VALUES (@id, @name, @data, @sortOrder, @createdAt, @updatedAt)
`);
const insertKey = db.prepare(`
INSERT OR REPLACE INTO api_keys (id, name, key, machine_id, allowed_models, no_log, created_at)
VALUES (@id, @name, @key, @machineId, @allowedModels, @noLog, @createdAt)
`);
const migrate = db.transaction(() => {
// 1. Provider Connections
for (const conn of data.providerConnections ?? []) {
insertConn.run({
id: conn.id,
provider: conn.provider,
authType: conn.authType ?? "oauth",
name: conn.name ?? null,
email: conn.email ?? null,
priority: conn.priority ?? 0,
isActive: conn.isActive === false ? 0 : 1,
accessToken: conn.accessToken ?? null,
refreshToken: conn.refreshToken ?? null,
expiresAt: conn.expiresAt ?? null,
tokenExpiresAt: conn.tokenExpiresAt ?? null,
scope: conn.scope ?? null,
projectId: conn.projectId ?? null,
testStatus: conn.testStatus ?? null,
errorCode: conn.errorCode ?? null,
lastError: conn.lastError ?? null,
lastErrorAt: conn.lastErrorAt ?? null,
lastErrorType: conn.lastErrorType ?? null,
lastErrorSource: conn.lastErrorSource ?? null,
backoffLevel: conn.backoffLevel ?? 0,
rateLimitedUntil: conn.rateLimitedUntil ?? null,
healthCheckInterval: conn.healthCheckInterval ?? null,
lastHealthCheckAt: conn.lastHealthCheckAt ?? null,
lastTested: conn.lastTested ?? null,
apiKey: conn.apiKey ?? null,
idToken: conn.idToken ?? null,
providerSpecificData: conn.providerSpecificData
? JSON.stringify(conn.providerSpecificData)
: null,
expiresIn: conn.expiresIn ?? null,
displayName: conn.displayName ?? null,
globalPriority: conn.globalPriority ?? null,
defaultModel: conn.defaultModel ?? null,
tokenType: conn.tokenType ?? null,
consecutiveUseCount: conn.consecutiveUseCount ?? 0,
lastUsedAt: conn.lastUsedAt ?? null,
rateLimitProtection:
conn.rateLimitProtection === true || conn.rateLimitProtection === 1 ? 1 : 0,
createdAt: conn.createdAt ?? new Date().toISOString(),
updatedAt: conn.updatedAt ?? new Date().toISOString(),
});
}
// 2. Provider Nodes
for (const node of data.providerNodes ?? []) {
insertNode.run({
id: node.id,
type: node.type,
name: node.name,
prefix: node.prefix ?? null,
apiType: node.apiType ?? null,
baseUrl: node.baseUrl ?? null,
createdAt: node.createdAt ?? new Date().toISOString(),
updatedAt: node.updatedAt ?? new Date().toISOString(),
});
}
// 3. Key-Value Settings (caller must have stripped password / requireLogin)
for (const [key, value] of Object.entries(data.settings ?? {})) {
insertKv.run("settings", key, JSON.stringify(value));
}
// 4. Legacy key-value namespaces
for (const [alias, model] of Object.entries(data.modelAliases ?? {})) {
insertKv.run("modelAliases", alias, JSON.stringify(model));
}
for (const [toolName, mappings] of Object.entries(data.mitmAlias ?? {})) {
insertKv.run("mitmAlias", toolName, JSON.stringify(mappings));
}
for (const [provider, models] of Object.entries(data.pricing ?? {})) {
insertKv.run("pricing", provider, JSON.stringify(models));
}
for (const [providerId, models] of Object.entries(data.customModels ?? {})) {
insertKv.run("customModels", providerId, JSON.stringify(models));
}
if (data.proxyConfig) {
insertKv.run("proxyConfig", "global", JSON.stringify(data.proxyConfig.global ?? null));
insertKv.run("proxyConfig", "providers", JSON.stringify(data.proxyConfig.providers ?? {}));
insertKv.run("proxyConfig", "combos", JSON.stringify(data.proxyConfig.combos ?? {}));
insertKv.run("proxyConfig", "keys", JSON.stringify(data.proxyConfig.keys ?? {}));
}
// 5. Combos
for (const [index, combo] of (data.combos ?? []).entries()) {
const config =
combo.config && typeof combo.config === "object" && !Array.isArray(combo.config)
? { ...(combo.config as Record<string, unknown>) }
: combo.config;
if (config && typeof config === "object" && !Array.isArray(config) && "strategy" in config) {
(config as Record<string, unknown>).strategy = normalizeRoutingStrategy(
(config as Record<string, unknown>).strategy
);
}
const normalizedCombo: Record<string, unknown> = {
...combo,
strategy: normalizeRoutingStrategy(combo.strategy),
config,
sortOrder: typeof combo.sortOrder === "number" ? combo.sortOrder : index + 1,
};
insertCombo.run({
id: normalizedCombo.id,
name: normalizedCombo.name,
data: JSON.stringify(normalizedCombo),
sortOrder: normalizedCombo.sortOrder,
createdAt: normalizedCombo.createdAt ?? new Date().toISOString(),
updatedAt: normalizedCombo.updatedAt ?? new Date().toISOString(),
});
}
// 6. API Keys
for (const apiKey of data.apiKeys ?? []) {
insertKey.run({
id: apiKey.id,
name: apiKey.name,
key: apiKey.key,
machineId: apiKey.machineId ?? null,
allowedModels: JSON.stringify(apiKey.allowedModels ?? []),
noLog: apiKey.noLog ? 1 : 0,
createdAt: apiKey.createdAt ?? new Date().toISOString(),
});
}
// 7. Usage History
if (data.usageHistory && data.usageHistory.length > 0) {
const insertUsageHistory = db.prepare(`
INSERT OR REPLACE INTO usage_history (
id, provider, model, connection_id, api_key_id, api_key_name,
tokens_input, tokens_output, tokens_cache_read, tokens_cache_creation,
tokens_reasoning, status, success, latency_ms, ttft_ms, error_code, timestamp
) VALUES (
@id, @provider, @model, @connection_id, @api_key_id, @api_key_name,
@tokens_input, @tokens_output, @tokens_cache_read, @tokens_cache_creation,
@tokens_reasoning, @status, @success, @latency_ms, @ttft_ms, @error_code, @timestamp
)
`);
for (const row of data.usageHistory) {
insertUsageHistory.run({
id: row.id,
provider: row.provider ?? null,
model: row.model ?? null,
connection_id: row.connection_id ?? null,
api_key_id: row.api_key_id ?? null,
api_key_name: row.api_key_name ?? null,
tokens_input: row.tokens_input ?? 0,
tokens_output: row.tokens_output ?? 0,
tokens_cache_read: row.tokens_cache_read ?? 0,
tokens_cache_creation: row.tokens_cache_creation ?? 0,
tokens_reasoning: row.tokens_reasoning ?? 0,
status: row.status ?? null,
success: row.success ?? 1,
latency_ms: row.latency_ms ?? 0,
ttft_ms: row.ttft_ms ?? 0,
error_code: row.error_code ?? null,
timestamp: row.timestamp,
});
}
}
// 8. Domain Cost History
if (data.domainCostHistory && data.domainCostHistory.length > 0) {
const insertCostHistory = db.prepare(`
INSERT OR REPLACE INTO domain_cost_history (
id, api_key_id, cost, timestamp
) VALUES (
@id, @api_key_id, @cost, @timestamp
)
`);
for (const row of data.domainCostHistory) {
insertCostHistory.run({
id: row.id,
api_key_id: row.api_key_id,
cost: row.cost,
timestamp: row.timestamp,
});
}
}
// 9. Domain Budgets
if (data.domainBudgets && data.domainBudgets.length > 0) {
const insertBudgets = db.prepare(`
INSERT OR REPLACE INTO domain_budgets (
api_key_id, daily_limit_usd, weekly_limit_usd, monthly_limit_usd,
warning_threshold, reset_interval, reset_time, budget_reset_at,
last_budget_reset_at, warning_emitted_at, warning_period_start
) VALUES (
@api_key_id, @daily_limit_usd, @weekly_limit_usd, @monthly_limit_usd,
@warning_threshold, @reset_interval, @reset_time, @budget_reset_at,
@last_budget_reset_at, @warning_emitted_at, @warning_period_start
)
`);
for (const row of data.domainBudgets) {
insertBudgets.run({
api_key_id: row.api_key_id,
daily_limit_usd: row.daily_limit_usd,
weekly_limit_usd: row.weekly_limit_usd ?? 0,
monthly_limit_usd: row.monthly_limit_usd ?? 0,
warning_threshold: row.warning_threshold ?? 0.8,
reset_interval: row.reset_interval ?? "daily",
reset_time: row.reset_time ?? "00:00",
budget_reset_at: row.budget_reset_at ?? null,
last_budget_reset_at: row.last_budget_reset_at ?? null,
warning_emitted_at: row.warning_emitted_at ?? null,
warning_period_start: row.warning_period_start ?? null,
});
}
}
});
migrate();
return {
connections: (data.providerConnections ?? []).length,
nodes: (data.providerNodes ?? []).length,
combos: (data.combos ?? []).length,
apiKeys: (data.apiKeys ?? []).length,
usageHistory: (data.usageHistory ?? []).length,
domainCostHistory: (data.domainCostHistory ?? []).length,
domainBudgets: (data.domainBudgets ?? []).length,
};
}