supabase / supabase-flutter / 39264869603

92%

Build Type

push

github

Committed by web-flow

Commit Message

feat(postgrest)!: quote JSON path keys and add int array-index methods (#1983)

`jsonText(path)` and `jsonObject(path)` on the typed column expressions
sent `path` as written, `data->>$path`. So `jsonText('0')` read array
index 0 instead of the key `"0"`, `jsonText('a.b')` did not parse, and a
key with `,` or `"` had to be quoted and escaped by hand.

Now a `String` is always an object key, sent quoted with `\` and `"`
escaped the way PostgREST reads them. Two new methods, `jsonTextAt(int
index)` and `jsonObjectAt(int index)`, send a bare array index, and a
negative index counts from the end. Dart has no overloading, so these
are separate methods rather than an `int` overload as in
supabase/supabase-swift#1498.

```dart
Items.data.jsonText('name');                    // data->>"name"
Items.data.jsonText('0');                       // data->>"0", the key
Items.data.jsonObject('tags').jsonTextAt(0);    // data->"tags"->>0
Items.data.jsonObject('tags').jsonTextAt(-1);   // data->"tags"->>-1
```

A multi-step string path like `jsonObject('items->0')` no longer works.
Chain the calls instead: `jsonObject('items').jsonObjectAt(0)`. The
response key of a path now includes the quotes, `data->>"name"`. The
quoting reuses the escaping the `select` alias already did.

This is breaking only for the `@experimental` typed table surface, which
has shipped in 3.0.0 dev releases only, so there is no `MIGRATION.md`
section.

## Tests

- Unit tests cover quoted keys (digits, `.`, `,`, parentheses, empty),
escaping of `"` and `\`, bare indexes, and a quoted `"0"` inside an
embed, which does not get the closing cast that a bare index needs.
- The live `resource_embedding_test` now reads a digit key, a dotted
key, a comma key, a quoted key and a negative index. It also filters on
a quoted key, compares a `->` value numerically and orders by a dotted
key. It passes against the local stack.
- The full postgrest suite passes with `-j 1`.

Fixes SDK-2278

<!-- This is an auto-... (continued)

Coverage Stats

28 of 40 new or added lines in 3 files covered. (70.0%)

1 existing line in 1 file now uncovered.

10069 of 10949 relevant lines covered (91.96%)

5.43 hits per line