feat(mobile): add plugin config to the Plugin class (#6763)

Author: lucasfernog

.changes/mobile-plugin-config.md

@@ -0,0 +1,5 @@
+---
+"tauri": patch
+---
+
+Expose plugin configuration on the Android and iOS plugin classes.

.changes/simplify-ios-plugin-init-fn.md

@@ -0,0 +1,5 @@
+---
+"tauri": patch
+---
+
+Change iOS plugin init function signature to `func init_plugin() -> Plugin`.

core/tauri/mobile/android/src/main/java/app/tauri/plugin/Plugin.kt

@@ -26,6 +26,10 @@ abstract class Plugin(private val activity: Activity) {
 
   open fun load(webView: WebView) {}
 
+  fun getConfig(): JSObject {
+    return handle!!.config
+  }
+
   /**
    * Start activity for result with the provided Intent and resolve calling the provided callback method name.
    *
@@ -74,7 +78,7 @@ abstract class Plugin(private val activity: Activity) {
    */
   @Command
   @PermissionCallback
-  fun checkPermissions(invoke: Invoke) {
+  open fun checkPermissions(invoke: Invoke) {
     val permissionsResult: Map<String, PermissionState?> = getPermissionStates()
     if (permissionsResult.isEmpty()) {
       // if no permissions are defined on the plugin, resolve undefined

core/tauri/mobile/android/src/main/java/app/tauri/plugin/PluginHandle.kt

@@ -17,7 +17,7 @@ import app.tauri.annotation.Command
 import app.tauri.annotation.TauriPlugin
 import java.lang.reflect.Method
 
-class PluginHandle(private val manager: PluginManager, val name: String, private val instance: Plugin) {
+class PluginHandle(private val manager: PluginManager, val name: String, private val instance: Plugin, val config: JSObject) {
   private val commands: HashMap<String, CommandData> = HashMap()
   private val permissionCallbackMethods: HashMap<String, Method> = HashMap()
   private val startActivityCallbackMethods: HashMap<String, Method> = HashMap()

core/tauri/mobile/android/src/main/java/app/tauri/plugin/PluginManager.kt

@@ -69,8 +69,8 @@ class PluginManager(val activity: AppCompatActivity) {
   }
 
   @JniMethod
-  fun load(webView: WebView?, name: String, plugin: Plugin) {
-    val handle = PluginHandle(this, name, plugin)
+  fun load(webView: WebView?, name: String, plugin: Plugin, config: JSObject) {
+    val handle = PluginHandle(this, name, plugin, config)
     plugins[name] = handle
     if (webView != null) {
       plugin.load(webView)

core/tauri/mobile/ios-api/Sources/Tauri/Plugin/Plugin.swift

@@ -7,6 +7,11 @@ import os.log
 
 open class Plugin: NSObject {
     public let manager: PluginManager = PluginManager.shared
+    public var config: JSObject = [:]
+
+    internal func setConfig(_ config: JSObject) {
+      self.config = config
+    }
 
     @objc open func load(webview: WKWebView) {}
 

core/tauri/mobile/ios-api/Sources/Tauri/Tauri.swift

@@ -46,7 +46,8 @@ public class PluginManager {
 		}
 	}
 
-	func load<P: Plugin>(webview: WKWebView?, name: String, plugin: P) {
+	func load<P: Plugin>(name: String, plugin: P, config: JSObject, webview: WKWebView?) {
+    plugin.setConfig(config)
 		let handle = PluginHandle(plugin: plugin)
 		if let webview = webview {
 			handle.instance.load(webview: webview)
@@ -91,11 +92,13 @@ extension PluginManager: NSCopying {
 	}
 }
 
-public func registerPlugin<P: Plugin>(webview: WKWebView?, name: String, plugin: P) {
+@_cdecl("register_plugin")
+func registerPlugin(name: SRString, plugin: NSObject, config: NSDictionary, webview: WKWebView?) {
 	PluginManager.shared.load(
-		webview: webview,
-		name: name,
-		plugin: plugin
+		name: name.toString(),
+		plugin: plugin as! Plugin,
+    config: JSTypes.coerceDictionaryToJSObject(config, formattingDatesAsStrings: true)!,
+    webview: webview
 	)
 }
 

core/tauri/src/ios.rs

@@ -38,9 +38,15 @@ swift!(pub fn run_plugin_method(
   data: *const c_void,
   callback: PluginMessageCallback
 ));
+swift!(pub fn register_plugin(
+  name: &SRString,
+  plugin: *const c_void,
+  config: *const c_void,
+  webview: *const c_void
+));
 swift!(pub fn on_webview_created(webview: *const c_void, controller: *const c_void));
 
-pub fn json_to_dictionary(json: JsonValue) -> id {
+pub fn json_to_dictionary(json: &JsonValue) -> id {
   if let serde_json::Value::Object(map) = json {
     unsafe {
       let dictionary: id = msg_send![class!(NSMutableDictionary), alloc];
@@ -78,14 +84,14 @@ impl NSString {
   }
 }
 
-unsafe fn add_json_value_to_array(array: id, value: JsonValue) {
+unsafe fn add_json_value_to_array(array: id, value: &JsonValue) {
   match value {
     JsonValue::Null => {
       let null: id = msg_send![class!(NSNull), null];
       let () = msg_send![array, addObject: null];
     }
     JsonValue::Bool(val) => {
-      let value = if val { YES } else { NO };
+      let value = if *val { YES } else { NO };
       let v: id = msg_send![class!(NSNumber), numberWithBool: value];
       let () = msg_send![array, addObject: v];
     }
@@ -123,15 +129,15 @@ unsafe fn add_json_value_to_array(array: id, value: JsonValue) {
   }
 }
 
-unsafe fn add_json_entry_to_dictionary(data: id, key: String, value: JsonValue) {
+unsafe fn add_json_entry_to_dictionary(data: id, key: &str, value: &JsonValue) {
   let key = NSString::new(&key);
   match value {
     JsonValue::Null => {
       let null: id = msg_send![class!(NSNull), null];
       let () = msg_send![data, setObject:null forKey: key];
     }
     JsonValue::Bool(val) => {
-      let flag = if val { YES } else { NO };
+      let flag = if *val { YES } else { NO };
       let value: id = msg_send![class!(NSNumber), numberWithBool: flag];
       let () = msg_send![data, setObject:value forKey: key];
     }

core/tauri/src/jni_helpers.rs

@@ -15,11 +15,11 @@ fn json_to_java<'a, R: Runtime>(
   env: JNIEnv<'a>,
   activity: JObject<'a>,
   runtime_handle: &R::Handle,
-  json: JsonValue,
+  json: &JsonValue,
 ) -> Result<(&'static str, JValue<'a>), JniError> {
   let (class, v) = match json {
     JsonValue::Null => ("Ljava/lang/Object;", JObject::null().into()),
-    JsonValue::Bool(val) => ("Z", val.into()),
+    JsonValue::Bool(val) => ("Z", (*val).into()),
     JsonValue::Number(val) => {
       if let Some(v) = val.as_i64() {
         ("J", v.into())
@@ -74,9 +74,9 @@ pub fn to_jsobject<'a, R: Runtime>(
   env: JNIEnv<'a>,
   activity: JObject<'a>,
   runtime_handle: &R::Handle,
-  json: JsonValue,
+  json: &JsonValue,
 ) -> Result<JValue<'a>, JniError> {
-  if let JsonValue::Object(_) = &json {
+  if let JsonValue::Object(_) = json {
     json_to_java::<R>(env, activity, runtime_handle, json).map(|(_class, data)| data)
   } else {
     // currently the Kotlin lib cannot handle nulls or raw values, it must be an object

core/tauri/src/lib.rs

@@ -157,7 +157,7 @@
 #[macro_export]
 macro_rules! ios_plugin_binding {
   ($fn_name: ident) => {
-    tauri::swift_rs::swift!(fn $fn_name(name: &::tauri::swift_rs::SRString, webview: *const ::std::ffi::c_void));
+    tauri::swift_rs::swift!(fn $fn_name() -> *const ::std::ffi::c_void);
   }
 }
 #[cfg(target_os = "ios")]