feat: Add support for async/Future

Cargo.toml

@@ -48,6 +48,7 @@ members = [
   "fixtures/simple-fns",
   "fixtures/simple-iface",
   "fixtures/swift-omit-labels",
+  "fixtures/futures",
 ]
 
 resolver = "2"

docker/Dockerfile-build

@@ -45,10 +45,10 @@ RUN rm rust-toolchain.toml
 
 RUN mkdir -p /tmp/setup-swift \
     && cd /tmp/setup-swift \
-    && curl -o swift.tar.gz https://swift.org/builds/swift-5.2.4-release/ubuntu1804/swift-5.2.4-RELEASE/swift-5.2.4-RELEASE-ubuntu18.04.tar.gz \
+    && curl -o swift.tar.gz https://download.swift.org/swift-5.5-release/ubuntu1804/swift-5.5-RELEASE/swift-5.5-RELEASE-ubuntu18.04.tar.gz
     # XXX TODO: should check a sha256sum or something here...
     && tar -xzf swift.tar.gz \
-    && sudo mv swift-5.2.4-RELEASE-ubuntu18.04 /opt/swift \
+    && sudo mv swift-5.5-RELEASE-ubuntu18.04 /opt/swift \
     && echo "export PATH=\"\$PATH:/opt/swift/usr/bin\"" >> /home/circleci/.bashrc \
     && echo "export PATH=\"\$PATH:/opt/swift/usr/bin\"" >> /home/circleci/.profile \
     && cd ../ \
@@ -75,4 +75,14 @@ RUN mkdir -p /tmp/setup-jna \
     && cd ../ \
     && rm -rf ./setup-jna
 
+RUN mkdir -p /tmp/setup-kotlinx \
+    && cd /tmp/setup-kotlinx \
+    && curl -o kotlinx-coroutines-core-jvm.jar https://repo1.maven.org/maven2/org/jetbrains/kotlinx/kotlinx-coroutines-core-jvm/1.6.4/kotlinx-coroutines-core-jvm-1.6.4.jar \
+    # XXX TODO: should check a sha256sum or something here...
+    && sudo mv kotlinx-coroutines-core-jvm.jar /opt \
+    && echo "export CLASSPATH=\"\$CLASSPATH:/opt/kotlinx-coroutines-core-jvm.jar\"" >> /home/circleci/.bashrc \
+    && echo "export CLASSPATH=\"\$CLASSPATH:/opt/kotlinx-coroutines-core-jvm.jar\"" >> /home/circleci/.profile \
+    && cd ../ \
+    && rm -rf ./setup-kotlinx
+
 RUN sudo gem install ffi --no-document

docker/Dockerfile-build.checksum

@@ -0,0 +1 @@
+df97bf2200a9af87bd773ec620ec7ebd605cf5ef65a9bc3101cbb0b385d02d447584b17e2bc8a3e8601ed3e5dfb00e903286dece6bfa5885f24c9bbfac1663fb  Dockerfile-build

fixtures/futures/Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "uniffi-fixture-futures"
+version = "0.21.0"
+authors = ["Ivan Enderlin <ivan@mnt.io>"]
+edition = "2021"
+license = "MPL-2.0"
+publish = false
+
+[lib]
+name = "uniffi_futures"
+crate-type = ["lib", "cdylib"]
+
+[[bin]]
+name = "uniffi-fixtures-futures"
+path = "src/bin.rs"
+
+[dependencies]
+uniffi = { path = "../../uniffi", features = ["tokio", "cli"] }
+tokio = { version = "1.24.1", features = ["time"] }
+
+[build-dependencies]
+uniffi = { path = "../../uniffi", features = ["build"] }
+
+[dev-dependencies]
+uniffi = { path = "../../uniffi", features = ["bindgen-tests"] }

fixtures/futures/README.md

