supabase / supabase-flutter / 32033193174

89%

push

github

feat(storage)!: return the file id from upload and update methods (#1730)

## What kind of change does this PR introduce?

Feature (breaking change, part of v3, #1278).

Closes #1274

## What is the current behavior?

`upload`, `uploadBinary`, `update`, `updateBinary`, `uploadToSignedUrl`
and `uploadBinaryToSignedUrl` return a plain `String` key, so the id of
the created object is discarded even though the storage server has been
returning it since
[supabase/storage#332](https://github.com/supabase/storage/pull/332).

## What is the new behavior?

All six methods return an `UploadResponse` with:

- `id`: the identifier of the stored object (`null` for signed URL
uploads, where the server does not report it)
- `path`: the path of the object within the bucket
- `fullPath`: the path prefixed with the bucket id

This matches the `{ id, path, fullPath }` shape supabase-js returns from
its upload methods.

## Additional context

- The upload and update methods now normalize the object path the same
way the signed URL uploads already did (leading, trailing and duplicate
slashes are removed), matching supabase-js.
- The new `UploadResponse` symbols are registered in
`sdk-compliance.yaml`; the symbol, drift and schema checks pass locally.
- Unit tests and the storage integration suite pass against the local
stack, including a new assertion that the real server returns the id.

67 of 71 new or added lines in 3 files covered. (94.37%)

5759 of 6526 relevant lines covered (88.25%)

4.13 hits per line