From 5aba26441b8e57f6647da8690f89bd36955f0fe0 Mon Sep 17 00:00:00 2001 From: jinhyuk9714 Date: Wed, 20 May 2026 14:53:33 +0900 Subject: [PATCH] fix(golang): escape generated enum values --- .../codegen/golang/templates/template.tmpl | 2 +- .../postgresql/stdlib/exec.json | 3 + .../postgresql/stdlib/go/db.go | 31 ++++++ .../postgresql/stdlib/go/models.go | 100 ++++++++++++++++++ .../postgresql/stdlib/go/query.sql.go | 21 ++++ .../postgresql/stdlib/query.sql | 2 + .../postgresql/stdlib/schema.sql | 15 +++ .../postgresql/stdlib/sqlc.yaml | 9 ++ 8 files changed, 182 insertions(+), 1 deletion(-) create mode 100644 internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/exec.json create mode 100644 internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/db.go create mode 100644 internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/models.go create mode 100644 internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/query.sql.go create mode 100644 internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/query.sql create mode 100644 internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/schema.sql create mode 100644 internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/sqlc.yaml diff --git a/internal/codegen/golang/templates/template.tmpl b/internal/codegen/golang/templates/template.tmpl index 9365817457..61892232e3 100644 --- a/internal/codegen/golang/templates/template.tmpl +++ b/internal/codegen/golang/templates/template.tmpl @@ -92,7 +92,7 @@ type {{.Name}} string const ( {{- range .Constants}} - {{.Name}} {{.Type}} = "{{.Value}}" + {{.Name}} {{.Type}} = {{printf "%q" .Value}} {{- end}} ) diff --git a/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/exec.json b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/exec.json new file mode 100644 index 0000000000..2e996ca79d --- /dev/null +++ b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/exec.json @@ -0,0 +1,3 @@ +{ + "contexts": ["base"] +} diff --git a/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/db.go b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/db.go new file mode 100644 index 0000000000..80dd6ab1f6 --- /dev/null +++ b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/db.go @@ -0,0 +1,31 @@ +// Code generated by sqlc. DO NOT EDIT. +// versions: +// sqlc v1.31.1 + +package querytest + +import ( + "context" + "database/sql" +) + +type DBTX interface { + ExecContext(context.Context, string, ...interface{}) (sql.Result, error) + PrepareContext(context.Context, string) (*sql.Stmt, error) + QueryContext(context.Context, string, ...interface{}) (*sql.Rows, error) + QueryRowContext(context.Context, string, ...interface{}) *sql.Row +} + +func New(db DBTX) *Queries { + return &Queries{db: db} +} + +type Queries struct { + db DBTX +} + +func (q *Queries) WithTx(tx *sql.Tx) *Queries { + return &Queries{ + db: tx, + } +} diff --git a/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/models.go b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/models.go new file mode 100644 index 0000000000..dfdfba7b5e --- /dev/null +++ b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/models.go @@ -0,0 +1,100 @@ +// Code generated by sqlc. DO NOT EDIT. +// versions: +// sqlc v1.31.1 + +package querytest + +import ( + "database/sql/driver" + "fmt" +) + +type Injection string + +const ( + InjectionSafeValue Injection = "safe_value" + InjectionInjectedarbitraryGoCode Injection = "injected\" + \"arbitrary_go_code\" + \"" +) + +func (e *Injection) Scan(src interface{}) error { + switch s := src.(type) { + case []byte: + *e = Injection(s) + case string: + *e = Injection(s) + default: + return fmt.Errorf("unsupported scan type for Injection: %T", src) + } + return nil +} + +type NullInjection struct { + Injection Injection + Valid bool // Valid is true if Injection is not NULL +} + +// Scan implements the Scanner interface. +func (ns *NullInjection) Scan(value interface{}) error { + if value == nil { + ns.Injection, ns.Valid = "", false + return nil + } + ns.Valid = true + return ns.Injection.Scan(value) +} + +// Value implements the driver Valuer interface. +func (ns NullInjection) Value() (driver.Value, error) { + if !ns.Valid { + return nil, nil + } + return string(ns.Injection), nil +} + +type UserRole string + +const ( + UserRoleAdmin UserRole = "admin" + UserRoleUsernadmin UserRole = "user\\nadmin" +) + +func (e *UserRole) Scan(src interface{}) error { + switch s := src.(type) { + case []byte: + *e = UserRole(s) + case string: + *e = UserRole(s) + default: + return fmt.Errorf("unsupported scan type for UserRole: %T", src) + } + return nil +} + +type NullUserRole struct { + UserRole UserRole + Valid bool // Valid is true if UserRole is not NULL +} + +// Scan implements the Scanner interface. +func (ns *NullUserRole) Scan(value interface{}) error { + if value == nil { + ns.UserRole, ns.Valid = "", false + return nil + } + ns.Valid = true + return ns.UserRole.Scan(value) +} + +// Value implements the driver Valuer interface. +func (ns NullUserRole) Value() (driver.Value, error) { + if !ns.Valid { + return nil, nil + } + return string(ns.UserRole), nil +} + +type User struct { + ID int32 + Role UserRole + Payload Injection +} diff --git a/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/query.sql.go b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/query.sql.go new file mode 100644 index 0000000000..d0bbef64aa --- /dev/null +++ b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/go/query.sql.go @@ -0,0 +1,21 @@ +// Code generated by sqlc. DO NOT EDIT. +// versions: +// sqlc v1.31.1 +// source: query.sql + +package querytest + +import ( + "context" +) + +const getUser = `-- name: GetUser :one +SELECT id, role, payload FROM users WHERE id = $1 +` + +func (q *Queries) GetUser(ctx context.Context, id int32) (User, error) { + row := q.db.QueryRowContext(ctx, getUser, id) + var i User + err := row.Scan(&i.ID, &i.Role, &i.Payload) + return i, err +} diff --git a/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/query.sql b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/query.sql new file mode 100644 index 0000000000..43c7516959 --- /dev/null +++ b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/query.sql @@ -0,0 +1,2 @@ +-- name: GetUser :one +SELECT id, role, payload FROM users WHERE id = $1; diff --git a/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/schema.sql b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/schema.sql new file mode 100644 index 0000000000..d7b726c173 --- /dev/null +++ b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/schema.sql @@ -0,0 +1,15 @@ +CREATE TYPE injection AS ENUM ( + 'safe_value', + 'injected" + "arbitrary_go_code" + "' +); + +CREATE TYPE user_role AS ENUM ( + 'admin', + 'user\nadmin' +); + +CREATE TABLE users ( + id SERIAL PRIMARY KEY, + role user_role NOT NULL, + payload injection NOT NULL +); diff --git a/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/sqlc.yaml b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/sqlc.yaml new file mode 100644 index 0000000000..610a4a1ed5 --- /dev/null +++ b/internal/endtoend/testdata/enum_escaped_values/postgresql/stdlib/sqlc.yaml @@ -0,0 +1,9 @@ +version: "2" +sql: + - engine: postgresql + schema: "schema.sql" + queries: "query.sql" + gen: + go: + package: "querytest" + out: "go"