FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Fix PostgreSQL timestamptz db_type override alias matching. by marcusacosta · Pull Request #4486 · sqlc-dev/sqlc · GitHub

/ sqlc Public

Fix PostgreSQL timestamptz db_type override alias matching. #4486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcusacosta wants to merge 1 commit into
base: main
Choose a base branch
Could not load branches
Branch not found: {{ refName }}

Are you sure you want to change the base?

Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
from
Conversation 0 Commits 1 Checks 12 Files changed
Open

Fix PostgreSQL timestamptz db_type override alias matching. #4486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .go  (6) .json  (1) .sql  (2) All 3 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
        • db.go
        • models.go
        • query.sql.go
      • query.sql
      • schema.sql
      • sqlc.json
5 changes: 3 additions & 2 deletions internal/codegen/golang/opts/override.go
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,10 @@ func (o *Override) Matches(n *plugin.Identifier, defaultSchema string) bool {
}

func (o *Override) MatchesColumn(col *plugin.Column) bool {
columnType := sdk.DataType(col.Type)
columnType := canonicalPostgreSQLType(sdk.DataType(col.Type))
overrideType := canonicalPostgreSQLType(o.DBType)
notNull := col.NotNull || col.IsArray
return o.DBType != "" && o.DBType == columnType && o.Nullable != notNull && o.Unsigned == col.Unsigned
return o.DBType != "" && overrideType == columnType && o.Nullable != notNull && o.Unsigned == col.Unsigned
}

func (o *Override) parse(req *plugin.GenerateRequest) (err error) {
Expand Down
101 changes: 101 additions & 0 deletions internal/codegen/golang/opts/override_test.go
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
package opts

import (
"strings"
"testing"

"github.com/google/go-cmp/cmp"

"github.com/sqlc-dev/sqlc/internal/plugin"
)

func TestTypeOverrides(t *testing.T) {
Expand Down Expand Up @@ -100,6 +103,104 @@ func TestTypeOverrides(t *testing.T) {
}
}

func TestMatchesColumnTimestamptzAliases(t *testing.T) {
t.Parallel()

parseOverride := func(t *testing.T, dbType string, nullable bool) Override {
t.Helper()
o := Override{
DBType: dbType,
Nullable: nullable,
GoType: GoType{Spec: "*time.Time"},
}
if err := o.parse(nil); err != nil {
t.Fatalf("override parsing failed: %s", err)
}
return o
}

column := func(typeName string, nullable bool) *plugin.Column {
typ := &plugin.Identifier{Name: typeName}
if schema, name, ok := strings.Cut(typeName, "."); ok && schema == "pg_catalog" {
typ = &plugin.Identifier{Schema: schema, Name: name}
}
return &plugin.Column{
Type: typ,
NotNull: !nullable,
}
}

for _, test := range []struct {
name string
override Override
column *plugin.Column
wantMatch bool
}{
{
name: "timestamptz override matches timestamptz column",
override: parseOverride(t, "timestamptz", true),
column: column("timestamptz", true),
wantMatch: true,
},
{
name: "timestamptz override matches timestamp with time zone column",
override: parseOverride(t, "timestamptz", true),
column: column("timestamp with time zone", true),
wantMatch: true,
},
{
name: "timestamptz override matches pg_catalog.timestamptz column",
override: parseOverride(t, "timestamptz", true),
column: column("pg_catalog.timestamptz", true),
wantMatch: true,
},
{
name: "pg_catalog.timestamptz override matches timestamptz column",
override: parseOverride(t, "pg_catalog.timestamptz", true),
column: column("timestamptz", true),
wantMatch: true,
},
{
name: "pg_catalog.timestamptz override matches timestamp with time zone column",
override: parseOverride(t, "pg_catalog.timestamptz", true),
column: column("timestamp with time zone", true),
wantMatch: true,
},
{
name: "timestamp with time zone override matches timestamptz column",
override: parseOverride(t, "timestamp with time zone", true),
column: column("timestamptz", true),
wantMatch: true,
},
{
name: "timestamptz override does not match not-null column",
override: parseOverride(t, "timestamptz", true),
column: column("timestamptz", false),
wantMatch: false,
},
{
name: "timestamptz override does not match timestamp without time zone",
override: parseOverride(t, "timestamptz", true),
column: column("timestamp", true),
wantMatch: false,
},
{
name: "timestamptz override does not match timestamp without time zone long form",
override: parseOverride(t, "timestamptz", true),
column: column("timestamp without time zone", true),
wantMatch: false,
},
} {
t.Run(test.name, func(t *testing.T) {
t.Parallel()
got := test.override.MatchesColumn(test.column)
if got != test.wantMatch {
t.Errorf("MatchesColumn() = %v, want %v", got, test.wantMatch)
}
})
}
}

func FuzzOverride(f *testing.F) {
for _, spec := range []string{
"string",
Expand Down
32 changes: 32 additions & 0 deletions internal/codegen/golang/opts/pg_type.go
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
package opts

var pgTypeCanonicalNames map[string]string

func init() {
groups := []struct {
canonical string
aliases []string
}{
{"pg_catalog.timestamptz", []string{"timestamptz", "timestamp with time zone"}},
{"pg_catalog.timestamp", []string{"timestamp", "timestamp without time zone"}},
{"pg_catalog.time", []string{"time", "time without time zone"}},
{"pg_catalog.timetz", []string{"timetz", "time with time zone"}},
}

pgTypeCanonicalNames = make(map[string]string, len(groups)*3)
for _, g := range groups {
pgTypeCanonicalNames[g.canonical] = g.canonical
for _, alias := range g.aliases {
pgTypeCanonicalNames[alias] = g.canonical
}
}
}

// canonicalPostgreSQLType maps PostgreSQL type aliases to a single canonical name
// so db_type overrides match regardless of spelling in schema SQL or config.
func canonicalPostgreSQLType(t string) string {
if canonical, ok := pgTypeCanonicalNames[t]; ok {
return canonical
}
return t
}
32 changes: 32 additions & 0 deletions internal/endtoend/testdata/overrides_timestamptz_alias/postgresql/pgx/v5/go/db.go
Show comments
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions internal/endtoend/testdata/overrides_timestamptz_alias/postgresql/pgx/v5/go/models.go
Show comments
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 34 additions & 0 deletions internal/endtoend/testdata/overrides_timestamptz_alias/postgresql/pgx/v5/go/query.sql.go
Show comments
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions internal/endtoend/testdata/overrides_timestamptz_alias/postgresql/pgx/v5/query.sql
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
-- name: ListUsers :many
SELECT * FROM users;
4 changes: 4 additions & 0 deletions internal/endtoend/testdata/overrides_timestamptz_alias/postgresql/pgx/v5/schema.sql
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
CREATE TABLE users (
short_form timestamptz,
long_form timestamp with time zone
);
24 changes: 24 additions & 0 deletions internal/endtoend/testdata/overrides_timestamptz_alias/postgresql/pgx/v5/sqlc.json
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"version": "1",
"packages": [
{
"path": "go",
"engine": "postgresql",
"sql_package": "pgx/v5",
"name": "querytest",
"schema": "schema.sql",
"queries": "query.sql"
}
],
"overrides": [
{
"db_type": "timestamptz",
"nullable": true,
"go_type": {
"import": "time",
"type": "Time",
"pointer": true
}
}
]
}
Loading
Back | FazBrowse Home | New Git URL