wasmtime-cli: support `run --invoke` for components using wave by pchickey · Pull Request #10054 · bytecodealliance/wasmtime

pchickey · 2025-01-20T20:20:15Z

This PR adds support for wasmtime run --invoke <wave-function-call> component.wasm to wasmtime-cli. In the existing invoke for modules, the user provides a bare function name, and only functions that do not take arguments are supported. For components, the argument to invoke is parsed into component vals using the existing wasm-wave parsing introduced in #8872. We make some effort to provide useful error messages when we can't parse the wave function call.

tpmccallum · 2025-02-26T05:08:47Z

Tried this locally and got the following:

cd /Users/tpmccallum
git clone https://github.com/bytecodealliance/wasmtime.git
cd wasmtime
git checkout main
git pull origin main
git checkout pch/invoke_wave
git merge main
cargo clean
cargo build --release

Repo I used for testing is at https://github.com/tpmccallum/testing_components/tree/main (specifically the compress component):

tpmccallum@192-168-1-17 compress % /Users/tpmccallum/wasmtime/target/release/wasmtime run --invoke compress target/wasm32-wasip1/debug/compress.wasm

Error: failed to run main module `target/wasm32-wasip1/debug/compress.wasm`

Caused by:
    0: parsing invoke "compress"
    1: unexpected end of input at 8..8

pchickey · 2025-02-26T17:19:46Z

The wave syntax requires functions to be invoked with parens, so --invoke "compress()" should hopefully work. one of the big things missing is better error messages...

tpmccallum · 2025-02-27T23:20:28Z

Thanks for the response @pchickey
That makes sense. Thank you, and I will try that next and report back here.

tpmccallum · 2025-03-03T04:27:06Z

Hi @pchickey
Thanks for the additional info. I got this working - and wrote an article.
Thanks again!
Let me know if you need/want me to do any further testing on this. Super happy to assist.

tpmccallum · 2025-04-01T06:35:04Z

Hi @pchickey,
I have implemented the error message, tested out a bunch of scenarios and also updated the documentation.
Please see the details below.

Run.rs

Original/Before (Original error message)

An example of a user typing --invoke "compress" (with quotes).

Command:

$ /Users/tpmccallum/test_wasmtime/wasmtime/target/release/wasmtime run --invoke "compress" /Users/tpmccallum/testing_components/compress/target/wasm32-wasip1/debug/compress.wasm

Output:

Error: failed to run main module `/Users/tpmccallum/testing_components/compress/target/wasm32-wasip1/debug/compress.wasm`

Caused by:
    0: parsing invoke "compress"
    1: unexpected end of input at 8..8

An example of a user typing --invoke compress (no quotes):

Command:

/Users/tpmccallum/test_wasmtime/wasmtime/target/release/wasmtime run --invoke compress /Users/tpmccallum/testing_components/compress/target/wasm32-wasip1/debug/compress.wasm

Output:

Error: failed to run main module `/Users/tpmccallum/testing_components/compress/target/wasm32-wasip1/debug/compress.wasm`

Caused by:
    0: parsing invoke "compress"
    1: unexpected end of input at 8..8

After (Confirming new error message that provides advice about quotes and parentheses)

