fix(portable): prevent stale portable marker from wiping history data

This commit is contained in:
zipg authored and GitHub committed 2026-06-28 19:00:40 +08:00
1 parent 33422ec921
commit f57c41381b
4 files changed
+389 -63

No files matched your search

+226 -2
View File
@@ -1,7 +1,7 @@
use std::collections::{HashMap, HashSet};
use std::path::Path;
use rusqlite::{params, params_from_iter, Connection, OptionalExtension, ToSql};
use rusqlite::{params, params_from_iter, Connection, DatabaseName, OpenFlags, OptionalExtension, ToSql};
use serde::{Deserialize, Serialize};
use uuid::Uuid;
@@ -17,6 +17,80 @@ use crate::saved_sql::{SavedSqlFile, SavedSqlFolder, SavedSqlLibrary};
const SSH_TUNNEL_SECRET_PREFIX: &str = "ssh_tunnels.";
const TRANSPORT_LAYER_SECRET_PREFIX: &str = "transport_layers.";
const STORAGE_DB_FILE_NAME: &str = "dbx.db";
const USER_DATA_TABLES: &[&str] = &[
"connections",
"connection_secrets",
"history",
"ai_conversations",
"mq_token_records",
"saved_sql_folders",
"saved_sql_files",
];
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DataDbImportResult {
Imported,
SkippedNoSource,
SkippedInvalidSource,
SkippedInvalidTarget,
SkippedSourceEmpty,
SkippedTargetHasData,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum SqliteDbFileState {
Missing,
Empty,
Valid,
Invalid,
}
pub fn maybe_import_user_data_db(
target_data_dir: &Path,
source_data_dir: Option<&Path>,
) -> Result<DataDbImportResult, String> {
let Some(source_data_dir) = source_data_dir else {
return Ok(DataDbImportResult::SkippedNoSource);
};
let source_db_path = source_data_dir.join(STORAGE_DB_FILE_NAME);
if !source_db_path.is_file() {
return Ok(DataDbImportResult::SkippedNoSource);
}
if inspect_sqlite_db_file(&source_db_path)? != SqliteDbFileState::Valid {
return Ok(DataDbImportResult::SkippedInvalidSource);
}
let source_conn = open_read_only_sqlite(&source_db_path)?;
if !sqlite_db_has_user_data(&source_conn)? {
return Ok(DataDbImportResult::SkippedSourceEmpty);
}
let target_db_path = target_data_dir.join(STORAGE_DB_FILE_NAME);
match inspect_sqlite_db_file(&target_db_path)? {
SqliteDbFileState::Missing => {}
SqliteDbFileState::Empty => {
remove_sqlite_db_files(&target_db_path)?;
}
SqliteDbFileState::Valid => {
let target_conn = open_read_only_sqlite(&target_db_path)?;
if sqlite_db_has_user_data(&target_conn)? {
return Ok(DataDbImportResult::SkippedTargetHasData);
}
drop(target_conn);
remove_sqlite_db_files(&target_db_path)?;
}
SqliteDbFileState::Invalid => return Ok(DataDbImportResult::SkippedInvalidTarget),
}
std::fs::create_dir_all(target_data_dir).map_err(|e| format!("Failed to create data dir: {e}"))?;
source_conn
.backup(DatabaseName::Main, &target_db_path, None)
.map_err(|e| format!("Failed to import user data db: {e}"))?;
Ok(DataDbImportResult::Imported)
}
pub struct Storage {
db: SqliteHandle,
@@ -224,6 +298,64 @@ impl Storage {
}
}
fn inspect_sqlite_db_file(path: &Path) -> Result<SqliteDbFileState, String> {
if !path.exists() {
return Ok(SqliteDbFileState::Missing);
}
let metadata = path.metadata().map_err(|e| format!("Failed to inspect db file: {e}"))?;
if metadata.len() == 0 {
return Ok(SqliteDbFileState::Empty);
}
if crate::db::sqlite::path_has_sqlite_header(path)? {
Ok(SqliteDbFileState::Valid)
} else {
Ok(SqliteDbFileState::Invalid)
}
}
fn open_read_only_sqlite(path: &Path) -> Result<Connection, String> {
Connection::open_with_flags(path, OpenFlags::SQLITE_OPEN_READ_ONLY)
.map_err(|e| format!("Failed to open db read-only: {e}"))
}
fn sqlite_db_has_user_data(conn: &Connection) -> Result<bool, String> {
for table_name in USER_DATA_TABLES {
if sqlite_table_has_rows(conn, table_name)? {
return Ok(true);
}
}
Ok(false)
}
fn sqlite_table_has_rows(conn: &Connection, table_name: &str) -> Result<bool, String> {
let exists: bool = conn
.query_row(
"SELECT EXISTS(SELECT 1 FROM sqlite_master WHERE type = 'table' AND name = ?1)",
[table_name],
|row| row.get(0),
)
.map_err(|e| e.to_string())?;
if !exists {
return Ok(false);
}
let sql = format!("SELECT EXISTS(SELECT 1 FROM {table_name} LIMIT 1)");
conn.query_row(&sql, [], |row| row.get(0)).map_err(|e| e.to_string())
}
fn remove_sqlite_db_files(db_path: &Path) -> Result<(), String> {
for path in [db_path.to_path_buf(), db_path.with_extension("db-wal"), db_path.with_extension("db-shm")] {
match std::fs::remove_file(&path) {
Ok(()) => {}
Err(err) if err.kind() == std::io::ErrorKind::NotFound => {}
Err(err) => return Err(format!("Failed to remove empty target db file {}: {err}", path.display())),
}
}
Ok(())
}
fn ensure_history_columns_sync(conn: &Connection) -> Result<(), String> {
const COLUMNS: &[(&str, &str)] = &[
("activity_kind", "TEXT NOT NULL DEFAULT 'query'"),
@@ -1956,7 +2088,7 @@ fn map_from_sql_err(err: serde_json::Error) -> rusqlite::Error {
#[cfg(test)]
mod tests {
use super::{DesktopIconTheme, DesktopSettings, Storage};
use super::{maybe_import_user_data_db, DataDbImportResult, DesktopIconTheme, DesktopSettings, Storage};
use crate::connection_secrets::{MQ_AUTH_PASSWORD_KEY, MQ_AUTH_TOKEN_KEY, MQ_TOKEN_SIGNING_KEY};
use crate::models::connection::{ConnectionConfig, DatabaseType};
use crate::saved_sql::SavedSqlFile;
@@ -1967,6 +2099,11 @@ mod tests {
std::env::temp_dir().join(format!("dbx-storage-{name}-{}-{stamp}.db", std::process::id()))
}
fn temp_data_dir(name: &str) -> std::path::PathBuf {
let stamp = SystemTime::now().duration_since(UNIX_EPOCH).unwrap().as_nanos();
std::env::temp_dir().join(format!("dbx-storage-{name}-{}-{stamp}", std::process::id()))
}
fn mq_connection(id: &str, token: &str) -> ConnectionConfig {
ConnectionConfig {
id: id.to_string(),
@@ -2055,6 +2192,93 @@ mod tests {
config.external_config.as_ref()?.get("tokenSigning")?.get("key")?.as_str()
}
async fn create_data_dir_with_connection(name: &str, connection_id: &str, token: &str) -> std::path::PathBuf {
let data_dir = temp_data_dir(name);
let storage = Storage::open(&data_dir.join("dbx.db")).await.unwrap();
storage.save_connections(&[mq_connection(connection_id, token)]).await.unwrap();
drop(storage);
data_dir
}
#[tokio::test]
async fn import_user_data_db_copies_source_when_target_is_missing() {
let source_dir = create_data_dir_with_connection("import-source", "source-connection", "source-token").await;
let target_dir = temp_data_dir("import-target");
let result = maybe_import_user_data_db(&target_dir, Some(&source_dir)).unwrap();
assert_eq!(result, DataDbImportResult::Imported);
let storage = Storage::open(&target_dir.join("dbx.db")).await.unwrap();
let connections = storage.load_connections().await.unwrap();
assert_eq!(connections.len(), 1);
assert_eq!(connections[0].id, "source-connection");
assert_eq!(mq_token(&connections[0]), Some("source-token"));
}
#[tokio::test]
async fn import_user_data_db_does_not_overwrite_target_with_user_data() {
let source_dir =
create_data_dir_with_connection("import-source-existing", "source-connection", "source-token").await;
let target_dir =
create_data_dir_with_connection("import-target-existing", "target-connection", "target-token").await;
let result = maybe_import_user_data_db(&target_dir, Some(&source_dir)).unwrap();
assert_eq!(result, DataDbImportResult::SkippedTargetHasData);
let storage = Storage::open(&target_dir.join("dbx.db")).await.unwrap();
let connections = storage.load_connections().await.unwrap();
assert_eq!(connections.len(), 1);
assert_eq!(connections[0].id, "target-connection");
assert_eq!(mq_token(&connections[0]), Some("target-token"));
}
#[tokio::test]
async fn import_user_data_db_replaces_empty_target_schema() {
let source_dir =
create_data_dir_with_connection("import-source-empty-target", "source-connection", "source-token").await;
let target_dir = temp_data_dir("import-empty-target");
let target_storage = Storage::open(&target_dir.join("dbx.db")).await.unwrap();
target_storage
.save_desktop_settings(&DesktopSettings { debug_logging_enabled: true, ..DesktopSettings::default() })
.await
.unwrap();
drop(target_storage);
let result = maybe_import_user_data_db(&target_dir, Some(&source_dir)).unwrap();
assert_eq!(result, DataDbImportResult::Imported);
let storage = Storage::open(&target_dir.join("dbx.db")).await.unwrap();
let connections = storage.load_connections().await.unwrap();
assert_eq!(connections.len(), 1);
assert_eq!(connections[0].id, "source-connection");
}
#[tokio::test]
async fn import_user_data_db_skips_empty_source_schema() {
let source_dir = temp_data_dir("import-empty-source");
let source_storage = Storage::open(&source_dir.join("dbx.db")).await.unwrap();
drop(source_storage);
let target_dir = temp_data_dir("import-empty-source-target");
let result = maybe_import_user_data_db(&target_dir, Some(&source_dir)).unwrap();
assert_eq!(result, DataDbImportResult::SkippedSourceEmpty);
assert!(!target_dir.join("dbx.db").exists());
}
#[test]
fn import_user_data_db_skips_invalid_source_file() {
let source_dir = temp_data_dir("import-invalid-source");
std::fs::create_dir_all(&source_dir).unwrap();
std::fs::write(source_dir.join("dbx.db"), b"not sqlite").unwrap();
let target_dir = temp_data_dir("import-invalid-source-target");
let result = maybe_import_user_data_db(&target_dir, Some(&source_dir)).unwrap();
assert_eq!(result, DataDbImportResult::SkippedInvalidSource);
assert!(!target_dir.join("dbx.db").exists());
}
#[tokio::test]
async fn save_connections_moves_mq_auth_token_to_secret_table_and_restores_it() {
let path = temp_db_path("mq-token-secrets");