Skip to content

Latest commit

 

History

History
593 lines (410 loc) · 31.5 KB

CHANGELOG.md

File metadata and controls

593 lines (410 loc) · 31.5 KB
Raw

[[UnreleasedUniFFIVersion]] (backend crates: [[UnreleasedBackendVersion]]) - ([[ReleaseDate]])

All changes in [[UnreleasedUniFFIVersion]].

What's fixed?

  • Fixed a memory leak in callback interface handling.

⚠️ Breaking Changes for external bindings authors ⚠️

  • The callback interface code was reworked to use vtables rather than a single callback method. See mozilla#1818 for details and how the other bindings were updated.
  • Removed FfiType::RustFutureContinuationData. RustFutureContinuation callbacks now take a u64 handle.

v0.26.0 (backend crates: v0.26.0) - (2024-01-23)

What's changed?

  • The rust_future_continuation_callback_set FFI function was removed. rust_future_poll now inputs the callback pointer. External bindings authors will need to update their code.

What's new?

  • Rust traits Display, Hash and Eq exposed to Kotlin and Swift #1817
  • Foreign types can now implement trait interfaces #1791 and the documentation
    • UDL: use the [WithForeign] attribute
    • proc-macros: use the #[uniffi::export(with_foreign)] attribute
  • Generated Python code is able to specify a package name for the module #1784
  • UDL can describe async function #1834
  • UDL files can reference types defined in procmacros in this crate - see the external types docs and also external trait interfaces #1831
  • Add support for docstrings via procmacros #1862 and in UDL
  • Objects can now be returned from functions/constructors/methods without wrapping them in an Arc<>.

All changes in v0.26.0.

v0.25.3 (backend crates: v0.25.3) - (2023-12-07)

All changes in v0.25.3.

  • Switched to a patched version of oneshot so that consumers who use cargo vendor don't vendor loom and it's sub-dependencies like windows

v0.25.2 (backend crates: v0.25.2) - (2023-11-20)

What's fixed?

  • Fixed regression in the name of error enums in Kotlin #1842
  • Fix regression when error types are in dicts etc #1847

All changes in v0.25.2.

v0.25.1 (backend crates: v0.25.1) - (2023-11-09)

All changes in v0.25.1.

What's fixed?

  • Fixed several bugs with async functions were defined in multiple crates that get built together.

v0.25.0 (backend crates: v0.25.0) - (2023-10-18)

All changes in v0.25.0.

