supabase / supabase-flutter / 39972307761

93%

push

github

feat(functions)!: response headers, a region type, consistent naming and errors that stay in FunctionsException (#2031)

Resolves
[SDK-2350](https://linear.app/supabase/issue/SDK-2350/featfunctions-response-headers-a-region-enum-consistent-naming-and).

## Breaking changes

- **Naming.** `FunctionException` is now `FunctionsException` and
`FunctionResponse` is now `FunctionsResponse`, so every public type
shares the `Functions` prefix of `FunctionsClient`,
`FunctionsApiException`, `FunctionsFetchException` and
`FunctionsRelayException`.
- **Response headers.** `FunctionsResponse.headers` exposes the response
headers, on streamed responses too.
- **Region.** `region` on `invoke()`, `FunctionsClient` and
`FunctionsClientOptions` takes a `FunctionsRegion` instead of a
`String`. It has one constant per region that supabase-js
`FunctionRegion` lists, `FunctionsRegion.any`,
`FunctionsRegion.custom('...')` for regions that have no constant yet,
and `FunctionsRegion.values`. It is an extension type over `String`,
because a Dart enum cannot hold a custom value. A raw string no longer
compiles, so typos cannot reach the server.

## Fixes

- **Query parameters.** `queryParameters` is now `Map<String, Object?>`,
so `Map<String, dynamic>` still works. Values are sent as `toString()`,
a `DateTime` in ISO 8601, an `Iterable` as one parameter per element,
and `null` is dropped. Before, `{'page': 2}` threw a `_TypeError`.
- **JSON decoding.** `application/json` and every `+json` type
(`application/problem+json`, `application/vnd.api+json`, and so on) are
decoded, on both success and error responses. An empty JSON body is
`null` instead of `""`.
- **Errors stay in `FunctionsException`.** A body the codec cannot
encode, and a multipart `body` that is not a map of strings, now throw a
`FunctionsFetchException` before anything is sent. Before, release
builds got a `JsonUnsupportedObjectError` or a cast `TypeError`. A
successful response whose body is not valid JSON or UTF... (continued)

65 of 67 new or added lines in 3 files covered. (97.01%)

11668 of 12624 relevant lines covered (92.43%)

6.14 hits per line