Add callback interfaces for Swift #1066

jhugman · 2021-10-04T23:02:28Z

Fixes #353. It brings Swift parity with Kotlin, from #344 .

This is a rebase of #1045 by @pagr, following landing of #1042 and #1061.

Contributors @pagr and @patrick-fitzgerald will be interested in this.

Also in this PR:

~~deleted the examples/callback which seemed to be a duplicate to the fixture/callbacks directory~~
a cosmetic touch up to the kotlin implmentation of callbacks
- changing names to match the ffi_converter language @bdk pioneered.

Co-authored-by: Paul Griffin <[email protected]>

Re-work to fit in to the new structure Change to FfiConverter language cargo fmt Add docs to include swift

docs/manual/src/tutorial/callback_interfaces.md

Kotlin relies on Handle instead of Long (or ULong) Align kotlin implementation with swift

examples/callbacks/src/callbacks.udl

travis79

I had just a couple of suggestions, overall this is looking awesome!

fixtures/callbacks/tests/bindings/test_callbacks.swift

fixtures/callbacks/tests/test_generated_bindings.rs

patrick-fitzgerald · 2021-10-07T21:52:38Z

Looks great thanks @jhugman!

DAOCUONG · 2021-10-07T22:11:14Z

I have experience error when tried to add main uniffi after this commit

