supabase / supabase-flutter / 39597942708

92%

push

github

feat(typegen)!: read inet and cidr columns into a network address type (#1997)

## Summary

`inet` and `cidr` columns generated `String` getters, and their column
tokens offered the text filters, which Postgres has no operators for on
these types (42883). They now map to `PostgresNetworkAddress`, a new
value type in `supabase_common` re-exported from postgrest.

- It holds the address `bytes` (4 for IPv4, 16 for IPv6), the
`prefixLength` of its netmask, and `isIpv6`.
- It is pure Dart, so unlike `InternetAddress` from `dart:io` it also
works on the web.
- `parse` reads dotted IPv4, IPv6 with `::` compression and a dotted
IPv4 tail, and an optional `/prefixLength`.
- `literal` prints the address the way Postgres does. It compresses the
longest run of two or more zero groups, the first of equally long ones.
It prints the last four bytes dotted for IPv4-compatible and IPv4-mapped
addresses. It leaves out a netmask that covers the whole address, as
`inet` output does.

`cidr` output keeps the whole-address netmask (`192.168.1.5/32`). That
parses to the same value as `192.168.1.5`, and Postgres reads the
shorter literal back as the same `cidr`.

The formatting was checked against 500 addresses Postgres 17 printed:
400 random IPv6 addresses biased toward zero groups, and 100 IPv4
addresses with random netmasks. The `literal` matched every one, apart
from the whole-address netmask difference above.

It implements `PostgresValue`, so filters and writes need no postgrest
change. `cidr[]` and `inet[]` columns become
`List<PostgresNetworkAddress>`.

## Breaking change

Regenerated getters for these columns change from `String` to
`PostgresNetworkAddress`, and the text filters are no longer offered on
them.

## Tests

- Unit tests covering parse, the canonical IPv6 forms Postgres prints,
netmask defaults, rejection of malformed input, round trips, validation
and equality.
- Parser test, fixture columns (including a `cidr[]`), regenerated
goldens, and a behavior t... (continued)

106 of 108 new or added lines in 3 files covered. (98.15%)

10409 of 11313 relevant lines covered (92.01%)

5.44 hits per line