An example of a user typing `--invoke "compress" (with quotes).

Command:

$ /Users/tpmccallum/test_wasmtime/wasmtime/target/release/wasmtime run --invoke "compress" /Users/tpmccallum/testing_components/compress/target/wasm32-wasip1/debug/compress.wasm

Output:

Error: failed to run main module `/Users/tpmccallum/testing_components/compress/target/wasm32-wasip1/debug/compress.wasm`

Caused by:
    0: failed to parse invoke 'compress': invoked function calls must include parentheses after the function name in quoted wave syntax (e.g., "compress()")
    1: unexpected end of input at 8..8

An example of a user typing --invoke compress (no quotes):

Command:

/Users/tpmccallum/test_wasmtime/wasmtime/target/release/wasmtime run --invoke compress /Users/tpmccallum/testing_components/compress/target/wasm32-wasip1/debug/compress.wasm

Output:

Error: failed to run main module `/Users/tpmccallum/testing_components/compress/target/wasm32-wasip1/debug/compress.wasm`

Caused by:
    0: failed to parse invoke 'compress': invoked function calls must include parentheses after the function name in quoted wave syntax (e.g., "compress()")
    1: unexpected end of input at 8..8

After (Testing functionality of invoking a function with arguments inside the parentheses)

I also updated the Rust function to accept a string argument and then tested that the proper escaping of the string argument worked:

Command:

/Users/tpmccallum/test_wasmtime/wasmtime/target/release/wasmtime run --invoke "compress(\"hello\")" /Users/tpmccallum/testing_components/compress/target/wasm32-wasip1/debug/compress.wasm

Output:

[40, 181, 47, 253, 0, 88, 41, 0, 0, 104, 101, 108, 108, 111]

Documentation (`docs/cli-options.md`)

I also went ahead and updated the documentation that talks about --invoke with all of the above information (quotes, parenthesis, etc.).

Workflow

Below is how I pushed my changes. I hope this is what you were after, if not, please let me know.

Created a new branch called invoke_wave_enhancements.

$ git branch
          invoke_wave
        * invoke_wave_enhancements
          main

$ git status
	modified:   docs/cli-options.md
	modified:   src/commands/run.rs

$ git commit -m "Finalized enhancements for --invoke: error messages"
        [invoke_wave_enhancements 4a93050af] Finalized enhancements for --invoke: error messages
        2 files changed, 37 insertions(+), 5 deletions(-)

$ git push origin invoke_wave_enhancements
        git push origin invoke_wave_enhancements
        Enumerating objects: 13, done.
        Counting objects: 100% (13/13), done.
        Delta compression using up to 16 threads
        Compressing objects: 100% (7/7), done.
        Writing objects: 100% (7/7), 1.84 KiB | 1.84 MiB/s, done.
        Total 7 (delta 6), reused 0 (delta 0), pack-reused 0
        remote: Resolving deltas: 100% (6/6), completed with 6 local objects.
        remote: 
        remote: Create a pull request for 'invoke_wave_enhancements' on GitHub by visiting:
        remote:      https://github.com/tpmccallum/wasmtime/pull/new/invoke_wave_enhancements
        remote: 
        To github.com:tpmccallum/wasmtime.git
         * [new branch]          invoke_wave_enhancements -> invoke_wave_enhancements

When creating the PR in the GitHub UI, the base repository is set to pchickey/wasmtime, but the drop-down for the base branch does not have a pch/invoke_wave option. Not sure if you want/need to push pch/invoke_wave to your fork so I can set it in the drop-down for the base?

At this stage, I used main as the base because the changed files look relevant to the --invoke work specifically. So perhaps all is fine and you will see my changes.

The PR is at tpmccallum/wasmtime:invoke_wave_enhancements.
I did not get to fixing the CI errors today, only the CLI output messages and the documentation.

Please let me know your thoughts, and I can get the CI done tomorrow. On that note, I was wondering if you wanted to rebase and bring the PR up to date with the current code base. Happy to be guided by you.

Chat soon
Thanks!

tpmccallum · 2025-04-02T08:35:50Z

Update at #10511

tpmccallum

There was an excellent suggestion to use single quotes posted on the article about Invoke.
Using single quotes to surround the whole function call negates the need to escape double quotes around string arguments.

tpmccallum · 2025-04-05T00:35:29Z

src/commands/run.rs

+        let invoke: &String = self.invoke.as_ref().unwrap();
+
+        // Check if input is wrapped in double quotes
+        let lacks_quotes = !invoke.starts_with('"') && !invoke.ends_with('"');


I would like to revisit this logic (and will take some help if possible).
I discussed why Rust is not able to actually check for outer quotes in this comment .
But now that I realize we can use single quotes to surround the whole function there might be another way to attempt to detect the absence of surrounding quotes (that are passed, to Rust, from the CLI). I will try and get back to this in a few hours and do some local testing.

Long story short, if a user does not envelop the function with quotes, it trips over in the CLI, before the Rust even sees it:

$ wasmtime run --invoke compress(\"hello\") compress.wasm zsh: unknown file attribute: "

wasmtime run --invoke compress("hello") compress.wasm zsh: unknown file attribute: h

The following quoting examples do work, which is great.

$ wasmtime run --invoke "compress(\"hello\")" compress.wasm [40, 181, 47, 253, 0, 88, 41, 0, 0, 104, 101, 108, 108, 111]

$ wasmtime run --invoke 'compress("hello")' compress.wasm [40, 181, 47, 253, 0, 88, 41, 0, 0, 104, 101, 108, 108, 111]

Updates are ready at
#10533

tpmccallum · 2025-04-05T00:40:05Z

docs/cli-options.md

Just some inline updates that promote the use of ' instead of ".

tpmccallum · 2025-04-07T07:29:50Z

Hi @pchickey and @alexcrichton
Thanks for your patience. I have gotten around to some additional new work on a branch that handles the invoke quotes/parentheses and also takes care of the documentation about invoke's quotes and parentheses, etc.
#10533
Thanks so much.
Tim

tpmccallum · 2025-04-07T07:30:19Z

docs/cli-options.md

Updates at #10533

tpmccallum · 2025-04-07T07:30:32Z

src/commands/run.rs

Updates at #10533

alexcrichton · 2025-04-07T20:39:18Z

crates/wasmtime/src/runtime/component/component.rs

+    pub fn exports<'a>(
+        &'a self,
+        instance: Option<&'_ ComponentExportIndex>,
+    ) -> Option<impl Iterator<Item = (&'a str, types::ComponentItem, ComponentExportIndex)> + use<'a>>
+    {


I'm personally a bit hesitant to add too many flavors of accessors for exports, but would it be possible to use types::Component::exports here instead of adding these iterators?

alexcrichton · 2025-04-07T20:40:03Z

crates/wasmtime/src/runtime/wave/core.rs

        canonicalize_nan64(val)
    }
-
+    #[allow(clippy::cast_possible_truncation)]


Is this still necessary? This currently compiles on CI so the ignoring the warning may not be necessary.

I believe it is still necessary, yes.
For example, if I remove that line and then run the following:

rustfmt --edition 2021 crates/wasmtime/src/runtime/wave/core.rs export CARGO_INCREMENTAL=0 export CARGO_PROFILE_DEV_DEBUG=0 export CARGO_PROFILE_TEST_DEBUG=0 export RUSTFLAGS="-D warnings" export WIT_REQUIRE_SEMICOLONS=1 cargo clippy --workspace --all-targets

An error appears:

error: casting `u128` to `i64` may truncate the value --> crates/wasmtime/src/runtime/wave/core.rs:103:19 | 103 | let low = v as i64; | ^^^^^^^^ | = help: if this is intentional allow the lint with `#[allow(clippy::cast_possible_truncation)]` ... = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#cast_possible_truncation = note: `-D clippy::cast-possible-truncation` implied by `-D warnings` = help: to override `-D warnings` add `#[allow(clippy::cast_possible_truncation)]` help: ... or use `try_from` and handle the error accordingly | 103 - let low = v as i64; 103 + let low = i64::try_from(v); | error: could not compile `wasmtime` (lib) due to 1 previous error

