Filesystem Sync (#142)

src-tauri/yaak-models/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "yaak-models"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[dependencies]
+chrono = { version = "0.4.38", features = ["serde"] }
+log = "0.4.22"
+nanoid = "0.4.0"
+r2d2 = "0.8.10"
+r2d2_sqlite = { version = "0.25.0" }
+rusqlite = { version = "0.32.1", features = ["bundled", "chrono"] }
+sea-query = { version = "0.32.1", features = ["with-chrono", "attr"] }
+sea-query-rusqlite = { version = "0.7.0", features = ["with-chrono"] }
+serde = { version = "1.0.204", features = ["derive"] }
+serde_json = "1.0.122"
+sqlx = { version = "0.8.0", features = ["sqlite", "runtime-tokio-rustls"] }
+tauri = { workspace = true }
+thiserror = "1.0.63"
+ts-rs = { workspace = true, features = ["chrono-impl", "serde-json-impl"] }

src-tauri/yaak-models/bindings/models.ts

@@ -0,0 +1,59 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type AnyModel = CookieJar | Environment | Folder | GrpcConnection | GrpcEvent | GrpcRequest | HttpRequest | HttpResponse | Plugin | Settings | KeyValue | Workspace;
+
+export type Cookie = { raw_cookie: string, domain: CookieDomain, expires: CookieExpires, path: [string, boolean], };
+
+export type CookieDomain = { "HostOnly": string } | { "Suffix": string } | "NotPresent" | "Empty";
+
+export type CookieExpires = { "AtUtc": string } | "SessionEnd";
+
+export type CookieJar = { model: "cookie_jar", id: string, createdAt: string, updatedAt: string, workspaceId: string, cookies: Array<Cookie>, name: string, };
+
+export type Environment = { model: "environment", id: string, workspaceId: string, environmentId: string | null, createdAt: string, updatedAt: string, name: string, variables: Array<EnvironmentVariable>, };
+
+export type EnvironmentVariable = { enabled?: boolean, name: string, value: string, id: string, };
+
+export type Folder = { model: "folder", id: string, createdAt: string, updatedAt: string, workspaceId: string, folderId: string | null, name: string, description: string, sortPriority: number, };
+
+export type GrpcConnection = { model: "grpc_connection", id: string, createdAt: string, updatedAt: string, workspaceId: string, requestId: string, elapsed: number, error: string | null, method: string, service: string, status: number, state: GrpcConnectionState, trailers: { [key in string]?: string }, url: string, };
+
+export type GrpcConnectionState = "initialized" | "connected" | "closed";
+
+export type GrpcEvent = { model: "grpc_event", id: string, createdAt: string, updatedAt: string, workspaceId: string, requestId: string, connectionId: string, content: string, error: string | null, eventType: GrpcEventType, metadata: { [key in string]?: string }, status: number | null, };
+
+export type GrpcEventType = "info" | "error" | "client_message" | "server_message" | "connection_start" | "connection_end";
+
+export type GrpcMetadataEntry = { enabled?: boolean, name: string, value: string, id: string, };
+
+export type GrpcRequest = { model: "grpc_request", id: string, createdAt: string, updatedAt: string, workspaceId: string, folderId: string | null, authenticationType: string | null, authentication: Record<string, any>, description: string, message: string, metadata: Array<GrpcMetadataEntry>, method: string | null, name: string, service: string | null, sortPriority: number, url: string, };
+
+export type HttpRequest = { model: "http_request", id: string, createdAt: string, updatedAt: string, workspaceId: string, folderId: string | null, authentication: Record<string, any>, authenticationType: string | null, body: Record<string, any>, bodyType: string | null, description: string, headers: Array<HttpRequestHeader>, method: string, name: string, sortPriority: number, url: string, urlParameters: Array<HttpUrlParameter>, };
+
+export type HttpRequestHeader = { enabled?: boolean, name: string, value: string, id: string, };
+
+export type HttpResponse = { model: "http_response", id: string, createdAt: string, updatedAt: string, workspaceId: string, requestId: string, bodyPath: string | null, contentLength: number | null, elapsed: number, elapsedHeaders: number, error: string | null, headers: Array<HttpResponseHeader>, remoteAddr: string | null, status: number, statusReason: string | null, state: HttpResponseState, url: string, version: string | null, };
+
+export type HttpResponseHeader = { name: string, value: string, };
+
+export type HttpResponseState = "initialized" | "connected" | "closed";
+
+export type HttpUrlParameter = { enabled?: boolean, name: string, value: string, id: string, };
+
+export type KeyValue = { model: "key_value", createdAt: string, updatedAt: string, key: string, namespace: string, value: string, };
+
+export type ModelPayload = { model: AnyModel, windowLabel: string, updateSource: UpdateSource, };
+
+export type Plugin = { model: "plugin", id: string, createdAt: string, updatedAt: string, checkedAt: string | null, directory: string, enabled: boolean, url: string | null, };
+
+export type ProxySetting = { "type": "enabled", http: string, https: string, auth: ProxySettingAuth | null, } | { "type": "disabled" };
+
+export type ProxySettingAuth = { user: string, password: string, };
+
+export type Settings = { model: "settings", id: string, createdAt: string, updatedAt: string, appearance: string, editorFontSize: number, editorSoftWrap: boolean, interfaceFontSize: number, interfaceScale: number, openWorkspaceNewWindow: boolean | null, telemetry: boolean, theme: string, themeDark: string, themeLight: string, updateChannel: string, proxy: ProxySetting | null, };
+
+export type SyncState = { model: "sync_state", id: string, workspaceId: string, createdAt: string, updatedAt: string, flushedAt: string, modelId: string, checksum: string, relPath: string, syncDir: string, };
+
+export type UpdateSource = "sync" | "window" | "plugin" | "background";
+
+export type Workspace = { model: "workspace", id: string, createdAt: string, updatedAt: string, name: string, description: string, settingValidateCertificates: boolean, settingFollowRedirects: boolean, settingRequestTimeout: number, settingSyncDir: string | null, };

src-tauri/yaak-models/index.ts

@@ -0,0 +1 @@
+export * from './bindings/models';

src-tauri/yaak-models/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@yaakapp-internal/models",
+  "private": true,
+  "version": "1.0.0",
+  "main": "index.ts"
+}

