Rename module in database library.

tmpfs · tmpfs · commit d80997829cf0 · 2025-02-05T09:25:35.000+08:00
diff --git a/crates/backend/src/compact.rs b/crates/backend/src/compact.rs
@@ -4,7 +4,7 @@ use sos_core::events::{
     patch::{FolderDiff, Patch},
     EventLog, EventRecord,
 };
-use sos_database::db::open_memory;
+use sos_database::open_memory;
 use sos_filesystem::FolderEventLog as FsFolderEventLog;
 use sos_reducers::FolderReducer;
 use tempfile::NamedTempFile;
diff --git a/crates/backend/src/folder.rs b/crates/backend/src/folder.rs
@@ -11,7 +11,7 @@ use sos_core::{
 use sos_core::{constants::EVENT_LOG_EXT, decode};
 use sos_database::{
     async_sqlite::Client,
-    db::{FolderEntity, FolderRecord, SecretRecord},
+    entity::{FolderEntity, FolderRecord, SecretRecord},
     VaultDatabaseWriter,
 };
 use sos_filesystem::VaultFileWriter;
diff --git a/crates/backend/src/lib.rs b/crates/backend/src/lib.rs
@@ -41,7 +41,7 @@ pub use event_log::BackendFileEventLog as FileEventLog;
 pub(crate) type Result<T> = std::result::Result<T, Error>;
 
 use sos_core::{AccountId, PublicIdentity};
-use sos_database::db::{
+use sos_database::entity::{
     AccountEntity, AccountRecord, FolderEntity, FolderRecord,
 };
 
diff --git a/crates/database/src/archive/archive.rs b/crates/database/src/archive/archive.rs
@@ -1,5 +1,5 @@
 use super::{zip::Writer, Error, Result};
-use crate::db::{AccountEntity, AccountRecord};
+use crate::entity::{AccountEntity, AccountRecord};
 use async_sqlite::rusqlite::{backup, Connection};
 use sos_core::{
     constants::{BLOBS_DIR, DATABASE_FILE},
diff --git a/crates/database/src/archive/import.rs b/crates/database/src/archive/import.rs
@@ -1,5 +1,5 @@
 use super::{types::ManifestVersion3, zip::Reader, Error, Result};
-use crate::db::{
+use crate::entity::{
     AccountEntity, AccountRecord, AccountRow, EventEntity, EventRecordRow,
     FolderEntity, FolderRow, PreferenceEntity, PreferenceRow, SecretRow,
     ServerEntity, ServerRow, SystemMessageEntity, SystemMessageRow,
diff --git a/crates/database/src/audit_provider.rs b/crates/database/src/audit_provider.rs
@@ -1,6 +1,6 @@
 //! Database audit log provider.
 use crate::{
-    db::{AuditEntity, AuditRecord, AuditRow},
+    entity::{AuditEntity, AuditRecord, AuditRow},
     Error,
 };
 use async_sqlite::Client;
diff --git a/crates/database/src/db/mod.rs b/crates/database/src/db/mod.rs
diff --git a/crates/database/src/entity/account.rs b/crates/database/src/entity/account.rs
diff --git a/crates/database/src/entity/audit.rs b/crates/database/src/entity/audit.rs
diff --git a/crates/database/src/entity/event.rs b/crates/database/src/entity/event.rs
diff --git a/crates/database/src/entity/folder.rs b/crates/database/src/entity/folder.rs
diff --git a/crates/database/src/entity/mod.rs b/crates/database/src/entity/mod.rs
@@ -0,0 +1,26 @@
+//! Database entities.
+mod account;
+mod audit;
+mod event;
+// #[cfg(feature = "files")]
+// mod file;
+mod folder;
+#[cfg(feature = "preferences")]
+mod preference;
+mod server;
+#[cfg(feature = "system-messages")]
+mod system_message;
+
+pub use account::{AccountEntity, AccountRecord, AccountRow};
+pub use audit::{AuditEntity, AuditRecord, AuditRow};
+pub use event::{CommitRecord, EventEntity, EventRecordRow};
+// #[cfg(feature = "files")]
+// pub use file::FileEntity;
+pub use folder::{
+    FolderEntity, FolderRecord, FolderRow, SecretRecord, SecretRow,
+};
+#[cfg(feature = "preferences")]
+pub use preference::{PreferenceEntity, PreferenceRow};
+pub use server::{ServerEntity, ServerRow};
+#[cfg(feature = "system-messages")]
+pub use system_message::{SystemMessageEntity, SystemMessageRow};
diff --git a/crates/database/src/entity/preference.rs b/crates/database/src/entity/preference.rs
diff --git a/crates/database/src/entity/server.rs b/crates/database/src/entity/server.rs
diff --git a/crates/database/src/entity/system_message.rs b/crates/database/src/entity/system_message.rs
diff --git a/crates/database/src/event_log.rs b/crates/database/src/event_log.rs
@@ -1,6 +1,6 @@
 //! Event log backed by a database table.
 use crate::{
-    db::{
+    entity::{
         AccountEntity, AccountRecord, CommitRecord, EventEntity,
         EventRecordRow, FolderEntity, FolderRecord,
     },
diff --git a/crates/database/src/lib.rs b/crates/database/src/lib.rs
@@ -7,7 +7,7 @@ pub mod archive;
 #[cfg(all(feature = "audit", feature = "sqlite"))]
 pub mod audit_provider;
 #[cfg(feature = "sqlite")]
-pub mod db;
+pub mod entity;
 #[cfg(feature = "sqlite")]
 pub mod event_log;
 #[cfg(feature = "sqlite")]
@@ -49,3 +49,46 @@ pub use error::Error;
 
 /// Result type for the library.
 pub(crate) type Result<T> = std::result::Result<T, Error>;
+
+use async_sqlite::{Client, ClientBuilder, JournalMode};
+use std::path::Path;
+
+/// Open a database file from a path with WAL journal mode enabled.
+pub async fn open_file(path: impl AsRef<Path>) -> Result<Client> {
+    Ok(ClientBuilder::new()
+        .path(path.as_ref())
+        .journal_mode(JournalMode::Wal)
+        .open()
+        .await?)
+}
+
+/// Open an in-memory database and run migrations.
+pub async fn open_memory() -> Result<Client> {
+    let mut client = ClientBuilder::new().open().await?;
+    crate::migrations::migrate_client(&mut client).await?;
+    Ok(client)
+}
+
+#[cfg(debug_assertions)]
+#[allow(dead_code)]
+pub(crate) fn dump_rows<C>(
+    conn: C,
+    table: &str,
+) -> std::result::Result<(), async_sqlite::rusqlite::Error>
+where
+    C: std::ops::Deref<Target = async_sqlite::rusqlite::Connection>,
+{
+    println!("--- BEGIN DUMP ---");
+    let mut stmt = conn.prepare(&format!(
+        r#"
+            SELECT * FROM {}
+        "#,
+        table
+    ))?;
+    let mut rows = stmt.query([])?;
+    while let Ok(Some(row)) = rows.next() {
+        println!("{:#?}", row);
+    }
+    println!("--- END DUMP ---");
+    Ok(())
+}
diff --git a/crates/database/src/preferences.rs b/crates/database/src/preferences.rs
@@ -1,5 +1,5 @@
 use crate::{
-    db::{AccountEntity, PreferenceEntity, PreferenceRow},
+    entity::{AccountEntity, PreferenceEntity, PreferenceRow},
     Error,
 };
 use async_sqlite::Client;
diff --git a/crates/database/src/server_origins.rs b/crates/database/src/server_origins.rs
@@ -1,5 +1,5 @@
 use crate::{
-    db::{AccountEntity, ServerEntity, ServerRow},
+    entity::{AccountEntity, ServerEntity, ServerRow},
     Error,
 };
 use async_sqlite::Client;
diff --git a/crates/database/src/system_messages.rs b/crates/database/src/system_messages.rs
@@ -2,7 +2,7 @@
 use std::collections::HashMap;
 
 use crate::{
-    db::{AccountEntity, SystemMessageEntity, SystemMessageRow},
+    entity::{AccountEntity, SystemMessageEntity, SystemMessageRow},
     Error,
 };
 use async_sqlite::Client;
diff --git a/crates/database/src/vault_writer.rs b/crates/database/src/vault_writer.rs
@@ -1,6 +1,6 @@
 //! Write vault changes to a database.
 use crate::{
-    db::{FolderEntity, FolderRecord, SecretRecord, SecretRow},
+    entity::{FolderEntity, FolderRecord, SecretRecord, SecretRow},
     Error,
 };
 use async_sqlite::Client;
diff --git a/crates/database_upgrader/src/upgrader/db_import.rs b/crates/database_upgrader/src/upgrader/db_import.rs
@@ -9,7 +9,7 @@ use sos_core::{Origin, VaultCommit};
 use sos_core::{Paths, PublicIdentity, SecretId};
 use sos_database::{
     async_sqlite::{rusqlite::Transaction, Client},
-    db::{
+    entity::{
         AccountEntity, AccountRow, AuditEntity, EventEntity, EventRecordRow,
         FolderEntity, FolderRow, PreferenceEntity, PreferenceRow, SecretRow,
         ServerEntity, SystemMessageEntity, SystemMessageRow,
diff --git a/crates/database_upgrader/src/upgrader/mod.rs b/crates/database_upgrader/src/upgrader/mod.rs
@@ -2,7 +2,7 @@
 use crate::{Error, Result};
 use serde::{Deserialize, Serialize};
 use sos_core::{Paths, PublicIdentity};
-use sos_database::{db, migrations::migrate_client};
+use sos_database::{migrations::migrate_client, open_file, open_memory};
 use sos_external_files::list_external_files;
 use sos_filesystem::archive::AccountBackup;
 use sos_vault::list_accounts;
@@ -88,11 +88,11 @@ async fn import_accounts(
             .db_file
             .as_ref()
             .unwrap_or(options.paths.database_file());
-        let mut client = db::open_file(db_file).await?;
+        let mut client = open_file(db_file).await?;
         migrate_client(&mut client).await?;
         client
     } else {
-        db::open_memory().await?
+        open_memory().await?
     };
 
     db_import::import_globals(&mut client, &options.paths).await?;
diff --git a/crates/login/src/identity_folder.rs b/crates/login/src/identity_folder.rs
@@ -6,12 +6,12 @@
 use crate::device::{DeviceManager, DeviceSigner};
 use crate::{Error, PrivateIdentity, Result, UrnLookup};
 use secrecy::{ExposeSecret, SecretBox, SecretString};
-use sos_backend::database::db::FolderRecord;
 use sos_backend::{
     database::{
         async_sqlite::Client,
-        db::{
-            AccountEntity, AccountRow, FolderEntity, FolderRow, SecretRecord,
+        entity::{
+            AccountEntity, AccountRow, FolderEntity, FolderRecord, FolderRow,
+            SecretRecord,
         },
     },
     write_exclusive, AccessPoint, Folder, FolderEventLog,
diff --git a/crates/storage/server/src/database/mod.rs b/crates/storage/server/src/database/mod.rs
@@ -16,7 +16,7 @@ use sos_core::{
     AccountId, Paths, VaultId,
 };
 use sos_database::async_sqlite::Client;
-use sos_database::db::{
+use sos_database::entity::{
     AccountEntity, AccountRow, FolderEntity, FolderRecord, FolderRow,
 };
 use sos_reducers::{DeviceReducer, FolderReducer};
diff --git a/crates/storage/server/src/database/sync.rs b/crates/storage/server/src/database/sync.rs
@@ -16,7 +16,7 @@ use sos_core::{
     },
     VaultId,
 };
-use sos_database::db::{
+use sos_database::entity::{
     AccountEntity, FolderEntity, FolderRecord, FolderRow,
 };
 use sos_reducers::{DeviceReducer, FolderReducer};
@@ -428,9 +428,11 @@ impl StorageEventLogs for ServerDatabaseStorage {
         &self,
         id: &VaultId,
     ) -> Result<Arc<RwLock<FolderEventLog>>> {
-        Ok(Arc::clone(self.folders.get(id).ok_or(
-            sos_backend::StorageError::FolderNotFound(*id),
-        )?))
+        Ok(Arc::clone(
+            self.folders
+                .get(id)
+                .ok_or(sos_backend::StorageError::FolderNotFound(*id))?,
+        ))
     }
 }
 
diff --git a/crates/storage/server/src/storage.rs b/crates/storage/server/src/storage.rs
@@ -20,7 +20,7 @@ use sos_core::{
 };
 use sos_database::{
     async_sqlite::Client,
-    db::{AccountEntity, FolderEntity, FolderRecord},
+    entity::{AccountEntity, FolderEntity, FolderRecord},
 };
 use sos_sync::{
     CreateSet, ForceMerge, Merge, MergeOutcome, StorageEventLogs, SyncStatus,
diff --git a/tests/unit/src/tests/account_builder.rs b/tests/unit/src/tests/account_builder.rs
@@ -2,7 +2,7 @@ use anyhow::Result;
 use sos_account::AccountBuilder;
 use sos_backend::BackendTarget;
 use sos_core::Paths;
-use sos_database::{db::open_file, migrations::migrate_client};
+use sos_database::{migrations::migrate_client, open_file};
 use sos_login::Identity;
 use sos_password::memorable;
 use sos_sdk::crypto::AccessKey;
diff --git a/tests/unit/src/tests/database_migrations.rs b/tests/unit/src/tests/database_migrations.rs
@@ -1,6 +1,6 @@
 use anyhow::Result;
 use async_sqlite::ClientBuilder;
-use sos_database::{db::open_file, migrations::migrate_client};
+use sos_database::{migrations::migrate_client, open_file};
 use tempfile::NamedTempFile;
 
 #[tokio::test]
diff --git a/tests/utils/src/mock/mod.rs b/tests/utils/src/mock/mod.rs
@@ -17,9 +17,12 @@ use sos_core::{
     events::{EventLog, EventLogType, EventRecord, WriteEvent},
     AccountId, SecretId, VaultEntry,
 };
-use sos_database::db::{
-    open_file, AccountEntity, AccountRow, EventEntity, EventRecordRow,
-    FolderEntity, FolderRow,
+use sos_database::{
+    entity::{
+        AccountEntity, AccountRow, EventEntity, EventRecordRow, FolderEntity,
+        FolderRow,
+    },
+    open_file,
 };
 use sos_password::diceware::generate_passphrase;
 use sos_vault::{
@@ -198,7 +201,7 @@ pub async fn file_database() -> Result<(NamedTempFile, Client)> {
 
 /// Create an in-memory database and run migrations.
 pub async fn memory_database() -> Result<Client> {
-    Ok(sos_database::db::open_memory().await?)
+    Ok(sos_database::open_memory().await?)
 }
 
 /// Create a database account.