If I add the #[allow(clippy::cast_possible_truncation)] back on line 100 the error goes away.
I originally noticed the issue in the GitHub UI. Please see screen capture below:

Ah ok makes sense, I think it's because the wave feature must not be enabled on the clippy run which would explain this a well

docs/cli-options.md

src/commands/run.rs

alexcrichton · 2025-04-07T20:55:12Z

src/commands/run.rs

+        match matches.len()  {
+                        0 => bail!("No export named `{name}` in component."),
+                        1 => {}
+                        _ => bail!("Multiple exports named `{name}`: {matches:?}. FIXME: support some way to disambiguate names"),
+                    };


FWIW I think the long string above is causing rustfmt to bail out here.

* wip * wasmtime::component::Component: add iterator of exports * components_rec * exports_rec gives fully qualified name * invoke works!!! * code motion * more context in errors * fix test of invoke * Finalized enhancements for --invoke: error messages * Testing and documenting --invoke * Update if else re: invoke * Updating to fix truncation possibilities in unwrap_tuple * Add clippy annotation to resolve CI error and leave original code (that makes 2 i64 out of 1 i128 and discards extra bits). * Format (rustfmt --edition 2021) Rust files in this PR. * Removing duplicate code missed from previous conflict resolution * Add more verbose documentation * Add more verbose documentation --------- Co-authored-by: Pat Hickey <pat@moreproductive.org>

* Convert docs and error trapping to single quote approach * Adjust the error message a little

pchickey · 2025-04-11T18:18:01Z

@alexcrichton I rewrote the search for component exports to live in the wasmtime-cli and be much dumber/simpler than the borrowing version that was a method on Component.

pchickey force-pushed the pch/invoke_wave branch from b8e53e8 to 2c60577 Compare January 20, 2025 20:26

github-actions bot added the wasmtime:api Related to the API of the `wasmtime` crate itself label Jan 20, 2025