src-tauri/yaak-models/src/error.rs

@@ -0,0 +1,15 @@
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum Error {
+    #[error("SQL error: {0}")]
+    SqlError(#[from] rusqlite::Error),
+    #[error("JSON error: {0}")]
+    JsonError(#[from] serde_json::Error),
+    #[error("Model not found {0}")]
+    ModelNotFound(String),
+    #[error("unknown error")]
+    Unknown,
+}
+
+pub type Result<T> = std::result::Result<T, Error>;

src-tauri/yaak-models/src/lib.rs

@@ -0,0 +1,5 @@
+pub mod models;
+pub mod queries;
+pub mod error;
+
+pub mod plugin;

src-tauri/yaak-models/src/plugin.rs

@@ -0,0 +1,86 @@
+use log::info;
+use r2d2::Pool;
+use r2d2_sqlite::SqliteConnectionManager;
+use serde::Deserialize;
+use sqlx::migrate::Migrator;
+use sqlx::sqlite::SqliteConnectOptions;
+use sqlx::{ConnectOptions, SqlitePool};
+use std::fs::create_dir_all;
+use std::path::PathBuf;
+use std::time::Duration;
+use tauri::async_runtime::Mutex;
+use tauri::path::BaseDirectory;
+use tauri::plugin::TauriPlugin;
+use tauri::{plugin, AppHandle, Manager, Runtime, Url};
+
+pub struct SqliteConnection(pub Mutex<Pool<SqliteConnectionManager>>);
+
+#[derive(Default, Deserialize)]
+pub struct PluginConfig {
+    // Nothing yet (will be configurable in tauri.conf.json
+}
+
+/// Tauri SQL plugin builder.
+#[derive(Default)]
+pub struct Builder {
+    // Nothing Yet
+}
+
+impl Builder {
+    pub fn new() -> Self {
+        Self::default()
+    }
+
+    pub fn build<R: Runtime>(&self) -> TauriPlugin<R, Option<PluginConfig>> {
+        plugin::Builder::<R, Option<PluginConfig>>::new("yaak_models")
+            .setup(|app, _api| {
+                let app_path = app.path().app_data_dir().unwrap();
+                create_dir_all(app_path.clone()).expect("Problem creating App directory!");
+
+                let db_file_path = app_path.join("db.sqlite");
+
+                {
+                    let db_file_path = db_file_path.clone();
+                    tauri::async_runtime::block_on(async move {
+                        must_migrate_db(app.app_handle(), &db_file_path).await;
+                    });
+                };
+
+                let manager = SqliteConnectionManager::file(db_file_path);
+                let pool = Pool::builder()
+                    .max_size(100) // Up from 10 (just in case)
+                    .connection_timeout(Duration::from_secs(10)) // Down from 30
+                    .build(manager)
+                    .unwrap();
+
+                app.manage(SqliteConnection(Mutex::new(pool)));
+
+                Ok(())
+            })
+            .build()
+    }
+}
+
+fn db_connection_url(sqlite_file_path: &PathBuf) -> Url {
+    let p_string = sqlite_file_path.to_string_lossy().replace(' ', "%20");
+    let url = format!("sqlite://{}?mode=rwc", p_string);
+    Url::parse(&url).unwrap()
+}
+
+async fn must_migrate_db<R: Runtime>(app_handle: &AppHandle<R>, sqlite_file_path: &PathBuf) {
+    let url = db_connection_url(sqlite_file_path);
+    info!("Connecting to database at {}", url);
+    let opts = SqliteConnectOptions::from_url(&url).unwrap();
+    let pool = SqlitePool::connect_with(opts).await.expect("Failed to connect to database");
+    let p = app_handle
+        .path()
+        .resolve("migrations", BaseDirectory::Resource)
+        .expect("failed to resolve resource");
+
+    info!("Running database migrations from: {}", p.to_string_lossy());
+    let mut m = Migrator::new(p).await.expect("Failed to load migrations");
+    m.set_ignore_missing(true); // So we can roll back versions and not crash
+    m.run(&pool).await.expect("Failed to run migrations");
+
+    info!("Database migrations complete");
+}