Adding support for dart/flutter

[matnex-mix]

I think the innovation really makes sense and solves a lot of problems while making it easier and more flexible. I'd like to build a dart client for surrealdb with major focus on flutter and was wondering if anyone can give me heads up. I think I'd start by using the library, the rust/javascript client libraries.

[tobiemh]

Hi @matnex-mix that sounds amazing! We'd love contributions in this space. I'll try and guide you as much as possible.

I presume if we could build upon the Rust library connector we could use this: https://github.com/fzyzcjy/flutter_rust_bridge ?

Alternatively, how could flutter work with the JavaScript client library?

[buraktabn]

You could use HeadlessInAppView to load and execute javascript in the background. It only works on iOS and Android.

I don't think it's necessary to bridge the rust connector to dart using FFI. IMHO it would be better to implement a client using desired transportation method (HTTP, WS, RPC, etc).

For the server implementation, bridging Rust to Dart definitely makes sense. Isar is a really good example of this as mentioned below.

Since Isar aims to be a local database for the platform, it needs to use it for its rust code. SurrealDB could do this in the server library and also there would be a native client written in native Dart.

[matnex-mix]

Yes exactly... I've considered building an HTTP client which is straightforward.

I think it'd be better if we use FFI ensure consistency in specifications and all of that... Idk...

[huang12zheng]

Hi @matnex-mix that sounds amazing! We'd love contributions in this space. I'll try and guide you as much as possible.

I presume if we could build upon the Rust library connector we could use this: https://github.com/fzyzcjy/flutter_rust_bridge ?

Alternatively, how could flutter work with the JavaScript client library?

@tobiemh

If you want to use an frb, the following URL might be an example
https://github.com/GregoryConrad/mimir/blob/main/packages/mimir/native/src/api.rs#L197
mimir
(I'd also like to say that it looks like a database-related one).

But as far as I know, frb currently only support basic types and extensions to them.(more about is https://cjycode.com/flutter_rust_bridge/feature/lang_simple.html)

[huang12zheng]

And finally,
Because the api uses generic, I don't know how to get a good solution.
I had to define the Model and implement multiple select.

#[tokio::main(flavor = "current_thread")]
pub async fn user_create_thing(resource: String, content: User) -> anyhow::Result<User> {
    let db = DB.get().unwrap();
    Ok(db
        .create(("User", resource).into_thing())
        .content(content)
        .await
        .unwrap())
}
#[tokio::main(flavor = "current_thread")]
pub async fn user_create_json(resource: String, content: User) -> anyhow::Result<User> {
#[tokio::main(flavor = "current_thread")]
pub async fn user_create_array(resource: Vec<String>, content: User) -> anyhow::Result<Vec<User>> {
#[tokio::main(flavor = "current_thread")]
pub async fn user_create_table(content: User) -> anyhow::Result<Vec<User>> {

[1l0]

FYI Isar the database for Flutter uses Rust and FFI.

[matnex-mix]

Exactly @1l0 @tobiemh, we can use a shared library .so, .dylib or .dll file generated by rust.

But i'd also checkout the flutter_bridge_tool

[1l0]

@matnex-mix A library for iOS must be static (.a). A dynamic library can be used in the local development however will be rejected by Apple through the review process.

[matnex-mix]

Oh... Oh... Thanks for pointing that out... But I think it still works though as rust can generate a static or dynamic library. @tobiemh ...?

[tobiemh]

@matnex-mix A library for iOS must be static (.a). A dynamic library can be used in the local development however will be rejected by Apple through the review process.

Very useful to know @1l0 !

[rifkyputra]

https://pub.dev/packages/wasm

dart can use wasm module, so technically it can load 'surrealdb.wasm' but i haven't tried it yet.

[limcheekin]

Wow! Almost a year, may I know anyone here managed to get surrealdb working in Flutter apps such as android and ios? Appreciate if you could share your experiences here or the URL of the GitHub repo.

I'm trying to make it works with Flutter Web using surrealdb.wasm at the moment but hitting an error on connecting to Surreal using JavaScript, please see the detail at https://github.com/orgs/surrealdb/discussions/2730.

[naisofly]

Hey @limcheekin, have you seen this community-maintained SDK for Flutter? Let us know if this helps or if you need any further support.

Thanks!

[limcheekin]

@naisofly Thanks for sharing. I aware about the package, but I need a surrealdb run in the browser, hence I created and published https://github.com/limcheekin/surrealdb_wasm

[1l0]

Cool. So we have a web support on Flutter. Hope it will integrate with other platforms into a package (mobile + desktop + web).

[limcheekin]

Yes, I plan to do so after this issue had been fixed #2332.

Appreciate your feedback for the surrealdb_wasm package if you're using it.

[1l0]

I guess that WASM is not needed for others (rust-bindgen + ffi). I'am wrong or you have a visionary idea.

[limcheekin]

You are right. I did look into it briefly, it is definitely possible to embed surrealdb instance to Flutter apps of mobile and desktop without wasm using the https://pub.dev/packages/flutter_rust_bridge. It is a more challenging task compare to my current approach from my understanding. Hence, I created the surrealdb_wasm package for my own requirement of Flutter web support.

If anyone here would like to sponsor this feature with financial support, we can discuss further details.