pchickey mentioned this pull request Feb 25, 2025

Unable to run wasmtime component (Error: No such file or directory (os error 2)) #10291

Closed

This was referenced Apr 1, 2025

Invoke wave enhancements pchickey/wasmtime#1

Closed

Invoke wave enhancements #10511

Merged

pchickey force-pushed the pch/invoke_wave branch from 2c60577 to e12f933 Compare April 2, 2025 14:39

tpmccallum mentioned this pull request Apr 4, 2025

blog: Running Wasm Components From the Command Line (approved) bytecodealliance/bytecodealliance.org#126

Merged

github-actions bot added the wasmtime:docs Issues related to Wasmtime's documentation label Apr 4, 2025

pchickey marked this pull request as ready for review April 4, 2025 22:45

pchickey requested review from a team as code owners April 4, 2025 22:45

pchickey requested review from alexcrichton and removed request for a team April 4, 2025 22:45

tpmccallum reviewed Apr 5, 2025

View reviewed changes

docs/cli-options.md

Copy link

Contributor

tpmccallum Apr 5, 2025

Choose a reason for hiding this comment

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

Just some inline updates that promote the use of ' instead of ".

tpmccallum mentioned this pull request Apr 7, 2025

Convert docs and error trapping to single quote approach #10533

Merged

tpmccallum reviewed Apr 7, 2025

View reviewed changes

docs/cli-options.md

Copy link

Contributor

tpmccallum Apr 7, 2025

Choose a reason for hiding this comment

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

Updates at #10533

tpmccallum reviewed Apr 7, 2025

View reviewed changes

src/commands/run.rs

Copy link

Contributor

tpmccallum Apr 7, 2025

Choose a reason for hiding this comment

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

Updates at #10533

alexcrichton reviewed Apr 7, 2025

View reviewed changes

pchickey added 3 commits April 10, 2025 15:36

wip

1138ef8

invoke works!!!

79c0542

code motion

65bc906

pchickey and others added 5 commits April 11, 2025 10:14

more context in errors

c2788bf

fix test of invoke

9d9bf45

Convert docs and error trapping to single quote approach (#10533)

104af2a

* Convert docs and error trapping to single quote approach * Adjust the error message a little

Respond to review (#10544)

2a8c75f

pchickey force-pushed the pch/invoke_wave branch from 3e856ee to d8b1666 Compare April 11, 2025 18:11

cli: search component for export items

051f906

pchickey force-pushed the pch/invoke_wave branch from d8b1666 to 051f906 Compare April 11, 2025 18:13

alexcrichton approved these changes Apr 11, 2025

View reviewed changes

alexcrichton added this pull request to the merge queue Apr 11, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 11, 2025

pchickey added this pull request to the merge queue Apr 11, 2025

Merged via the queue into main with commit 9ca321e Apr 11, 2025
43 checks passed

pchickey deleted the pch/invoke_wave branch April 11, 2025 22:22

pchickey mentioned this pull request Apr 21, 2025

Stabilize output of wasmtime-cli for modules to the current output #10620

Open

bjorn3 mentioned this pull request May 10, 2025

Using --invoke with components is not supported #10764

Closed

pchickey mentioned this pull request Feb 5, 2026

ComponentType: add as_val method to convert to tagged representation #12496

Closed

3 tasks

Comments

Conversation

pchickey commented Jan 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tpmccallum commented Feb 26, 2025

Uh oh!

pchickey commented Feb 26, 2025

Uh oh!

tpmccallum commented Feb 27, 2025

Uh oh!

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

Uh oh!

Uh oh!

tpmccallum commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Run.rs

Original/Before (Original error message)

After (Confirming new error message that provides advice about quotes and parentheses)

After (Testing functionality of invoking a function with arguments inside the parentheses)

Documentation (docs/cli-options.md)

Workflow

Uh oh!

tpmccallum commented Apr 2, 2025

Uh oh!

tpmccallum left a comment

Choose a reason for hiding this comment

Uh oh!

tpmccallum Apr 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tpmccallum commented Apr 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pchickey commented Apr 11, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

pchickey commented Jan 20, 2025 •

edited

Loading

tpmccallum commented Mar 3, 2025 •

edited

Loading

tpmccallum commented Apr 1, 2025 •

edited

Loading

Documentation (`docs/cli-options.md`)

tpmccallum Apr 5, 2025 •

edited

Loading