supabase / supabase-flutter / 37462558256
92%

DEFAULT BRANCH: main
Ran
Jobs 11
Files 173
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 91.453%. Remained the same
37462558256

push

github

web-flow 
fix(typegen): suffix a schema object named function so the generated code compiles (#1920)

## Summary

A table or an enum named `function` generates a file that does not
compile.

```sql
create table function (id bigint primary key);
```

```dart
class Function {
  const Function._();
```

```
error - The built-in identifier 'Function' can't be used as a type name. - built_in_identifier_in_declaration
```

The same happens for `enum Function` when a Postgres enum has that name,
in any letter case.

`_TypeNameRegistry` starts out with the names a schema object may not
take, and `Function` is not among them. It is the one built-in
identifier of Dart that `pascalCase` can produce, since all the others
are lower case. The fix adds it to the set, so the type is suffixed like
any other taken name: `Function$`. This is the same one-line change
#1893 made for `ArgumentError`.

`FunctionRow`, `FunctionInsert` and `FunctionUpdate` are valid names and
stay as they are. A schema without an object of this name generates the
same output as before.

## Test

- `dart_generator_test.dart`: `a table and an enum named function are
suffixed`. On `main` it fails with `does not contain 'enum Function$ '`.
- Two generated schemas that are not part of the PR back this up. One
has a table for every identifier the generated code itself uses: on
`main`, `dart analyze` rejects only `Function` in its output. The other
has 356 enums named the same way plus the `dart:core` type names, each
used by a column, a list column and a computed field: with this change
`dart analyze` reports nothing.
- `dart test` in `packages/supabase_typegen` passes, `dart format -l 80
--set-exit-if-changed` on the changed files and `dart analyze
--fatal-infos .` are clean.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
* Generated Dart schema names now avoid conflicts with the reserved
`Function` identifier. Tables and enums with co... (continued)

9277 of 10144 relevant lines covered (91.45%)

5.13 hits per line

Jobs
ID Job ID Ran Files Coverage
11 supabase_typegen - 37462558256.11 24
96.22
GitHub Action Run
6 yet_another_json_isolate - 36864123641.6 1
98.44
GitHub Action Run
5 supabase - 37325589602.5 18
94.26
GitHub Action Run
3 supabase_functions - 37446858483.3 4
96.04
GitHub Action Run
11 iceberg - 37446858483.11 6
68.57
GitHub Action Run
4 supabase_storage - 37446858483.4 9
98.1
GitHub Action Run
5 supabase_flutter - 37446858483.5 15
81.0
GitHub Action Run
6 supabase_common - 37446858483.6 22
87.55
GitHub Action Run
10 supabase_realtime - 37446858483.10 13
90.67
GitHub Action Run
8 postgrest - 37446858483.8 29
93.41
GitHub Action Run
7 supabase_auth - 37446858483.7 32
92.07
GitHub Action Run
Source Files on build 37462558256