Compiling uniffi v0.14.0 (https://github.com/mozilla/uniffi-rs.git?branch=main#d2b8d56a)
error[E0308]: mismatched types
--> /Users/dao/.cargo/git/checkouts/uniffi-rs-6f89edd2a1ffa4bd/d2b8d56/uniffi/src/testing.rs:144:34
|
144 | .args(&["test", out_dir, udl_files, test_file])
| ^^^^^^^^^
| |
| expected &str, found struct String
| help: consider borrowing here: &udl_files

For more information about this error, try rustc --explain E0308.
error: could not compile

* Added swift callback support * Temporary fix for running callbacks in another thread * Generate all the required swift code * Make run_uniffi_bindgen_test build * [wip] add tests for callbacks (mozilla#1) Co-authored-by: Paul Griffin <[email protected]> * Fix nits * Fit new Swift callbacks into the new Unit of Code structure Re-work to fit in to the new structure Change to FfiConverter language cargo fmt Add docs to include swift * Backfill Kotlin callbacks to closer match the Swift implementation Kotlin relies on Handle instead of Long (or ULong) Align kotlin implementation with swift * Fixup markdown weirdness * Address self-review * Address reviewer comments Co-authored-by: Paul Griffin <[email protected]> Co-authored-by: Paul Griffin <[email protected]>

bendk · 2021-10-11T23:16:57Z

@DAOCUONG I'm seeing the same issue. If you don't need to use the absolute latest code, you could try using uniffi from crates.io until it's fixed.

@jhugman I think it's just a one-liner, but it's hard to test because it only runs when builtin-bindgen is not set, which I don't think happens when the tests are run from the uniffi crate. Can you take a look at the above PR and see if it seems okay?

artfuldev · 2021-10-27T19:01:13Z

I'm seeing this message but wasn't sure if I should be, since I thought we implemented callback interfaces for swift in this PR:

I'm using 0.14 - is there another version I should be using?

badboy · 2021-10-27T19:05:16Z

I'm seeing this message but wasn't sure if I should be, since I thought we implemented callback interfaces for swift in this PR:

I'm using 0.14 - is there another version I should be using?

There was no release since we merged this.

artfuldev · 2021-10-27T19:11:45Z

There was no release since we merged this.

Thank you so much! When can we expect the next release?

bendk · 2021-10-27T20:10:07Z

Just pushed it out, 0.14.1 should have what you need.

artfuldev · 2021-10-27T20:29:43Z

It doesn't compile:

It also seems to have failed the pipeline:
https://app.circleci.com/pipelines/github/mozilla/uniffi-rs/1455/workflows/8ec87b78-dff7-42a1-b68d-84f6d612842f/jobs/5149

bendk · 2021-10-27T20:43:40Z

I'm not sure what's happening, but it looks like you have version of the scaffolding built with the older unify. I would try cargo clean and see what happens.

That CI failure is related, but I don't think it's the cause of your issue.

DAOCUONG · 2021-10-27T22:54:55Z

Reinstall uniffi_bindgen will help

artfuldev · 2021-10-28T09:40:12Z

Sorry to pollute this PR thread, but it doesn't work after cargo clean. Fails with the exact same error. I can share my Cargo.toml:

I've updated all my dependencies so I'm not sure what else I can do.

bendk · 2021-10-28T13:28:57Z

I think DAOCUONG might be right, it seems to me that uniffi and uniffi_bindgen are out of sync. Maybe try cargo install uniffi-bindgen or switching the dependency to:

uniffi_build = { version = "0.14.1", features=["builtin-bindgen"] }

If that doesn't work, feel free to reach out on matrix or email me directly ([email protected]).

artfuldev · 2021-10-28T17:14:31Z

Thanks @bendk , @DAOCUONG
I don't know how, but somehow the versions did get mismatched even though I updated my uniffi_bindgen.

I did

uniffi-bindgen --version

and got 0.14.1 as expected, so I couldn't understand why it failed cargo build.

After your responses, I did

cargo clean
cargo uninstall uniffi_bindgen
cargo install uniffi_bindgen
cargo build

and it worked.

songhuaixu · 2024-09-03T03:04:54Z

docs/manual/src/tutorial/callback_interfaces.md

+}
+```
+
+Note: in Swift, this must be a `class`.


Why can't it be a struct

Paul Griffin and others added 7 commits October 4, 2021 23:41

Added swift callback support

52a8268

Temporary fix for running callbacks in another thread

c2e5a9a

Generate all the required swift code

77e7b50

Make run_uniffi_bindgen_test build

8199a23

[wip] add tests for callbacks (#1)

fc24565

Co-authored-by: Paul Griffin <[email protected]>

Fix nits

2b7bb16

Fit new Swift callbacks into the new Unit of Code structure

10dc57b

Re-work to fit in to the new structure Change to FfiConverter language cargo fmt Add docs to include swift

jhugman requested a review from a team October 4, 2021 23:02

patrick-fitzgerald reviewed Oct 4, 2021

View reviewed changes

docs/manual/src/tutorial/callback_interfaces.md Outdated Show resolved Hide resolved

jhugman and others added 2 commits October 5, 2021 14:56

Backfill Kotlin callbacks to closer match the Swift implementation

3b86aa4

Kotlin relies on Handle instead of Long (or ULong) Align kotlin implementation with swift

Fixup markdown weirdness

c2ef2c3

jhugman force-pushed the jhugman/swift-callbacks-pagr branch from c5bbc25 to 0c66759 Compare October 5, 2021 13:57

Address self-review

f17be20

jhugman force-pushed the jhugman/swift-callbacks-pagr branch from 0c66759 to f17be20 Compare October 5, 2021 13:59

jhugman commented Oct 6, 2021

View reviewed changes

examples/callbacks/src/callbacks.udl Outdated Show resolved Hide resolved

travis79 approved these changes Oct 6, 2021

View reviewed changes

jhugman mentioned this pull request Oct 6, 2021

Add callback interfaces for Python #1068

Closed

Address reviewer comments

fc6ade8

jhugman merged commit d2b8d56 into main Oct 7, 2021

jhugman deleted the jhugman/swift-callbacks-pagr branch October 7, 2021 12:04

jhugman mentioned this pull request Oct 7, 2021

Callbacks in swift #1045

Closed

bendk mentioned this pull request Oct 11, 2021

Fix for run_uniffi_bindgen_test #1071

Merged

songhuaixu reviewed Sep 3, 2024

View reviewed changes

docs/manual/src/tutorial/callback_interfaces.md

}

```

Note: in Swift, this must be a `class`.

Copy link

songhuaixu Sep 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why can't it be a struct

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add callback interfaces for Swift #1066

Add callback interfaces for Swift #1066

jhugman commented Oct 4, 2021 •

edited

Loading

travis79 left a comment

patrick-fitzgerald commented Oct 7, 2021

DAOCUONG commented Oct 7, 2021

bendk commented Oct 11, 2021

artfuldev commented Oct 27, 2021

badboy commented Oct 27, 2021

artfuldev commented Oct 27, 2021

bendk commented Oct 27, 2021

artfuldev commented Oct 27, 2021 •

edited

Loading

bendk commented Oct 27, 2021

DAOCUONG commented Oct 27, 2021

artfuldev commented Oct 28, 2021 •

edited

Loading

bendk commented Oct 28, 2021 •

edited

Loading

artfuldev commented Oct 28, 2021

songhuaixu Sep 3, 2024

Add callback interfaces for Swift #1066

Add callback interfaces for Swift #1066

Conversation

jhugman commented Oct 4, 2021 • edited Loading

travis79 left a comment

Choose a reason for hiding this comment

patrick-fitzgerald commented Oct 7, 2021

DAOCUONG commented Oct 7, 2021

bendk commented Oct 11, 2021

artfuldev commented Oct 27, 2021

badboy commented Oct 27, 2021

artfuldev commented Oct 27, 2021

bendk commented Oct 27, 2021

artfuldev commented Oct 27, 2021 • edited Loading

bendk commented Oct 27, 2021

DAOCUONG commented Oct 27, 2021

artfuldev commented Oct 28, 2021 • edited Loading

bendk commented Oct 28, 2021 • edited Loading

artfuldev commented Oct 28, 2021

songhuaixu Sep 3, 2024

Choose a reason for hiding this comment

jhugman commented Oct 4, 2021 •

edited

Loading

artfuldev commented Oct 27, 2021 •

edited

Loading

artfuldev commented Oct 28, 2021 •

edited

Loading

bendk commented Oct 28, 2021 •

edited

Loading