matrix-org / matrix-org/matrix-rust-sdk

Add support for real-time upload progress in sendImage, sendVideo, and other send* methods

Open
#5,844 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
2.3k
Forks
500
Avg merge
1d 16h
Merged PRs (30d)
106

Description

Currently, the sendImage, sendVideo, sendFile, and similar methods in the Matrix Rust SDK only report progress as 0% or 100% when uploading media to timelines. This makes it difficult to provide real-time, chunk-based progress updates to users.

Suggested Changes:
Add an optional ProgressWatcher parameter to the send* methods.
Emit periodic progress updates during the upload (e.g., every few KB or every 250ms).
Ensure backward compatibility by making the progress parameter optional.

This would enable smoother user experience with accurate upload progress while keeping existing functionality intact.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing sendImage, sendVideo, sendFile, and related send* methods, along with their current upload progress reporting and ProgressWatcher usage. Define how optional progress updates should be emitted during uploads, preserve existing callers, and verify that timeline media uploads report intermediate progress rather than only 0% and 100%.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.