What's new

  • Proc-macros can now expose standard Rust traits (eg, Display, Eq, etc)

  • Fixed issues when trying to combine UDL and procmacros in the same crate when the "namespace" is different from the crate name. This meant that the "ffi namespace" has changed to consistently be the crate name, rather than either the crate name or the namespace name depending on whether the item was declared via a procmacro or UDL. This should be invisible in most cases, but custom build environments might require some changes. Specifically:

    • uniffi::generate_scaffolding(udl_path) now uses the udl_path to locate the corresponding Cargo.toml, which is parsed to determine the crate name (ie, the name under the [lib] entry). If your environment is such that Cargo.toml can't be located or parsed, you should instead use uniffi::generate_scaffolding_for_crate(udl_path, crate_name).
    • Similarly, when executing uniffi_bindgen from the command-line to generate bindings and when not using "library mode", Cargo.toml will be located and parsed to determine the crate name. Specifying --crate-name on the command-line can be used to avoid this and use the specified value.

  • Crates can now use proc-macros without UDL files to export their interface. See the "Procedural Macros: Attributes and Derives" manual section for details.

  • Custom Types are now supported for proc-macros, including a very low-friction way of exposing types implementing the new-type idiom.

  • Proc-macros: Added support for ByRef arguments

  • Proc-macros: Implemented custom type conversion error handling (https://mozilla.github.io/uniffi-rs/udl/custom_types.html#error-handling-during-conversion)

  • Error types must now implement Error + Send + Sync + 'static.

  • Proc-macros: The handle_unknown_callback_error attribute is no longer needed for callback interface errors

What's Fixed

  • Updated the async functionality to correctly handle cancellation (#1669)
  • Kotlin: Fixed low-level issue with exported async APIs
  • Kotlin: Fixed empty records being exported as empty data classes in Kotlin. A class with a proper equals function should be used instead.

What's changed?

  • Implementing From<uniffi::UnexpectedUniFFICallbackError is now optional for callback interface error types. If the error type implements that, things will continue to work as before. If not, then any unexpected callback error will result in a Rust panic.

v0.24.3 (backend crates: v0.24.3) - (2023-08-01)

All changes in v0.24.3.

What's changed?

  • uniffi_macros: Force-include the Cargo.toml to read (#1683)

v0.24.2 (backend crates: v0.24.2) - (2023-07-25)

All changes in v0.24.2.

What's changed?

  • Inline the metadata module in uniffi_meta to avoid a dependency of uniffi_core to avoid hitting an upstream bug during link time (#1666)

v0.24.1 (backend crates: v0.24.1) - (2023-06-23)

All changes in v0.24.1.

What's changed

  • Python: remove unused import (and unbreak Python 3.6 compatibility) (#1618)
  • Python: Delay contract checks until after all functions are defined to avoid wrong ABI use (#1619)
  • Kotlin: Fix error handling in async functions (#1614)

v0.24.0 (backend crates: v0.24.0) - (2023-06-21)

All changes in v0.24.0.

⚠️ Breaking Changes ⚠️

  • ABI: Implemented a new callback-interface ABI that significantly improves performance on Python and Kotlin.
    • UniFFI users will automatically get the benefits of this without any code changes.
    • External bindings authors will need to update their bindings code. Please see Guidance for external bindings below for details.
  • ABI: Changed API checksum handling. This affects external bindings authors who will need to update their code to work with the new system. See PR #1469 for details.
  • Removed the long deprecated ThreadSafe attribute.
  • External types now require a valid crate name. Before the docs said it must be a crate name, but any string could be used as long as it was consistent with the external type map in uniffi.toml.
  • External types must be available in the Rust crate root.
  • External bindings: The ExternalBindingsConfig trait was replaced with BindingsConfig. External bindings implementations will need to make minor changes to implement the new trait instead.
  • Removed support for the --config flag when running the scaffolding command. This flag has never an effect, because there was no scaffolding configuration options.
  • Python bindings are now more strict with their types. You can no longer pass strings to methods taking integers or floats, or floats to methods taking integers.

What's changed

  • Added "library mode" bindings generation using generate --library [path-to-cdylib]. This mode simplifies bindings generation, especially when you have dependencies between multiple UniFFIed crates. See the tutorial for a description.
  • The include_scaffolding!() macro must now either be called from your crate root or you must have use the_mod_that_calls_include_scaffolding::* in your crate root. This was always the expectation, but wasn't required before. This will now start failing with errors that say crate::UniFfiTag does not exist.
  • proc-macros now work with many more types including type aliases, type paths, etc.
  • The uniffi_types module is no longer needed when using proc-macros.
  • Traits can be exposed as a UniFFI interface by using a [Trait] attribute in the UDL. See the documentation.
  • The bytes primitive type was added, it represents an array of bytes. It maps to ByteArray in Kotlin, bytes in Python, String with Encoding::BINARY in Ruby and Data in Swift. (#1543)
  • Shortened str() representations of errors in Python to align with other exceptions in Python. Use repr() or the {!r} format to get the old representation back (#1556)
  • Methods implemented by standard Rust traits, such as Debug, Display, Eq and Hash can now be exposed over the FFI and bindings may implement special methods for them. See the documentation.
  • Added support for async/futures (#1409, #1515)
  • Added constructor support to proc-macro frontend (#1518)
  • Added support for field defaults to proc-macro frontend (#1560)
  • Implemented proc-macro callback interface support (#1573)
  • Python bindings now generate type stubs for all functions and types (#1506)
  • Enforced checks for integer overflows in Python bindings (#1546)
  • No more implicit conversion to integers/floats in Python (#1554)
  • Enforced checks for integer overflows in Ruby bindings (#1572)
  • Only UTF-8 valid strings are passed from Ruby to Rust (#1595)
  • No more implicit conversion to integers/floats in Ruby (#1596)
  • Updated Rust dependencies (#1495, #1583, #1569)
  • Added type checking to strings/bytes for Python/Ruby (#1597)
  • Implemented proc-macro external type support. This allows proc-macros to use types defined in UDL files from other crates, #1600

Guidance for external bindings

There are many breaking changes for external bindings - we hope there will be fewer in later releases, but we are laying the groundwork for some nice improvements. Significant patches to UniFFI's builtin bindings which you will need to port include:

v0.23.0 (backend crates: v0.23.0) - (2023-01-27)

Migrating to UniFFI 0.23+

All changes in v0.23.0.

⚠️ Breaking Changes ⚠️

  • uniffi_bindgen no longer provides a standalone binary. Having a standalone binary resulted in version mismatches when the uniffi version specified in Cargo.toml didn't match the uniffi_bindgen version installed on the system. Read The foreign language bindings section of the manual for how to set up a uniffi-bindgen binary that's local to your workspace.
  • uniffi_bindgen: Removed the run_main function. It's moved to uniffi::uniffi_bindgen_main and now unconditionally succeeds rather than return a Result<()>.

What's changed

  • The UniFFI crate organization has been significantly reworked:
    • Projects that use UniFFI for binding/scaffolding generation now only need to depend on the uniffi crate and no longer need to depend on uniffi_bindgen, uniffi_build, etc.
    • The version numbers for each crate will no longer by kept in sync after this release. In particular uniffi will have breaking changes less often than uniffi_bindgen and other crates. This means that UniFFI consumers that specify their versions like uniffi = "0.23" will not need to bump their uniffi version as often as before.
  • Callback interface method calls are no longer logged (#1439)

v0.22.0 - (2022-12-16)

All changes in v0.22.0.

⚠️ Breaking Changes ⚠️

  • uniffi_bindgen: Renamed FFIArgument, FFIFunction and FFIType to FfiArgument, FfiFunction and FfiType

What's changed

  • Added support for Swift external types
  • Fix whitespace issues in scaffolding code breaking some versions of rustfmt
  • Fix ruby time support
  • proc-macro
    • Document (experimental) proc-macro support
    • Support fallible functions
    • Add Enum derive macro
    • Add Error derive macro

v0.21.1 - (2022-12-16)

All changes in v0.21.1.

What's changed

  • Replace checksum mechanism for function naming to give consistent results, independent of the target's endianness and bit width. This should have no visible effect on the outside.

v0.21.0 - (2022-10-14)

All changes in v0.21.0.

⚠️ Breaking Changes ⚠️

  • uniffi_bindgen: Renamed the throws() method of Function, Method, and Constructor to throws_str(). Added a new throws() method that returns a boolean.

What's changed

  • Added support for exceptions in callback interface methods.
  • Improved error stringifying on Kotlin and Ruby (the message and to_s methods respectively).

v0.20.0 - (2022-09-13)

All changes in v0.20.0.

⚠️ Breaking Changes ⚠️

  • Renamed the uniffi_bindgen cydlib argument to lib_file, since it can also accept static libraries

What's changed

  • The guess_crate_root function is now public

What's changed

  • The UDL can contain identifiers which are also keywords in Swift, except in namespace functions.

v0.19.6 - (2022-08-31)

All changes in v0.19.6.

  • Fix callback interface init signature in Rust scaffolding
  • Drop unused dependencies
  • Update to MSRV 1.61.0

v0.19.5 - (2022-08-29)

All changes in v0.19.5.

  • Fixed a small bug in the 0.19.4 release, where the extraneous r# was present in the HashMap generated scaffolding.

v0.19.4 - (2022-08-29)

All changes in v0.19.4.

  • Implement Timestamp and Duration types in Ruby backend.
  • Fixed in a bug where callback interfaces with arguments that include underscores do not get converted to camelCase on Swift.

v0.19.3 - (2022-07-08)

All changes in v0.19.3.

v0.19.2 - (2022-06-28)

All changes in v0.19.2.

  • Fixed sccache issue with the askama.toml config file.

v0.19.1 - (2022-06-16)

All changes in v0.19.1.

What's Changed

  • Fixed the dependency from uniffi_build -> uniffi_bindgen

v0.19.0 - (2022-06-16)

All changes in v0.19.0.

⚠️ Breaking Changes ⚠️

  • breaking for external binding generators, the FFIType::RustArcPtr now includes an inner String. The string represents the name of the object the RustArcPtr was derived from.
  • Kotlin exception names are now formatted as strict UpperCamelCase. Most names shouldn't change, but names that use one word with all caps will be affected (for example URL -> Url, JSONException -> JsonException)

What's changed

  • The UDL can contain identifiers which are also keywords in Rust, Python or Kotlin.

v0.18.0 - (2022-05-05)

All changes in v0.18.0.

⚠️ Breaking Changes ⚠️

  • When custom types are used in function/method signatures UniFFI will now use the UDL name for that type and create a typealias to the concrete type. In the URL example, this means the type will be now appear on Kotlin as Url rather than URL. Any existing code should continue to work because of the typealias, but this might affect your generated documentation and/or code completion.
  • For Python libraries the native library is now loaded from an absolute path. The shared library (*.dll on Windows, *.dylib on macOS and .so on other platforms) must be placed next to the Python wrapper code.

What's changed

  • Allow record types with arbitrary key types
    • Record types can now contain any hashable type as its key. This is implemented for Kotlin, Python and Swift
  • Python
    • Added support for default values in dictionaries
    • Generated Python code is now annotated to avoid mypy type checking
  • Kotlin
    • Added external type support
  • Swift
    • Fix test helper code to work with Swift 5.6

v0.17.0 - (2022-02-03)

All changes in v0.17.0.

⚠️ Breaking Changes ⚠️

  • Wrapped types have been renamed custom types.
    • The UDL attribute is now [Custom] instead of [Wrapped]
    • The trait name has been renamed to UniffiCustomTypeConverter from UniffiCustomTypeWrapper
    • The method names of that trait have been renamed to into_custom() / from_custom() instead of wrap() and unwrap()
    • The associated type has been renamed to Builtin instead of Wrapped

What's Changed

  • Custom types (formerly wrapped) now can be configured on the bindings side as well as the scaffolding side. See the "Custom Types" section of the manual for details.
  • Kotlin now prefixes more local UniFFI variables with the _ char to avoid conflicts with user-defined names.
  • Updated Kotlin to use the FfiConverter pattern (#1144)
  • Documentation updates: Added a doc comparing UniFFI to Diplomat. Added a README note describing the foreign languages we currently support.
  • Fixed RustCallStatus.__str__ implementation on Python
  • Fixed the version numbers in the CHANGELOG compare links.

v0.16.0 - (2021-12-15)

All changes in v0.16.0

⚠️ Breaking Changes ⚠️

What's Changed

  • Python: Added Callback Interface support
  • Swift bindings can now omit argument labels in generated functions using omit_argument_labels = true in the configuration.

v0.15.2 - (2021-11-25)

What's Changed

  • Kotlin now generates valid code for optional timestamps/durations.

All changes in v0.15.2.

v0.15.1 (2021-11-23)

(Note that v0.15.0 was accidentally published, then yanked. v0.15.1 should be used instead)

⚠️ Breaking Changes ⚠️

  • Previously, an interface which didn't declare a constructor got a default one anyway, making it impossible to decline to provide one. This is no longer true, so if your interface wants a constructor, you must add one explicitly.

What's Changed

  • Kotlin and Swift, like Python, now support simple "wrapped" types.

  • The Python backend has been refactored to more closely match the other backends, but this should be invisible to consumers.

  • The Swift and Kotlin backends have had minor tweaks.

  • The kotlin backend now explicitly checks for a null pointer in cases where it should be impossible to help us diagnose issues seen in the wild. See #1108.

All changes in v0.15.1.

v0.14.1 (2021-10-27)

⚠️ Breaking Changes ⚠️

  • The build_foreign_language_testcases! macro now takes an array of UDL files as the first argument.

What's Changed

  • Swift: Added Callback Interface support
  • Swift: Refactored codegen to better match Kotlin / Unit of Code
  • Kotlin: Added some defensive programming around RustBufferBuilder.discard()

All changes in v0.14.1.

v0.14.0 (2021-08-17)

All changes in v0.14.0.

⚠️ Breaking Changes ⚠️

  • The Rust implementations of all dictionary, enum or error types defined in UDL must be public. If you see errors like: private type <type-name> in public interface or similar, please declare the types as pub in your Rust code.

  • Errors declared using the [Error] enum syntax will now expose the error string from Rust to the foreign language bindings. This reverts an unintended change in behaviour from the v0.13 release which made the error message inaccessible.

What's Changed

  • You can now use external types of various flavours - see the fine manual

  • An environment variable UNIFFI_TESTS_DISABLE_EXTENSIONS can disable foreign language bindings when running tests. See the contributing guide for more.

v0.13.1 (2021-08-09)

All changes in v0.13.1.

What's Changed

  • Fixed an accidental regression in v0.13.0 where errors were no longer being coerced to the correct type via Into. If the UDL declares a [Throws=ExampleError] function or method, the underlying implementation can now return anything that is Into<ExampleError>, matching the implicit Into behavior of Rust's ? operator.
  • Fixed an accidental regression in v0.13.0 where the generated Rust scaffolding assumed that the HashMap type would be in scope. It now uses fully-qualified type names in order to be more robust.

v0.13.0 (2021-08-09)

All changes in v0.13.0.

⚠️ Breaking Changes ⚠️

  • UniFFI no longer has ffi-support as a dependency. This means it handles panic logging on its own. If you previously enabled the log_panics feature for ffi-support, now you should enable it for uniffi.
  • The Swift bindings now explicitly generate two separate Swift modules, one for the high-level Swift code and one for the low-level C FFI. This change is intended to simplify distribution of the bindings via Swift packages, but brings with it some changes to the generated file layout.
    • For an interface namespace "example", we now generate:
      • A bridged C module named "exampleFFI" containing the low-level C FFI, consisting of an exampleFFI.h file and matching exampleFFI.modulemap file. The name can be customized using the ffi_module_name config option.
      • A Swift module named "example" containing the high-level Swift bindings, which imports and uses the low-level C FFI. The name can be customized using the module_name config option.
  • Python timestamps will now be in UTC and timezone-aware rather than naive.
  • Kotlin exceptions names will now replace a trailing "Error" with "Exception" rather than appending the string (FooException instead of FooErrorException)
  • JNA 5.7 or greater is required for Kotlin consumers

What's Changed

  • Both python and ruby backends now handle U16 correctly.
  • Error variants can now contain named fields, similar to Enum variants
  • Replaced the ViaFfi trait with the FfiConverter trait. FfiConverter is a more flexible version of ViaFfi because it can convert any Rust type to/from an Ffi type, rather than only Self. This allows for using UniFFI with a type defined in an external crate.

v0.12.0 (2021-06-14)

All changes in v0.12.0.

What's New

  • It is now possible to use Object instances as fields in Records or Enums, to pass them as arguments, and to return them from function and method calls. They should for the most part behave just like a host language object, and their lifecycle is managed transparently using Rust's Arc<T> type.
    • Reference cycles that include Rust objects will not be garbage collected; if you cannot avoid creating reference cycles you may need to use Rust's Weak<T> type to help break them.
    • In the Kotlin bindings, Object instances must be manually freed by calling their destroy() method or by using their .use block helper method. Records or Enums that contain an Object instance now also have a destroy() method and must be similarly disposed of after use.

What's Changed

  • Kotlin objects now implement AutoCloseable by default; closing an object instance is equivalent to calling its destroy() method.

v0.11.0 (2021-06-03)

All changes in v0.11.0.

⚠️ Breaking Changes ⚠️

  • All interface implementations must now be Sync + Send, and Rust will give a compile-time error if they are not. This makes the [Threadsafe] annotation redundant, so it is now deprecated and will be removed in a future release. More details on the motivation for this change can be found in ADR-0004.

What's Changed

  • Swift structs and Kotlin data classes generated from dictionary are now mutable by default:
    • Swift now uses var instead of let
    • Kotlin now uses var instead of val
  • Kotlin objects can now safely have their destroy() method or .use block execute concurrently with other method calls. It's recommended that you not do this, but if you accidentally do so, it will now work correctly rather than triggering a panic in the underlying Rust code.

v0.10.0 (2021-05-26)

All changes in v0.10.0.

⚠️ Breaking Changes ⚠️

  • Two new built-in datatypes have been added: the timestamp type for representing moments in time, and the duration type for representing a difference between two timestamps. These mirror the std::time::{SystemTime, Duration} types from Rust. Thanks to @npars for contributing this feature!
    • This is a breaking change as it may conflict with user-declared timestamp or duration types in existing .udl files.

What's New

  • A new Ruby codegen backend has been added. You can now call uniffi-bindgen -l ruby to generate a Ruby module that wraps a UniFFI Rust component. Thanks to @saks for contributing this backend!
    • When running cargo test locally, you will need a recent version of Ruby and the ffi gem in order to successfully execute the Ruby backend tests.
  • Threadsafe Object methods can now use self: Arc<Self> as the method receiver in the underlying Rust code, in addition to the default self: &Self. To do so, annotate the method with [Self=ByArc] in the .udl file and update the corresponding Rust method signature to match. This will not change the generated foreign-language bindings in any way but may be useful for more explicit management of Object references in the Rust code.

What's Changed

  • Kotlin: Fixed buggy codegen for optional primitive types like i32?; on earlier versions this would generate invalid Kotlin code which would fail to compile.

v0.9.0 (2021-05-21)

All changes in v0.9.0.

⚠️ Breaking Changes ⚠️

  • Support for non-[Threadsafe] interfaces has been deprecated. A future release will require that all interface implementations be Sync + Send, making the [Threadsafe] annotation redundant.

What's Changed

  • Errors when parsing a .udl file are now marginally more useful (they're still not great, but they're better).
  • Generated code should now be deterministic between runs with the same input file and version of UniFFI. Previously, the generated code could depend on the iteration order of an internal hash table.
  • Swift: Generated Swift Enums now conform to Hashable by default.
  • Swift: There are now additional docs on how to consume the generated Swift bindings via XCode.

Previous releases.

We did not maintain a changelog for previous releases.