feat(store)!: fully rework and add auto save (#1550)

* Add auto save to store plugin * Put jsdoc at constructor instead of class level * Clippy * Use enum instead of bool * Some(AutoSaveMessage::Cancel) | None * from_millis * u64 * Add change file * Rename to emit_on_change * should use Duration in `with_store` * Add breaking change notice to change file * Emit change event for inserts by reset * Update readme example * Update example * Remove extra line * Make description clear it only works with managed * Fix links in docstring * Fix doc string closing * get_mut * Proof of concept * fmt * Load store on create * cargo fmt * Fix merge conflits * Format * small cleanup * update docs, use `impl Into<JsonValue>` * fix doctests, further simplification of api * add store options --------- Co-authored-by: Tillmann <[email protected]> Co-authored-by: Lucas Nogueira <[email protected]>
tauri-apps · Oct 1, 2024 · f12d356 · f12d356
1 parent 44273b9
commit f12d356
Show file tree

Hide file tree

Showing 16 changed files with 603 additions and 363 deletions.
diff --git a/.changes/store-api-refactor.md b/.changes/store-api-refactor.md
@@ -0,0 +1,5 @@
+---
+"store-js": patch
+---
+
+**Breaking change**: Removed the `Store` constructor and added the `createStore` API.
diff --git a/.changes/store-auto-save.md b/.changes/store-auto-save.md
@@ -0,0 +1,7 @@
+---
+"store": patch
+---
+
+Add a setting `auto_save` to enable a store to debounce save on modification (on calls like set, clear, delete, reset)
+
+**Breaking change**: Removed the `with_store` API and added `StoreExt::store_builder`.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/plugins/store/Cargo.toml b/plugins/store/Cargo.toml
@@ -30,6 +30,10 @@ tauri = { workspace = true }
 log = { workspace = true }
 thiserror = { workspace = true }
 dunce = { workspace = true }
+tokio = { version = "1", features = ["sync", "time", "macros"] }
 
 [target.'cfg(target_os = "ios")'.dependencies]
 tauri = { workspace = true, features = ["wry"] }
+
+[dev-dependencies]
+tauri = { workspace = true, features = ["wry"] }
diff --git a/plugins/store/README.md b/plugins/store/README.md
@@ -149,12 +149,10 @@ As you may have noticed, the `Store` crated above isn't accessible to the fronte
 
 ```rust
 use tauri::Wry;
-use tauri_plugin_store::with_store;
+use tauri_plugin_store::StoreExt;
 
-let stores = app.state::<StoreCollection<Wry>>();
-let path = PathBuf::from("app_data.bin");
-
-with_store(app_handle, stores, path, |store| store.insert("a".to_string(), json!("b")))
+let store = app.store_builder("app_data.bin").build();
+store.insert("key", "value");
 ```
 
 ## Contributing

diff --git a/plugins/store/api-iife.js b/plugins/store/api-iife.js
diff --git a/plugins/store/build.rs b/plugins/store/build.rs
@@ -3,7 +3,18 @@
 // SPDX-License-Identifier: MIT
 
 const COMMANDS: &[&str] = &[
-    "set", "get", "has", "delete", "clear", "reset", "keys", "values", "length", "entries", "load",
+    "create_store",
+    "set",
+    "get",
+    "has",
+    "delete",
+    "clear",
+    "reset",
+    "keys",
+    "values",
+    "length",
+    "entries",
+    "load",
     "save",
 ];
 

diff --git a/plugins/store/examples/AppSettingsManager/src-tauri/src/app/settings.rs b/plugins/store/examples/AppSettingsManager/src-tauri/src/app/settings.rs
@@ -21,9 +21,8 @@ impl AppSettings {
 
         let theme = store
             .get("appSettings.theme")
-            .and_then(|v| v.as_str())
-            .map(|s| s.to_string())
-            .unwrap_or_else(|| "dark".to_string());
+            .and_then(|v| v.as_str().map(String::from))
+            .unwrap_or_else(|| "dark".to_owned());
 
         Ok(AppSettings {
             launch_at_login,

diff --git a/plugins/store/examples/AppSettingsManager/src-tauri/src/main.rs b/plugins/store/examples/AppSettingsManager/src-tauri/src/main.rs
@@ -5,17 +5,24 @@
 // Prevents additional console window on Windows in release, DO NOT REMOVE!!
 #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
 
-use tauri_plugin_store::StoreBuilder;
+use std::time::Duration;
+
+use serde_json::json;
+use tauri_plugin_store::StoreExt;
 
 mod app;
 use app::settings::AppSettings;
 
 fn main() {
     tauri::Builder::default()
-        .plugin(tauri_plugin_store::Builder::default().build())
+        .plugin(tauri_plugin_store::Builder::new().build())
         .setup(|app| {
             // Init store and load it from disk
-            let mut store = StoreBuilder::new("settings.json").build(app.handle().clone());
+            let store = app
+                .handle()
+                .store_builder("settings.json")
+                .auto_save(Duration::from_millis(100))
+                .build();
 
             // If there are no saved settings yet, this will return an error so we ignore the return value.
             let _ = store.load();
@@ -27,17 +34,20 @@ fn main() {
                     let theme = app_settings.theme;
                     let launch_at_login = app_settings.launch_at_login;
 
-                    println!("theme {}", theme);
-                    println!("launch_at_login {}", launch_at_login);
-
-                    Ok(())
+                    println!("theme {theme}");
+                    println!("launch_at_login {launch_at_login}");
+                    store.set(
+                        "appSettings",
+                        json!({ "theme": theme, "launchAtLogin": launch_at_login }),
+                    );
                 }
                 Err(err) => {
-                    eprintln!("Error loading settings: {}", err);
+                    eprintln!("Error loading settings: {err}");
                     // Handle the error case if needed
-                    Err(err) // Convert the error to a Box<dyn Error> and return Err(err) here
+                    return Err(err); // Convert the error to a Box<dyn Error> and return Err(err) here
                 }
             }
+            Ok(())
         })
         .run(tauri::generate_context!())
         .expect("error while running tauri application");

diff --git a/plugins/store/guest-js/index.ts b/plugins/store/guest-js/index.ts
@@ -4,7 +4,7 @@
 
 import { listen, type UnlistenFn } from '@tauri-apps/api/event'
 
-import { invoke } from '@tauri-apps/api/core'
+import { invoke, Resource } from '@tauri-apps/api/core'
 
 interface ChangePayload<T> {
   path: string
@@ -13,12 +13,36 @@ interface ChangePayload<T> {
 }
 
 /**
- * A key-value store persisted by the backend layer.
+ * Options to create a store
  */
-export class Store {
-  path: string
-  constructor(path: string) {
-    this.path = path
+export type StoreOptions = {
+  /**
+   * Auto save on modification with debounce duration in milliseconds
+   */
+  autoSave?: boolean
+}
+
+/**
+ * @param path: Path to save the store in `app_data_dir`
+ * @param options: Store configuration options
+ */
+export async function createStore(path: string, options?: StoreOptions) {
+  const resourceId = await invoke<number>('plugin:store|create_store', {
+    path,
+    ...options
+  })
+  return new Store(resourceId, path)
+}
+
+/**
+ * A lazy loaded key-value store persisted by the backend layer.
+ */
+export class Store extends Resource {
+  constructor(
+    rid: number,
+    private readonly path: string
+  ) {
+    super(rid)
   }
 
   /**
@@ -30,7 +54,7 @@ export class Store {
    */
   async set(key: string, value: unknown): Promise<void> {
     await invoke('plugin:store|set', {
-      path: this.path,
+      rid: this.rid,
       key,
       value
     })
@@ -44,7 +68,7 @@ export class Store {
    */
   async get<T>(key: string): Promise<T | null> {
     return await invoke('plugin:store|get', {
-      path: this.path,
+      rid: this.rid,
       key
     })
   }
@@ -57,7 +81,7 @@ export class Store {
    */
   async has(key: string): Promise<boolean> {
     return await invoke('plugin:store|has', {
-      path: this.path,
+      rid: this.rid,
       key
     })
   }
@@ -70,7 +94,7 @@ export class Store {
    */
   async delete(key: string): Promise<boolean> {
     return await invoke('plugin:store|delete', {
-      path: this.path,
+      rid: this.rid,
       key
     })
   }
@@ -82,9 +106,7 @@ export class Store {
    * @returns
    */
   async clear(): Promise<void> {
-    await invoke('plugin:store|clear', {
-      path: this.path
-    })
+    await invoke('plugin:store|clear', { rid: this.rid })
   }
 
   /**
@@ -94,9 +116,7 @@ export class Store {
    * @returns
    */
   async reset(): Promise<void> {
-    await invoke('plugin:store|reset', {
-      path: this.path
-    })
+    await invoke('plugin:store|reset', { rid: this.rid })
   }
 
   /**
@@ -105,9 +125,7 @@ export class Store {
    * @returns
    */
   async keys(): Promise<string[]> {
-    return await invoke('plugin:store|keys', {
-      path: this.path
-    })
+    return await invoke('plugin:store|keys', { rid: this.rid })
   }
 
   /**
@@ -116,9 +134,7 @@ export class Store {
    * @returns
    */
   async values<T>(): Promise<T[]> {
-    return await invoke('plugin:store|values', {
-      path: this.path
-    })
+    return await invoke('plugin:store|values', { rid: this.rid })
   }
 
   /**
@@ -127,9 +143,7 @@ export class Store {
    * @returns
    */
   async entries<T>(): Promise<Array<[key: string, value: T]>> {
-    return await invoke('plugin:store|entries', {
-      path: this.path
-    })
+    return await invoke('plugin:store|entries', { rid: this.rid })
   }
 
   /**
@@ -138,9 +152,7 @@ export class Store {
    * @returns
    */
   async length(): Promise<number> {
-    return await invoke('plugin:store|length', {
-      path: this.path
-    })
+    return await invoke('plugin:store|length', { rid: this.rid })
   }
 
   /**
@@ -152,9 +164,7 @@ export class Store {
    * @returns
    */
   async load(): Promise<void> {
-    await invoke('plugin:store|load', {
-      path: this.path
-    })
+    await invoke('plugin:store|load', { rid: this.rid })
   }
 
   /**
@@ -165,9 +175,7 @@ export class Store {
    * @returns
    */
   async save(): Promise<void> {
-    await invoke('plugin:store|save', {
-      path: this.path
-    })
+    await invoke('plugin:store|save', { rid: this.rid })
   }
 
   /**

diff --git a/plugins/store/permissions/autogenerated/commands/create_store.toml b/plugins/store/permissions/autogenerated/commands/create_store.toml
@@ -0,0 +1,13 @@
+# Automatically generated - DO NOT EDIT!
+
+"$schema" = "../../schemas/schema.json"
+
+[[permission]]
+identifier = "allow-create-store"
+description = "Enables the create_store command without any pre-configured scope."
+commands.allow = ["create_store"]
+
+[[permission]]
+identifier = "deny-create-store"
+description = "Denies the create_store command without any pre-configured scope."
+commands.deny = ["create_store"]
diff --git a/plugins/store/permissions/autogenerated/reference.md b/plugins/store/permissions/autogenerated/reference.md
@@ -9,6 +9,7 @@ All operations are enabled by default.
 
 
 
+- `allow-create-store`
 - `allow-clear`
 - `allow-delete`
 - `allow-entries`
@@ -60,6 +61,32 @@ Denies the clear command without any pre-configured scope.
 <tr>
 <td>
 
+`store:allow-create-store`
+
+</td>
+<td>
+
+Enables the create_store command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`store:deny-create-store`
+
+</td>
+<td>
+
+Denies the create_store command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
 `store:allow-delete`
 
 </td>

diff --git a/plugins/store/permissions/default.toml b/plugins/store/permissions/default.toml
@@ -11,6 +11,7 @@ All operations are enabled by default.
 
 """
 permissions = [
+  "allow-create-store",
   "allow-clear",
   "allow-delete",
   "allow-entries",

diff --git a/plugins/store/permissions/schemas/schema.json b/plugins/store/permissions/schemas/schema.json
@@ -304,6 +304,16 @@
           "type": "string",
           "const": "deny-clear"
         },
+        {
+          "description": "Enables the create_store command without any pre-configured scope.",
+          "type": "string",
+          "const": "allow-create-store"
+        },
+        {
+          "description": "Denies the create_store command without any pre-configured scope.",
+          "type": "string",
+          "const": "deny-create-store"
+        },
         {
           "description": "Enables the delete command without any pre-configured scope.",
           "type": "string",