[meta] Breaking changes before v2-beta release

[amrbashir]

Public API changes:

• Remove custom protocol types and replace with http crate types - refactor(core): allow custom protocol handler to resolve async #7754
• Remove tauri::api module, not sure if it is needed, it still has hidden exports but ultimately it should be removed and replace with a public API if needed - refactor!: remove tauri::api module #7874
• path and plugin modules both, have a Result type alias, where they should be using tauri::Result instead and not have Error types on their own - refactor!: remove unnecessary error enum and result type aliases #7875
• Make almost all callbacks (where it makes sense), return a tauri::Result because most of our APIs return tauri::Result and would be easier to use ? operator.
• Remove rand and uuid crates, our usages of it could be replaced with an atomically incremented counter - refactor!: remove uuid and rand dependencies where applicable #7939
• change Env.args to pull from std::env::args_os instead of std::env::args - refactor!: changed Env.args to Env.args_os and use OsString instead of String #7876
• Consistent naming
  • Scope struct names, we have FsScope, then we have ipc::Scope - refactor!: consistent naming in tauri::scope module #7944
  • TrayIconBuilder/TrayIcon::on_tray_event should be renamed to TrayIconBuilder/TrayIcon::on_tray_icon_event - refactor!: renamed TrayIconBuilder/TrayIcon::on_tray_event to TrayIconBuilder/TrayIcon::on_tray_icon_event #7943
  • Environment variables used by tauri and tauri-cli is inconsistent and needs major renaming with possibly prefixing each var with TAURI_<SCOPE>_<VAR> - refactor!: consistent environment variables #7949
    A few examples but not limited to:
    • TAURI_FIPS_COMPLIANT should be TAURI_BUNDLER_WIX_FIPS_COMPLIANT
    • TAURI_PRIVATE_KEY relies on TAURI_KEY_PASSWORD and so it should be renamed to TAURI_PRIVATE_KEY_PASSWORD
    • APPLE_ID and APPLE_PASSWORD should probably be prefixed with TAURI_ unless these env vars are somewhat of a convention used by other tools, in that case, it should be fine to keep as is.
  • Event and RunEvent, I think RunEvent should be renamed to Event and Event should be changed to EmittedEvent and a variant under Event (which was previously named RunEvent)

Internal changes:

• primitives in @tauri-apps/api, like invoke, Channel, convertFileSrc and probably all exports from @tauri-apps/api/tauri module, should be all just a shim for the globally defined equivalents in scripts/core.js - refactor(core&api)!: hide internal functions and reuse them in api.js & rename tauri module to primitives #7942
• Move from TS to JS with JSDoc for @tauri-apps/api npm package, see discord wg-forum post
• Make tauri-runtime agnostic again #8036

This list is open for discussion, I just made it because I keep forgetting about them and feel free to add more as you see fit.

cc @tauri-apps/wg-tauri

[lucasfernog]

I like most of this, but I'm not sure about Make almost all callbacks (where it makes sense), return a tauri::Result because most of our APIs return tauri::Result and would be easier to use ? operator.. This one makes it harder to use custom Result types.

[lorenzolewis]

I'm not sure if these qualify under "breaking changes", but I'm tracking these in tauri-apps/tauri-docs#1344 :

• [feat] 2.0: Add plugin to lib.rs with tauri plugin add #7696
• refactor(cli): rename plugin add command to add #7744
• [feat] Add CLI option to tauri plugin init to enable/disable iOS/Android projects #7749 - refactor(cli): enhance plugin subcommand, closes #7749 #7990
• (optional, more messages and info that can be post 2.0) Tauri CLI 2.0 DX Improvements #7572 - refactor: enhance the descriptions of CLI commands, closes #7572 #7952

[FabianLars]

I'd like to request another one, merging the 2 updater configs into one. It may be a bit awkward to have the cli/bundler care about plugin configs but that's still wayyyyy less awkward than having 2 updater configs imo.
Also we'll likely need something similar for the shell and deep link plugins anyway (to bundle the additional binaries needed for them if the plugins are used)

• Merge bundle.updater into plugins.updater

[amrbashir]

I like most of this, but I'm not sure about Make almost all callbacks (where it makes sense), return a tauri::Result because most of our APIs return tauri::Result and would be easier to use ? operator.. This one makes it harder to use custom Result types.

My bad, I actually thought we have more than one callback that returns a result, turns out it is only .setup, Should be fine to keep as is then.

[lorenzolewis]

Met @nathan234 at RustConf, Nathan mentioned looking at integrating ART for the Android side of 2.0. Feel free to join the conversation here, open a new issue/PR, or join us on Discord!

[amrbashir]

• Event and RunEvent, I think RunEvent should be renamed to Event and Event should be changed to EmittedEvent and a variant under Event (which was previously named RunEvent)

While trying to implement this change, I had a change of heart because the JS side uses Event as the type name of the so called EmittedEvent in Rust and that doesn't make sense, so I decided to keep the names as they are for now.

if anyone feels like this change is still needed, let me know

[amrbashir]

Move from TS to JS with JSDoc for @tauri-apps/api npm package, see discord wg-forum post

Decided to keep TS and instead opted into simplifying the output JS files in #8025 which makes:

1. The generated files easier to edit and patch locally
2. Go to definition doesn't work as expected but Go to source definition does

[amrbashir]

Closing this as most items are now implemented, the remaining 2 items could be added later, and will be tracked in their respective issues.