supabase / supabase-flutter / 40904007901

94%

push

github

feat(storage): report download progress through an optional onProgress callback (#2102)

## Summary

- Adds an optional `onProgress` (`DownloadProgressCallback`) to
`StorageFileApi.download` and `downloadStream`, following the
`storage.file_buckets.transfer_progress` spec in supabase/sdk.
- The total is the `Content-Length` of the 2xx response (the range
length for a ranged download), and is `null` without one or when the
response has a `Content-Encoding`.
- Nothing is reported for an error response or after the body fails, the
count never decreases, and a zero-byte body gets exactly one report of 0
and 0.
- Marks `storage.file_buckets.transfer_progress` as `implemented` in
`sdk-compliance.yaml` and registers `DownloadProgressCallback`.

The change is additive and lives in the shared fetch layer, so it
carries over whatever shape SDK-2576 settles on for `downloadStream`,
and the collect and file helpers of SDK-2590 can pass the same callback.

## Test plan

- [x] `dart test test/download_progress_test.dart` covers a known
length, an unknown length, `Content-Encoding`, a ranged download, a
zero-byte body, an error response, a failing body and a throwing
callback, for both methods.
- [x] `dart analyze` and `dart format` are clean.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

<!-- coderabbit-ai-generated:v1 -->

## Summary by CodeRabbit

* **New Features**
* Added download-progress reporting to file downloads and streamed
downloads, including bytes received and the total when available.
* Progress callbacks can report unknown totals, and errors raised by
callbacks are surfaced to the caller.
* **Bug Fixes**
* Download progress is not reported for unsuccessful responses, and
empty downloads report zero bytes once.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

38 of 38 new or added lines in 1 file covered. (100.0%)

12434 of 13195 relevant lines covered (94.23%)

6.56 hits per line