@@ -0,0 +1,39 @@
+# A basic test for uniffi components
+
+This test covers async functions and methods. It also provides examples.
+
+## Run the tests
+
+Simply use `cargo`:
+
+```sh
+$ cargo test
+```
+
+It is possible to filter by test names, like `cargo test -- swift` to only run
+Swift's tests.
+
+## Run the examples
+
+At the time of writing, each `examples/*` directory has a `Makefile`. They are
+mostly designed for Unix-ish systems, sorry for that.
+
+To run the examples, first `uniffi` must be compiled:
+
+```sh
+$ cargo build --release -p uniffi`
+```
+
+Then, each `Makefile` has 2 targets: `build` and `run`:
+
+```sh
+$ # Build the examples.
+$ make build
+$
+$ # Run the example.
+$ make run
+```
+
+One note for `examples/kotlin/`, some JAR files must be present, so please
+run `make install-jar` first: It will just download the appropriated JAR files
+directly inside the directory from Maven.

fixtures/futures/build.rs

@@ -0,0 +1,3 @@
+fn main() {
+    uniffi::generate_scaffolding("./src/uniffi_futures.udl").unwrap();
+}

fixtures/futures/examples/kotlin/.gitignore

@@ -0,0 +1,4 @@
+/*.jar
+/uniffi
+/libuniffi_futures.dylib
+/*.log

fixtures/futures/examples/kotlin/Makefile

@@ -0,0 +1,13 @@
+install-jar:
+	curl https://repo1.maven.org/maven2/net/java/dev/jna/jna/5.8.0/jna-5.8.0.jar -o jna.jar
+	curl https://repo1.maven.org/maven2/org/jetbrains/kotlinx/kotlinx-coroutines-core-jvm/1.6.4/kotlinx-coroutines-core-jvm-1.6.4.jar -o kotlinx-coroutines-core-jvm.jar
+
+build:
+	cargo build --release
+	../../../../target/release/uniffi-fixtures-futures generate --lib-file ../../../../target/release/libuniffi_futures.dylib ../../src/uniffi_futures.udl --language kotlin --out-dir .
+	rm -f libuniffi_futures.dylib
+	ln -s ../../../../target/release/libuniffi_futures.dylib libuniffi_futures.dylib
+	kotlinc -cp kotlinx-coroutines-core-jvm.jar:jna.jar -include-runtime -d demo.jar uniffi/fixture/futures/*.kt demo.kt
+
+run:
+	java -cp demo.jar:kotlinx-coroutines-core-jvm.jar:jna.jar my.demo.DemoKt

fixtures/futures/examples/kotlin/demo.kt

@@ -0,0 +1,41 @@
+package my.demo
+
+import kotlinx.coroutines.*
+import kotlin.coroutines.*
+import kotlin.system.*
+import uniffi.fixture.futures.*
+
+fun main() = runBlocking {
+    println("Let's start!\n")
+
+    println("Wait 2secs before greeting you, dear public!")
+
+    var time = measureTimeMillis {
+        val result = sayAfter(2000U, "You")
+        println("result: ${result}")
+    }
+
+    println("[in ${time / 1000.toDouble()}sec]")
+
+    println("\nWouah, 'tired. Let's sleep for 3secs!")
+
+    time = measureTimeMillis {
+        sleep(3000U)
+    }
+
+    println("[in ${time / 1000.toDouble()}sec]")
+
+    println("\nIs it really blocking? Nah. Let's greet Alice and Bob after resp. 2secs and 3secs _concurrently_!")
+
+    time = measureTimeMillis {
+        val alice = async { sayAfter(2000U, "Alice") }
+        val bob = async { sayAfter(3000U, "Bob") }
+
+        println("alice: ${alice.await()}")
+        println("bob: ${bob.await()}")
+    }
+
+    println("[in ${time / 1000.toDouble()}sec]")
+
+    println("\nSee, it took 3secs, not 5secs!")
+}

fixtures/futures/examples/python/.gitignore

@@ -0,0 +1,3 @@
+__pycache__
+libuniffi_futures.*
+uniffi_futures.py

fixtures/futures/examples/python/Makefile

@@ -0,0 +1,8 @@
+build:
+	cargo build --release
+	../../../../target/release/uniffi-fixtures-futures generate --lib-file ../../../../target/release/libuniffi_futures.dylib ../../src/uniffi_futures.udl --language python --out-dir .
+	rm -f libuniffi_futures.dylib
+	ln -s ../../../../target/release/libuniffi_futures.dylib libuniffi_futures.dylib
+
+run:
+	python3 demo.py

fixtures/futures/examples/python/demo.py

@@ -0,0 +1,37 @@
+from uniffi_futures import sleep, say_after, void
+import asyncio
+import time
+
+def show_time():
+    print(f"[time {time.strftime('%X')}]")
+
+async def main():
+    print("Let's start!\n")
+
+    print('Wait 2secs before greeting you, dear public!\n')
+
+    show_time()
+    result = await say_after(2000, 'You')
+    print(f'result: {result}')
+    show_time()
+
+    print("\nWouah, 'tired. Let's sleep for 3secs!\n")
+
+    show_time()
+    await sleep(3000)
+    show_time()
+
+    print("\nIs it really blocking? Nah. Let's greet Alice and Bob after resp. 2secs and 3secs _concurrently_!\n")
+
+    alice = asyncio.create_task(say_after(2000, 'Alice'))
+    bob = asyncio.create_task(say_after(3000, 'Bob'))
+    show_time()
+    result_alice = await alice
+    result_bob = await bob
+    print(f'result_alice: {result_alice}')
+    print(f'result_bob: {result_bob}')
+
+    show_time()
+    print("\nSee, it took 3secs, not 5secs!")
+
+asyncio.run(main())

fixtures/futures/examples/swift/.gitignore

@@ -0,0 +1,2 @@
+.build
+uniffi_futures*

fixtures/futures/examples/swift/Makefile

@@ -0,0 +1,19 @@
+build:
+	cargo build --release
+	../../../../target/release/uniffi-fixtures-futures generate --lib-file ../../../../target/release/libuniffi_futures.dylib ../../src/uniffi_futures.udl --language swift --out-dir ../../../../target/release/
+	swiftc \
+		-module-name uniffi_futures \
+		-emit-library -o ../../../../target/release/libuniffi_futures.dylib \
+		-emit-module -emit-module-path ../../../../target/release/ \
+		-parse-as-library \
+		-L ../../../../target/release/ \
+		-luniffi_futures \
+		-Xcc -fmodule-map-file=../../../../target/release/uniffi_futuresFFI.modulemap \
+		../../../../target/release/uniffi_futures.swift
+	# There is no equivalent to `-Xcc -fmodule-map-file` in `Package.swift`. The
+	# only solution is to rename the modulemap to… `module.modulemap`, and boom,
+	# magic.
+	cp ../../../../target/release/uniffi_futuresFFI.modulemap ../../../../target/release/module.modulemap
+
+run:
+	swift run

fixtures/futures/examples/swift/Package.swift

@@ -0,0 +1,22 @@
+// swift-tools-version: 5.6
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "demo",
+    platforms: [.macOS(.v12)],
+    dependencies: [],
+    targets: [
+        .executableTarget(
+            name: "demo",
+            dependencies: [],
+            swiftSettings: [
+                .unsafeFlags(["-I", "../../../../target/release"])
+            ],
+            linkerSettings: [
+                .linkedLibrary("uniffi_futures"),
+                .unsafeFlags(["-L../../../../target/release/"])
+            ]),
+    ]
+)

fixtures/futures/examples/swift/Sources/demo/Demo.swift

@@ -0,0 +1,42 @@
+import uniffi_futures
+import Foundation // to get `Date` and `DateFormatter`
+
+func showTime() {
+	let now = Date()
+	let formatter = DateFormatter()
+	formatter.timeStyle = .medium
+	print("[time \(formatter.string(from: now))]")
+}
+
+@main
+struct Testing {
+	static func main() async throws {
+		print("Let's start!\n")
+
+		print("Wait 2secs before greeting you, dear public!\n")
+
+		showTime()
+		let result = await sayAfter(ms: 2000, who: "You")
+		print("result: \(result)")
+		showTime()
+
+		print("\nWouha, 'tired. Let's sleep for 3secs!\n")
+
+		showTime()
+		let _ = await sleep(ms: 3000)
+		showTime()
+
+		print("\nIs it really blocking? Nah. Let's greet Alice and Bob after resp. 2secs and 3secs _concurrently_!\n")
+
+		async let alice = sayAfter(ms: 2000, who: "Alice")
+		async let bob = sayAfter(ms: 3000, who: "Bob")
+
+		showTime()
+		let (result_alice, result_bob) = await (alice, bob)
+		print("result_alice: \(result_alice)")
+		print("result_bob: \(result_bob)")
+		showTime()
+
+		print("\nSee, it tooks 3secs, not 5secs!\n")
+	}
+}

fixtures/futures/src/bin.rs

@@ -0,0 +1,3 @@
+fn main() {
+    uniffi::uniffi_bindgen_main()
+}