Skip to content

feat(docs): add troubleshooting for chunking errors #843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericgregory merged 2 commits into from
Feb 19, 2025
Merged

feat(docs): add troubleshooting for chunking errors #843

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfe6df3
feat(docs): add troubleshooting for chunking errors
ericgregory Feb 18, 2025
dcdca4d
Merge branch 'main' into chunk
ericgregory Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion docs/developer/troubleshooting/components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Even though port 5000 may be available on your host's network, networking works

### Failing to invoke a component

#### Missing Runtime Links
#### Missing runtime links

Invocations are only allowed between components and providers that have been [linked](/docs/concepts/linking-components/). Omitting a link will result in a runtime error when the host denies the invocation:

Expand All @@ -55,6 +55,24 @@ The command line wasmCloud shell (aka [wash](https://github.com/wasmCloud/wasmCl

If any of the component ID, provider ID, link name, or contract ID are misspelled or omitted, then the host will deny the invocation.

### Chunking errors

When using the `wasi-http` interface directly, failed invocations can be the result of chunking errors caused by incorrect sequence of `wasi-http` operations. In this case, the component blocks during write and never finishes because the buffer becomes full.

The proper sequence of operations when using `wasi-http` directly in a Rust-based component is as follows:

1. Create an `OutgoingResponse`
2. Get the response body
3. Set the `ResponseOutparam` to that response
4. Get the `OutputStream` write handle to the response body
5. In a loop, `blocking_write_and_flush` until the call returns 0 or the stream is closed
6. Drop the output stream
7. Finish the outgoing body

Refer to component examples like [Blobby](https://github.com/wasmCloud/wasmCloud/blob/main/examples/rust/components/blobby/src/lib.rs#L175) to see this in practice.

In general, we recommend using a library like [`wasmcloud-component`](https://docs.rs/wasmcloud-component/0.2.0/wasmcloud_component/http/index.html) that abstracts HTTP operations.

## Troubleshooting invocations

:::info
Expand Down