supabase / supabase-flutter / 39934644218

94%

Build Type

push

github

Committed by web-flow

Commit Message

refactor(storage)!: consistent bucket option types, return shapes and hidden wire helpers (#2019)

Resolves
[SDK-2348](https://linear.app/supabase/issue/SDK-2348/refactorstorage-consistent-bucket-option-types-return-shapes-and).

Tidies up the storage API before 3.0.0.

## Changes

- **`BucketOptions.public` is optional.** `updateBucket` only sends the
options that are set. Before, changing just the MIME types or the
versioning status also sent `public`, which could make a public bucket
private. A bucket created without `public` is still private.
- **`BucketOptions.fileSizeLimit` is an `int` in bytes**, the same type
`Bucket.fileSizeLimit` has, instead of a string like `'20MB'`. The
server accepts both forms.
- **`SignedUploadURLResponse` is renamed `SignedUploadUrlResponse`** and
is a standalone class with `path`, `signedUrl` and `token`, so
`copyWith` can no longer drop the token. `SignedUrl` was only used as
its base class, so it is removed. `toString` leaves out `token`, since
`signedUrl` already contains it.
- **One rule for return shapes:** a method that only confirms success
returns `Future<void>` and throws on failure, like the vector methods
already did. That covers `createBucket`, `updateBucket`, `emptyBucket`,
`deleteBucket`, `deleteBucketLifecycle`, `purgeBucketCache`,
`purgeProjectCache`, `deleteAnalyticsBucket`, `move` and `purgeCache`.
`copy` creates an object, so it returns an `UploadResponse` like
`upload` does: `id`, `path` and `fullPath` (the old bucket-prefixed
return value). `versionId` stays `null`, because the `version` field in
the copy response is the object's internal version, which the server
returns even on buckets that are not versioned. I checked against the
local stack that the server returns only `{name}` or `{message}` for the
void methods.
- **The `StorageFileApi` constructor is `@internal`.** It now takes the
client's resumable upload registry as a required argument instead of
quietly creating an in-memory one.
- **W... (continued)

Coverage Stats

33 of 37 new or added lines in 5 files covered. (89.19%)

4 existing lines in 2 files now uncovered.

11244 of 12230 relevant lines covered (91.94%)

5.63 hits per line