feat: add a new option to remove unused commands by Legend-Master · Pull Request #12890 · tauri-apps/tauri

Legend-Master · 2025-03-04T09:02:15Z

Introducing a new config option build > removeUnusedCommands to let the tauri-cli pass in an environment variable to let the build script of tauri-plugin and tauri to generate a list of allowed commands from the ACL, this will then be used by the generate_handler macro to remove unused commands

Note: this won't be accounting for dynamically added ACLs so make sure to check it when using this

Some results:

Release build of the helloworld example in the repo gone from 3.92 MB to 1.91 MB on Windows (it doesn't use any plugin commands, so the improvement is quite big, also the basic executable contains the image dependency, it's around 2.67 MB if that's removed, but still a great improvement!)

github-actions · 2025-03-04T09:02:48Z

Package Changes Through `b813b76`

There are 12 changes which include tauri with minor, tauri-runtime with minor, tauri-runtime-wry with minor, tauri-utils with minor, tauri-cli with minor, @tauri-apps/cli with minor, @tauri-apps/api with minor, tauri-bundler with patch, tauri-build with minor, tauri-codegen with minor, tauri-macros with minor, tauri-plugin with minor

Planned Package Versions

The following package releases are the planned based on the context of changes in this pull request.

package	current	next
@tauri-apps/api	2.3.0	2.4.0
tauri-utils	2.2.0	2.3.0
tauri-bundler	2.2.4	2.2.5
tauri-runtime	2.4.0	2.5.0
tauri-runtime-wry	2.4.1	2.5.0
tauri-codegen	2.0.5	2.1.0
tauri-macros	2.0.5	2.1.0
tauri-plugin	2.0.5	2.1.0
tauri-build	2.0.6	2.1.0
tauri	2.3.1	2.4.0
@tauri-apps/cli	2.3.1	2.4.0
tauri-cli	2.3.1	2.4.0

Add another change file through the GitHub UI by following this link.

Read about change files or the docs at github.com/jbolda/covector

WSH032 · 2025-03-04T11:54:47Z

Hi @Legend-Master (I stumbled upon this PR 😇).

Can we implement this feature in build.rs or as cargo features instead of tauri-cli?

Sometimes I only use cargo build --features tauri/custom-protocol instead of tauri build.

ref: #4670 (comment)

Additionally, the regular Tauri development process heavily relies on Tauri-Cli to generate executables. However, for Pyo3 bindings, dynamic libraries (.so/.dll/.dylib) are required, so we cannot use Tauri-Cli and must use cargo build instead.

Legend-Master · 2025-03-04T12:14:57Z

I have tried it first before this and unfortunately since we can't run the build script before all the macros in plugins, it's not really viable

I could expose the command for generating the used commands though so that you can run it first and then exposing it to the environment manually

WSH032 · 2025-03-04T14:56:54Z

I could expose the command for generating the used commands though so that you can run it first and then exposing it to the environment manually.

In some cases, we don't even have tauri-cli 😥, and cargo is the only tool available.

since we can't run the build script before all the macros in plugins

Can we set an environment variable pointing to the capabilities files and then parse the allowed commands in the generate_handler! macro within the plugins?

This way, we wouldn't need to rely on tauri-cli to generate allowed-commands.json.

When I want to enable this feature, I will manually set this environment variable pointing to the capabilities.

(I'm not very familiar with this part of Tauri, so my idea might be wrong)

Legend-Master · 2025-03-04T15:44:15Z

In some cases, we don't even have tauri-cli 😥, and cargo is the only tool available.

I would also like to make those features not relying on the tauri cli if possible

Can we set an environment variable pointing to the capabilities files and then parse the allowed commands in the generate_handler! macro within the plugins?

Actually good idea, I'll give it a try when I got time, but instead of doing it in the macro, I think in plugins's build script should be better? (I'll see when I get there)

My current approach is not that great as it relies on the build scripts to generate the acl manifest first, so definitely something I would like to improve as well

(I'm not very familiar with this part of Tauri, so my idea might be wrong)

To be honest, I'm not very familiar with acl and macro related things either, so any suggestion would be much appreciated

crates/tauri-cli/src/build.rs

due to UNC paths...

Legend-Master · 2025-03-15T14:23:12Z

Well, it still removes the app commands if there're inline plugins but no app manifest right now (app-menu:default seems to be also included through default in the __app-acl__ entry)

I get it now, it's because of UNC paths...

Also I would like to push these thing to the json file as we're already reading and writing from there

I have gone ahead and did that

// when there's no app manifest / inlined plugins we should skip generating the allowed command list
// which then skips the removal of unused commands

I have also moved this to inside of generate_allowed_commands which will help removing the file to reflect potential edits

@lucasfernog This should be working now, tested locally with the api example with some configurations and all seems to work fine

crates/tauri-macros/src/command/handler.rs

Legend-Master · 2025-03-15T15:03:15Z

Actually, we should not skip this when permissions_map is empty in generate_allowed_commands, that could just mean we didn't specify any commands so we need to remove everything

This reverts commit b727dd6.

Legend-Master · 2025-03-15T15:16:26Z

Actually, we should not skip this when permissions_map is empty in generate_allowed_commands, that could just mean we didn't specify any commands so we need to remove everything

Sorry, it was right, it's about the permissions, I thought it was capabilities somehow 😂

lucasfernog

looks good! 🔥

crates/tauri-utils/src/config.rs

Co-authored-by: Fabian-Lars <github@fabianlars.de>

Legend-Master · 2025-03-15T16:50:05Z

I feel like we shouldn't apply it for dev as that would likely cause rebuilds due to different environment variables from rust analyzer, and I don't think this is useful in dev anyways

1111mp · 2025-03-19T04:59:53Z

@Legend-Master Your work is great, thank you. ❤️

I have a question I hope you can answer: Is this determined by whether the user explicitly provides the required permissions for the command when using the plugin to determine whether it needs to be added to allowed-commands.json. And is it possible to remove unused command in the project itself without using plugins?

Thank you again for your contribution.

Legend-Master · 2025-03-19T05:22:13Z

@Legend-Master Your work is great, thank you. ❤️

❤️

Is this determined by whether the user explicitly provides the required permissions for the command

Yes, but it should already be provided by your capability files that you don't need any additional configs

using the plugin to determine whether it needs to be added to allowed-commands.json

I'm not sure I get what plugin do you mean by that, but this feature would work with or without the plugins (by plugin I mean for example tauri-plugin-updater), the build script (both tauri, tauri-plugin, tauri-build crates) will generate the allowed-commands.json file based on your capability files separately for each crate

WSH032 · 2025-03-23T01:50:58Z

crates/tauri-utils/src/config/parse.rs

-  root_dir: PathBuf,
-) -> Result<(Value, Option<PathBuf>), ConfigError> {
-  let mut config: Value = parse_value(target, root_dir.join("tauri.conf.json"))?.0;
+pub fn read_from(target: Target, root_dir: &Path) -> Result<(Value, Vec<PathBuf>), ConfigError> {


@Legend-Master Does this crate not follow semantic versioning? Changing root_dir: PathBuf to root_dir: &Path is a breaking change. My library depends on both tauri and tauri-utils, and this change caused a compilation failure when upgrading to tauri v2.4.

Does this crate not follow semantic versioning?

No, But I think we should still note that in the release note (honestly we rarely did it for tauri-utils and tauri-runtime, but maybe we should as people started using them)

https://docs.rs/tauri-utils/latest/tauri_utils/config/index.html#stability
This is a core functionality that is not considered part of the stable API. If you use it, note that it may include breaking changes in the future.

These items are intended to be non-breaking from a de/serialization standpoint only. Using and modifying existing config values will try to avoid breaking changes, but they are free to add fields in the future - causing breaking changes for creating and full destructuring.

This documentation misled me into thinking that only Config is unstable (I mistakenly thought other APIs were stable 😂)

I am currently using these APIs to dynamically load tauri.conf.json at runtime. I want to know if it is necessary to pin the version of tauri-utils?

This documentation misled me into thinking that only Config is unstable (I mistakenly thought other APIs were stable 😂)

I'm not familiar with this to be honest, not sure if other things are stable or we just didn't put the stability notice at the right place

I am currently using these APIs to dynamically load tauri.conf.json at runtime. I want to know if it is necessary to pin the version of tauri-utils?

I would say yes

if it is necessary to pin the version of tauri-utils

I would say yes

Thanks! It's okay to me.

ref: <tauri-apps/tauri#12890 (comment)>

* fix(pytauri-wheel/sdist): do not use `path` dependencies in `Cargo.toml` * fix: pin minor version for unstable `tauri-utils` ref: <tauri-apps/tauri#12890 (comment)>

Add a new option to remove unused commands

ae4ad1b

github-project-automation bot added this to Roadmap Mar 4, 2025

github-project-automation bot moved this to 📬Proposal in Roadmap Mar 4, 2025

Legend-Master added 4 commits March 4, 2025 17:05

Fix compile

3d9ebf5

Add markers to all core plugins

75eaa91

Clippy

6127edf

Add allow unused when running with this

ae8ed00

Legend-Master added 5 commits March 6, 2025 13:58

Use build script to generate allowed-commands.json

86d8932

Clean up and add proper reruns

4bfe1cd

Wrong path

3b4065a

Revert to #[cfg_attr(not(debug_assertions), allow(unused))]

af613ce

Add change files

39e753e

Legend-Master marked this pull request as ready for review March 6, 2025 07:32

Legend-Master requested review from a team as code owners March 6, 2025 07:32

Legend-Master added 5 commits March 6, 2025 15:43

Some more docs

4e3cc06

Add version requirement note

533c830

Avoid rerun if no capabilities folder

039780a

Remove unused box

a9dead4

Merge branch 'dev' into remove-unused-commands

13ed425

WSH032 reviewed Mar 14, 2025

View reviewed changes

crates/tauri-cli/src/build.rs Outdated Show resolved Hide resolved

lucasfernog added 4 commits March 14, 2025 12:40

small cleanup

2197997

Merge remote-tracking branch 'origin/dev' into remove-unused-commands

39bdc8a

fix channel

cc27829

implement for app handler too

08660e3

Legend-Master added 2 commits March 15, 2025 22:00

Clippy

c7cb10f

Fix can't exclude inlined plugins on Windows

b950346

due to UNC paths...

lucasfernog reviewed Mar 15, 2025

View reviewed changes

crates/tauri-macros/src/command/handler.rs Outdated Show resolved Hide resolved

Apply suggestion from code review

3942051

Legend-Master added 3 commits March 15, 2025 23:09

Remove remove on empty to tauri-build

b727dd6

Revert "Remove remove on empty to tauri-build"

d7a50c9

This reverts commit b727dd6.

Centralize remove_file(allowed_commands_file_path)

47044fc

Legend-Master and others added 3 commits March 15, 2025 23:21

Escape glob pattern

b123f71

update change file [skip ci]

a00a01e

remove unused commands for dev too

1f73c31

lucasfernog previously approved these changes Mar 15, 2025

View reviewed changes

FabianLars reviewed Mar 15, 2025

View reviewed changes

crates/tauri-utils/src/config.rs Outdated Show resolved Hide resolved

Update crates/tauri-utils/src/config.rs

e88c9ed

Co-authored-by: Fabian-Lars <github@fabianlars.de>

lucasfernog dismissed their stale review via e88c9ed March 15, 2025 16:36

regen schema

b813b76

lucasfernog merged commit 013f8f6 into tauri-apps:dev Mar 15, 2025
27 checks passed

github-project-automation bot moved this from 📬Proposal to 🔎 In audit in Roadmap Mar 15, 2025

lucasfernog mentioned this pull request Mar 15, 2025

[bug] Huge increase in app size by upgrading from Tauri V1 to V2 #12820

Open

github-actions bot mentioned this pull request Mar 15, 2025

Apply Version Updates From Current Changes #12856

Merged

This was referenced Mar 20, 2025

fix: channel no longer being always allowed #13032

Merged

Document remove unused commands in app size page tauri-apps/tauri-docs#3218

Merged

WSH032 reviewed Mar 23, 2025

View reviewed changes

WSH032 added a commit to pytauri/pytauri that referenced this pull request Mar 23, 2025

fix: pin minor version for unstable tauri-utils

24032d3

ref: <tauri-apps/tauri#12890 (comment)>

Uh oh!

Conversation

Legend-Master commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Package Changes Through b813b76

Uh oh!

WSH032 commented Mar 4, 2025

Uh oh!

Legend-Master commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WSH032 commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Legend-Master commented Mar 4, 2025

Uh oh!

Uh oh!

Legend-Master commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Legend-Master commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Legend-Master commented Mar 15, 2025

Uh oh!

lucasfernog left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Legend-Master commented Mar 15, 2025

Uh oh!

1111mp commented Mar 19, 2025

Uh oh!

Legend-Master commented Mar 19, 2025

Uh oh!

WSH032 Mar 23, 2025

Choose a reason for hiding this comment

Uh oh!

Legend-Master Mar 23, 2025

Choose a reason for hiding this comment

Uh oh!

WSH032 Mar 23, 2025

Choose a reason for hiding this comment

Uh oh!

Legend-Master Mar 23, 2025

Choose a reason for hiding this comment

Uh oh!

WSH032 Mar 23, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Legend-Master commented Mar 4, 2025 •

edited

Loading

github-actions bot commented Mar 4, 2025 •

edited

Loading

Package Changes Through `b813b76`

Legend-Master commented Mar 4, 2025 •

edited

Loading

WSH032 commented Mar 4, 2025 •

edited

Loading

Legend-Master commented Mar 15, 2025 •

edited

Loading

Legend-Master commented Mar 15, 2025 •

edited

Loading