Provide an option to set compiled library file path

temeddix · temeddix · commit 463cff545397 · 2024-06-01T10:12:30.000+09:00
diff --git a/flutter_ffi_plugin/bin/src/message.dart b/flutter_ffi_plugin/bin/src/message.dart
@@ -504,7 +504,8 @@ hash_map.insert(
 import 'dart:typed_data';
 import 'package:rinf/rinf.dart';
 
-Future<void> initializeRust() async {
+Future<void> initializeRust({String? compiledLibPath}) async {
+  setCompiledLibPath(compiledLibPath);
   await prepareInterface(handleRustSignal);
   startRustLogic();
 }
diff --git a/flutter_ffi_plugin/lib/rinf.dart b/flutter_ffi_plugin/lib/rinf.dart
@@ -6,6 +6,16 @@ import 'src/exports.dart';
 
 export 'src/interface.dart' show RustSignal;
 
+/// Sets the exact file path of the dynamic library
+/// compiled from the `hub` crate.
+/// On the web, this function sets the path to the JavaScript module
+/// that needs to be loaded.
+/// This function might not be necessary for major platforms
+/// but can be useful when the app runs on embedded devices.
+void setCompiledLibPath(String? path) {
+  setCompiledLibPathExtern(path);
+}
+
 /// Prepares the native interface
 /// needed to communicate with Rust.
 Future<void> prepareInterface(HandleRustSignal handleRustSignal) async {
@@ -18,9 +28,9 @@ void startRustLogic() async {
 }
 
 /// Terminates all Rust tasks.
-/// Doing so before closing the Flutter app
-/// can prevent potential memory errors that may occur
-/// when Rust attempts to send data after the Dart VM has been turned off.
+/// Calling this function before closing the Flutter app
+/// can prevent potential resource leaks that may occur
+/// if the Rust side is abruptly terminated.
 /// Please note that on the web, this function does not have any effect,
 /// as tasks are managed by the JavaScript runtime, not Rust.
 void stopRustLogic() async {
diff --git a/flutter_ffi_plugin/lib/src/interface_os.dart b/flutter_ffi_plugin/lib/src/interface_os.dart
@@ -7,6 +7,10 @@ import 'dart:isolate';
 import 'interface.dart';
 import 'dart:convert';
 
+void setCompiledLibPathExtern(String? path) {
+  setDynamicLibPath(path);
+}
+
 Future<void> prepareInterfaceExtern(
   HandleRustSignal handleRustSignal,
 ) async {
diff --git a/flutter_ffi_plugin/lib/src/interface_web.dart b/flutter_ffi_plugin/lib/src/interface_web.dart
@@ -7,6 +7,10 @@ import 'interface.dart';
 import 'dart:async';
 import 'dart:convert';
 
+void setCompiledLibPathExtern(String? path) {
+  setJsLibPath(path);
+}
+
 Future<void> prepareInterfaceExtern(
   HandleRustSignal handleRustSignal,
 ) async {
diff --git a/flutter_ffi_plugin/lib/src/load_os.dart b/flutter_ffi_plugin/lib/src/load_os.dart
@@ -1,9 +1,21 @@
 import 'dart:io' as io;
 import 'dart:ffi';
 
+String? dynamicLibPath;
 final rustLibrary = loadRustLibrary();
 
+void setDynamicLibPath(String? path) {
+  dynamicLibPath = path;
+}
+
 DynamicLibrary loadRustLibrary() {
+  // Use provided dynamic library path if possible.
+  final path = dynamicLibPath;
+  if (path != null) {
+    return DynamicLibrary.open(path);
+  }
+
+  // Otherewise, use the default path.
   if (io.Platform.isLinux) {
     return DynamicLibrary.open('libhub.so');
   } else if (io.Platform.isAndroid) {
diff --git a/flutter_ffi_plugin/lib/src/load_web.dart b/flutter_ffi_plugin/lib/src/load_web.dart
@@ -4,11 +4,17 @@ import 'dart:js' as js;
 import 'dart:html';
 import 'dart:async';
 
+String? jsLibPath;
+
 // When Dart performs hot restart,
 // the `rinf` object is already defined
 // as a global JavaScript variable.
 final wasAlreadyLoaded = js.context.hasProperty("rinf");
 
+void setJsLibPath(String? path) {
+  jsLibPath = path;
+}
+
 Future<void> loadJsFile() async {
   if (wasAlreadyLoaded) {
     return;
@@ -17,10 +23,13 @@ Future<void> loadJsFile() async {
   final loadCompleter = Completer<void>();
   js.context['completeRinfLoad'] = loadCompleter.complete;
 
+  // Use the default JavaScript path unless provided.
+  final path = jsLibPath ?? "/pkg/hub.js";
+
   final scriptElement = ScriptElement();
   scriptElement.type = "module";
   scriptElement.innerHtml = '''
-import init, * as wasmBindings from "/pkg/hub.js";
+import init, * as wasmBindings from "$path";
 await init();
 window.rinf = { ...wasmBindings };
 completeRinfLoad();

Original file line number	Diff line number	Diff line change
`@@ -504,7 +504,8 @@ hash_map.insert(`
`504`	`504`	`import 'dart:typed_data';`
`505`	`505`	`import 'package:rinf/rinf.dart';`
`506`	`506`
`507`		`-Future<void> initializeRust() async {`
	`507`	`+Future<void> initializeRust({String? compiledLibPath}) async {`
	`508`	`+ setCompiledLibPath(compiledLibPath);`
`508`	`509`	`await prepareInterface(handleRustSignal);`
`509`	`510`	`startRustLogic();`
`510`	`511`	`}`