supabase / supabase-flutter / 32488229193

89%

push

github

refactor!: process JSON through the AsyncJsonCodec interface (#1751)

`YAJsonIsolate` was the type the clients named in their public API. That
tied
them to one implementation, and on web to one that spawns no isolate at
all, so
the parameter both misnamed what it takes and left no way to process
JSON any
other way.

`YAJsonIsolate` now implements `AsyncJsonCodec`, a four method interface
(`decode`, `decodeBytes`, `encode`, `dispose`), and the clients take
that
interface instead.

### Changes

- `yet_another_json_isolate`: new `AsyncJsonCodec` interface,
implemented by
both the io and the web `YAJsonIsolate`, and exported from the package.
- `SupabaseClient`, `PostgrestClient` and `FunctionsClient`: `isolate:`
is now
`jsonCodec:` and takes an `AsyncJsonCodec`. The same rename runs through
  `PostgrestBuilder`, `PostgrestQueryBuilder`, `PostgrestRpcBuilder`,
`RawPostgrestBuilder`, `SupabaseQueryBuilder` and `SupabaseQuerySchema`.
- `postgrest` and `supabase_functions` export the interface, so the
parameter is
reachable without depending on `yet_another_json_isolate` directly,
which the
old parameter was not. `supabase` and `supabase_flutter` re-export it in
turn.
The concrete `YAJsonIsolate` stays unexported, so replacing the default
implementation later is not a breaking change for the flagship package.
- Ownership is unchanged: a codec passed to a client belongs to the
caller and
is never disposed by it. A client that was not given one creates the
default
codec and disposes it with itself. `SupabaseClient` hands its codec to
the
  rest and functions clients it builds, so one codec serves all three.
- `MIGRATION.md`: an entry for the rename.
- `sdk-compliance.yaml`: the interface registered under
`supporting_symbols`.

### Why an interface rather than the concrete type

Since #1746 there is no long-lived worker isolate: small payloads are
processed
inline and large ones on a short-lived isolate spawned per call. So
sharing an
instance buys nothing meas... (continued)

35 of 36 new or added lines in 6 files covered. (97.22%)

5978 of 6749 relevant lines covered (88.58%)

4.44 hits per line