supabase / supabase-flutter / 37318330230

92%

Build Type

push

github

Committed by web-flow

Commit Message

feat(storage)!: upload the raw file body and stream files from disk (#1911)

Every storage upload used `AbortableMultipartRequest`, with
`cacheControl` and `metadata` as form fields, and `upload(path, file)`
called `file.readAsBytesSync()`, which loaded the whole file into memory
and blocked the isolate while reading. There was also no way to upload
from a `Stream<List<int>>`.

## Changes

- The file is now the raw request body. `Content-Type`, `Cache-Control:
max-age=<seconds>`, `x-upsert` and `x-metadata` (base64-encoded JSON)
carry what the form fields used to. This matches what supabase-js sends
for an `ArrayBuffer` and what supabase-swift sends since
supabase/supabase-swift#1400. storage-api's `uploadFromRequest` reads
both shapes into the same body, mime type, cache control and user
metadata, so the server treats them identically, and a known-size upload
over the bucket limit is now rejected before any bytes are transferred.
- `upload`, `update` and `uploadToSignedUrl` stream the `File` from disk
with its length as `Content-Length`. A private `BaseRequest` subclass
creates the body stream in `finalize()`, so every retry attempt reads a
fresh stream instead of one an earlier attempt consumed.
- New `uploadStream`, `updateStream` and `uploadStreamToSignedUrl` take
a `Stream<List<int>>` and an optional `contentLength`. Without a length
the body is sent with chunked transfer encoding, which the server
accepts. A stream can only be listened to once, so these are never
retried and take no `retryOptions`.

**Breaking:** the wire format is no longer `multipart/form-data`. The
Dart API is unchanged; middleware, proxies or test fixtures that matched
on the multipart body need to read the raw body and the `x-metadata`
header instead. `MIGRATION.md` has a new section.

The new symbols are registered in `sdk-compliance.yaml` under `upload`,
`upload_with_signed_url`, `update_file` and `request_cancellation`.

## Testing

- `supabase_storage` unit tests: the u... (continued)

Coverage Stats

63 of 63 new or added lines in 2 files covered. (100.0%)

32 existing lines in 2 files now uncovered.

9262 of 10129 relevant lines covered (91.44%)

5.14 hits per line