feat(store): Add android & iOS support (#1011)

* update cli

* init android module

* upgdate gitignore

* add desktop and mobile

* android

* ios

* lib

* remove comment

* cargo fmt

* skip empty file creation

* android comments

* apple path

* Discard changes to plugins/store/ios/README.md

* stop auto directories creation

* Update README.md

plugins/store/src/desktop.rs

@@ -0,0 +1,49 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use crate::Error;
+use crate::Runtime;
+use crate::Store;
+use std::fs::create_dir_all;
+use std::fs::read;
+use std::fs::File;
+use std::io::Write;
+use tauri::Manager;
+
+#[cfg(desktop)]
+impl<R: Runtime> Store<R> {
+    pub fn save(&self) -> Result<(), Error> {
+        let app_dir = self
+            .app
+            .path()
+            .app_data_dir()
+            .expect("failed to resolve app dir");
+        let store_path = app_dir.join(&self.path);
+
+        create_dir_all(store_path.parent().expect("invalid store path"))?;
+
+        let bytes = (self.serialize)(&self.cache).map_err(Error::Serialize)?;
+        let mut f = File::create(&store_path)?;
+        f.write_all(&bytes)?;
+
+        Ok(())
+    }
+
+    /// Update the store from the on-disk state
+    pub fn load(&mut self) -> Result<(), Error> {
+        let app_dir = self
+            .app
+            .path()
+            .app_data_dir()
+            .expect("failed to resolve app dir");
+        let store_path = app_dir.join(&self.path);
+
+        let bytes = read(store_path)?;
+
+        self.cache
+            .extend((self.deserialize)(&bytes).map_err(Error::Deserialize)?);
+
+        Ok(())
+    }
+}

plugins/store/src/error.rs

@@ -5,10 +5,19 @@
 use serde::{Serialize, Serializer};
 use std::path::PathBuf;
 
+pub type Result<T> = std::result::Result<T, Error>;
+
 /// The error types.
 #[derive(thiserror::Error, Debug)]
 #[non_exhaustive]
 pub enum Error {
+    #[cfg(mobile)]
+    #[error(transparent)]
+    PluginInvoke(#[from] tauri::plugin::mobile::PluginInvokeError),
+    /// Mobile plugin handled is not initialized, Probably [`StoreBuilder::mobile_plugin_handle`] was not called.
+    #[cfg(mobile)]
+    #[error("Mobile plugin handled is not initialized, Perhaps you forgot to call StoreBuilder::mobile_plugin_handle")]
+    MobilePluginHandleUnInitialized,
     #[error("Failed to serialize store. {0}")]
     Serialize(Box<dyn std::error::Error + Send + Sync>),
     #[error("Failed to deserialize store. {0}")]

plugins/store/src/lib.rs

@@ -11,7 +11,7 @@
     html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png"
 )]
 
-pub use error::Error;
+pub use error::{Error, Result};
 use log::warn;
 use serde::Serialize;
 pub use serde_json::Value as JsonValue;
@@ -29,6 +29,18 @@ use tauri::{
 mod error;
 mod store;
 
+#[cfg(mobile)]
+mod mobile;
+#[cfg(mobile)]
+use crate::plugin::PluginHandle;
+#[cfg(target_os = "android")]
+const PLUGIN_IDENTIFIER: &str = "app.tauri.store";
+#[cfg(target_os = "ios")]
+tauri::ios_plugin_binding!(init_plugin_store);
+
+#[cfg(desktop)]
+mod desktop;
+
 #[derive(Serialize, Clone)]
 struct ChangePayload<'a> {
     path: &'a Path,
@@ -36,18 +48,20 @@ struct ChangePayload<'a> {
     value: &'a JsonValue,
 }
 
-#[derive(Default)]
-pub struct StoreCollection<R: Runtime> {
+struct StoreCollection<R: Runtime> {
     stores: Mutex<HashMap<PathBuf, Store<R>>>,
     frozen: bool,
+
+    #[cfg(mobile)]
+    mobile_plugin_handle: PluginHandle<R>,
 }
 
-pub fn with_store<R: Runtime, T, F: FnOnce(&mut Store<R>) -> Result<T, Error>>(
+fn with_store<R: Runtime, T, F: FnOnce(&mut Store<R>) -> Result<T>>(
     app: AppHandle<R>,
     collection: State<'_, StoreCollection<R>>,
     path: impl AsRef<Path>,
     f: F,
-) -> Result<T, Error> {
+) -> Result<T> {
     let mut stores = collection.stores.lock().expect("mutex poisoned");
 
     let path = path.as_ref();
@@ -55,7 +69,17 @@ pub fn with_store<R: Runtime, T, F: FnOnce(&mut Store<R>) -> Result<T, Error>>(
         if collection.frozen {
             return Err(Error::NotFound(path.to_path_buf()));
         }
-        let mut store = StoreBuilder::new(path).build(app);
+
+        #[allow(unused_mut)]
+        let mut builder = StoreBuilder::new(path);
+
+        #[cfg(mobile)]
+        {
+            builder = builder.mobile_plugin_handle(collection.mobile_plugin_handle.clone());
+        }
+
+        let mut store = builder.build(app);
+
         // ignore loading errors, just use the default
         if let Err(err) = store.load() {
             warn!(
@@ -78,7 +102,7 @@ async fn set<R: Runtime>(
     path: PathBuf,
     key: String,
     value: JsonValue,
-) -> Result<(), Error> {
+) -> Result<()> {
     with_store(app, stores, path, |store| store.insert(key, value))
 }
 
@@ -88,7 +112,7 @@ async fn get<R: Runtime>(
     stores: State<'_, StoreCollection<R>>,
     path: PathBuf,
     key: String,
-) -> Result<Option<JsonValue>, Error> {
+) -> Result<Option<JsonValue>> {
     with_store(app, stores, path, |store| Ok(store.get(key).cloned()))
 }
 
@@ -98,7 +122,7 @@ async fn has<R: Runtime>(
     stores: State<'_, StoreCollection<R>>,
     path: PathBuf,
     key: String,
-) -> Result<bool, Error> {
+) -> Result<bool> {
     with_store(app, stores, path, |store| Ok(store.has(key)))
 }
 
@@ -108,7 +132,7 @@ async fn delete<R: Runtime>(
     stores: State<'_, StoreCollection<R>>,
     path: PathBuf,
     key: String,
-) -> Result<bool, Error> {
+) -> Result<bool> {
     with_store(app, stores, path, |store| store.delete(key))
 }
 
@@ -117,7 +141,7 @@ async fn clear<R: Runtime>(
     app: AppHandle<R>,
     stores: State<'_, StoreCollection<R>>,
     path: PathBuf,
-) -> Result<(), Error> {
+) -> Result<()> {
     with_store(app, stores, path, |store| store.clear())
 }
 
@@ -126,7 +150,7 @@ async fn reset<R: Runtime>(
     app: AppHandle<R>,
     collection: State<'_, StoreCollection<R>>,
     path: PathBuf,
-) -> Result<(), Error> {
+) -> Result<()> {
     with_store(app, collection, path, |store| store.reset())
 }
 
@@ -135,7 +159,7 @@ async fn keys<R: Runtime>(
     app: AppHandle<R>,
     stores: State<'_, StoreCollection<R>>,
     path: PathBuf,
-) -> Result<Vec<String>, Error> {
+) -> Result<Vec<String>> {
     with_store(app, stores, path, |store| {
         Ok(store.keys().cloned().collect())
     })
@@ -146,7 +170,7 @@ async fn values<R: Runtime>(
     app: AppHandle<R>,
     stores: State<'_, StoreCollection<R>>,
     path: PathBuf,
-) -> Result<Vec<JsonValue>, Error> {
+) -> Result<Vec<JsonValue>> {
     with_store(app, stores, path, |store| {
         Ok(store.values().cloned().collect())
     })
@@ -157,7 +181,7 @@ async fn entries<R: Runtime>(
     app: AppHandle<R>,
     stores: State<'_, StoreCollection<R>>,
     path: PathBuf,
-) -> Result<Vec<(String, JsonValue)>, Error> {
+) -> Result<Vec<(String, JsonValue)>> {
     with_store(app, stores, path, |store| {
         Ok(store
             .entries()
@@ -171,7 +195,7 @@ async fn length<R: Runtime>(
     app: AppHandle<R>,
     stores: State<'_, StoreCollection<R>>,
     path: PathBuf,
-) -> Result<usize, Error> {
+) -> Result<usize> {
     with_store(app, stores, path, |store| Ok(store.len()))
 }
 
@@ -180,7 +204,7 @@ async fn load<R: Runtime>(
     app: AppHandle<R>,
     stores: State<'_, StoreCollection<R>>,
     path: PathBuf,
-) -> Result<(), Error> {
+) -> Result<()> {
     with_store(app, stores, path, |store| store.load())
 }
 
@@ -189,7 +213,7 @@ async fn save<R: Runtime>(
     app: AppHandle<R>,
     stores: State<'_, StoreCollection<R>>,
     path: PathBuf,
-) -> Result<(), Error> {
+) -> Result<()> {
     with_store(app, stores, path, |store| store.save())
 }
 
@@ -306,9 +330,17 @@ impl<R: Runtime> Builder<R> {
                     }
                 }
 
+                #[cfg(target_os = "android")]
+                let handle = _api.register_android_plugin(PLUGIN_IDENTIFIER, "StorePlugin")?;
+                #[cfg(target_os = "ios")]
+                let handle = _api.register_ios_plugin(init_plugin_store)?;
+
                 app_handle.manage(StoreCollection {
                     stores: Mutex::new(self.stores),
                     frozen: self.frozen,
+
+                    #[cfg(mobile)]
+                    mobile_plugin_handle: handle,
                 });
 
                 Ok(())

plugins/store/src/mobile.rs

@@ -0,0 +1,53 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use tauri::Runtime;
+
+use crate::error::Result;
+use crate::Store;
+use serde_json::Value;
+use std::collections::HashMap;
+
+#[derive(Debug, serde::Serialize, serde::Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct LoadStore {
+    pub cache: HashMap<String, Value>,
+}
+
+#[derive(Debug, serde::Serialize, serde::Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct SaveStore {
+    pub store: String,
+    pub cache: HashMap<String, Value>,
+}
+
+#[cfg(mobile)]
+impl<R: Runtime> Store<R> {
+    pub fn save(&self) -> Result<()> {
+        self.mobile_plugin_handle
+            .as_ref()
+            .ok_or_else(|| crate::error::Error::MobilePluginHandleUnInitialized)?
+            .run_mobile_plugin(
+                "save",
+                SaveStore {
+                    store: self.path.to_string_lossy().to_string(),
+                    cache: self.cache.clone(),
+                },
+            )
+            .map_err(Into::into)
+    }
+
+    pub fn load(&mut self) -> Result<()> {
+        let result: Value = self
+            .mobile_plugin_handle
+            .as_ref()
+            .ok_or_else(|| crate::error::Error::MobilePluginHandleUnInitialized)?
+            .run_mobile_plugin("load", self.path.to_string_lossy().to_string())?;
+
+        let map = serde_json::from_value::<HashMap<String, Value>>(result)?;
+        self.cache.extend(map);
+
+        Ok(())
+    }
+}

plugins/store/src/store.rs

@@ -2,12 +2,12 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
+#[cfg(mobile)]
+use crate::plugin::PluginHandle;
 use crate::{ChangePayload, Error};
 use serde_json::Value as JsonValue;
 use std::{
     collections::HashMap,
-    fs::{create_dir_all, read, File},
-    io::Write,
     path::{Path, PathBuf},
 };
 use tauri::{AppHandle, Manager, Runtime};
@@ -30,15 +30,20 @@ fn default_deserialize(
 }
 
 /// Builds a [`Store`]
-pub struct StoreBuilder {
+pub struct StoreBuilder<R: Runtime> {
     path: PathBuf,
     defaults: Option<HashMap<String, JsonValue>>,
     cache: HashMap<String, JsonValue>,
     serialize: SerializeFn,
     deserialize: DeserializeFn,
+
+    #[cfg(mobile)]
+    mobile_plugin_handle: Option<PluginHandle<R>>,
+    #[cfg(not(mobile))]
+    _marker: std::marker::PhantomData<R>,
 }
 
-impl StoreBuilder {
+impl<R: Runtime> StoreBuilder<R> {
     /// Creates a new [`StoreBuilder`].
     ///
     /// # Examples
@@ -58,9 +63,19 @@ impl StoreBuilder {
             cache: Default::default(),
             serialize: default_serialize,
             deserialize: default_deserialize,
+            #[cfg(mobile)]
+            mobile_plugin_handle: None,
+            #[cfg(not(mobile))]
+            _marker: std::marker::PhantomData,
         }
     }
 
+    #[cfg(mobile)]
+    pub fn mobile_plugin_handle(mut self, handle: PluginHandle<R>) -> Self {
+        self.mobile_plugin_handle = Some(handle);
+        self
+    }
+
     /// Inserts a default key-value pair.
     ///
     /// # Examples
@@ -148,7 +163,7 @@ impl StoreBuilder {
     ///     Ok(())
     ///   });
     /// ```
-    pub fn build<R: Runtime>(self, app: AppHandle<R>) -> Store<R> {
+    pub fn build(self, app: AppHandle<R>) -> Store<R> {
         Store {
             app,
             path: self.path,
@@ -156,56 +171,27 @@ impl StoreBuilder {
             cache: self.cache,
             serialize: self.serialize,
             deserialize: self.deserialize,
+
+            #[cfg(mobile)]
+            mobile_plugin_handle: self.mobile_plugin_handle,
         }
     }
 }
 
 #[derive(Clone)]
 pub struct Store<R: Runtime> {
-    app: AppHandle<R>,
+    pub(crate) app: AppHandle<R>,
     pub(crate) path: PathBuf,
     defaults: Option<HashMap<String, JsonValue>>,
-    cache: HashMap<String, JsonValue>,
-    serialize: SerializeFn,
-    deserialize: DeserializeFn,
+    pub(crate) cache: HashMap<String, JsonValue>,
+    pub(crate) serialize: SerializeFn,
+    pub(crate) deserialize: DeserializeFn,
+
+    #[cfg(mobile)]
+    pub(crate) mobile_plugin_handle: Option<PluginHandle<R>>,
 }
 
 impl<R: Runtime> Store<R> {
-    /// Update the store from the on-disk state
-    pub fn load(&mut self) -> Result<(), Error> {
-        let app_dir = self
-            .app
-            .path()
-            .app_data_dir()
-            .expect("failed to resolve app dir");
-        let store_path = app_dir.join(&self.path);
-
-        let bytes = read(store_path)?;
-
-        self.cache
-            .extend((self.deserialize)(&bytes).map_err(Error::Deserialize)?);
-
-        Ok(())
-    }
-
-    /// Saves the store to disk
-    pub fn save(&self) -> Result<(), Error> {
-        let app_dir = self
-            .app
-            .path()
-            .app_data_dir()
-            .expect("failed to resolve app dir");
-        let store_path = app_dir.join(&self.path);
-
-        create_dir_all(store_path.parent().expect("invalid store path"))?;
-
-        let bytes = (self.serialize)(&self.cache).map_err(Error::Serialize)?;
-        let mut f = File::create(&store_path)?;
-        f.write_all(&bytes)?;
-
-        Ok(())
-    }
-
     pub fn insert(&mut self, key: String, value: JsonValue) -> Result<(), Error> {
         self.cache.insert(key.clone(), value.clone());
         self.app.emit(